Merge pull request #4 from lamoda/support_for_order_requests_signing

Support for sending signed order requests

Author: omnilight

README.md

@@ -46,3 +46,11 @@ $omsApi = new OmsApi($client, $serializer);
  */
 // $response = $omsApi->getICBufferStatus();
 ```
+
+## Signing of OMS requests
+
+It is also possible to send signed OMS requests for orders.
+
+To do that implement `\Lamoda\OmsClient\V2\Signer\SignerInterface`. 
+
+Signer must return signature for the given data (no data itself transformation is required).

src/Exception/OmsSignerErrorException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Lamoda\OmsClient\Exception;
+
+final class OmsSignerErrorException extends \RuntimeException implements OmsClientExceptionInterface
+{
+    public static function becauseOfError(\Throwable $exception): self
+    {
+        return new static(sprintf(
+            'Signer request finished with an error "%s"',
+            $exception->getMessage()
+        ), 0, $exception);
+    }
+}

src/V2/OmsApi.php

@@ -10,12 +10,14 @@
 use Lamoda\OmsClient\Exception\OmsClientExceptionInterface;
 use Lamoda\OmsClient\Exception\OmsGeneralErrorException;
 use Lamoda\OmsClient\Exception\OmsRequestErrorException;
+use Lamoda\OmsClient\Exception\OmsSignerErrorException;
 use Lamoda\OmsClient\Serializer\SerializerInterface;
 use Lamoda\OmsClient\V2\Dto\CloseICArrayResponse;
 use Lamoda\OmsClient\V2\Dto\CreateOrderForEmissionICRequest;
 use Lamoda\OmsClient\V2\Dto\CreateOrderForEmissionICResponse;
 use Lamoda\OmsClient\V2\Dto\GetICBufferStatusResponse;
 use Lamoda\OmsClient\V2\Dto\GetICsFromOrderResponse;
+use Lamoda\OmsClient\V2\Signer\SignerInterface;
 
 final class OmsApi
 {
@@ -38,14 +40,18 @@ public function createOrderForEmissionIC(
         Extension $extension,
         string $token,
         string $omsId,
-        CreateOrderForEmissionICRequest $request
+        CreateOrderForEmissionICRequest $request,
+        SignerInterface $signer = null
     ): CreateOrderForEmissionICResponse {
         $url = sprintf('/api/v2/%s/orders', (string)$extension);
         $body = $this->serializer->serialize($request);
 
+        $headers = [];
+        $headers = $this->appendSignatureHeader($headers, $body, $signer);
+
         $result = $this->request($token, 'POST', $url, [
             'omsId' => $omsId,
-        ], $body);
+        ], $body, $headers);
 
         /* @noinspection PhpIncompatibleReturnTypeInspection */
         return $this->serializer->deserialize(CreateOrderForEmissionICResponse::class, $result);
@@ -114,14 +120,20 @@ public function closeICArray(
     /**
      * @throws OmsRequestErrorException
      */
-    private function request(string $token, string $method, string $uri, array $query = [], $body = null): string
-    {
+    private function request(
+        string $token,
+        string $method,
+        string $uri,
+        array $query = [],
+        $body = null,
+        $headers = []
+    ): string {
         $options = [
             RequestOptions::BODY => $body,
-            RequestOptions::HEADERS => [
+            RequestOptions::HEADERS => array_merge($headers, [
                 'Content-Type' => 'application/json',
                 'clientToken' => $token,
-            ],
+            ]),
             RequestOptions::QUERY => $query,
             RequestOptions::HTTP_ERRORS => true,
         ];
@@ -150,4 +162,21 @@ private function handleRequestException(\Throwable $exception): OmsClientExcepti
 
         return OmsGeneralErrorException::becauseOfError($exception);
     }
+
+    private function appendSignatureHeader(array $headers, string $data, SignerInterface $signer = null): array
+    {
+        if ($signer === null) {
+            return $headers;
+        }
+
+        $base64encoded = base64_encode($data);
+
+        try {
+            $headers['X-Signature'] = $signer->sign($base64encoded);
+        } catch (\Throwable $exception) {
+            throw OmsSignerErrorException::becauseOfError($exception);
+        }
+
+        return $headers;
+    }
 }

src/V2/Signer/SignerInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Lamoda\OmsClient\V2\Signer;
+
+interface SignerInterface
+{
+    public function sign(string $data): string;
+}

tests/V2/OmsApiTest.php

@@ -10,6 +10,7 @@
 use GuzzleHttp\RequestOptions;
 use Lamoda\OmsClient\Exception\OmsGeneralErrorException;
 use Lamoda\OmsClient\Exception\OmsRequestErrorException;
+use Lamoda\OmsClient\Exception\OmsSignerErrorException;
 use Lamoda\OmsClient\Serializer\SerializerInterface;
 use Lamoda\OmsClient\V2\Dto\CloseICArrayResponse;
 use Lamoda\OmsClient\V2\Dto\CreateOrderForEmissionICRequestLight;
@@ -18,6 +19,8 @@
 use Lamoda\OmsClient\V2\Dto\GetICsFromOrderResponse;
 use Lamoda\OmsClient\V2\Extension;
 use Lamoda\OmsClient\V2\OmsApi;
+use Lamoda\OmsClient\V2\Signer\SignerInterface;
+use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\RequestInterface;
@@ -184,6 +187,112 @@ public function testCreateOrderForEmissionIC(): void
         $this->assertEquals($expectedResult, $result);
     }
 
+    public function testCreateOrderForEmissionICWithSignature(): void
+    {
+        $createOrderForEmissionICRequestLight = new CreateOrderForEmissionICRequestLight(
+            '',
+            '',
+            '',
+            '',
+            '',
+            new \DateTimeImmutable(),
+            []
+        );
+
+        $serializedRequest = '{"test": "value"}';
+        $signature = 'signature';
+
+        $this->serializer->expects($this->once())
+            ->method('serialize')
+            ->with(
+                $createOrderForEmissionICRequestLight
+            )
+            ->willReturn($serializedRequest);
+
+
+        $this->client->expects($this->once())
+            ->method('request')
+            ->with(
+                'POST',
+                'api/v2/light/orders',
+                [
+                    RequestOptions::BODY => $serializedRequest,
+                    RequestOptions::HEADERS => [
+                        'Content-Type' => 'application/json',
+                        'clientToken' => self::TOKEN,
+                        'X-Signature' => $signature
+                    ],
+                    RequestOptions::QUERY => [
+                        'omsId' => self::OMS_ID,
+                    ],
+                    RequestOptions::HTTP_ERRORS => true,
+                ]
+            )
+            ->willReturn(
+                (new Response())
+                    ->withBody(stream_for(self::API_RESPONSE))
+            );
+
+        $expectedResult = new CreateOrderForEmissionICResponse(self::OMS_ID, self::ORDER_ID, 100);
+        $this->serializer
+            ->method('deserialize')
+            ->willReturn($expectedResult);
+
+        $signer = $this->createMock(SignerInterface::class);
+        $signer->method('sign')
+            ->with(base64_encode($serializedRequest))
+            ->willReturn($signature);
+
+        $result = $this->api->createOrderForEmissionIC(
+            Extension::light(),
+            self::TOKEN,
+            self::OMS_ID,
+            $createOrderForEmissionICRequestLight,
+            $signer
+        );
+
+        $this->assertEquals($expectedResult, $result);
+    }
+
+    public function testCreateOrderForEmissionFinishedWithSignerException(): void
+    {
+        $createOrderForEmissionICRequestLight = new CreateOrderForEmissionICRequestLight(
+            '',
+            '',
+            '',
+            '',
+            '',
+            new \DateTimeImmutable(),
+            []
+        );
+
+        $serializedRequest = '{"test": "value"}';
+
+        $this->serializer->expects($this->once())
+            ->method('serialize')
+            ->with(
+                $createOrderForEmissionICRequestLight
+            )
+            ->willReturn($serializedRequest);
+
+
+        $this->client->expects($this->never())
+            ->method('request');
+
+        $signer = $this->createMock(SignerInterface::class);
+        $signer->method('sign')
+            ->willThrowException(new \Exception('Something happened in signer'));
+
+        $this->expectException(OmsSignerErrorException::class);
+        $this->api->createOrderForEmissionIC(
+            Extension::light(),
+            self::TOKEN,
+            self::OMS_ID,
+            $createOrderForEmissionICRequestLight,
+            $signer
+        );
+    }
+
     public function testGetICBufferStatus(): void
     {
         $this->client->expects($this->once())