Merge pull request #15 from SoapBox/feature/customizable-generators

[Feature] Decouple the Generators from the Illuminate Configuration Repository

Author: Jaspaul

src/Configurations/Configuration.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace SoapBox\SignedRequests\Configurations;
+
+interface Configuration
+{
+    /**
+     * Returns the name of the header that will contain the algorithm used to
+     * sign the request.
+     *
+     * @return string
+     */
+    public function getAlgorithmHeader(): string;
+
+    /**
+     * Returns the name of the header that will contain the generated signature.
+     *
+     * @return string
+     */
+    public function getSignatureHeader(): string;
+
+    /**
+     * Returns the algorithm to use to generate the signature.
+     *
+     * @return string
+     */
+    public function getSigningAlgorithm(): string;
+
+    /**
+     * Returns the key to sign the request with.
+     *
+     * @return string
+     */
+    public function getSigningKey(): string;
+}

src/Configurations/CustomConfiguration.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace SoapBox\SignedRequests\Configurations;
+
+class CustomConfiguration implements Configuration
+{
+    /**
+     * The algorithm header to return.
+     *
+     * @var string
+     */
+    protected $algorithmHeader;
+
+    /**
+     * The signature header to return.
+     *
+     * @var string
+     */
+    protected $signatureHeader;
+
+    /**
+     * The signing algorithm to return.
+     *
+     * @var string
+     */
+    protected $signingAlgorithm;
+
+    /**
+     * The signing key to return.
+     *
+     * @var string
+     */
+    protected $signingKey;
+
+    /**
+     * Sets up our custom configuration with various properties.
+     *
+     * @param string $algorithmHeader
+     *        The algorithm header to use.
+     * @param string $signatureHeader
+     *        The signature header to use.
+     * @param string $signingAlgorithm
+     *        The signing algorithm to use.
+     * @param string $signingKey
+     *        The signing key to use.
+     */
+    public function __construct(
+        string $algorithmHeader,
+        string $signatureHeader,
+        string $signingAlgorithm,
+        string $signingKey
+    ) {
+        $this->algorithmHeader = $algorithmHeader;
+        $this->signatureHeader = $signatureHeader;
+        $this->signingAlgorithm = $signingAlgorithm;
+        $this->signingKey = $signingKey;
+    }
+
+    /**
+     * Returns the name of the header that will contain the algorithm used to
+     * sign the request.
+     *
+     * @return string
+     */
+    public function getAlgorithmHeader(): string
+    {
+        return $this->algorithmHeader;
+    }
+
+    /**
+     * Returns the name of the header that will contain the generated signature.
+     *
+     * @return string
+     */
+    public function getSignatureHeader(): string
+    {
+        return $this->signatureHeader;
+    }
+
+    /**
+     * Returns the algorithm to use to generate the signature.
+     *
+     * @return string
+     */
+    public function getSigningAlgorithm(): string
+    {
+        return $this->signingAlgorithm;
+    }
+
+    /**
+     * Returns the key to sign the request with.
+     *
+     * @return string
+     */
+    public function getSigningKey(): string
+    {
+        return $this->signingKey;
+    }
+}

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/Exceptions/ExpiredRequestException.php

@@ -3,7 +3,6 @@
 namespace SoapBox\SignedRequests\Exceptions;
 
 use Exception;
-use Throwable;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 

src/Exceptions/InvalidSignatureException.php

@@ -3,7 +3,6 @@
 namespace SoapBox\SignedRequests\Exceptions;
 
 use Exception;
-use Throwable;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 

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

@@ -6,28 +6,27 @@
 use Ramsey\Uuid\Uuid;
 use GuzzleHttp\Psr7\Request;
 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 +36,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());

src/Requests/Verifier.php

@@ -5,7 +5,6 @@
 use Carbon\Carbon;
 use Illuminate\Http\Request;
 use SoapBox\SignedRequests\Signature;
-use SoapBox\SignedRequests\Requests\Payload;
 
 class Verifier
 {

tests/Configurations/CustomConfigurationTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Tests\Configurations;
+
+use Tests\TestCase;
+use SoapBox\SignedRequests\Configurations\CustomConfiguration;
+
+class CustomConfigurationTest extends TestCase
+{
+    /**
+     * @test
+     */
+    function it_returns_the_set_values_when_requested()
+    {
+        $algorithmHeader = 'a';
+        $signatureHeader = 's';
+        $signingAlgorithm = 'sa';
+        $signingKey = 'sk';
+
+        $configuration = new CustomConfiguration(
+            $algorithmHeader,
+            $signatureHeader,
+            $signingAlgorithm,
+            $signingKey
+        );
+
+        $this->assertSame($algorithmHeader, $configuration->getAlgorithmHeader());
+        $this->assertSame($signatureHeader, $configuration->getSignatureHeader());
+        $this->assertSame($signingAlgorithm, $configuration->getSigningAlgorithm());
+        $this->assertSame($signingKey, $configuration->getSigningKey());
+    }
+}