Merge pull request #240 from kubawerlos/improvements

bookernath · web-flow · commit e6f844605cef · 2018-11-01T17:22:59.000-07:00
Improvements: composer.json, coding style, PHPUnit and Travis CI
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@ script/*
 /build
 /test/reports
 .env
+/.php_cs
+/.php_cs.cache
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -0,0 +1,11 @@
+<?php
+ return PhpCsFixer\Config::create()
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->files()
+            ->in(__DIR__ . '/src')
+            ->in(__DIR__ . '/test')
+    )
+    ->setRules([
+        '@PSR2' => true,
+    ]);
diff --git a/.travis.yml b/.travis.yml
@@ -1,15 +1,36 @@
+sudo: false
+
+cache:
+    directories:
+        - $HOME/.composer
+
+git:
+    depth: 1
+
 language: php
-php:
-- 7.2
-- 7.1
-- 7.0
-before_script:
-- composer install --dev --optimize-autoloader
-- mkdir -p build/logs
-after_script:
-- php vendor/bin/coveralls -v
-env:
-  global:
-  - secure: esQlDAcdxPtpwlOIFrC6d7/ejoOQyJJGeY/lhPv0qiWJ974+XxjLU7vGn0lKS5K4Z5WlZkGClEsfNok51Bm4JPnMsAZHTAO9f6bR7YpNrynmTyrwdv2NMUfAID8cJ9pUVZpbuT91M9aCuxUy4i2s+lx88myOVVr2r1YxQVcV1OA=
-  - secure: c9AOiucZTzzQu5QSLycx5CnQObIvkLiGrAv7yZg9gEouCDd3p4InOrW28WwMJjvVlTSN5BzEe1FLDh+rvatO2q4dwTTbx6NQ2QMTfM4W/L3M/Iv5yBt7VjuqlPXb4oHIvydvr/GXoRL/hNtn9wL/EdU5sKfSu+n0xVwsmCql/3U=
-  - secure: VKJgrYDePSIbdux5NodegW3vhLa3YSWLEkeTlScrGHBZVGK7K4F73s3v+32TeSNz/RYM8/MnSq2r9DUA7uPdms4UAWAFcz8uC36sOl1hkBy2gJAvYJJB5oLylR9TWXe+j20sDShdeGgfpFLcy/POcqdwQcJAx5XitDY4pw2ZwBI=
+
+before_install:
+    - composer self-update
+    - phpenv config-rm xdebug.ini || return 0
+    - composer global show hirak/prestissimo -q || composer global require hirak/prestissimo
+
+matrix:
+    include:
+        - name: PHP 7.0 with lowest versions of dependencies
+          php: '7.0'
+          install: composer update --prefer-lowest
+        - name: PHP 7.0
+          php: '7.0'
+          install: composer update
+        - name: PHP 7.1
+          php: '7.1'
+          install: composer update
+        - name: PHP 7.2
+          php: '7.2'
+          install: composer update
+          after_script:
+              - php vendor/bin/coveralls -v
+
+script:
+    - vendor/bin/php-cs-fixer fix --diff --dry-run -v
+    - vendor/bin/phpunit
diff --git a/composer.json b/composer.json
@@ -2,7 +2,13 @@
     "name": "bigcommerce/api",
     "type": "library",
     "description": "Enables PHP applications to communicate with the Bigcommerce API.",
-    "keywords": ["api", "http", "rest", "ecommerce", "business"],
+    "keywords": [
+        "api",
+        "http",
+        "rest",
+        "ecommerce",
+        "business"
+    ],
     "homepage": "http://developer.bigcommerce.com",
     "license": "MIT",
     "authors": [
@@ -13,22 +19,22 @@
     ],
     "require": {
         "php": ">=7.0",
-        "firebase/php-jwt": "~3.0|~5.0"
+        "firebase/php-jwt": "~3.0 || ~5.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8.35",
+        "codeless/jugglecode": "1.0",
+        "friendsofphp/php-cs-fixer": "^2.13",
         "php-coveralls/php-coveralls": "2.1",
-        "codeless/jugglecode": "1.0"
+        "phpunit/phpunit": "^6.4 || ^7.4"
     },
     "autoload": {
         "psr-0": {
             "Bigcommerce": "src/"
-        },
+        }
+    },
+    "autoload-dev": {
         "psr-4": {
             "Bigcommerce\\Test\\": "test/"
         }
-    },
-    "scripts": {
-        "test": "phpunit"
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.8/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation='vendor/phpunit/phpunit/phpunit.xsd'
          backupGlobals="true"
          backupStaticAttributes="true"
          colors="true"
@@ -15,18 +15,15 @@
         <log type="coverage-php" target="build/logs/coverage.cov"/>
         <log type="coverage-text" target="build/logs/coverage.txt" showUncoveredFiles="false"/>
         <log type="coverage-html" target="test/reports/coverage/" showUncoveredFiles="true"/>
-        <log type="junit" target="test/reports/junit.xml" logIncompleteSkipped="false"/>
+        <log type="junit" target="test/reports/junit.xml"/>
     </logging>
     <testsuites>
-        <testsuite>
+        <testsuite name="test">
             <directory>test/</directory>
         </testsuite>
     </testsuites>
     <filter>
-        <blacklist>
-            <directory suffix=".php">vendor/</directory>
-        </blacklist>
-        <whitelist addUncoveredFilesFromWhitelist="true">
+        <whitelist>
             <directory suffix=".php">src/</directory>
         </whitelist>
     </filter>
diff --git a/src/Bigcommerce/Api/Client.php b/src/Bigcommerce/Api/Client.php
@@ -15,56 +15,56 @@ class Client
      *
      * @var string
      */
