Refactors our generator to depend on a configuration adapter

Previously the generator was aware of the illuminate configuration
contract, which made it difficult to use multiple signed request
configurations in a single project. With the addition of the
configuration adapters we can now have many implementations
of configurations.

Author: Jaspaul

src/Configurations/RepositoryConfiguration.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace SoapBox\SignedRequests\Configurations;
+
+use Illuminate\Contracts\Config\Repository;
+
+class RepositoryConfiguration implements Configuration
+{
+    /**
+     * An instance of the configuration repository.
+     *
+     * @var \Illuminate\Contracts\Config\Repository
+     */
+    protected $repository;
+
+    /**
+     * Sets up our configuration with an instance of the laravel configuration
+     * repository.
+     *
+     * @param \Illuminate\Contracts\Config\Repository $repository
+     *        A configuration repository.
+     */
+    public function __construct(Repository $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    /**
+     * Returns the name of the header that will contain the algorithm used to
+     * sign the request.
+     *
+     * @return string
+     */
+    public function getAlgorithmHeader(): string
+    {
+        return $this->repository->get('signed-requests.headers.algorithm');
+    }
+
+    /**
+     * Returns the name of the header that will contain the generated signature.
+     *
+     * @return string
+     */
+    public function getSignatureHeader(): string
+    {
+        return $this->repository->get('signed-requests.headers.signature');
+    }
+
+    /**
+     * Returns the algorithm to use to generate the signature.
+     *
+     * @return string
+     */
+    public function getSigningAlgorithm(): string
+    {
+        return $this->repository->get('signed-requests.algorithm');
+    }
+
+    /**
+     * Returns the key to sign the request with.
+     *
+     * @return string
+     */
+    public function getSigningKey(): string
+    {
+        return $this->repository->get('signed-requests.key');
+    }
+}

src/Middlewares/Guzzle/GenerateSignature.php

@@ -4,6 +4,7 @@
 
 use Psr\Http\Message\RequestInterface;
 use SoapBox\SignedRequests\Requests\Generator;
+use SoapBox\SignedRequests\Configurations\Configuration;
 
 class GenerateSignature
 {
@@ -15,14 +16,14 @@ class GenerateSignature
     protected $generator;
 
     /**
-     * Expect an instance of the generator so we can sign the request
+     * Expect a configuration to build our generator with.
      *
-     * @param \SoapBox\SignedRequests\Requests\Generator $generator
-     *        An instance of the signed request generator
+     * @param \SoapBox\SignedRequests\Configurations\Configuration $configuration
+     *        The configuration to use for generating signed requests.
      */
-    public function __construct(Generator $generator)
+    public function __construct(Configuration $configuration)
     {
-        $this->generator = $generator;
+        $this->generator = new Generator($configuration);
     }
 
     /**

src/Requests/Generator.php

@@ -8,26 +8,27 @@
 use SoapBox\SignedRequests\Signature;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Contracts\Config\Repository;
+use SoapBox\SignedRequests\Configurations\Configuration;
 
 class Generator
 {
     /**
-     * An instance of the configuration repository.
+     * A configuration to use for generating signatures.
      *
-     * @var \Illuminate\Contracts\Config\Repository
+     * @var \SoapBox\SignedRequests\Configurations\Configuration
      */
-    private $repository;
+    private $configuration;
 
     /**
      * Constructs our signed request generator with an instance of the
      * configurations.
      *
-     * @param \Illuminate\Contracts\Config\Repository $repository
-     *        A configuration repository.
+     * @param \SoapBox\SignedRequests\Configurations\Configuration $configuration
+     *        The configuration to use for generating the signed request.
      */
-    public function __construct(Repository $repository)
+    public function __construct(Configuration $configuration)
     {
-        $this->repository = $repository;
+        $this->configuration = $configuration;
     }
 
     /**
@@ -37,15 +38,15 @@ public function __construct(Repository $repository)
      *        The request to sign.
      *
      * @return \GuzzleHttp\Psr7\Request
-     *         The request with an id, algorith, and signature.
+     *         The request with an id, algorithm, and signature.
      */
     public function sign(Request $request) : Request
     {
-        $algorithmHeader = $this->repository->get('signed-requests.headers.algorithm');
-        $signatureHeader = $this->repository->get('signed-requests.headers.signature');
+        $algorithmHeader = $this->configuration->getAlgorithmHeader();
+        $signatureHeader = $this->configuration->getSignatureHeader();
 
-        $algorithm = $this->repository->get('signed-requests.algorithm');
-        $key = $this->repository->get('signed-requests.key');
+        $algorithm = $this->configuration->getSigningAlgorithm();
+        $key = $this->configuration->getSigningKey();
 
         $request = $request->withHeader('X-SIGNED-ID', (string) Uuid::uuid4());
         $request = $request->withHeader('X-SIGNED-TIMESTAMP', (string) Carbon::now());

tests/Configurations/RepositoryConfigurationTest.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Tests\Configurations;
+
+use Mockery;
+use Tests\TestCase;
+use Illuminate\Contracts\Config\Repository;
+use SoapBox\SignedRequests\Configurations\RepositoryConfiguration;
+
+class RepositoryConfigurationTest extends TestCase
+{
+    protected $repository;
+    protected $configuration;
+
+    /**
+     * @before
+     */
+    function setup_repository()
+    {
+        $this->repository = Mockery::mock(Repository::class);
+        $this->configuration = new RepositoryConfiguration($this->repository);
+    }
+
+    /**
+     * @test
+     */
+    function get_algorithm_header_returns_the_algorithm_header_value_from_the_configuration_repository()
+    {
+        $this->repository->shouldReceive('get')
+            ->with('signed-requests.headers.algorithm')
+            ->andReturn('algorithm');
+
+        $this->assertSame('algorithm', $this->configuration->getAlgorithmHeader());
+    }
+
+    /**
+     * @test
+     */
+    function get_signature_header_returns_the_signature_header_value_from_the_configuration_repository()
+    {
+        $this->repository->shouldReceive('get')
+            ->with('signed-requests.headers.signature')
+            ->andReturn('signature');
+
+        $this->assertSame('signature', $this->configuration->getSignatureHeader());
+    }
+
+    /**
+     * @test
+     */
+    function get_signing_algorithm_returns_the_signing_algorithm_to_use_from_the_configuration_repository()
+    {
+        $this->repository->shouldReceive('get')
+            ->with('signed-requests.algorithm')
+            ->andReturn('sha256');
+
+        $this->assertSame('sha256', $this->configuration->getSigningAlgorithm());
+    }
+
+    /**
+     * @test
+     */
+    function get_signing_key_returns_the_key_used_for_signing_the_request_from_the_configuration_repository()
+    {
+        $this->repository->shouldReceive('get')
+            ->with('signed-requests.key')
+            ->andReturn('key');
+
+        $this->assertSame('key', $this->configuration->getSigningKey());
+    }
+}

tests/Middlewares/Guzzle/GenerateSignatureTest.php

@@ -8,7 +8,9 @@
 use Illuminate\Config\Repository;
 use Psr\Http\Message\RequestInterface;
 use SoapBox\SignedRequests\Requests\Generator;
+use SoapBox\SignedRequests\Configurations\Configuration;
 use SoapBox\SignedRequests\Middlewares\Guzzle\GenerateSignature;
+use SoapBox\SignedRequests\Configurations\RepositoryConfiguration;
 
 class GenerateSignatureTest extends TestCase
 {
@@ -17,7 +19,7 @@ class GenerateSignatureTest extends TestCase
      */
     public function it_can_be_constructed()
     {
-        $middleware = new GenerateSignature(new Generator(Mockery::mock(Repository::class)));
+        $middleware = new GenerateSignature(Mockery::mock(Configuration::class));
         $this->assertInstanceOf(GenerateSignature::class, $middleware);
     }
 
@@ -45,7 +47,7 @@ public function it_signs_the_request()
         $key = $configurations->shouldReceive('get')
             ->with('signed-requests.key')
             ->andReturn('bigsecretrighthereitellyouwhat');
-        $middleware = new GenerateSignature(new Generator($configurations));
+        $middleware = new GenerateSignature(new RepositoryConfiguration($configurations));
 
         $nextHandler = function (RequestInterface $request, array $options) {
             return $request;

tests/Requests/GeneratorTest.php

@@ -6,40 +6,36 @@
 use Tests\TestCase;
 use GuzzleHttp\Psr7\Request;
 use SoapBox\SignedRequests\Signature;
-use Illuminate\Contracts\Config\Repository;
 use SoapBox\SignedRequests\Requests\Payload;
 use SoapBox\SignedRequests\Requests\Generator;
+use SoapBox\SignedRequests\Configurations\Configuration;
 
 class GeneratorTest extends TestCase
 {
-    private $repository;
+    private $configuration;
     private $generator;
 
     /**
      * @before
      */
     public function setup_a_local_generator()
     {
-        $this->repository = Mockery::mock(Repository::class);
+        $this->configuration = Mockery::mock(Configuration::class);
 
-        $this->repository
-            ->shouldReceive('get')
-            ->with('signed-requests.headers.algorithm')
+        $this->configuration
+            ->shouldReceive('getAlgorithmHeader')
             ->andReturn('X-ALGORITHM');
-        $this->repository
-            ->shouldReceive('get')
-            ->with('signed-requests.headers.signature')
+        $this->configuration
+            ->shouldReceive('getSignatureHeader')
             ->andReturn('X-SIGNATURE');
-        $this->repository
-            ->shouldReceive('get')
-            ->with('signed-requests.algorithm')
+        $this->configuration
+            ->shouldReceive('getSigningAlgorithm')
             ->andReturn('sha256');
-        $this->repository
-            ->shouldReceive('get')
-            ->with('signed-requests.key')
+        $this->configuration
+            ->shouldReceive('getSigningKey')
             ->andReturn('key');
 
-        $this->generator = new Generator($this->repository);
+        $this->generator = new Generator($this->configuration);
     }
 
     /**