Merge pull request #40 from php-http/terminology

Terminology

Author: sagikazarmark

.gitattributes

@@ -1,4 +1,9 @@
+spec/            export-ignore
 .editorconfig    export-ignore
 .gitattributes   export-ignore
 .gitignore       export-ignore
+.scrutinizer.yml export-ignore
+.travis.yml      export-ignore
 CONTRIBUTING.md  export-ignore
+phpspec.yml.ci   export-ignore
+phpspec.yml.dist export-ignore

.scrutinizer.yml

@@ -0,0 +1,11 @@
+filter:
+  paths: [src/*]
+checks:
+  php:
+    code_rating: true
+    duplication: true
+tools:
+  external_code_coverage: true
+  php_code_sniffer:
+    config:
+      standard: "PSR2"

.travis.yml

@@ -0,0 +1,38 @@
+language: php
+
+sudo: false
+
+php:
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - hhvm
+
+env:
+  global:
+    - TEST_COMMAND="composer test"
+
+matrix:
+  allow_failures:
+    - php: 7.0
+  fast_finish: true
+  include:
+    - php: 5.4
+      env:
+        - COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+        - COVERAGE=true
+        - TEST_COMMAND="composer test-ci"
+
+before_install:
+  - travis_retry composer self-update
+
+install:
+  - travis_retry composer update ${COMPOSER_FLAGS} --prefer-source --no-interaction
+
+script:
+  - $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

README.md

@@ -1,35 +1,47 @@
-# HTTP Adapter
+# HTTP Client
 
-[![Latest Version](https://img.shields.io/github/release/php-http/adapter.svg?style=flat-square)](https://github.com/php-http/adapter/releases)
+[![Latest Version](https://img.shields.io/github/release/php-http/client.svg?style=flat-square)](https://github.com/php-http/client/releases)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
-[![Total Downloads](https://img.shields.io/packagist/dt/php-http/adapter.svg?style=flat-square)](https://packagist.org/packages/php-http/adapter)
+[![Build Status](https://img.shields.io/travis/php-http/client.svg?style=flat-square)](https://travis-ci.org/php-http/client)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/php-http/client.svg?style=flat-square)](https://scrutinizer-ci.com/g/php-http/client)
+[![Quality Score](https://img.shields.io/scrutinizer/g/php-http/client.svg?style=flat-square)](https://scrutinizer-ci.com/g/php-http/client)
+[![Total Downloads](https://img.shields.io/packagist/dt/php-http/client.svg?style=flat-square)](https://packagist.org/packages/php-http/client)
 
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/php-http/adapter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-**HTTP Adapter interfaces.**
+**HTTP Client interfaces.**
 
 
 ## Install
 
 Via Composer
 
 ``` bash
-$ composer require php-http/adapter
+$ composer require php-http/client
 ```
 
 
 ## Usage
 
-This is the contract package for HTTP Adapter. It should be used when implementing a custom HTTP Adapter or to rely on a stable version of interfaces.
+This is the contract package for HTTP Client interfacess. PSR-7 does not contain Client interfaces which is fine. However there is still need for HTTP Client interoperability.
 
-There is also a virtual package which is versioned together with this contract package: [php-http/adapter-implementation](https://packagist.org/providers/php-http/adapter-implementation).
+These interfaces are mostly used to create adapter packages around existing HTTP Client implementations.
+
+There is also a virtual package which is versioned together with this contract package: [php-http/client-implementation](https://packagist.org/providers/php-http/client-implementation).
 
 
 ## Documentation
 
 Please see the [official documentation](http://php-http.readthedocs.org/en/latest/).
 
 
+## Testing
+
+``` bash
+$ composer test
+```
+
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

composer.json

@@ -1,8 +1,8 @@
 {
-    "name": "php-http/adapter",
-    "description": "HTTP Adapter interfaces",
+    "name": "php-http/client",
+    "description": "HTTP Client interfaces",
     "license": "MIT",
-    "keywords": ["http", "adapter"],
+    "keywords": ["http", "client"],
     "homepage": "http://php-http.org",
     "authors": [
         {
@@ -18,11 +18,19 @@
         "php": ">=5.4",
         "psr/http-message": "^1.0"
     },
+    "require-dev": {
+        "phpspec/phpspec": "^2.2",
+        "henrikbjorn/phpspec-code-coverage" : "^1.0"
+    },
     "autoload": {
         "psr-4": {
-            "Http\\Adapter\\": "src/"
+            "Http\\Client\\": "src/"
         }
     },
+    "scripts": {
+        "test": "vendor/bin/phpspec run",
+        "test-ci": "vendor/bin/phpspec run -c phpspec.yml.ci"
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "0.2-dev"

phpspec.yml.ci

@@ -0,0 +1,10 @@
+suites:
+  client_suite:
+    namespace: Http\Client
+    psr4_prefix: Http\Client
+formatter.name: pretty
+extensions:
+  - PhpSpec\Extension\CodeCoverageExtension
+code_coverage:
+  format: clover
+  output: build/coverage.xml

phpspec.yml.dist

@@ -0,0 +1,5 @@
+suites:
+  client_suite:
+    namespace: Http\Client
+    psr4_prefix: Http\Client
+formatter.name: pretty

spec/BatchResultSpec.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace spec\Http\Client;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+
+class BatchResultSpec extends ObjectBehavior
+{
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\BatchResult');
+    }
+
+    function it_is_immutable(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->getResponses()->shouldReturn([]);
+        $new->shouldHaveType('Http\Client\BatchResult');
+        $new->getResponses()->shouldReturn([$response]);
+    }
+
+    function it_has_a_responses(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->hasResponses()->shouldReturn(false);
+        $this->getResponses()->shouldReturn([]);
+        $new->hasResponses()->shouldReturn(true);
+        $new->getResponses()->shouldReturn([$response]);
+    }
+
+    function it_has_a_response_for_a_request(RequestInterface $request, ResponseInterface $response)
+    {
+        $new = $this->addResponse($request, $response);
+
+        $this->shouldThrow('Http\Client\Exception\UnexpectedValueException')->duringGetResponseFor($request);
+        $this->hasResponseFor($request)->shouldReturn(false);
+        $new->getResponseFor($request)->shouldReturn($response);
+        $new->hasResponseFor($request)->shouldReturn(true);
+    }
+}

spec/Body/CombinedMultipartSpec.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace spec\Http\Client\Body;
+
+use PhpSpec\ObjectBehavior;
+
+class CombinedMultipartSpec extends ObjectBehavior
+{
+    protected $file;
+
+    function let()
+    {
+        $this->file = tempnam(sys_get_temp_dir(), 'multipart');
+
+        $this->beConstructedWith(['data' => 1], ['file' => $this->file], 'boundary');
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\Body\CombinedMultipart');
+    }
+
+    function it_is_body()
+    {
+        $this->shouldImplement('Http\Client\Body');
+    }
+
+    function it_is_multipart()
+    {
+        $this->shouldHaveType('Http\Client\Body\Multipart');
+    }
+
+    function it_has_content_header()
+    {
+        $this->getContentHeaders()->shouldReturn(['Content-Type' => 'multipart/form-data; boundary=boundary']);
+    }
+
+    function it_is_streamable()
+    {
+        $body = sprintf("--boundary\r\nContent-Disposition: form-data; name=\"data\"\r\n\r\n1\r\n--boundary\r\nContent-Disposition: form-data; name=\"file\"; filename=\"%s\"\r\n\r\n\r\n", basename($this->file));
+
+        $this->toStreamable()->shouldReturn($body);
+    }
+}

spec/Body/FilesSpec.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace spec\Http\Client\Body;
+
+use PhpSpec\ObjectBehavior;
+
+class FilesSpec extends ObjectBehavior
+{
+    protected $file;
+
+    function let()
+    {
+        $this->file = tempnam(sys_get_temp_dir(), 'multipart');
+
+        $this->beConstructedWith(['file' => $this->file], 'boundary');
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\Body\Files');
+    }
+
+    function it_is_body()
+    {
+        $this->shouldImplement('Http\Client\Body');
+    }
+
+    function it_is_multipart()
+    {
+        $this->shouldHaveType('Http\Client\Body\Multipart');
+    }
+
+    function it_has_content_header()
+    {
+        $this->getContentHeaders()->shouldReturn(['Content-Type' => 'multipart/form-data; boundary=boundary']);
+    }
+
+    function it_is_streamable()
+    {
+        $body = sprintf("--boundary\r\nContent-Disposition: form-data; name=\"file\"; filename=\"%s\"\r\n\r\n\r\n", basename($this->file));
+
+        $this->toStreamable()->shouldReturn($body);
+    }
+}

spec/Body/MultipartDataSpec.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace spec\Http\Client\Body;
+
+use PhpSpec\ObjectBehavior;
+
+class MultipartDataSpec extends ObjectBehavior
+{
+    function let()
+    {
+        $this->beConstructedWith(['data' => 1], 'boundary');
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\Body\MultipartData');
+    }
+
+    function it_is_body()
+    {
+        $this->shouldImplement('Http\Client\Body');
+    }
+
+    function it_is_multipart()
+    {
+        $this->shouldHaveType('Http\Client\Body\Multipart');
+    }
+
+    function it_has_content_header()
+    {
+        $this->getContentHeaders()->shouldReturn(['Content-Type' => 'multipart/form-data; boundary=boundary']);
+    }
+
+    function it_is_streamable()
+    {
+        $body = "--boundary\r\nContent-Disposition: form-data; name=\"data\"\r\n\r\n1\r\n";
+
+        $this->toStreamable()->shouldReturn($body);
+    }
+}

spec/Body/UrlencodedDataSpec.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace spec\Http\Client\Body;
+
+use PhpSpec\ObjectBehavior;
+
+class UrlencodedDataSpec extends ObjectBehavior
+{
+    function let()
+    {
+        $this->beConstructedWith(['data1' => 1, 'data2' => 2]);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Client\Body\UrlencodedData');
+    }
+
+    function it_is_body()
+    {
+        $this->shouldImplement('Http\Client\Body');
+    }
+
+    function it_has_content_header()
+    {
+        $this->getContentHeaders()->shouldReturn(['Content-Type' => 'application/x-www-form-urlencoded']);
+    }
+
+    function it_is_streamable()
+    {
+        $this->toStreamable()->shouldReturn('data1=1&data2=2');
+    }
+}