-    static private $store_url;
+    private static $store_url;
 
     /**
      * Username to connect to the store API with
      *
      * @var string
      */
-    static private $username;
+    private static $username;
 
     /**
      * API key
      *
      * @var string
      */
-    static private $api_key;
+    private static $api_key;
 
     /**
      * Connection instance
      *
      * @var Connection
      */
-    static private $connection;
+    private static $connection;
 
     /**
      * Resource class name
      *
      * @var string
      */
-    static private $resource;
+    private static $resource;
 
     /**
      * API path prefix to be added to store URL for requests
      *
      * @var string
      */
-    static private $path_prefix = '/api/v2';
+    private static $path_prefix = '/api/v2';
 
     /**
      * Full URL path to the configured store API.
      *
      * @var string
      */
-    static public $api_path;
-    static private $client_id;
-    static private $store_hash;
-    static private $auth_token;
-    static private $client_secret;
-    static private $stores_prefix = '/stores/%s/v2';
-    static private $api_url = 'https://api.bigcommerce.com';
-    static private $login_url = 'https://login.bigcommerce.com';
+    public static $api_path;
+    private static $client_id;
+    private static $store_hash;
+    private static $auth_token;
+    private static $client_secret;
+    private static $stores_prefix = '/stores/%s/v2';
+    private static $api_url = 'https://api.bigcommerce.com';
+    private static $login_url = 'https://login.bigcommerce.com';
 
     /**
      * Configure the API client with the required settings to access
diff --git a/src/Bigcommerce/Api/ClientError.php b/src/Bigcommerce/Api/ClientError.php
@@ -7,7 +7,6 @@
  */
 class ClientError extends Error
 {
-
     public function __toString()
     {
         return "Client Error ({$this->code}): " . $this->message;
diff --git a/src/Bigcommerce/Api/Connection.php b/src/Bigcommerce/Api/Connection.php
@@ -340,7 +340,6 @@ private function followRedirectPath()
                 }
 
                 $this->get($url);
-
             } else {
                 $errorString = "Too many redirects when trying to follow location.";
                 throw new NetworkError($errorString, CURLE_TOO_MANY_REDIRECTS);
diff --git a/src/Bigcommerce/Api/Resources/Address.php b/src/Bigcommerce/Api/Resources/Address.php
@@ -7,5 +7,4 @@
 
 class Address extends Resource
 {
-
-}
+}
diff --git a/src/Bigcommerce/Api/Resources/DiscountRule.php b/src/Bigcommerce/Api/Resources/DiscountRule.php
@@ -10,5 +10,4 @@
  */
 class DiscountRule extends Resource
 {
-
 }
