Merge pull request #134 from php-http/2.x

2.x to become the new master

Author: dbu

.gitignore

@@ -1,3 +1,5 @@
+/.php_cs
+/.php_cs.cache
 /behat.yml
 /build/
 /composer.lock

.php_cs

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * Configuration for fabpot/php-cs-fixer
+ *
+ * @link https://github.com/FriendsOfPHP/PHP-CS-Fixer
+ */
+
+$finder = PhpCsFixer\Finder::create()
+    ->in('src')
+    ->in('spec')
+;
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        '@Symfony' => true,
+        'array_syntax' => [
+            'syntax' => 'short',
+        ],
+        'no_empty_phpdoc' => true,
+        'no_superfluous_phpdoc_tags' => true,
+    ])
+    ->setFinder($finder);

.php_cs.dist

@@ -1,67 +1,55 @@
 language: php
-
 sudo: false
 
-dist: trusty
-
 cache:
-    directories:
-        - $HOME/.composer/cache/files
+  directories:
+  - $HOME/.composer/cache/files
 
-env:
-    global:
-        - TEST_COMMAND="composer test"
-
-branches:
-    except:
-        - /^analysis-.*$/
+php:
+- 7.0
+- 7.1
+- 7.2
+- 7.3
 
 matrix:
-    fast_finish: true
-    include:
-        - php: 7.1
-          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest" DEPENDENCIES="doctrine/instantiator:^1.1"
-
-          # Test the latest stable release
-        - php: 5.4
-        - php: 5.5
-        - php: 5.6
-        - php: 7.0
-        - php: 7.1
-        - php: 7.2
-          env: COVERAGE=true TEST_COMMAND="composer test-ci"  DEPENDENCIES="henrikbjorn/phpspec-code-coverage:^1.0"
+  fast_finish: true
+
+jobs:
+  include:
+  - php: 7.0
+    env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+  - php: 7.2
+    env: COVERAGE=true DEPENDENCIES="leanphp/phpspec-code-coverage"
+    script:
+    - composer test-ci
+    after_success:
+    - wget https://scrutinizer-ci.com/ocular.phar
+    - php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml --revision=$TRAVIS_COMMIT
+    # Test LTS versions
+  - php: 7.2
+    env: DEPENDENCIES="dunglas/symfony-lock:^2"
+  - php: 7.2
+    env: DEPENDENCIES="dunglas/symfony-lock:^3"
+  - php: 7.2
+    env: DEPENDENCIES="dunglas/symfony-lock:^4"
+  - php: 7.2
+    env: TEST_COMMAND="./vendor/bin/phpunit" DEPENDENCIES="phpunit/phpunit:^7.5 nyholm/psr7:^1.0"
+
+    # Latest dev release
+  - php: 7.3
+    env: STABILITY="dev"
 
-          # Test LTS versions
-        - php: 7.1
-          env: DEPENDENCIES="dunglas/symfony-lock:^2"
-        - php: 7.1
-          env: DEPENDENCIES="dunglas/symfony-lock:^3"
-        - php: 7.1
-          env: DEPENDENCIES="dunglas/symfony-lock:^4" STABILITY="rc"
-
-          # Latest dev release
-        - php: 7.1
-          env: STABILITY="dev"
-
-    allow_failures:
-          # Latest dev is allowed to fail.
-        - env: STABILITY="dev"
-          
 before_install:
-    - if [[ $COVERAGE != true ]]; then phpenv config-rm xdebug.ini || true; fi
-    - if ! [ -z "$STABILITY" ]; then composer config minimum-stability ${STABILITY}; fi;
-    - if ! [ -z "$DEPENDENCIES" ]; then composer require --no-update ${DEPENDENCIES}; fi;
+- if [[ $COVERAGE != true ]]; then phpenv config-rm xdebug.ini || true; fi
+- if ! [ -z "$STABILITY" ]; then composer config minimum-stability ${STABILITY}; fi;
+- if ! [ -z "$DEPENDENCIES" ]; then composer require --no-update ${DEPENDENCIES}; fi;
 
 install:
