Merge pull request #52 from tyx/feature/php-http

📦 Move to php-http to replace egeloen/http-adapter

Author: shouze

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-    - 5.4
     - 5.5
     - 5.6
     - 7.0

README.md

@@ -17,15 +17,19 @@ default:
             rest:
                 base_url: http://localhost:8888
                 store_response: true
-                adaptor_name: curl # Should be one of these adapters : https://github.com/egeloen/ivory-http-adapter/blob/master/doc/adapters.md#factory
     suites:
         default:
             contexts:
                 - Rezzza\RestApiBehatExtension\RestApiContext
                 - Rezzza\RestApiBehatExtension\Json\JsonContext
 ```
 
-Regarding the `adaptor_name` you choose, you will have to install the deps needed on your own.
+Then you will need to require in your composer the http client you want to use, and the message factory.
+
+Example:
+```
+composer require --dev guzzlehttp/psr7 php-http/curl-client
+```
 
 ## Usage
 You can use directly the `JsonContext` or `RestApiContext` by loading them in your behat.yml or use the `RestApiBrowser` and `JsonInspector` by adding them in the construct of your own context.

behat.yml

@@ -12,4 +12,3 @@ default:
             rest:
                 base_url: http://localhost:8888
                 store_response: true
-                adaptor_name: curl

composer.json

@@ -16,16 +16,22 @@
         "psr-4": { "Rezzza\\RestApiBehatExtension\\": "src/" }
     },
     "require": {
-        "php": ">=5.3.2",
+        "php": ">=5.5.0",
         "behat/behat": "~3.0",
         "atoum/atoum": "~1.0|~2.0",
         "symfony/property-access": "~2.4|~3.0",
         "justinrainbow/json-schema": "^2.0",
-        "egeloen/http-adapter": "^0.8.0"
+        "psr/http-message": "^1.0",
+        "php-http/discovery": "^1.0",
+        "php-http/client-common": "^1.2",
+        "php-http/message": "^1.3"
     },
     "require-dev": {
         "silex/silex": "~1.0",
-        "symfony/process": "~2.1|~3.0"
+        "symfony/process": "~2.1|~3.0",
+        "guzzlehttp/psr7": "^1.3",
+        "php-http/curl-client": "^1.5",
+        "php-http/mock-client": "^0.3.2"
     },
     "config": {
         "bin-dir": "bin/"

features/json_inspection.feature

@@ -37,7 +37,7 @@ Feature: Test json inspection payload
     Scenario: Json array should contain specific values
         Then the JSON array node "fooarray" should contain "bar1" element
         And the JSON array node "fooarray" should contain "bar2" element
-        
+
     Scenario: Json array should not contain specific values
         Then the JSON array node "fooarray" should not contain "bar3" element
 

features/json_inspection_edge_case.feature

@@ -19,7 +19,6 @@ Feature: Test json inspection edge cases
                     rest:
                         base_url: http://localhost:8888
                         store_response: true
-                        adaptor_name: curl
         """
 
     Scenario: Reading json before loading json

features/send_request.feature

@@ -25,25 +25,17 @@ Feature: Test send API request
         And the JSON node "username" should be equal to "pablo"
         And the JSON node "password" should be equal to "money"
 
-    Scenario: Sending POST request with form data
-        When I send a POST request to "echo" with form data:
-            | username | pablo |
-            | password | money |
-        Then the response status code should be 200
-        And the JSON node "username" should be equal to "pablo"
-        And the JSON node "password" should be equal to "money"
-
     Scenario: Add same header 2 times
         Given I add "header" header equal to "value"
-        Given I add "header" header equal to "value2"
+        And I add "header" header equal to "value2"
         When I send a POST request to "echo"
         Then the response status code should be 200
         And the JSON node "headers.header" should have 1 element
         And the JSON node "headers.header[0]" should be equal to "value, value2"
 
     Scenario: Set same header 2 times
         Given I set "header" header equal to "value"
-        Given I set "header" header equal to "value2"
+        And I set "header" header equal to "value2"
         When I send a POST request to "echo"
         Then the response status code should be 200
         And the JSON node "headers.header" should have 1 element

src/Extension.php

@@ -15,7 +15,6 @@ class Extension implements ExtensionInterface
     public function load(ContainerBuilder $container, array $config)
     {
         $container->setParameter('rezzza.json_api.rest.base_url', $config['rest']['base_url']);
-        $container->setParameter('rezzza.json_api.rest.adaptor_name', $config['rest']['adaptor_name']);
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/Resources'));
         $loader->load('services.xml');
 
@@ -36,7 +35,6 @@ public function configure(ArrayNodeDefinition $builder)
                         ->scalarNode('base_url')->end()
                         ->booleanNode('store_response')
                             ->defaultTrue()->end()
-            ->scalarNode('adaptor_name')->end()
                         ->end()
                     ->end()
                 ->end()

src/Resources/services.xml

@@ -20,7 +20,6 @@
 
         <service id="rezzza.json_api.rest.rest_api_browser" class="Rezzza\RestApiBehatExtension\Rest\RestApiBrowser" public="false">
             <argument>%rezzza.json_api.rest.base_url%</argument>
-            <argument>%rezzza.json_api.rest.adaptor_name%</argument>
         </service>
 
         <service id="rezzza.json_api.rest.rest_api_browser.resolver" class="Rezzza\RestApiBehatExtension\Rest\RestApiBrowserResolver">

src/Rest/RestApiBrowser.php

@@ -2,11 +2,9 @@
 
 namespace Rezzza\RestApiBehatExtension\Rest;
 
-use Ivory\HttpAdapter\HttpAdapterFactory;
-use Ivory\HttpAdapter\HttpAdapterInterface as HttpClient;
-use Ivory\HttpAdapter\HttpAdapterException;
-use Ivory\HttpAdapter\Message\Request;
-use Zend\Diactoros\Stream;
+use Http\Client\HttpClient;
+use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\MessageFactoryDiscovery;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -27,23 +25,28 @@ class RestApiBrowser
     /** @var ResponseStorage */
     private $responseStorage;
 
+    /** @var string */
+    private $host;
+
+    /** @var MessageFactoryDiscovery */
+    private $messageFactory;
+
     /**
-     * @param string $base_url
-     * @param string|null $adaptor_name
-     * @throws HttpAdapterException
+     * @param string $host
      */
-    public function __construct($base_url, $adaptor_name, HttpClient $httpClient = null)
+    public function __construct($host, HttpClient $httpClient = null)
     {
-        if (!is_null($httpClient) && $httpClient instanceof HttpClient) {
-            $this->httpClient = $httpClient;
-        } else {
-            if (is_string($adaptor_name) && HttpAdapterFactory::capable($adaptor_name)) {
-                $this->httpClient = HttpAdapterFactory::create($adaptor_name);
-            } else {
-                $this->httpClient = HttpAdapterFactory::guess();
-            }
-            $this->httpClient->getConfiguration()->setBaseUri($base_url);
-        }
+        $this->host = $host;
+        $this->httpClient = $httpClient ?: HttpClientDiscovery::find();
+        $this->messageFactory = MessageFactoryDiscovery::find();
+    }
+
+    /**
+     * Allow to override the httpClient to use yours with specific middleware for example
+     */
+    public function useHttpClient(HttpClient $httpClient)
+    {
+        $this->httpClient = $httpClient;
     }
 
     /**
@@ -54,7 +57,6 @@ public function enableResponseStorage(ResponseStorage $responseStorage)
         $this->responseStorage = $responseStorage;
     }
 
-
     /**
      * @return ResponseInterface
      */
@@ -81,78 +83,46 @@ public function getRequestHeaders()
         return $this->requestHeaders;
     }
 
-    /**
-     * @return HttpClient
-     */
-    public function getHttpClient()
-    {
-        return $this->httpClient;
-    }
-
     /**
      * @param string $method
-     * @param string $url
+     * @param string $uri
      * @param string|array $body
      */
-    public function sendRequest($method, $url, $body = null)
+    public function sendRequest($method, $uri, $body = null)
     {
-        try {
-            $this->send($method, $url, $body);
-        } catch (HttpAdapterException $e) {
-            if ($e->hasResponse()) {
-                $this->response = $e->getResponse();
-            }
-
-            if (null === $this->response) {
-                throw $e;
-            }
+        if (false === $this->hasHost($uri)) {
+            $uri = rtrim($this->host, '/').'/'.ltrim($uri, '/');
         }
 
-        if (null !== $this->responseStorage) {
-            $this->responseStorage->writeRawContent($this->response->getBody()->getContents());
-        }
-    }
+        $this->request = $this->messageFactory->createRequest($method, $uri, $this->requestHeaders, $body);
+        $this->response = $this->httpClient->sendRequest($this->request);
 
-    /**
-     * @param string $method
-     * @param string $uri With or without host
-     * @param string|array $body
-     */
-    private function send($method, $uri, $body = null)
-    {
-        if (!$this->hasHost($uri)) {
-            $uri = rtrim($this->httpClient->getConfiguration()->getBaseUri(), '/') . '/' . ltrim($uri, '/');
-        }
-        $body = is_array($body) ? http_build_query($body) : $body;
-        $stream = new Stream('php://memory', 'rw');
-        if (is_scalar($body)) {
-            $stream->write($body);
+        if (null !== $this->responseStorage) {
+            $this->responseStorage->writeRawContent((string) $this->response->getBody());
         }
-
-        $this->request = new Request($uri, $method, $stream, $this->requestHeaders);
-        $this->response = $this->httpClient->sendRequest($this->request);
-        // Reset headers used for the HTTP request
-        $this->requestHeaders = [];
     }
 
     /**
-     * @param string $uri
-     *
-     * @return bool
+     * @param string $name
+     * @param string $value
      */
-    private function hasHost($uri)
+    public function setRequestHeader($name, $value)
     {
-        return strpos($uri, '://') !== false;
+        $this->removeRequestHeader($name);
+        $this->addRequestHeader($name, $value);
     }
 
     /**
      * @param string $name
      * @param string $value
      */
-    public function setRequestHeader($name, $value)
+    public function addRequestHeader($name, $value)
     {
-        $this->removeRequestHeader($name);
-        $this->addRequestHeader($name, $value);
+        if (isset($this->requestHeaders[$name])) {
+            $this->requestHeaders[$name] .= ', '.$value;
+        } else {
+            $this->requestHeaders[$name] = $value;
+        }
     }
 
     /**
@@ -166,18 +136,12 @@ private function removeRequestHeader($headerName)
     }
 
     /**
-     * @param string $name
-     * @param string $value
+     * @param string $uri
+     *
+     * @return bool
      */
-    public function addRequestHeader($name, $value)
+    private function hasHost($uri)
     {
-        if (isset($this->requestHeaders[$name])) {
-            if (!is_array($this->requestHeaders[$name])) {
-                $this->requestHeaders[$name] = [$this->requestHeaders[$name]];
-            }
-            $this->requestHeaders[$name][] = $value;
-        } else {
-            $this->requestHeaders[$name] = $value;
-        }
+        return strpos($uri, '://') !== false;
     }
 }