Merge pull request #104 from alma/develop

Release 2.0.7

.github/workflows/code-coverage.yaml

@@ -2,9 +2,9 @@ name: PHPUnit Coverage Report
 
 on:
   push:
-    branches: [develop, master]
+    branches: [develop, main]
   pull_request:
-    branches: [develop, master]
+    branches: [develop, main]
   workflow_dispatch: ~
 
 jobs:

.github/workflows/php.yml

@@ -2,9 +2,9 @@ name: PHP Lint and unit tests
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
+    branches: [main]
   workflow_dispatch: ~
 
 jobs:

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-added-large-files
         args: ["--maxkb=1024"]

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+v2.0.7
+-------
+* Add endpoint Order State
+
+
 v2.0.6
 -------
 * Fix error in throw exception without sprintf

composer.json

@@ -1,19 +1,20 @@
 {
   "name": "alma/alma-php-client",
   "description": "PHP API client for the Alma payments API",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "type": "library",
   "require": {
     "php": "^5.6 || ~7.0 || ~7.1 || ~7.2 || ~7.3 || ~7.4 || ~8.0 || ~8.1 || ~8.2",
     "psr/log": "^1 || ^2 || ^3",
     "ext-curl": "*",
     "ext-json": "*",
-    "ext-simplexml": "*"
+    "ext-simplexml": "*",
+    "ext-iconv": "*"
   },
   "require-dev": {
-    "dealerdirect/phpcodesniffer-composer-installer": "^0.7.0",
+    "dealerdirect/phpcodesniffer-composer-installer": "^1.0.0",
     "phpcompatibility/php-compatibility": "^9.0",
-    "phpunit/phpunit": "^5 || ^6 || ^7 || ^8 || ^9 || ^10",
+    "phpunit/phpunit": "^5 || ^6 || ^7 || ^8 || ^9 || ^10 || ^11",
     "roave/security-advisories": "@dev",
     "squizlabs/php_codesniffer": "^3.3",
     "mockery/mockery": "^1.3"

src/Client.php

@@ -30,7 +30,7 @@
 
 class Client
 {
-    const VERSION = '2.0.6';
+    const VERSION = '2.0.7';
 
     const LIVE_MODE = 'live';
     const TEST_MODE = 'test';

src/Endpoints/Orders.php

@@ -26,12 +26,30 @@
 namespace Alma\API\Endpoints;
 
 use Alma\API\Entities\Order;
+use Alma\API\Exceptions\AlmaException;
+use Alma\API\Exceptions\MissingKeyException;
+use Alma\API\Exceptions\ParametersException;
+use Alma\API\Exceptions\RequestException;
+use Alma\API\Lib\ArrayUtils;
 use Alma\API\RequestError;
 use Alma\API\PaginatedResults;
 
 class Orders extends Base
 {
+    /**
+     * @var ArrayUtils
+     */
+    public $arrayUtils;
+
     const ORDERS_PATH = '/v1/orders';
+    const ORDERS_PATH_V2 = '/v2/orders';
+
+    public function __construct($client_context)
+    {
+        parent::__construct($client_context);
+
+        $this->arrayUtils = new ArrayUtils();
+    }
 
     /**
      * @param string $orderId
@@ -90,4 +108,57 @@ public function fetch($orderId)
         $response = $this->request(self::ORDERS_PATH . "/{$orderId}")->get();
         return new Order($response->json);
     }
+
+    /**
+     * @param string $orderExternalId
+     * @param array $orderData
+     * @return void
+     * @throws ParametersException
+     * @throws RequestException
+     */
+    public function sendStatus($orderExternalId, $orderData = array())
+    {
+        $this->validateStatusData($orderData);
+        $label = $this->arrayUtils->slugify($orderData['status']);
+
+        try {
+            $response = $this->request(self::ORDERS_PATH_V2 . "/{$orderExternalId}/status")->setRequestBody(array(
+                'status' =>  $label,
+                'is_shipped' => $orderData['is_shipped'],
+            ))->post();
+        }catch (AlmaException $e) {
+            $this->logger->error('Error sending status');
+            throw new RequestException('Error sending status', $e);
+        }
+
+        if ($response->isError()) {
+            throw new RequestException($response->errorMessage, null, $response);
+        }
+    }
+
+    /**
+     * @param array $orderData
+     * @return void
+     * @throws ParametersException
+     */
+    public function validateStatusData($orderData = array())
+    {
+        if(count($orderData) == 0) {
+            throw new ParametersException('Missing in the required parameters (status, is_shipped) when calling orders.sendStatus');
+        }
+
+        try {
+            $this->arrayUtils->checkMandatoryKeys(['status', 'is_shipped'], $orderData);
+        } catch (MissingKeyException $e ) {
+            throw new ParametersException('Error in the required parameters (status, is_shipped) when calling orders.sendStatus',null,  $e);
+        }
+
+        if(!is_bool($orderData['is_shipped'])) {
+            throw new ParametersException('Parameter "is_shipped" must be a boolean');
+        }
+
+        if(!$orderData['status']) {
+            throw new ParametersException('Missing the required parameter "status" when calling orders.sendStatus');
+        }
+    }
 }

src/Lib/ArrayUtils.php

@@ -26,7 +26,9 @@
 
 namespace Alma\API\Lib;
 
+use Alma\API\Exceptions\AlmaException;
 use Alma\API\Exceptions\MissingKeyException;
+use Alma\API\Exceptions\ParametersException;
 
 /**
  * Class ArrayUtils
@@ -64,4 +66,48 @@ public function checkMandatoryKeys($keys, $array)
             }
         }
     }
+
+    /**
+     * Return the slug of a string to be used in a URL.
+     *
+     * @param string $textToSlugify
+     *
+     * @throws ParametersException
+     *
+     * @return String
+     */
+    public function slugify($textToSlugify){
+        if(!is_string($textToSlugify)) {
+            throw new ParametersException('Status must be a string');
+        }
+
+        // trim
+        $text = trim($textToSlugify, '-');
+
+        // replace non letter or digits by -
+        $text = preg_replace('~[^\pL\d]+~u', '_', $text);
+
+        // transliterate
+        $text = iconv('utf-8', 'us-ascii//TRANSLIT', $text);
+
+        // remove unwanted characters
+        $text = preg_replace('~[^-\w]+~', '', $text);
+
+
+        // remove duplicated - symbols
+        $text = preg_replace('~-+~', '-', $text);
+
+        // lowercase
+        $text = strtolower($text);
+
+        if (
+            empty($text)
+            || '_' === $text
+        ) {
+            throw new ParametersException(sprintf('The slug is empty, status "%s"', $textToSlugify));
+        }
+
+        return $text;
+    }
+
 }

tests/Unit/Legacy/Endpoints/OrdersTest.php

@@ -0,0 +1,162 @@
+<?php
+
+namespace Alma\API\Tests\Unit\Legacy\Endpoints;
+
+
+use Alma\API\ClientContext;
+use Alma\API\Endpoints\Orders;
+
+use Alma\API\Exceptions\MissingKeyException;
+use Alma\API\Exceptions\ParametersException;
+use Alma\API\Exceptions\RequestException;
+use Alma\API\Lib\ArrayUtils;
+use Alma\API\Request;
+use Alma\API\Response;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class OrdersTest extends TestCase
+{
+
+    /**
+     * @var \Mockery\Mock|(\Mockery\MockInterface&Orders)
+     */
+    protected $orderEndpoint;
+
+    public function setUp()
+    {
+        $this->clientContext = \Mockery::mock(ClientContext::class);
+        $this->orderEndpoint = \Mockery::mock(Orders::class)->makePartial();
+        $this->arrayUtils = \Mockery::mock(ArrayUtils::class)->makePartial();
+        $this->responseMock = \Mockery::mock(Response::class);
+        $this->requestObject = \Mockery::mock(Request::class);
+        $loggerMock = \Mockery::mock(LoggerInterface::class);
+        $loggerMock->shouldReceive('error');
+
+        $this->orderEndpoint->arrayUtils = $this->arrayUtils;
+        $this->externalId  = 'Mon external Id';
+        $this->status = 'Mon Status - 1';
+        $this->clientContext->logger = $loggerMock;
+        $this->orderEndpoint->setClientContext($this->clientContext);
+
+    }
+    public function testValidateStatusDataNoOrderData()
+    {
+        $this->expectException(ParametersException::class);
+        $this->expectExceptionMessage('Missing in the required parameters (status, is_shipped) when calling orders.sendStatus');
+        $this->orderEndpoint->validateStatusData();
+    }
+
+    public function testValidateStatusDataMissingSomeOrderData()
+    {
+        $orderEndpoint = \Mockery::mock(Orders::class)->makePartial();
+        $arrayUtils = \Mockery::mock(ArrayUtils::class)->makePartial();
+        $arrayUtils->shouldReceive('checkMandatoryKeys')->andThrow(new MissingKeyException());
+        $orderEndpoint->arrayUtils = $arrayUtils;
+
+        $this->expectException(ParametersException::class);
+        $this->expectExceptionMessage('Error in the required parameters (status, is_shipped) when calling orders.sendStatus');
+        $orderEndpoint->validateStatusData(array('status'));
+    }
+
+    public function testValidateStatusDataIsShippedNotBool()
+    {
+        $orderEndpoint = \Mockery::mock(Orders::class)->makePartial();
+        $arrayUtils = \Mockery::mock(ArrayUtils::class)->makePartial();
+        $arrayUtils->shouldReceive('checkMandatoryKeys')->andReturn(null);
+        $orderEndpoint->arrayUtils = $arrayUtils;
+
+        $this->expectException(ParametersException::class);
+        $this->expectExceptionMessage('Parameter "is_shipped" must be a boolean');
+
+        $orderEndpoint->validateStatusData(array(
+            'status' => $this->status,
+            'is_shipped' => 'oui',
+        ));
+    }
+
+    public function testValidateStatusDataStatusIsEmpty()
+    {
+        $orderEndpoint = \Mockery::mock(Orders::class)->makePartial();
+        $arrayUtils = \Mockery::mock(ArrayUtils::class)->makePartial();
+        $arrayUtils->shouldReceive('checkMandatoryKeys')->andReturn(null);
+        $orderEndpoint->arrayUtils = $arrayUtils;
+
+        $this->expectException(ParametersException::class);
+        $this->expectExceptionMessage('Missing the required parameter "status" when calling orders.sendStatus');
+
+        $orderEndpoint->validateStatusData(array(
+            'status' => '',
+            'is_shipped' => true,
+        ));
+    }
+
+    public function testSendStatusOK()
+    {
+        $this->orderEndpoint->shouldReceive('validateStatusData')->andReturn(null);
+
+        $this->responseMock->shouldReceive('isError')->once()->andReturn(false);
+        $this->requestObject->shouldReceive('setRequestBody')->andReturn($this->requestObject);
+
+        $this->requestObject->shouldReceive('post')->once()->andReturn($this->responseMock);
+        $this->orderEndpoint->shouldReceive('request')
+            ->with(Orders::ORDERS_PATH_V2 .  "/{$this->externalId}/status")
+            ->once()
+            ->andReturn($this->requestObject);
+
+        $this->orderEndpoint->sendStatus($this->externalId  , array(
+            'status' => $this->status,
+            'is_shipped' => true,
+        ));
+    }
+
+    public function testSendStatusRequestError()
+    {
+        $this->orderEndpoint->shouldReceive('validateStatusData')->andReturn(null);
+
+        $this->responseMock->shouldReceive('isError')->once()->andReturn(true);
+        $this->requestObject->shouldReceive('setRequestBody')->andReturn($this->requestObject);
+
+        $this->requestObject->shouldReceive('post')->once()->andReturn($this->responseMock);
+        $this->orderEndpoint->shouldReceive('request')
+            ->with(Orders::ORDERS_PATH_V2 .  "/{$this->externalId}/status")
+            ->once()
+            ->andReturn($this->requestObject);
+
+        $this->expectException(RequestException::class);
+        $this->orderEndpoint->sendStatus($this->externalId  , array(
+            'status' => $this->status,
+            'is_shipped' => true,
+        ));
+
+    }
+    public function testSendStatusWithException()
+    {
+        $this->orderEndpoint->shouldReceive('validateStatusData')->andReturn(null);
+
+        $this->responseMock->shouldReceive('isError')->once()->andReturn(false);
+        $this->requestObject->shouldReceive('setRequestBody')->andReturn($this->requestObject);
+
+        $this->requestObject->shouldReceive('post')->andThrow(new RequestException());
+        $this->orderEndpoint->shouldReceive('request')
+            ->with(Orders::ORDERS_PATH_V2 .  "/{$this->externalId}/status")
+            ->once()
+            ->andReturn($this->requestObject);
+
+        $this->expectException(RequestException::class);
+        $this->orderEndpoint->sendStatus($this->externalId  , array(
+            'status' => $this->status,
+            'is_shipped' => true,
+        ));
+    }
+
+
+    public function tearDown()
+    {
+        $this->orderEndpoint = null;
+        $this->arrayUtils = null;
+        $this->responseMock = null;
+        $this->requestObject = null;
+    }
+
+}