-    - cat composer.json
-    # To be removed when this issue will be resolved: https://github.com/composer/composer/issues/5355
-    - if [[ "$COMPOSER_FLAGS" == *"--prefer-lowest"* ]]; then composer update --prefer-dist --no-interaction --prefer-stable --quiet; fi
-    - composer update ${COMPOSER_FLAGS} --prefer-dist --no-interaction
+- cat composer.json
+# To be removed when this issue will be resolved: https://github.com/composer/composer/issues/5355
+- if [[ "$COMPOSER_FLAGS" == *"--prefer-lowest"* ]]; then composer update --prefer-dist --no-interaction --prefer-stable --quiet; fi
+- composer update ${COMPOSER_FLAGS} --prefer-dist --no-interaction
 
 script:
-    - composer validate --strict --no-check-lock
-    - $TEST_COMMAND
-
-after_success:
-    - if [[ $COVERAGE = true ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
-    - if [[ $COVERAGE = true ]]; then php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml; fi
+- composer validate --strict --no-check-lock
+- composer test

.styleci.yml

@@ -1,5 +1,20 @@
 # Change Log
 
+## 2.0 (unreleased)
+
+### Changed
+- RetryPlugin will no longer retry requests when the response failed with a HTTP code < 500.
+- Abstract method `HttpClientPool::chooseHttpClient()` has now an explicit return type (`Http\Client\Common\HttpClientPoolItem`)
+- Interface method `Plugin::handleRequest(...)` has now an explicit return type (`Http\Promise\Promise`)
+- Made  classes final that are not intended to be extended.
+  Added interfaces for BatchClient, HttpClientRouter and HttpMethodsClient.
+  (These interfaces use the `Interface` suffix to avoid name collisions.)
+- Added an interface for HttpClientPool and moved the abstract class to the HttpClientPool sub namespace.
+- AddPathPlugin: Do not add the prefix if the URL already has the same prefix.
+
+### Removed
+- Deprecated option `debug_plugins` has been removed from `PluginClient`
+
 ## 1.9.0 - 2019-01-03
 
 ### Added
@@ -10,7 +25,7 @@
 
 ### Changed
 
-- [RetryPlugin] Renamed the configuration options for the exception retry callback from `decider` to `exception_decider`
+- RetryPlugin: Renamed the configuration options for the exception retry callback from `decider` to `exception_decider`
   and `delay` to `exception_delay`. The old names still work but are deprecated.
 
 ## 1.8.2 - 2018-12-14

.travis.yml

@@ -11,17 +11,22 @@
         }
     ],
     "require": {
-        "php": "^5.4 || ^7.0",
-        "php-http/httplug": "^1.1",
+        "php": "^7.0",
+        "php-http/httplug": "^2.0",
         "php-http/message-factory": "^1.0",
         "php-http/message": "^1.6",
         "symfony/options-resolver": "^2.6 || ^3.0 || ^4.0"
     },
     "require-dev": {
-        "phpspec/phpspec": "^2.5 || ^3.4 || ^4.2",
-        "guzzlehttp/psr7": "^1.4"
+        "doctrine/instantiator": ">=1.0.5",
+        "guzzlehttp/psr7": "^1.4",
+        "phpspec/phpspec": "^3.4 || ^4.2",
+        "phpspec/prophecy": ">=1.8",
+        "sebastian/comparator": ">=2"
     },
     "suggest": {
+        "ext-json": "To detect JSON responses with the ContentTypePlugin",
+        "ext-libxml": "To detect XML responses with the ContentTypePlugin",
         "php-http/logger-plugin": "PSR-3 Logger plugin",
         "php-http/cache-plugin": "PSR-6 Cache plugin",
         "php-http/stopwatch-plugin": "Symfony Stopwatch plugin"
@@ -31,13 +36,18 @@
             "Http\\Client\\Common\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "spec\\Http\\Client\\Common\\": "spec/"
+        }
+    },
     "scripts": {
         "test": "vendor/bin/phpspec run",
         "test-ci": "vendor/bin/phpspec run -c phpspec.ci.yml"
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.9.x-dev"
+            "dev-master": "2.x-dev"
         }
     }
 }

CHANGELOG.md

@@ -4,7 +4,7 @@ suites:
         psr4_prefix: Http\Client\Common
 formatter.name: pretty
 extensions:
-    - PhpSpec\Extension\CodeCoverageExtension
+    LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension: ~
 code_coverage:
     format: clover
     output: build/coverage.xml

composer.json

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="./vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true">
+
+    <testsuites>
+        <testsuite name="HTTPlug unit tests">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

phpspec.ci.yml

