Merge pull request #152 from alma/chore/backport-main-to-develop

Backport main to develop

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v2.3.1 - 2024-11-14
+
+### Changes
+
+- Change send configuration url endpoint (#150)
+
+#### Contributors
+
+@Benjamin-Freoua-Alma and @github-actions
+
 ## v2.3.0 - 2024-11-04
 
 ### Changes
@@ -181,6 +191,7 @@
 
 
 
+
   ```
 * Add fields and docs to the Payment entity
 * Add a Refund entity and extract refunds data within the Payment entity constructor

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "alma/alma-php-client",
   "description": "PHP API client for the Alma payments API",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "type": "library",
   "require": {
     "php": "^5.6 || ~7.0 || ~7.1 || ~7.2 || ~7.3 || ~7.4 || ~8.0 || ~8.1 || ~8.2 || ~8.3",

src/Client.php

@@ -30,7 +30,7 @@
 
 class Client
 {
-    const VERSION = '2.3.0';
+    const VERSION = '2.3.1';
 
     const LIVE_MODE = 'live';
     const TEST_MODE = 'test';
@@ -71,6 +71,11 @@ class Client
      */
     public $insurance;
     /*************************/
+    /**
+     * @var Endpoints\Configuration
+     */
+    public $configuration;
+    /*************************/
 
     /**
      * Alma client initialization.
@@ -150,6 +155,7 @@ private function initEndpoints()
         $this->shareOfCheckout = new Endpoints\ShareOfCheckout($this->context);
         $this->webhooks = new Endpoints\Webhooks($this->context);
         $this->insurance = new Endpoints\Insurance($this->context);
+        $this->configuration = new Endpoints\Configuration($this->context);
     }
 
     private function initUserAgent()

src/Endpoints/Configuration.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright (c) 2018 Alma / Nabla SAS
+ *
+ * THE MIT LICENSE
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ *
+ * @author    Alma / Nabla SAS <[email protected]>
+ * @copyright Copyright (c) 2018 Alma / Nabla SAS
+ * @license   https://opensource.org/licenses/MIT The MIT License
+ *
+ */
+
+namespace Alma\API\Endpoints;
+
+use Alma\API\Exceptions\RequestException;
+use Alma\API\RequestError;
+
+class Configuration extends Base
+{
+    const CONFIGURATION_PATH = '/v1/integration-configuration';
+
+    /**
+     * @param string $url The URL to send to Alma for integrations configuration
+     * @throws RequestException
+     * @throws RequestError
+     */
+    public function sendIntegrationsConfigurationsUrl($url)
+    {
+        $res = $this->request(self::CONFIGURATION_PATH . "/api")->setRequestBody(array(
+            "collect_data_url" => $url
+        ))->put();
+
+        if ($res->isError()) {
+            throw new RequestException($res->errorMessage, null, $res);
+        }
+    }
+}

src/Endpoints/Merchants.php

@@ -27,8 +27,6 @@
 
 use Alma\API\Entities\FeePlan;
 use Alma\API\Entities\Merchant;
-use Alma\API\Entities\MerchantData\MerchantData;
-use Alma\API\Exceptions\RequestException;
 use Alma\API\RequestError;
 
 class Merchants extends Base
@@ -82,20 +80,4 @@ public function feePlans($kind = FeePlan::KIND_GENERAL, $installmentsCounts = "a
             return new FeePlan($val);
         }, $res->json);
     }
-
-    /**
-     * @param string $url The URL to send to Alma for integrations configuration
-     * @throws RequestException
-     * @throws RequestError
-     */
-    public function sendIntegrationsConfigurationsUrl($url)
-    {
-        $res = $this->request(self::ME_PATH . "/configuration")->setRequestBody(array(
-            "endpoint_url" => $url
-        ))->post();
-
-        if ($res->isError()) {
-            throw new RequestException($res->errorMessage, null, $res);
-        }
-    }
 }

tests/Unit/Endpoints/MerchantsTest.php → tests/Unit/Endpoints/ConfigurationTest.php

@@ -2,27 +2,31 @@
 
 namespace Unit\Endpoints;
 
-use Alma\API\Endpoints\Merchants;
+use Alma\API\Endpoints\Configuration;
 use Alma\API\Exceptions\RequestException;
 use Alma\API\Request;
 use Alma\API\Response;
 use Mockery;
 use PHPUnit\Framework\TestCase;
 
-class MerchantsTest extends TestCase
+class ConfigurationTest extends TestCase
 {
 	const URL = "https://www.example.com/integrations/configurations";
 
+    private $configurationEndpoint;
+    private $responseMock;
+    private $requestObject;
+
 	public function setUp(): void
 	{
-		$this->merchantEndpoint = Mockery::mock(Merchants::class)->makePartial();
+		$this->configurationEndpoint = Mockery::mock(Configuration::class)->makePartial();
 		$this->responseMock = Mockery::mock(Response::class);
 		$this->requestObject = Mockery::mock(Request::class);
 	}
 
 	public function tearDown(): void
 	{
-		$this->merchantEndpoint = null;
+		$this->configurationEndpoint = null;
 		$this->responseMock = null;
 		$this->requestObject = null;
 		Mockery::close();
@@ -31,34 +35,32 @@ public function tearDown(): void
 	public function testSendIntegrationsConfigurationsUrlIsOk(){
 		$this->responseMock->shouldReceive('isError')->once()->andReturn(false);
 		$this->requestObject->shouldReceive('setRequestBody')
-			->with(['endpoint_url' => self::URL])
+			->with(['collect_data_url' => self::URL])
 			->andReturn($this->requestObject);
 
-		$this->merchantEndpoint->shouldReceive('request')
-			->with(Merchants::ME_PATH . "/configuration")
+		$this->configurationEndpoint->shouldReceive('request')
+			->with(Configuration::CONFIGURATION_PATH . "/api")
 			->once()
 			->andReturn($this->requestObject);
-		$this->requestObject->shouldReceive('post')->once()->andReturn($this->responseMock);
+		$this->requestObject->shouldReceive('put')->once()->andReturn($this->responseMock);
 
-		$url = self::URL;
-		$this->assertNull($this->merchantEndpoint->sendIntegrationsConfigurationsUrl($url));
+		$this->assertNull($this->configurationEndpoint->sendIntegrationsConfigurationsUrl(self::URL));
 	}
 
 	public function testSendIntegrationsConfigurationsUrlThrowRequestException(){
 		$this->responseMock->shouldReceive('isError')->once()->andReturn(true);
 		$this->requestObject->shouldReceive('setRequestBody')
-			->with(['endpoint_url' => self::URL])
+			->with(['collect_data_url' => self::URL])
 			->andReturn($this->requestObject);
 
-		$this->merchantEndpoint->shouldReceive('request')
-			->with(Merchants::ME_PATH . "/configuration")
+		$this->configurationEndpoint->shouldReceive('request')
+			->with(Configuration::CONFIGURATION_PATH . "/api")
 			->once()
 			->andReturn($this->requestObject);
-		$this->requestObject->shouldReceive('post')->once()->andReturn($this->responseMock);
+		$this->requestObject->shouldReceive('put')->once()->andReturn($this->responseMock);
 
-		$url = self::URL;
 		$this->expectException(RequestException::class);
-		$this->merchantEndpoint->sendIntegrationsConfigurationsUrl($url);
+		$this->configurationEndpoint->sendIntegrationsConfigurationsUrl(self::URL);
 
 	}
 }