Merge branch 'release/v2.2.0'

Author: Jens Schulze

.travis.yml

@@ -33,7 +33,8 @@ before_script:
 - if [ $GUZZLE != '5' ] ; then composer install -o --prefer-dist; fi
 script:
 - ant phpcs-ci
-- vendor/bin/phpunit --testsuite=unit
+- if [ $GUZZLE == '5' ] || [ $PHP == '5.6' ] || [ $PHP == 'hhvm' ] ; then vendor/bin/phpunit -c phpunit5.xml.dist --testsuite=unit; fi
+- if [ $GUZZLE == '6' ] && [ $PHP != '5.6' ] ; then vendor/bin/phpunit --testsuite=unit; fi
 - if [ $PHP == '7.0' ] && [ $GUZZLE == '6' ] ; then vendor/bin/phpunit --testsuite=integration; fi
 - ant behat
 after_success:

CHANGELOG.md

@@ -1,3 +1,36 @@
+<a name="2.2.0"></a>
+# [2.2.0](https://github.com/commercetools/commercetools-php-sdk/compare/v2.1.0...v2.2.0) (2017-09-27)
+
+
+### Bug Fixes
+
+* **Me:** fix MeUpdateRequest constructor ([e96a2d1](https://github.com/commercetools/commercetools-php-sdk/commit/e96a2d1))
+* **Message:** fix object hierarchy for PaymentTransactionStateChanged message ([b4ec4a2](https://github.com/commercetools/commercetools-php-sdk/commit/b4ec4a2))
+* **StateTransitionMessage:** fix type of state in StateTransitionMessage ([2bb1efd](https://github.com/commercetools/commercetools-php-sdk/commit/2bb1efd))
+
+
+### Features
+
+* **Cart:** support add line item by sky ([3b81973](https://github.com/commercetools/commercetools-php-sdk/commit/3b81973)), closes [#341](https://github.com/commercetools/commercetools-php-sdk/issues/341)
+* **Cart:** support external tax amount ([95e5547](https://github.com/commercetools/commercetools-php-sdk/commit/95e5547)), closes [#347](https://github.com/commercetools/commercetools-php-sdk/issues/347)
+* **Cart:** support setAnonymousId ([1a1e472](https://github.com/commercetools/commercetools-php-sdk/commit/1a1e472)), closes [#338](https://github.com/commercetools/commercetools-php-sdk/issues/338)
+* **Cart:** support setCustomerGroup update action ([80c72ec](https://github.com/commercetools/commercetools-php-sdk/commit/80c72ec)), closes [#343](https://github.com/commercetools/commercetools-php-sdk/issues/343)
+* **Client:** add configuration options for guzzle ([18dbd00](https://github.com/commercetools/commercetools-php-sdk/commit/18dbd00)), closes [#345](https://github.com/commercetools/commercetools-php-sdk/issues/345)
+* **Client:** support creation of correlation id at client side ([124c004](https://github.com/commercetools/commercetools-php-sdk/commit/124c004)), closes [#328](https://github.com/commercetools/commercetools-php-sdk/issues/328)
+* **CustomField:** add type safe getter for field in field container ([732f861](https://github.com/commercetools/commercetools-php-sdk/commit/732f861))
+* **Customer:** support setKey for customers ([211573d](https://github.com/commercetools/commercetools-php-sdk/commit/211573d)), closes [#342](https://github.com/commercetools/commercetools-php-sdk/issues/342)
+* **CustomerGroup:** support field `key` functionality ([57e803c](https://github.com/commercetools/commercetools-php-sdk/commit/57e803c)), closes [#330](https://github.com/commercetools/commercetools-php-sdk/issues/330)
+* **Message:** add ProductVariantDeleted, ProductDeleted and ProductRevertedStagedChanges message ([f7291ae](https://github.com/commercetools/commercetools-php-sdk/commit/f7291ae)), closes [#332](https://github.com/commercetools/commercetools-php-sdk/issues/332)
+* **Product:** add typed getter for product attribute value ([34afcdd](https://github.com/commercetools/commercetools-php-sdk/commit/34afcdd))
+* **Product:** support scope for product publish ([9d0b5aa](https://github.com/commercetools/commercetools-php-sdk/commit/9d0b5aa)), closes [#340](https://github.com/commercetools/commercetools-php-sdk/issues/340)
+* **Project:** support change of project settings ([347ecb6](https://github.com/commercetools/commercetools-php-sdk/commit/347ecb6)), closes [#350](https://github.com/commercetools/commercetools-php-sdk/issues/350)
+* **ShippingMethod:** add support for shipping method predicate ([19ea63e](https://github.com/commercetools/commercetools-php-sdk/commit/19ea63e)), closes [#348](https://github.com/commercetools/commercetools-php-sdk/issues/348)
+* **ShippingMethod:** support shipping method by key functionality ([3ba9596](https://github.com/commercetools/commercetools-php-sdk/commit/3ba9596)), closes [#329](https://github.com/commercetools/commercetools-php-sdk/issues/329)
+* **Subscription:** support azure service bus destination ([58ad977](https://github.com/commercetools/commercetools-php-sdk/commit/58ad977)), closes [#331](https://github.com/commercetools/commercetools-php-sdk/issues/331)
+* **TaxCategory:** support setKey for tax categories ([6c41b97](https://github.com/commercetools/commercetools-php-sdk/commit/6c41b97)), closes [#339](https://github.com/commercetools/commercetools-php-sdk/issues/339)
+
+
+
 <a name="2.1.0"></a>
 # [2.1.0](https://github.com/commercetools/commercetools-php-sdk/compare/v2.0.0...v2.1.0) (2017-07-06)
 

README.md

@@ -30,7 +30,7 @@ curl -sS https://getcomposer.org/installer | php
 Next, run the Composer command to install the latest version of the SDK:
 
 ```bash
-composer require commercetools/php-sdk dev-master
+composer require commercetools/php-sdk
 ```
 
 The SDK supports Guzzle6 as well as Guzzle5 as HTTP client. For Guzzle6:

composer.json

@@ -35,12 +35,13 @@
     "psr/cache": "^1.0",
     "psr/simple-cache": "^1.0",
     "cache/apcu-adapter": "^0.2",
+    "paragonie/random_compat": "^2.0 || ^1.0",
     "ext-intl": "*",
     "ext-mbstring": "*"
   },
   "require-dev": {
     "guzzlehttp/guzzle": "^6.0",
-    "phpunit/phpunit": "^6.0 || ^5.7.14",
+    "phpunit/phpunit": "^6.0 || ^5.7.21",
     "phpmd/phpmd": "@stable",
     "squizlabs/php_codesniffer": "^2.6",
     "sebastian/phpcpd": "@stable",
@@ -76,7 +77,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-develop": "2.0-dev"
+      "dev-develop": "2.3-dev"
     },
     "incenteev-parameters": [
       {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "commercetools-php-sdk-changelog",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "commercetools PHP SDK changelog generator package description",
   "homepage": "https://github.com/commercetools/commercetools-php-sdk",
   "bugs": "https://github.com/commercetools/commercetools-php-sdk/issues",

phpunit.xml.dist

@@ -18,7 +18,10 @@
             <directory suffix=".php">src</directory>
         </whitelist>
     </filter>
-
+    <listeners>
+        <listener class="Commercetools\Core\ErrorListener" file="tests/integration/ErrorListener.php">
+        </listener>
+    </listeners>
     <!--<logging>
         <log type="coverage-html" target="build/coverage" title="Commercetools PHP SDK"
              charset="UTF-8" yui="true" highlight="true"

phpunit5.xml.dist

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         verbose="true">
+    <testsuites>
+        <testsuite name="unit">
+            <directory suffix="Test.php">tests/unit</directory>
+        </testsuite>
+        <testsuite name="integration">
+            <directory suffix="Test.php">tests/integration</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+    <listeners>
+        <listener class="Commercetools\Core\ErrorListener5" file="tests/integration/ErrorListener5.php">
+        </listener>
+    </listeners>
+</phpunit>

src/Core/AbstractHttpClient.php

@@ -14,7 +14,7 @@
  */
 abstract class AbstractHttpClient
 {
-    const VERSION = '2.1.0';
+    const VERSION = '2.2.0';
 
     /**
      * @var AdapterInterface

src/Core/Client.php

@@ -6,6 +6,10 @@
 
 namespace Commercetools\Core;
 
+use Commercetools\Core\Client\Adapter\CorrelationIdAware;
+use Commercetools\Core\Client\Adapter\TokenProviderAware;
+use Commercetools\Core\Helper\CorrelationIdProvider;
+use Commercetools\Core\Client\Adapter\AdapterOptionInterface;
 use Commercetools\Core\Response\ErrorResponse;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -198,14 +202,27 @@ public function setLogger(LoggerInterface $logger = null)
     public function getHttpClient($options = [])
     {
         if (is_null($this->httpClient)) {
+            $clientOptions = $this->config->getClientOptions();
+            if (count($clientOptions)) {
+                $options = array_merge($clientOptions, $options);
+            }
             $client = parent::getHttpClient($options);
+            if ($client instanceof TokenProviderAware) {
+                $client->setOAuthTokenProvider($this->getOauthManager());
+            }
             if ($this->logger instanceof LoggerInterface) {
                 $client->setLogger(
                     $this->logger,
                     $this->getConfig()->getLogLevel(),
                     $this->getConfig()->getMessageFormatter()
                 );
             }
+            if ($this->getConfig()->getCorrelationIdProvider() instanceof CorrelationIdProvider
+                && $client instanceof CorrelationIdAware
+            ) {
+                $client->setCorrelationIdProvider($this->getConfig()->getCorrelationIdProvider());
+            }
+            $this->httpClient = $client;
         }
 
         return $this->httpClient;
@@ -225,19 +242,25 @@ protected function getBaseUrl()
      *
      * @param ClientRequestInterface $request
      * @param array $headers
+     * @param array $clientOptions
      * @return ApiResponseInterface
      * @throws ApiException
      * @throws InvalidTokenException
      */
-    public function execute(ClientRequestInterface $request, array $headers = null)
+    public function execute(ClientRequestInterface $request, array $headers = null, array $clientOptions = [])
     {
         if ($request instanceof ContextAwareInterface) {
             $request->setContextIfNull($this->getConfig()->getContext());
         }
         $httpRequest = $this->createHttpRequest($request, $headers);
 
         try {
-            $httpResponse = $this->getHttpClient()->execute($httpRequest);
+            $client = $this->getHttpClient();
+            if ($client instanceof AdapterOptionInterface) {
+                $httpResponse = $client->execute($httpRequest, $clientOptions);
+            } else {
+                $httpResponse = $client->execute($httpRequest);
+            }
             $response = $request->buildResponse($httpResponse);
         } catch (ApiException $exception) {
             if ($exception instanceof InvalidTokenException && !$this->tokenRefreshed) {
@@ -261,15 +284,21 @@ public function execute(ClientRequestInterface $request, array $headers = null)
     /**
      * Executes an API request asynchronously
      * @param ClientRequestInterface $request
+     * @param array $clientOptions
      * @return ApiResponseInterface
      */
-    public function executeAsync(ClientRequestInterface $request, array $headers = null)
+    public function executeAsync(ClientRequestInterface $request, array $headers = null, array $clientOptions = [])
     {
         if ($request instanceof ContextAwareInterface) {
             $request->setContextIfNull($this->getConfig()->getContext());
         }
         $httpRequest = $this->createHttpRequest($request, $headers);
-        $response = $request->buildResponse($this->getHttpClient()->executeAsync($httpRequest));
+        $client = $this->getHttpClient();
+        if ($client instanceof AdapterOptionInterface) {
+            $response = $request->buildResponse($client->executeAsync($httpRequest, $clientOptions));
+        } else {
+            $response = $request->buildResponse($client->executeAsync($httpRequest));
+        }
 
         $response = $response->then(
             function ($httpResponse) use ($httpRequest) {
@@ -288,11 +317,13 @@ function ($httpResponse) use ($httpRequest) {
      */
     protected function createHttpRequest(ClientRequestInterface $request, array $headers = null)
     {
-        $token = $this->getOauthManager()->getToken();
         $httpRequest = $request->httpRequest();
-        $httpRequest = $httpRequest
-            ->withHeader('Authorization', 'Bearer ' . $token->getToken())
-        ;
+        if (!$this->getHttpClient() instanceof TokenProviderAware) {
+            $token = $this->getOauthManager()->getToken();
+            $httpRequest = $httpRequest
+                ->withHeader('Authorization', 'Bearer ' . $token->getToken())
+            ;
+        }
         if (is_array($headers)) {
             foreach ($headers as $headerName => $headerValues) {
                 $httpRequest = $httpRequest
@@ -307,13 +338,19 @@ protected function createHttpRequest(ClientRequestInterface $request, array $hea
     /**
      * Executes API requests in batch
      * @param array $headers
+     * @param array $clientOptions
      * @return ApiResponseInterface[]
      * @throws ApiException
      */
-    public function executeBatch(array $headers = null)
+    public function executeBatch(array $headers = null, array $clientOptions = [])
     {
         $requests = $this->getBatchHttpRequests($headers);
-        $httpResponses = $this->getHttpClient()->executeBatch($requests);
+        $client = $this->getHttpClient();
+        if ($client instanceof AdapterOptionInterface) {
+            $httpResponses = $client->executeBatch($requests, $clientOptions);
+        } else {
+            $httpResponses = $client->executeBatch($requests);
+        }
 
         $responses = [];
         foreach ($httpResponses as $key => $httpResponse) {

src/Core/Client/Adapter/AdapterOptionInterface.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * @author @jayS-de <[email protected]>
+ */
+
+namespace Commercetools\Core\Client\Adapter;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+interface AdapterOptionInterface extends AdapterInterface
+{
+    /**
+     * @param RequestInterface $request
+     * @param array $clientOptions
+     * @return ResponseInterface
+     */
+    public function execute(RequestInterface $request, array $clientOptions = []);
+
+    /**
+     * @param RequestInterface[] $requests
+     * @param array $clientOptions
+     * @return ResponseInterface[]
+     */
+    public function executeBatch(array $requests, array $clientOptions = []);
+
+    /**
+     * @param RequestInterface $request
+     * @param array $clientOptions
+     * @return AdapterPromiseInterface
+     */
+    public function executeAsync(RequestInterface $request, array $clientOptions = []);
+}