@@ -6,27 +6,31 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use PhpSpec\ObjectBehavior;
+use Http\Client\Common\BatchClient;
+use Http\Client\Common\BatchResult;
+use Http\Client\Exception\HttpException;
+use Http\Client\Common\Exception\BatchException;
 
 class BatchClientSpec extends ObjectBehavior
 {
-    function let(HttpClient $client)
+    public function let(HttpClient $client)
     {
-        $this->beAnInstanceOf('Http\Client\Common\BatchClient', [$client]);
+        $this->beAnInstanceOf(BatchClient::class, [$client]);
     }
 
-    function it_send_multiple_request_using_send_request(HttpClient $client, RequestInterface $request1, RequestInterface $request2, ResponseInterface $response1, ResponseInterface $response2)
+    public function it_send_multiple_request_using_send_request(HttpClient $client, RequestInterface $request1, RequestInterface $request2, ResponseInterface $response1, ResponseInterface $response2)
     {
         $client->sendRequest($request1)->willReturn($response1);
         $client->sendRequest($request2)->willReturn($response2);
 
-        $this->sendRequests([$request1, $request2])->shouldReturnAnInstanceOf('Http\Client\Common\BatchResult');
+        $this->sendRequests([$request1, $request2])->shouldReturnAnInstanceOf(BatchResult::class);
     }
 
-    function it_throw_batch_exception_if_one_or_more_request_failed(HttpClient $client, RequestInterface $request1, RequestInterface $request2, ResponseInterface $response)
+    public function it_throw_batch_exception_if_one_or_more_request_failed(HttpClient $client, RequestInterface $request1, RequestInterface $request2, ResponseInterface $response)
     {
         $client->sendRequest($request1)->willReturn($response);
-        $client->sendRequest($request2)->willThrow('Http\Client\Exception\HttpException');
+        $client->sendRequest($request2)->willThrow(HttpException::class);
 
-        $this->shouldThrow('Http\Client\Common\Exception\BatchException')->duringSendRequests([$request1, $request2]);
+        $this->shouldThrow(BatchException::class)->duringSendRequests([$request1, $request2]);
     }
 }

phpunit.xml.dist

@@ -6,24 +6,25 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use PhpSpec\ObjectBehavior;
+use Http\Client\Common\BatchResult;
 
 class BatchResultSpec extends ObjectBehavior
 {
-    function it_is_initializable()
+    public function it_is_initializable()
     {
-        $this->beAnInstanceOf('Http\Client\Common\BatchResult');
+        $this->beAnInstanceOf(BatchResult::class);
     }
 
-    function it_is_immutable(RequestInterface $request, ResponseInterface $response)
+    public function it_is_immutable(RequestInterface $request, ResponseInterface $response)
     {
         $new = $this->addResponse($request, $response);
 
         $this->getResponses()->shouldReturn([]);
-        $new->shouldHaveType('Http\Client\Common\BatchResult');
+        $new->shouldHaveType(BatchResult::class);
         $new->getResponses()->shouldReturn([$response]);
     }
 
-    function it_has_a_responses(RequestInterface $request, ResponseInterface $response)
+    public function it_has_a_responses(RequestInterface $request, ResponseInterface $response)
     {
         $new = $this->addResponse($request, $response);
 
@@ -33,17 +34,17 @@ function it_has_a_responses(RequestInterface $request, ResponseInterface $respon
         $new->getResponses()->shouldReturn([$response]);
     }
 
-    function it_has_a_response_for_a_request(RequestInterface $request, ResponseInterface $response)
+    public function it_has_a_response_for_a_request(RequestInterface $request, ResponseInterface $response)
     {
         $new = $this->addResponse($request, $response);
 
-        $this->shouldThrow('UnexpectedValueException')->duringGetResponseFor($request);
+        $this->shouldThrow(\UnexpectedValueException::class)->duringGetResponseFor($request);
         $this->isSuccessful($request)->shouldReturn(false);
         $new->getResponseFor($request)->shouldReturn($response);
         $new->isSuccessful($request)->shouldReturn(true);
     }
 
-    function it_keeps_exception_after_add_request(RequestInterface $request1, Exception $exception, RequestInterface $request2, ResponseInterface $response)
+    public function it_keeps_exception_after_add_request(RequestInterface $request1, Exception $exception, RequestInterface $request2, ResponseInterface $response)
     {
         $new = $this->addException($request1, $exception);
         $new = $new->addResponse($request2, $response);