diff --git a/src/Bigcommerce/Api/Resources/OrderCoupons.php b/src/Bigcommerce/Api/Resources/OrderCoupons.php
@@ -7,5 +7,4 @@
 
 class OrderCoupons extends Resource
 {
-
-}
+}
diff --git a/src/Bigcommerce/Api/Resources/OrderProduct.php b/src/Bigcommerce/Api/Resources/OrderProduct.php
@@ -7,5 +7,4 @@
 
 class OrderProduct extends Resource
 {
-
-}
+}
diff --git a/src/Bigcommerce/Api/Resources/OrderStatus.php b/src/Bigcommerce/Api/Resources/OrderStatus.php
@@ -7,5 +7,4 @@
 
 class OrderStatus extends Resource
 {
-
-}
+}
diff --git a/src/Bigcommerce/Api/Resources/ProductConfigurableField.php b/src/Bigcommerce/Api/Resources/ProductConfigurableField.php
@@ -10,6 +10,4 @@
  */
 class ProductConfigurableField extends Resource
 {
-
 }
-
diff --git a/src/Bigcommerce/Api/Resources/ProductGoogleProductSearch.php b/src/Bigcommerce/Api/Resources/ProductGoogleProductSearch.php
@@ -10,5 +10,4 @@
  */
 class ProductGoogleProductSearch extends Resource
 {
-
 }
diff --git a/src/Bigcommerce/Api/Resources/ProductReview.php b/src/Bigcommerce/Api/Resources/ProductReview.php
@@ -10,5 +10,4 @@
  */
 class ProductReview extends Resource
 {
-
 }
diff --git a/src/Bigcommerce/Api/Resources/ProductVideo.php b/src/Bigcommerce/Api/Resources/ProductVideo.php
@@ -10,5 +10,4 @@
  */
 class ProductVideo extends Resource
 {
-
 }
diff --git a/src/Bigcommerce/Api/Resources/RequestLog.php b/src/Bigcommerce/Api/Resources/RequestLog.php
@@ -10,5 +10,4 @@
  */
 class RequestLog extends Resource
 {
-
-}
+}
diff --git a/src/Bigcommerce/Api/Resources/TaxClass.php b/src/Bigcommerce/Api/Resources/TaxClass.php
@@ -10,5 +10,4 @@
  */
 class TaxClass extends Resource
 {
-
 }
diff --git a/test/Unit/Api/ClientErrorTest.php b/test/Unit/Api/ClientErrorTest.php
@@ -2,8 +2,9 @@
 namespace Bigcommerce\Unit\Api;
 
 use Bigcommerce\Api\ClientError;
+use PHPUnit\Framework\TestCase;
 
