Merge branch 'release/v1.0.0-RC12'

Author: Jens Schulze

.travis.yml

@@ -22,7 +22,7 @@ before_script:
   - composer config -g github-oauth.github.com $GITHUB_OAUTH_TOKEN
   - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] && [ `php-config --vernum` -lt 70000 ] ; then echo 'extension = redis.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini ; fi"
   - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] && [ `php-config --vernum` -ge 50400 ] && [ `php-config --vernum` -lt 70000 ]; then printf "yes\n" | pecl install -f apcu-4.0.10 ; fi"
-  - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] && [ `php-config --vernum` -ge 70000 ] ; then printf "yes\n" | pecl install -f apcu ; fi"
+  - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] && [ `php-config --vernum` -ge 70000 ] ; then printf "yes\n" | pecl install -f apcu-5.1.3 ; fi"
   - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] ; then phpenv config-add ./tests/apc.ini; fi"
   - if [ $TRAVIS_PHP_VERSION == '5.4' ] ; then ./set_guzzle5.sh; fi
   - composer global require hirak/prestissimo

CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="1.0.0-RC12"></a>
+# [1.0.0-RC12](https://github.com/sphereio/commercetools-php-sdk/compare/v1.0.0-RC11...v1.0.0-RC12) (2016-05-02)
+
+
+### Bug Fixes
+
+* **Cart:** fix type of custom line-item slug ([34367d5](https://github.com/sphereio/commercetools-php-sdk/commit/34367d5))
+* **CustomLineItem:** fix type of slug in custom line-item ([d8d7d2a](https://github.com/sphereio/commercetools-php-sdk/commit/d8d7d2a))
+
+### Features
+
+* **Cart:** add helper to calculate line item count ([291bd05](https://github.com/sphereio/commercetools-php-sdk/commit/291bd05))
+* **Client:** add support for oauth password and refresh token flow ([fe23c8b](https://github.com/sphereio/commercetools-php-sdk/commit/fe23c8b)), closes [#191](https://github.com/sphereio/commercetools-php-sdk/issues/191)
+* **Error:** add oauth error classes ([92eec57](https://github.com/sphereio/commercetools-php-sdk/commit/92eec57))
+* **Product:** add support to use sku to identify a product variant in update action ([7f1979b](https://github.com/sphereio/commercetools-php-sdk/commit/7f1979b)), closes [#192](https://github.com/sphereio/commercetools-php-sdk/issues/192)
+* **Reference:** add constructor ofKey constructor to references ([e6fafc3](https://github.com/sphereio/commercetools-php-sdk/commit/e6fafc3))
+
+
+
 <a name="1.0.0-RC11"></a>
 # [1.0.0-RC11](https://github.com/sphereio/commercetools-php-sdk/compare/v1.0.0-RC10...v1.0.0-RC11) (2016-04-06)
 

README.md

@@ -1,10 +1,5 @@
 # <img src="build/theme/resources/CT_cube_200px.png" width="40" align="center"></img> commercetools PHP SDK
 
->  STATUS: Release Candidate 11.  We ask you to really use this API thoroughly now, especially the API design and object structure. Thank you very much!
->
-> See the [Milestone Plan](https://github.com/sphereio/commercetools-php-sdk/milestones?direction=desc&sort=completeness&state=open) for details of what's planned in detail. We love feedback and [Issue reports](https://github.com/sphereio/commercetools-php-sdk/issues?q=is%3Aopen+is%3Aissue+sort%3Acreated-asc)!
-> Up-to-Date planning status can be found on this [Waffle Board](https://waffle.io/sphereio/commercetools-php-sdk)
-
 [![Build Status](https://img.shields.io/travis/sphereio/commercetools-php-sdk/master.svg?style=flat-square)](https://travis-ci.org/sphereio/commercetools-php-sdk) [![Scrutinizer](https://img.shields.io/scrutinizer/g/sphereio/commercetools-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/sphereio/commercetools-php-sdk/) [![Scrutinizer](https://img.shields.io/scrutinizer/coverage/g/sphereio/commercetools-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/sphereio/commercetools-php-sdk/) [![Packagist](https://img.shields.io/packagist/v/commercetools/php-sdk.svg?style=flat-square)](https://packagist.org/packages/commercetools/php-sdk) [![Packagist](https://img.shields.io/packagist/dm/commercetools/php-sdk.svg?style=flat-square)](https://packagist.org/packages/commercetools/php-sdk)
 
 The PHP SDK allows developers to build applications on the commercetools platform (technically speaking against the SPHERE.IO REST API) using PHP native interfaces, models and helpers instead of manually using the HTTP and JSON API.
@@ -184,16 +179,25 @@ To enable code style checks directly in phpStorm you have to configure the path
 Now you can enable at Preferences > Editor > Inspections > PHP the "PHP code sniffer validation" with PSR-2 standard. Change the severity if needed.
 
 
-### Running tests using docker
+### Running integration tests
+
+For running the integration tests you need an empty commercetools project and have to create an API client using the commercetools Admin Center with the scopes manage_project, view_orders and view_products.
+
+#### Local environment
+
+```sh
+composer update
+vendor/bin/phpunit
+```
+
+#### Using docker
 
 Running the test image:
 
 ```sh
 echo "COMMERCETOOLS_CLIENT_ID=YourClientID" > env.list
 echo "COMMERCETOOLS_CLIENT_SECRET=YourClientSecret" >> env.list
 echo "COMMERCETOOLS_PROJECT=YourProjectKey" >> env.list
-echo "COMMERCETOOLS_OAUTH_URL=https://auth.sphere.io/oauth/token" >> env.list
-echo "COMMERCETOOLS_API_URL=https://api.sphere.io" >> env.list
 
 docker run --env-file env.list -v $PWD:/opt/app -w /opt/app --rm=true jaysde/php-test-base tools/docker-phpunit.sh
 ```

composer.json

@@ -63,8 +63,14 @@
         "env-map": {
           "client_id": "COMMERCETOOLS_CLIENT_ID",
           "client_secret": "COMMERCETOOLS_CLIENT_SECRET",
-          "view_products-client_id": "COMMERCETOOLS_CLIENT_ID_VIEW",
-          "view_products-client_secret": "COMMERCETOOLS_CLIENT_SECRET_VIEW",
+          "project": "COMMERCETOOLS_PROJECT"
+        }
+      },
+      {
+        "file": "tests/myapp.yml",
+        "env-map": {
+          "client_id": "COMMERCETOOLS_CLIENT_ID",
+          "client_secret": "COMMERCETOOLS_CLIENT_SECRET",
           "project": "COMMERCETOOLS_PROJECT",
           "oauth_url": "COMMERCETOOLS_OAUTH_URL",
           "api_url": "COMMERCETOOLS_API_URL"

docroot/myapp.yml.dist

@@ -1,8 +1,4 @@
 parameters:
   client_id: Your Commercetools client ID
   client_secret: Your Commercetools client secret
-  view_products-client_id: Your Commercetools client ID
-  view_products-client_secret: Your Commercetools client secret
   project: Your Commercetools project key
-  oauth_url: https://auth.sphere.io/oauth/token
-  api_url: https://api.sphere.io

src/AbstractHttpClient.php

@@ -14,7 +14,7 @@
  */
 abstract class AbstractHttpClient
 {
-    const VERSION = '1.0.0-RC11';
+    const VERSION = '1.0.0-RC12';
 
     /**
      * @var AdapterInterface

src/Client/OAuth/Manager.php

@@ -6,15 +6,13 @@
 
 namespace Commercetools\Core\Client\OAuth;
 
+use Commercetools\Core\Config;
 use Commercetools\Core\Error\ApiException;
-use GuzzleHttp\Psr7\Request;
 use Psr\Http\Message\ResponseInterface;
 use Commercetools\Core\AbstractHttpClient;
 use Commercetools\Core\Cache\CacheAdapterFactory;
 use Commercetools\Core\Cache\CacheAdapterInterface;
-use Commercetools\Core\Client\HttpMethod;
 use Commercetools\Core\Error\InvalidClientCredentialsException;
-use Commercetools\Core\Error\Message;
 
 /**
  * @package Commercetools\Core\OAuth
@@ -24,6 +22,7 @@ class Manager extends AbstractHttpClient
 {
     const TOKEN_CACHE_KEY = 'commercetools-io-access-token';
 
+    const REFRESH_TOKEN = 'refresh_token';
     const ACCESS_TOKEN = 'access_token';
     const EXPIRES_IN = 'expires_in';
     const ERROR = 'error';
@@ -87,70 +86,90 @@ public function getCacheAdapter()
      * @return Token
      * @throws InvalidClientCredentialsException
      */
-    public function getToken($scope = null)
+    public function getToken()
     {
-        if (is_null($scope)) {
-            $scope = $this->getConfig()->getScope();
-        }
-        if ($token = $this->getCacheToken($scope)) {
+        $scope = $this->getConfig()->getScope();
+        if ($token = $this->getCacheToken()) {
             return new Token($token, null, $scope);
         }
 
-        return $this->refreshToken($scope);
+        return $this->refreshToken();
     }
 
     /**
-     * @param string $scope
      * @return Token
      * @throws InvalidClientCredentialsException
      */
-    public function refreshToken($scope = null)
+    public function refreshToken()
     {
-        if (is_null($scope)) {
-            $scope = $this->getConfig()->getScope();
+        $scope = $this->getConfig()->getScope();
+        $grantType = $this->getConfig()->getGrantType();
+        $data = [Config::SCOPE => $scope, Config::GRANT_TYPE => $grantType];
+
+        if ($grantType === Config::GRANT_TYPE_PASSWORD) {
+            $user = $this->getConfig()->getUsername();
+            $password = $this->getConfig()->getPassword();
+            $data[Config::USER_NAME] = $user;
+            $data[Config::PASSWORD] = $password;
+        } elseif ($grantType === Config::GRANT_TYPE_REFRESH) {
+            $refreshToken = $this->getConfig()->getRefreshToken();
+            $data[Config::REFRESH_TOKEN] = $refreshToken;
         }
-        $token = $this->getBearerToken($scope);
+        
+        $token = $this->getBearerToken($data);
+
+        if ($grantType === Config::GRANT_TYPE_PASSWORD) {
+            $this->getConfig()->setGrantType(Config::GRANT_TYPE_REFRESH);
+            $this->getConfig()->setRefreshToken($token->getRefreshToken());
+        }
+
         // ensure token to be invalidated in cache before TTL
         $ttl = max(1, floor($token->getTtl()/2));
-        $this->getCacheAdapter()->store($this->getCacheKey($scope), $token->getToken(), $ttl);
+        $this->getCacheAdapter()->store($this->getCacheKey(), $token->getToken(), $ttl);
 
         return $token;
     }
 
-    protected function getCacheToken($scope)
+    protected function getCacheToken()
     {
-        return $this->getCacheAdapter()->fetch($this->getCacheKey($scope));
+        return $this->getCacheAdapter()->fetch($this->getCacheKey());
     }
 
     /**
-     * @param $scope
      * @return string
      */
-    protected function getCacheKey($scope)
+    protected function getCacheKey()
     {
-        if (!isset($this->cacheKeys[$scope])) {
-            $this->cacheKeys[$scope] = static::TOKEN_CACHE_KEY . '-' .
-                sha1($scope);
+        $scope = $this->getConfig()->getScope();
+        $grantType = $this->getConfig()->getGrantType();
+        $cacheScope = $scope . '-' . $grantType;
+
+        if ($grantType === Config::GRANT_TYPE_PASSWORD) {
+            $user = $this->getConfig()->getUsername();
+            $cacheScope .= '-' . $user;
+        } elseif ($grantType === Config::GRANT_TYPE_REFRESH) {
+            $token = $this->getConfig()->getRefreshToken();
+            $cacheScope .= '-' . $token;
         }
 
-        return $this->cacheKeys[$scope];
+        if (!isset($this->cacheKeys[$cacheScope])) {
+            $this->cacheKeys[$cacheScope] = static::TOKEN_CACHE_KEY . '-' .
+                sha1($cacheScope);
+        }
+
+        return $this->cacheKeys[$cacheScope];
     }
 
     /**
-     * @param string $scope
+     * @param array $data
      * @return Token
      * @throws ApiException
      * @throws \Commercetools\Core\Error\BadGatewayException
      * @throws \Commercetools\Core\Error\GatewayTimeoutException
      * @throws \Commercetools\Core\Error\ServiceUnavailableException
      */
-    protected function getBearerToken($scope)
+    protected function getBearerToken(array $data)
     {
-        $data = [
-            'grant_type' => 'client_credentials',
-            'scope' => $scope
-        ];
-
         try {
             $response = $this->execute($data);
         } catch (ApiException $exception) {
@@ -161,6 +180,9 @@ protected function getBearerToken($scope)
 
         $token = new Token($result[static::ACCESS_TOKEN], $result[static::EXPIRES_IN], $result[static::SCOPE]);
         $token->setValidTo(new \DateTime('now +' . $result[static::EXPIRES_IN] . ' seconds'));
+        if (isset($result[static::REFRESH_TOKEN])) {
+            $token->setRefreshToken($result[static::REFRESH_TOKEN]);
+        }
 
         return $token;
     }

src/Client/OAuth/Token.php

@@ -31,6 +31,11 @@ class Token
      */
     protected $scope;
 
+    /**
+     * @var string
+     */
+    protected $refreshToken;
+
     public function __construct($token = null, $ttl = null, $scope = null)
     {
         $this->setToken($token)->setTtl($ttl)->setScope($scope);
@@ -110,6 +115,24 @@ public function setScope($scope)
         $this->scope = $scope;
 
         return $this;
+    }
 
+    /**
+     * @return string
+     */
+    public function getRefreshToken()
+    {
+        return $this->refreshToken;
+    }
+
+    /**
+     * @param string $refreshToken
+     * @return $this
+     */
+    public function setRefreshToken($refreshToken)
+    {
+        $this->refreshToken = $refreshToken;
+
+        return $this;
     }
 }