Merge pull request #46 from sphereio/develop

1.0.0 Milestone 2

Author: ct-jensschulze

.gitignore

@@ -3,6 +3,7 @@
 vendor
 build
 cache.properties
+apigen.phar
 composer.phar
 composer.lock
 docroot/myapp.ini

.scrutinizer.yml

@@ -17,5 +17,14 @@ build:
             - if [[ "`phpenv version-name`" =~ "^5.4" ]] && [ "`phpenv version-name`" != "hhvm" ]; then echo -e "apc.enabled=1\napc.enable_cli=1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini; fi
             #+5.5 uses APCU
             - if [[ ! "`phpenv version-name`" =~ "^5.4" ]] && [ "`phpenv version-name`" != "hhvm" ]; then printf "\n"| echo -e "apc.enabled=1\napc.enable_cli=1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini; fi
+    tests:
+        override:
+            -
+                command: vendor/bin/behat -f progress
+            -
+                command: vendor/bin/phpunit --testsuite=unit --coverage-clover=coverage0
+                coverage:
+                    file: 'coverage0'
+                    format: 'php-clover'
 filter:
     excluded_paths: [build/*, tests/*, docroot/*, features/*]

.travis.yml

@@ -16,17 +16,15 @@ cache:
   - vendor
 
 before_script:
-  - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ]  && [ `php-config --vernum` -ge 50500 ] ; then pecl config-set preferred_state beta; printf "yes\n" | pecl install -f apcu ; else echo 'extension="apc.so"' >> ./tests/apc.ini ; fi"
-  - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ]; then phpenv config-add ./tests/apc.ini; fi"
-  - if [ $(phpenv version-name) = '5.4' ]; then PHPUNIT_FLAGS="--coverage-clover=coverage.clover"; else PHPUNIT_FLAGS=""; fi
-  - composer self-update
+  - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] && [ $TRAVIS_PHP_VERSION != 'nightly' ] && [ `php-config --vernum` -ge 50500 ] ; then pecl config-set preferred_state beta; printf "yes\n" | pecl install -f apcu ; else echo 'extension="apc.so"' >> ./tests/apc.ini ; fi"
+  - sh -c "if [ $TRAVIS_PHP_VERSION != 'hhvm' ] && [ $TRAVIS_PHP_VERSION != 'nightly' ] ; then phpenv config-add ./tests/apc.ini; fi"
   - composer install --prefer-source -o
 
 script:
   - ant phpcs-ci
-  - phpunit $PHPUNIT_FLAGS
+  - phpunit --testsuite=unit
+  - if [ $TRAVIS_PHP_VERSION == '5.4' ] ; then phpunit --testsuite=integration; fi
   - ant behat
-  - if [ $TRAVIS_PHP_VERSION != 'hhvm' ]  && [ $(phpenv version-name) = '5.4' ]; then ant apigen; fi
 
 after_success:
   - ./push-docs-to-gh-pages.sh
@@ -35,3 +33,9 @@ env:
   global:
     # GH_TOKEN environment variable for pushing documentation:
     - secure: "i0TL7GsZ8TIZgr7WB5qXEs8fF5sSJHGagLXEsn4DSgxI52GatfjeEaSJuAbbWV/Tg0jYidNevdhCpe7LT3IWwa2cLVRpaV1TDoQ6K4wo8zzMzAw4AMB8DO2dBY3Mz+puRN55YAV3OpEF/RiiIc7zXLW/+5H9UCOXrcnnpg6PpxE="
+    # SPHERE_CLIENT_ID
+    - secure: MEht7kleJ/K9/daNOjEpPNJnXxKyQZ36oEM8fImi612BoJmZp/uwjuKpqKscIyyLwXSpsr7c9w+V2CfSk3QI+NGLnhSNgjJWE2QXxzxD6OgM0gKFTDtBq//+k77Sx4UnQDi0pQPRZ1BrfBUqrxw4H07i53hXd/kmjZnknRcbODc=
+    # SPHERE_CLIENT_SECRET
+    - secure: Q4zRyFxLw/7YlHG/iWzyR7V7Srm8LsQ3UgMshckUyqefhzhF19GefoPJdPdALyLVEYQMG3O/U1aebbyt8Puy5jWWKKiwFaQA+mMXzpBFcvhutgxByqBXdIysIhGU65No+WbiCKlpL2WPNtYvE1cMSjFfn7IX8ThGkBxhJQcha38=
+    # SPHERE_PROJECT
+    - secure: CPj46vCtmLaxGKXycJW+PmNXloXu5ruOV/Qg1mA6tU83oPjlxHVrqMOlb87ykf6U8X6XXAjMrgR0q3gBepPJg3HZmJyeOsVhwSU/jhfN7L1lR7BrQrPdLutvhuC6Fgj+b2Ubzh7PIt7pR6AYZyMCv5ofajW9aBcC5D556WJsSjE=

CHANGELOG.md

@@ -1,6 +1,51 @@
 # SPHERE.IO PHP SDK Changelog
 
+### 1.0.0 Milestone 2
+ * add unit tests for query, fetch and delete requests
+ * add tests for order and product update actions
+ * add customer, category and cart update action tests
+ * refactor annotation generator
+ * refactor context aware objects to give a context callback to child
+ * add constructor tests for update commands
+ * add customer object and order create request test
+ * add customer request tests
+ * update Collection and JsonObject tests
+ * add model unit tests
+ * execute apigen only at master or tag changes
+ * fix state and taxRate
+ * add reference test
+ * add typed objects for references
+ * add currency formatter test
+ * refactor collection and jsonObject
+ * remove deprecated functions
+ * add integration tests for category
+ * refactor query parameters
+ * add reference getter to JsonObject
+ * return references only for documents
+ * log deprecation headers
+ * add pool size configuration to client
+ * add future requests
+ * add future tests
+ * add toString to LocalizedSearchKeywords model
+ * fix product draft tax category
+ * add links to api documentation for models
+ * correct type hints for zone requests
+ * add links to api documentation for requests
+ * add limit of update action logging to update requests
+ * add cache adapter for redis storage
 
+### 1.0.0 Milestone 1
+ * batch execution of requests
+ * delete, update, fetchById and query requests for all endpoints
+ * cart create and update requests
+ * cart update actions
+ * order create and update requests
+ * order update actions
+ * customer create and update requests
+ * customer update actions
+ * customer sign-in, email verification and password requests
+ * custom object create request
+ * api result to object mapping
 
-### 1.0.0-M0
- * initial commit
+### 1.0.0 Milestone 0
+ * initial commit

README.md

@@ -4,16 +4,16 @@
 > WARNING: As of now, this is a pre-release partial implementation.
 > See the [Milestone Plan](https://github.com/sphereio/sphere-php-sdk/milestones?direction=desc&sort=completeness&state=open) for details of what's planned. We love feedback and [Issue reports](https://github.com/sphereio/sphere-php-sdk/issues?q=is%3Aopen+is%3Aissue+sort%3Acreated-asc)!
 
-[![Build Status](https://img.shields.io/travis/sphereio/sphere-php-sdk/develop.svg?style=flat-square)](https://travis-ci.org/sphereio/sphere-php-sdk) [![Scrutinizer](https://img.shields.io/scrutinizer/g/sphereio/sphere-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/sphereio/sphere-php-sdk/) [![Scrutinizer](https://img.shields.io/scrutinizer/coverage/g/sphereio/sphere-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/sphereio/sphere-php-sdk/) [![Packagist](https://img.shields.io/packagist/v/sphere/php-sdk.svg?style=flat-square)](https://packagist.org/packages/sphere/php-sdk) [![Packagist](https://img.shields.io/packagist/dm/sphere/php-sdk.svg?style=flat-square)](https://packagist.org/packages/sphere/php-sdk)
- 
-The PHP SDK allows developers to build applications on the SPHERE.IO REST API using PHP native interfaces, models and helpers instead of manually using the HTTP and JSON API. Users gain lots of IDE Auto-Completion and type checks on a literal API. 
-It also manages the OAuth2 security, provides caches and an interface for concurrent and asynchronous API calls. 
+[![Build Status](https://img.shields.io/travis/sphereio/sphere-php-sdk/master.svg?style=flat-square)](https://travis-ci.org/sphereio/sphere-php-sdk) [![Scrutinizer](https://img.shields.io/scrutinizer/g/sphereio/sphere-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/sphereio/sphere-php-sdk/) [![Scrutinizer](https://img.shields.io/scrutinizer/coverage/g/sphereio/sphere-php-sdk.svg?style=flat-square)](https://scrutinizer-ci.com/g/sphereio/sphere-php-sdk/) [![Packagist](https://img.shields.io/packagist/v/sphere/php-sdk.svg?style=flat-square)](https://packagist.org/packages/sphere/php-sdk) [![Packagist](https://img.shields.io/packagist/dm/sphere/php-sdk.svg?style=flat-square)](https://packagist.org/packages/sphere/php-sdk)
+
+The PHP SDK allows developers to build applications on the SPHERE.IO REST API using PHP native interfaces, models and helpers instead of manually using the HTTP and JSON API. Users gain lots of IDE Auto-Completion and type checks on a literal API.
+It also manages the OAuth2 security, provides caches and an interface for concurrent and asynchronous API calls.
 
 The SDK is licensed under the permissive [MIT License](LICENSE). Don't hesitate to [contribute](#contribute)!
 
 ## Install / Integrate into your Project
 
-The SDK requires a PHP version of 5.4 or higher with the apc(u) PHP extension for its default cache. If you provide an own Cache interface, apc(u) is not necessary. The curl extension is recommended but not strictly necessary because the SDK is using the [Guzzle library](https://github.com/guzzle/guzzle) library, which falls back to PHP stream wrappers if curl is not available. 
+The SDK requires a PHP version of 5.4 or higher with the apc(u) PHP extension for its default cache. If you provide an own Cache interface, apc(u) is not necessary. The curl extension is recommended but not strictly necessary because the SDK is using the [Guzzle library](https://github.com/guzzle/guzzle) library, which falls back to PHP stream wrappers if curl is not available.
 
 The recommended way to install the SDK is through [Composer](http://getcomposer.org).
 
@@ -34,23 +34,29 @@ After installing, you need to require Composer's autoloader if that's not yet th
 require 'vendor/autoload.php';
 ```
 
-If you don't use Composer, just [download a zip archive](archive/master.zip) of the latest release, manually integrate it and configure your own autoloader. 
+If you don't use Composer, just [download a zip archive](archive/master.zip) of the latest release, manually integrate it and configure your own autoloader.
 
-Until the 1.0.0 release M0, M1 etc. milestone releases can contain incompatible changes.  From 1.0.0 on, the project will follow the [semantic versioning](http://semver.org) guidelines, i.e. everything but major version changes are backwards-compatible. This matches composer's default behavior. 
+Until the 1.0.0 release M0, M1 etc. milestone releases can contain incompatible changes.  From 1.0.0 on, the project will follow the [semantic versioning](http://semver.org) guidelines, i.e. everything but major version changes are backwards-compatible. This matches composer's default behavior.
 
-With composer just run `composer update sphere/php-sdk` to update to compatible versions. Edit your `composer.json` file to update to incompatible versions. 
+With composer just run `composer update sphere/php-sdk` to update to compatible versions. Edit your `composer.json` file to update to incompatible versions.
 
-Please read the [Changelog](CHANGELOG.md) before updating in any case.  
+Please read the [Changelog](CHANGELOG.md) before updating in any case.
 
 ## Use the SDK
 
-To get up and running, [create a free test project](http://admin.sphere.io) to get a SPHERE project with API credentials (Menu "Developers"->"API Clients"). 
+To get up and running, [create a free test project](http://admin.sphere.io) to get a SPHERE project with API credentials (Menu "Developers"->"API Clients").
 
 ```php
 <?php
+
+require '../vendor/autoload.php';
+
+use Sphere\Core\Request\Products\ProductsSearchRequest;
+use Sphere\Core\Client;
+
+header('Content-Type: text/html; charset=utf-8');
+
 $config = [
-    'oauth_url' => 'https://auth.sphere.io/oauth/token',
-    'api_url' => 'https://api.sphere.io',
     'client_id' => 'my client id',
     'client_secret' => 'my client secret',
     'project' => 'my project id'
@@ -59,26 +65,25 @@ $config = [
 /**
  * create search request
  */
-$search = new \Sphere\Core\Request\Products\ProductsSearchRequest();
-$search->addParam('text.en', 'red');
+$search = ProductsSearchRequest::of()->addParam('text.en', 'red');
 
-$client = new \Sphere\Core\Client($config);
-$results = $client->execute($search);
+$client = new Client($config);
+$products = $client->execute($search)->toObject();
 
-foreach($results as $result) {
-    var_dump($result);
+foreach ($products as $product) {
+    echo $product->getName()->en . '<br/>';
 }
 
 ?>
 ```
 
-In real world, you will not put your API credentials directly into code but use a config file or your framework's config or dependency injection system for that. 
+In real world, you will not put your API credentials directly into code but use a config file or your framework's config or dependency injection system for that.
 
-The [API documentation](http://sphereio.github.io/sphere-php-sdk/docs/master) provides all the details you need in a searchable form. 
+The [API documentation](http://sphereio.github.io/sphere-php-sdk/docs/master) provides all the details you need in a searchable form.
 
 ## Develop and Improve
 
-prepare your development environment (if necessary). 
+prepare your development environment (if necessary).
 
 Mac OS X, assuming [Homebrew](http://brew.sh) is installed, do the following:
 
@@ -97,15 +102,15 @@ echo "date.timezone='Europe/Berlin'" >> /usr/local/etc/php/5.5/conf.d/60-user.in
 php composer.phar update
 ```
 
-Linux users install php 5.4+, apc(u), xdebug and ant according to their distro's package system.  
+Linux users install php 5.4+, apc(u), xdebug and ant according to their distro's package system.
 
 Clone the develop branch of the repository (we're using the [gitflow](http://nvie.com/posts/a-successful-git-branching-model/) branching model, so master is for releases only):
 
 ```
 git clone git@github.com:sphereio/sphere-php-sdk.git
 ```
 
-Please follow the [PSR-2](http://www.php-fig.org/psr/psr-2/) coding style, ideally via your IDE settings (see below for phpStorm instructions). 
+Please follow the [PSR-2](http://www.php-fig.org/psr/psr-2/) coding style, ideally via your IDE settings (see below for phpStorm instructions).
 
 Please make sure that exiting Unit and Integration tests don't fail and fully cover your new code with Unit Tests. You can run all tests locally:
 
@@ -119,14 +124,12 @@ You can use the `docroot` directory with the built-in PHP web server. Add to the
 
 ```ini
 [sphere]
-oauth_url = 'https://auth.sphere.io/oauth/token'
-api_url = 'https://api.sphere.io'
 client_id = 'my client id'
 client_secret = 'my client secret'
 project = 'my project id'
 ```
 
-Then activate the php builtin web server 
+Then activate the php builtin web server
 
 ```sh
 cd <project_folder>
@@ -143,14 +146,14 @@ Now you can enable at Preferences > Editor > Inspections > PHP the "PHP code sni
 
 ## <a name="contribute"></a>Contribute
 
-On bigger effort changes, please open a GitHub [issue](issues) and ask if you can help or get help with your idea. For typos and documentation improvements just make a pull request. 
+On bigger effort changes, please open a GitHub [issue](issues) and ask if you can help or get help with your idea. For typos and documentation improvements just make a pull request.
 
 Then:
 
  1. fork the repository on GitHub
  2. code and add tests that cover the created code. Your code should be warning-free.
- 3. stick to PSR-2 and and don't reformat existing code. 
- 4. make a pull request.  @ct-jensschulze will review it and pull or come back to you. 
+ 3. stick to PSR-2 and and don't reformat existing code.
+ 4. make a pull request.  @ct-jensschulze will review it and pull or come back to you.
 
 
 

behat.yml

@@ -0,0 +1,4 @@
+default:
+    suites:
+        request_features:
+            paths: [ %paths.base%/features/request ]

build.xml

@@ -171,19 +171,38 @@
         </exec>
     </target>
 
-    <target name="phpunit"
+    <target name="phpunit" description="Run tests with PHPUnit"
+            depends="unit-test, integration-test">
+    </target>
+
+    <target name="unit-test"
             depends="prepare"
             description="Run unit tests with PHPUnit">
         <exec executable="${toolsdir}phpunit" failonerror="true">
             <arg value="--configuration"/>
             <arg path="${basedir}/phpunit.xml.dist"/>
+            <arg value="--testsuite=unit"/>
+        </exec>
+    </target>
+
+    <target name="integration-test"
+            depends="prepare"
+            description="Run integration tests with PHPUnit">
+        <exec executable="${toolsdir}phpunit" failonerror="true">
+            <arg value="--configuration"/>
+            <arg path="${basedir}/phpunit.xml.dist"/>
+            <arg value="--testsuite=integration"/>
         </exec>
     </target>
 
+    <target name="install-apigen">
+        <exec executable="${basedir}/apigen.sh" dir="${basedir}" />
+    </target>
     <target name="apigen"
             depends="prepare"
             description="Generate project documentation using phpDocumentor">
-        <exec executable="${basedir}/${toolsdir}apigen" dir="${basedir}/build/" failonerror="true">
+        <exec executable="php" dir="${basedir}/build/" failonerror="true">
+            <arg value="${basedir}/vendor/bin/apigen"/>
             <arg value="generate"/>
             <arg value="--source"/>
             <arg path="${basedir}/src"/>

composer.json

@@ -8,27 +8,31 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Sphere\\Core\\": "tests/unit/"
+            "Sphere\\Core\\": [
+              "tests/unit/",
+              "tests/integration/"
+            ]
         }
     },
     "require": {
         "php": ">=5.4",
+        "psr/log": "~1.0",
         "guzzlehttp/guzzle": "~5.0",
-        "guzzlehttp/log-subscriber": "~1.0"
+        "guzzlehttp/log-subscriber": "~1.0",
+        "pimple/pimple": "~3.0"
     },
     "require-dev": {
-        "psr/log": "~1.0",
         "phpunit/phpunit": "~4.0",
         "phpmd/phpmd": "~1.0",
         "squizlabs/php_codesniffer": "~1.0",
-        "pdepend/pdepend": "1.1.*",
-        "phploc/phploc": "2.0.*",
-        "sebastian/phpcpd": "1.4.*",
-        "covex-nn/phpcb": "1.0.4.*",
+        "pdepend/pdepend": "~1.1",
+        "phploc/phploc": "~2.0",
+        "sebastian/phpcpd": "~1.4",
+        "mayflower/php-codebrowser": "~1.0",
         "doctrine/cache": "~1.4",
-        "apigen/apigen": "~4.0",
         "monolog/monolog": "~1.12",
         "behat/behat": "~3.0",
+        "apigen/apigen": "~4.1",
         "phpunit/phpcov": "*"
     },
     "suggest": {

docroot/annotations.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * @author @ct-jensschulze <jens.schulze@commercetools.de>
+ */
+
+namespace Sphere\Core;
+
+use Sphere\Core\Helper\Annotate\AnnotationGenerator;
+
+require '../vendor/autoload.php';
+
+$path = __DIR__ . '/../src/';
+
+$generator = new AnnotationGenerator();
+$generator->run($path);