-class ClientErrorTest extends \PHPUnit_Framework_TestCase
+class ClientErrorTest extends TestCase
 {
     public function testStringifyingReturnsTheMessageAndCodeAppropriately()
     {
diff --git a/test/Unit/Api/ClientTest.php b/test/Unit/Api/ClientTest.php
@@ -4,8 +4,9 @@
 
 use Bigcommerce\Api\Client;
 use Bigcommerce\Api\Connection;
+use PHPUnit\Framework\TestCase;
 
-class ClientTest extends \PHPUnit_Framework_TestCase
+class ClientTest extends TestCase
 {
     /**
      * @var Connection|\PHPUnit_Framework_MockObject_MockObject
@@ -52,19 +53,22 @@ public function tearDown()
 
     public function testConfigureRequiresStoreUrl()
     {
-        $this->setExpectedException('\\Exception', "'store_url' must be provided");
+        $this->expectException('\\Exception');
+        $this->expectExceptionMessage("'store_url' must be provided");
         Client::configure(array('username' => 'whatever', 'api_key' => 'whatever'));
     }
 
     public function testConfigureRequiresUsername()
     {
-        $this->setExpectedException('\\Exception', "'username' must be provided");
+        $this->expectException('\\Exception');
+        $this->expectExceptionMessage("'username' must be provided");
         Client::configure(array('store_url' => 'whatever', 'api_key' => 'whatever'));
     }
 
     public function testConfigureRequiresApiKey()
     {
-        $this->setExpectedException('\\Exception', "'api_key' must be provided");
+        $this->expectException('\\Exception');
+        $this->expectExceptionMessage("'api_key' must be provided");
         Client::configure(array('username' => 'whatever', 'store_url' => 'whatever'));
     }
 
@@ -144,7 +148,8 @@ public function testGetCustomerLoginTokenThrowsIfNoClientSecret()
             'auth_token' => 'def',
             'store_hash' => 'abc'
         ));
-        $this->setExpectedException('\Exception', 'Cannot sign customer login tokens without a client secret');
+        $this->expectException('\Exception');
+        $this->expectExceptionMessage('Cannot sign customer login tokens without a client secret');
         Client::getCustomerLoginToken(1);
     }
 
@@ -424,13 +429,13 @@ public function testUpdatingASkuPutsToTheSkuResource()
 
     public function testGettingProductGoogleProductSearch()
     {
-      $this->connection->expects($this->once())
+        $this->connection->expects($this->once())
           ->method('get')
           ->with($this->basePath . '/products/1/googleproductsearch')
           ->will($this->returnValue((object)array()));
 
-      $resource = Client::getGoogleProductSearch(1);
-      $this->assertInstanceOf('Bigcommerce\\Api\\Resources\\ProductGoogleProductSearch', $resource);
+        $resource = Client::getGoogleProductSearch(1);
+        $this->assertInstanceOf('Bigcommerce\\Api\\Resources\\ProductGoogleProductSearch', $resource);
     }
 
     public function testGettingProductImagesReturnsCollectionOfProductImages()
diff --git a/test/Unit/Api/ConnectionTest.php b/test/Unit/Api/ConnectionTest.php
@@ -3,8 +3,9 @@
 namespace Bigcommerce\Test\Unit;
 
 use Bigcommerce\Api\Connection;
+use PHPUnit\Framework\TestCase;
 
-class ConnectionTest extends \PHPUnit_Framework_TestCase
+class ConnectionTest extends TestCase
 {
     /**
      * @var \Bigcommerce\Api\Connection;
diff --git a/test/Unit/Api/ErrorTest.php b/test/Unit/Api/ErrorTest.php
diff --git a/test/Unit/Api/FilterTest.php b/test/Unit/Api/FilterTest.php
diff --git a/test/Unit/Api/NetworkErrorTest.php b/test/Unit/Api/NetworkErrorTest.php
diff --git a/test/Unit/Api/ResourceTest.php b/test/Unit/Api/ResourceTest.php
diff --git a/test/Unit/Api/Resources/PageTest.php b/test/Unit/Api/Resources/PageTest.php
diff --git a/test/Unit/Api/Resources/ResourceTestBase.php b/test/Unit/Api/Resources/ResourceTestBase.php
diff --git a/test/Unit/Api/Resources/ShippingMethodTest.php b/test/Unit/Api/Resources/ShippingMethodTest.php
diff --git a/test/Unit/Api/Resources/ShippingZoneTest.php b/test/Unit/Api/Resources/ShippingZoneTest.php
diff --git a/test/Unit/Api/ServerErrorTest.php b/test/Unit/Api/ServerErrorTest.php

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`*/`
`8`	`8`	`class ClientError extends Error`
`9`	`9`	`{`
`10`		`-`
`11`	`10`	`public function __toString()`
`12`	`11`	`{`
`13`	`12`	`return "Client Error ({$this->code}): " . $this->message;`
Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,6 @@ private function followRedirectPath()`
`340`	`340`	`}`
`341`	`341`
`342`	`342`	`$this->get($url);`
`343`		`-`
`344`	`343`	`} else {`
`345`	`344`	`$errorString = "Too many redirects when trying to follow location.";`
`346`	`345`	`throw new NetworkError($errorString, CURLE_TOO_MANY_REDIRECTS);`
Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,4 @@`
`7`	`7`
`8`	`8`	`class Address extends Resource`
`9`	`9`	`{`
`10`		`-`
`11`		`-}`
	`10`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,4 @@`
`10`	`10`	`*/`
`11`	`11`	`class DiscountRule extends Resource`
`12`	`12`	`{`
`13`		`-`
`14`	`13`	`}`