Merge pull request #6 from paragonie/adapter-injectable

Proposal: Inject adapters, punt to adapter where appropriate.

README.md

@@ -60,7 +60,7 @@ use ParagonIE\Sapient\Exception\InvalidMessageException;
 $http = new Client([
     'base_uri' => 'https://your-api.example.com'
 ]);
-$adapter = new GuzzleAdapter($http);
+$sapient = new Sapient(new GuzzleAdapter($http));
 
 // Keys
 $clientSigningKey = new SigningSecretKey(
@@ -83,7 +83,7 @@ $myMessage = [
 ];
 
 // Create the signed request:
-$request = $adapter->createSignedJsonRequest(
+$request = $sapient->createSignedJsonRequest(
     'POST',
      '/my/api/endpoint',
      $myMessage,
@@ -93,7 +93,7 @@ $request = $adapter->createSignedJsonRequest(
 $response = $http->send($request);
 try {
     /** @var array $verifiedResponse */
-    $verifiedResponse = Sapient::decodeSignedJsonResponse(
+    $verifiedResponse = $sapient->decodeSignedJsonResponse(
         $response,
         $serverPublicKey
     );
@@ -121,7 +121,7 @@ use ParagonIE\Sapient\Exception\InvalidMessageException;
 $http = new Client([
     'base_uri' => 'https://your-api.example.com'
 ]);
-$adapter = new GuzzleAdapter($http);
+$sapient = new Sapient(new GuzzleAdapter($http));
 
 $clientPublicKey = new SigningPublicKey(
     Base64UrlSafe::decode(
@@ -131,7 +131,7 @@ $clientPublicKey = new SigningPublicKey(
 $request = ServerRequest::fromGlobals();
 try {
     /** @var array $decodedRequest */
-    $decodedRequest = Sapient::decodeSignedJsonRequest(
+    $decodedRequest = $sapient->decodeSignedJsonRequest(
         $request,
         $clientPublicKey
     );
@@ -157,7 +157,7 @@ $responseMessage = [
     ]
 ];
 
-$response = $adapter->createSignedJsonResponse(
+$response = $sapient->createSignedJsonResponse(
     200,
     $responseMessage,
     $serverSignSecret

composer.json

@@ -4,15 +4,19 @@
   "type": "library",
   "require": {
     "php": "^7",
-    "guzzlehttp/guzzle": "^6",
     "guzzlehttp/psr7": "^1",
     "paragonie/constant_time_encoding": "^2",
-    "paragonie/sodium_compat": "^1"
+    "paragonie/sodium_compat": "^1",
+    "psr/http-message": "^1"
   },
   "require-dev": {
+    "guzzlehttp/guzzle": "^6",
     "phpunit/phpunit": "^6",
     "vimeo/psalm": "dev-master"
   },
+  "suggest": {
+    "guzzlehttp/guzzle": ">= 6.0 -- Sapient can be used a Guzzle adapter"
+  },
   "autoload": {
     "psr-4": {
       "ParagonIE\\Sapient\\": "src"

src/Adapter/AdapterInterface.php

@@ -13,7 +13,8 @@
 };
 use Psr\Http\Message\{
     RequestInterface,
-    ResponseInterface
+    ResponseInterface,
+    StreamInterface
 };
 
 
@@ -336,4 +337,12 @@ public function createSignedResponse(
         array $headers = [],
         string $version = '1.1'
     );
+
+    /**
+     * Adapter-specific way of converting a string into a StreamInterface
+     *
+     * @param string $input
+     * @return StreamInterface
+     */
+    public function stringToStream(string $input): StreamInterface;
 }

src/Adapter/Guzzle.php

@@ -7,6 +7,7 @@
     Request,
     Response
 };
+use function GuzzleHttp\Psr7\stream_for;
 use ParagonIE\ConstantTime\Base64UrlSafe;
 use ParagonIE\Sapient\Exception\{
     InvalidMessageException
@@ -21,7 +22,8 @@
 use ParagonIE\Sapient\Simple;
 use Psr\Http\Message\{
     RequestInterface,
-    ResponseInterface
+    ResponseInterface,
+    StreamInterface
 };
 
 /**
@@ -583,4 +585,20 @@ public function createSignedResponse(
             $version
         );
     }
+
+    /**
+     * Adapter-specific way of converting a string into a StreamInterface
+     *
+     * @param string $input
+     * @return StreamInterface
+     * @throws \TypeError
+     */
+    public function stringToStream(string $input): StreamInterface
+    {
+        $stream = stream_for($input);
+        if (!($stream instanceof StreamInterface)) {
+            throw new \TypeError('Could not convert string to a stream');
+        }
+        return $stream;
+    }
 }