From f556f629671f5c139d1444707d4d436a38891ec4 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Sun, 28 Oct 2018 22:38:42 +0100 Subject: [PATCH 01/10] Update change log --- CHANGELOG.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ba4c8e..c5d116f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,13 @@ # Change Log -## 2.0.0 - UNRELEASED + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + + +## [Unreleased] This version is no BC break for consumers using HTTPlug. However, HTTP clients that implement HTTPlug need to adjust because we add return type declarations. @@ -9,16 +16,17 @@ implement HTTPlug need to adjust because we add return type declarations. - Support for PSR-18 (HTTP client). +### Changed + +- **BC Break:** `HttpClient::sendRequest(RequestInterface $request)` has a return type annotation. The new +signature is `HttpClient::sendRequest(RequestInterface $request): ResponseInterface`. +- **BC Break:** `RequestException::getRequest()` has a return type annotation. The new +signature is `RequestException::getRequest(): RequestInterface`. + ### Removed - PHP 5 support -### Changed - -- [BC Break] `HttpClient::sendRequest(RequestInterface $request)` has a return type annotation. The new -signature is `HttpClient::sendRequest(RequestInterface $request): ResponseInterface`. -- [BC Break] `RequestException::getRequest()` has a return type annotation. The new -signature is `RequestException::getRequest(): RequestInterface`. ## 1.1.0 - 2016-08-31 @@ -93,3 +101,13 @@ signature is `RequestException::getRequest(): RequestInterface`. ### Added - Initial release + + +[Unreleased]: https://github.com/php-http/httplug/compare/v1.1.0...HEAD +[1.1.0]: https://github.com/php-http/httplug/compare/v1.0.0...v1.1.0 +[1.0.0]: https://github.com/php-http/httplug/compare/v1.0.0-RC1...v1.0.0 +[1.0.0-RC1]: https://github.com/php-http/httplug/compare/v1.0.0-beta...v1.0.0-RC1 +[1.0.0-beta]: https://github.com/php-http/httplug/compare/v1.0.0-alpha3...v1.0.0-beta +[1.0.0-alpha3]: https://github.com/php-http/httplug/compare/v1.0.0-alpha2...v1.0.0-alpha3 +[1.0.0-alpha2]: https://github.com/php-http/httplug/compare/v1.0.0-alpha...v1.0.0-alpha2 +[1.0.0-alpha]: https://github.com/php-http/httplug/compare/v0.1.0...v1.0.0-alpha From 820615159b8db5faa0a9af7e8511b87bf4f392c2 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Sun, 28 Oct 2018 22:38:42 +0100 Subject: [PATCH 02/10] Update readme --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aba5008..7e6d0a6 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,15 @@ **HTTPlug, the HTTP client abstraction for PHP.** +## Intro + +HTTPlug served as a reference is the predecessor of [PSR-18](https://github.com/php-fig/fig-standards/blob/master/accepted/http-client/http-client.md) +HTTP Client standard. Since there is an entire ecosystem built around HTTPlug and since it's already widely adapted, +this package stays available. + +This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter). + + ## Install Via Composer @@ -22,14 +31,6 @@ $ composer require php-http/httplug ``` -## Intro - -This is the contract package for HTTP Client. -Use it to create HTTP Clients which are interoperable and compatible with [PSR-7](http://www.php-fig.org/psr/psr-7/). - -This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter). - - ## Documentation Please see the [official documentation](http://docs.php-http.org). From b65f81b3c0f3c7ff6730df87a6f6e761853b6ce4 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 29 Oct 2018 12:25:49 +0100 Subject: [PATCH 03/10] Prepare release --- CHANGELOG.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c5d116f..d8b9d32 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] + +## [2.0.0] - 2018-10-29 + This version is no BC break for consumers using HTTPlug. However, HTTP clients that implement HTTPlug need to adjust because we add return type declarations. @@ -103,7 +106,8 @@ signature is `RequestException::getRequest(): RequestInterface`. - Initial release -[Unreleased]: https://github.com/php-http/httplug/compare/v1.1.0...HEAD +[Unreleased]: https://github.com/php-http/httplug/compare/v2.0.0...HEAD +[2.0.0]: https://github.com/php-http/httplug/compare/v1.1.0...HEAD [1.1.0]: https://github.com/php-http/httplug/compare/v1.0.0...v1.1.0 [1.0.0]: https://github.com/php-http/httplug/compare/v1.0.0-RC1...v1.0.0 [1.0.0-RC1]: https://github.com/php-http/httplug/compare/v1.0.0-beta...v1.0.0-RC1 From 553478dcfe4673e90851b45ab446ec8f3324c891 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 29 Oct 2018 12:26:34 +0100 Subject: [PATCH 04/10] Remove branch alias --- composer.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/composer.json b/composer.json index 2f76c41..915e895 100644 --- a/composer.json +++ b/composer.json @@ -32,10 +32,5 @@ "scripts": { "test": "vendor/bin/phpspec run", "test-ci": "vendor/bin/phpspec run -c phpspec.ci.yml" - }, - "extra": { - "branch-alias": { - "dev-2.x": "2.0.x-dev" - } } } From e3b49c719234a4472f8c19163849ac8ec613a6c5 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 29 Oct 2018 12:28:32 +0100 Subject: [PATCH 05/10] Update PSR-18 dependency version --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 915e895..9d50368 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,7 @@ "require": { "php": "^7.0", "psr/http-message": "^1.0", - "psr/http-client": "^0.3", + "psr/http-client": "^1.0", "php-http/promise": "^1.0" }, "require-dev": { From 89e11fca2b70d6a525a8f7091ea4f60bc118446e Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 29 Oct 2018 12:59:53 +0100 Subject: [PATCH 06/10] Fix changelog --- CHANGELOG.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d8b9d32..cb31b01 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,21 +31,21 @@ signature is `RequestException::getRequest(): RequestInterface`. - PHP 5 support -## 1.1.0 - 2016-08-31 +## [1.1.0] - 2016-08-31 ### Added - HttpFulfilledPromise and HttpRejectedPromise which respect the HttpAsyncClient interface -## 1.0.0 - 2016-01-26 +## [1.0.0] - 2016-01-26 ### Removed - Stability configuration from composer -## 1.0.0-RC1 - 2016-01-12 +## [1.0.0-RC1] - 2016-01-12 ### Changed @@ -53,7 +53,7 @@ signature is `RequestException::getRequest(): RequestInterface`. - Updated promise dependency to RC1 -## 1.0.0-beta - 2015-12-17 +## [1.0.0-beta] - 2015-12-17 ### Added @@ -64,7 +64,7 @@ signature is `RequestException::getRequest(): RequestInterface`. - Exception concept -## 1.0.0-alpha3 - 2015-12-13 +## [1.0.0-alpha3] - 2015-12-13 ### Changed @@ -75,14 +75,14 @@ signature is `RequestException::getRequest(): RequestInterface`. - Promise interface moved to its own repository: [php-http/promise](https://github.com/php-http/promise) -## 1.0.0-alpha2 - 2015-11-16 +## [1.0.0-alpha2] - 2015-11-16 ### Added - Async client and Promise interface -## 1.0.0-alpha - 2015-10-26 +## [1.0.0-alpha] - 2015-10-26 ### Added From ad519a2b9b083fde0e79108be8de677772c1de21 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 29 Oct 2018 13:10:19 +0100 Subject: [PATCH 07/10] Mention in the readme that new implementations should use PSR-18 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e6d0a6..9641946 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ HTTPlug served as a reference is the predecessor of [PSR-18](https://github.com/php-fig/fig-standards/blob/master/accepted/http-client/http-client.md) HTTP Client standard. Since there is an entire ecosystem built around HTTPlug and since it's already widely adapted, -this package stays available. +this package stays available, but new implementations and consumers should use the PSR-18 interfaces. This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter). From 4c5db9fa18b712118e610b33690e82c5e1ada4d3 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 29 Oct 2018 14:33:21 +0100 Subject: [PATCH 08/10] Make requested changes --- README.md | 10 +++++++--- composer.json | 5 +++++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9641946..17bdeb7 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,13 @@ ## Intro -HTTPlug served as a reference is the predecessor of [PSR-18](https://github.com/php-fig/fig-standards/blob/master/accepted/http-client/http-client.md) -HTTP Client standard. Since there is an entire ecosystem built around HTTPlug and since it's already widely adapted, -this package stays available, but new implementations and consumers should use the PSR-18 interfaces. +HTTPlug is the predecessor of [PSR-18](http://www.php-fig.org/psr/psr-18/) +HTTP Client standard built on [PSR-7](http://www.php-fig.org/psr/psr-7/) HTTP messages. +Since there is an entire ecosystem built around HTTPlug which is already widely adapted, +we will keep maintaining this package for the time being, +but new implementations and consumers should use the PSR-18 interfaces. +HTTPlug 2.x extends the PSR-18 interfaces to allow a convenient migration path, +but in time it may be completely replaced by the standard. This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter). diff --git a/composer.json b/composer.json index 9d50368..a38f46e 100644 --- a/composer.json +++ b/composer.json @@ -32,5 +32,10 @@ "scripts": { "test": "vendor/bin/phpspec run", "test-ci": "vendor/bin/phpspec run -c phpspec.ci.yml" + }, + "extra": { + "branch-alias": { + "dev-master": "2.0.x-dev" + } } } From 9f1ea9c9e0675e95269062081221ad9051a99fe3 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Tue, 30 Oct 2018 14:09:47 +0100 Subject: [PATCH 09/10] Update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 17bdeb7..3bacf0e 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,11 @@ HTTPlug is the predecessor of [PSR-18](http://www.php-fig.org/psr/psr-18/) HTTP Client standard built on [PSR-7](http://www.php-fig.org/psr/psr-7/) HTTP messages. -Since there is an entire ecosystem built around HTTPlug which is already widely adapted, +Since there is an entire ecosystem built around HTTPlug which is already widely adopted, we will keep maintaining this package for the time being, but new implementations and consumers should use the PSR-18 interfaces. -HTTPlug 2.x extends the PSR-18 interfaces to allow a convenient migration path, -but in time it may be completely replaced by the standard. +HTTPlug 2.x extends the PSR-18 interfaces to allow a convenient migration path. +In the long term, we expect PSR-18 to completely replace the need for HTTPlug. This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter). From 4db71635fbd6d855c0df18e4912fdc3c7b53ef34 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Tue, 30 Oct 2018 14:11:34 +0100 Subject: [PATCH 10/10] Update change log --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cb31b01..a87403d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] -## [2.0.0] - 2018-10-29 +## [2.0.0] - 2018-10-31 This version is no BC break for consumers using HTTPlug. However, HTTP clients that implement HTTPlug need to adjust because we add return type declarations.