Deprecate plugins and plugin client

sagikazarmark · sagikazarmark · commit 81264f2c5911 · 2016-05-04T08:37:30.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Change Log
 
+
+## Unreleased
+
+### Deprecated
+
+- Core plugins and plugin client, moved to [client-common](https://github.com/php-http/client-common)
+- Logger plugin, moved to [logger-plugin](https://github.com/php-http/logger-plugin)
+- Cache plugin, moved to [cache-plugin](https://github.com/php-http/cache-plugin)
+- Stopwatch plugin, moved to [stopwatch-plugin](https://github.com/php-http/stopwatch-plugin)
+
+
 ## 1.0.1 - 2016-01-29
 
 ### Changed
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
         "php": ">=5.4",
         "php-http/httplug": "^1.0",
         "php-http/message-factory": "^1.0.2",
-        "php-http/client-common": "^1.0",
+        "php-http/client-common": "^1.1",
         "php-http/message": "^1.0",
         "symfony/options-resolver": "^2.6|^3.0"
     },
diff --git a/src/AddHostPlugin.php b/src/AddHostPlugin.php
@@ -10,6 +10,8 @@
  * Add schema and host to a request. Can be set to overwrite the schema and host if desired.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\AddHostPlugin} instead.
  */
 class AddHostPlugin implements Plugin
 {
diff --git a/src/AuthenticationPlugin.php b/src/AuthenticationPlugin.php
@@ -9,6 +9,8 @@
  * Send an authenticated request.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\AuthenticationPlugin} instead.
  */
 class AuthenticationPlugin implements Plugin
 {
diff --git a/src/CachePlugin.php b/src/CachePlugin.php
@@ -13,6 +13,8 @@
  * Allow for caching a response.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\CachePlugin} instead.
  */
 class CachePlugin implements Plugin
 {
diff --git a/src/ContentLengthPlugin.php b/src/ContentLengthPlugin.php
@@ -9,6 +9,8 @@
  * Allow to set the correct content length header on the request or to transfer it as a chunk if not possible.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\ContentLengthPlugin} instead.
  */
 class ContentLengthPlugin implements Plugin
 {
diff --git a/src/CookiePlugin.php b/src/CookiePlugin.php
@@ -12,6 +12,8 @@
  * Handle request cookies.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\CookiePlugin} instead.
  */
 class CookiePlugin implements Plugin
 {
diff --git a/src/DecoderPlugin.php b/src/DecoderPlugin.php
@@ -19,6 +19,8 @@
  * If Content-Encoding is not disabled, the plugin will add an Accept-Encoding header for the encoding methods it supports.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\DecoderPlugin} instead.
  */
 class DecoderPlugin implements Plugin
 {
diff --git a/src/ErrorPlugin.php b/src/ErrorPlugin.php
@@ -13,6 +13,8 @@
  * By default an exception will be thrown for all status codes from 400 to 599.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\ErrorPlugin} instead.
  */
 class ErrorPlugin implements Plugin
 {
diff --git a/src/Exception/CircularRedirectionException.php b/src/Exception/CircularRedirectionException.php
@@ -8,6 +8,8 @@
  * Thrown when circular redirection is detected.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Exception\CircularRedirectionException} instead.
  */
 class CircularRedirectionException extends HttpException
 {
diff --git a/src/Exception/ClientErrorException.php b/src/Exception/ClientErrorException.php
@@ -8,6 +8,8 @@
  * Thrown when there is a client error (4xx).
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Exception\ClientErrorException} instead.
  */
 class ClientErrorException extends HttpException
 {
diff --git a/src/Exception/LoopException.php b/src/Exception/LoopException.php
@@ -6,6 +6,8 @@
 
 /**
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Exception\LoopException} instead.
  */
 class LoopException extends RequestException
 {
diff --git a/src/Exception/MultipleRedirectionException.php b/src/Exception/MultipleRedirectionException.php
@@ -8,6 +8,8 @@
  * Redirect location cannot be chosen.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Exception\MultipleRedirectionException} instead.
  */
 class MultipleRedirectionException extends HttpException
 {
diff --git a/src/Exception/ServerErrorException.php b/src/Exception/ServerErrorException.php
@@ -8,6 +8,8 @@
  * Thrown when there is a server error (5xx).
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Exception\ServerErrorException} instead.
  */
 class ServerErrorException extends HttpException
 {
diff --git a/src/HeaderAppendPlugin.php b/src/HeaderAppendPlugin.php
@@ -13,6 +13,8 @@
  * @link https://en.wikipedia.org/wiki/List_of_HTTP_header_fields
  *
  * @author Soufiane Ghzal <sghzal@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\HeaderAppendPlugin} instead.
  */
 class HeaderAppendPlugin implements Plugin
 {
diff --git a/src/HeaderDefaultsPlugin.php b/src/HeaderDefaultsPlugin.php
@@ -9,6 +9,8 @@
  * If a given header already exists the value wont be replaced and the request wont be changed.
  *
  * @author Soufiane Ghzal <sghzal@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\HeaderDefaultsPlugin} instead.
  */
 class HeaderDefaultsPlugin implements Plugin
 {
diff --git a/src/HeaderRemovePlugin.php b/src/HeaderRemovePlugin.php
@@ -8,6 +8,8 @@
  * Removes headers from the request.
  *
  * @author Soufiane Ghzal <sghzal@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\HeaderRemovePlugin} instead.
  */
 class HeaderRemovePlugin implements Plugin
 {
diff --git a/src/HeaderSetPlugin.php b/src/HeaderSetPlugin.php
@@ -9,6 +9,8 @@
  * If the header does not exist it wil be set, if the header already exists it will be replaced.
  *
  * @author Soufiane Ghzal <sghzal@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\HeaderSetPlugin} instead.
  */
 class HeaderSetPlugin implements Plugin
 {
diff --git a/src/HistoryPlugin.php b/src/HistoryPlugin.php
@@ -8,6 +8,8 @@
 
 /**
  * Record http call.
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\HistoryPlugin} instead.
  */
 class HistoryPlugin implements Plugin
 {
diff --git a/src/Journal.php b/src/Journal.php
@@ -10,6 +10,8 @@
  * Records history of http calls.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\Journal} instead.
  */
 interface Journal
 {
diff --git a/src/LoggerPlugin.php b/src/LoggerPlugin.php
@@ -13,6 +13,8 @@
  * Log request, response and exception for a HTTP Client.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\LoggerPlugin} instead.
  */
 class LoggerPlugin implements Plugin
 {
diff --git a/src/Plugin.php b/src/Plugin.php
@@ -2,9 +2,6 @@
 
 namespace Http\Client\Plugin;
 
-use Http\Promise\Promise;
-use Psr\Http\Message\RequestInterface;
-
 /**
  * A plugin is a middleware to transform the request and/or the response.
  *
@@ -14,17 +11,9 @@
  *  - restart the request
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin} instead.
  */
-interface Plugin
+interface Plugin extends \Http\Client\Common\Plugin
 {
-    /**
-     * Handle the request and return the response coming from the next callable.
-     *
-     * @param RequestInterface $request
-     * @param callable         $next    Next middleware in the chain, the request is passed as the first argument
-     * @param callable         $first   First middleware in the chain, used to to restart a request
-     *
-     * @return Promise
-     */
-    public function handleRequest(RequestInterface $request, callable $next, callable $first);
 }
diff --git a/src/PluginClient.php b/src/PluginClient.php
@@ -16,6 +16,8 @@
  * The client managing plugins and providing a decorator around HTTP Clients.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\PluginClient} instead.
  */
 final class PluginClient implements HttpClient, HttpAsyncClient
 {
diff --git a/src/RedirectPlugin.php b/src/RedirectPlugin.php
@@ -15,6 +15,8 @@
  * Follow redirections.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\RedirectPlugin} instead.
  */
 class RedirectPlugin implements Plugin
 {
diff --git a/src/RetryPlugin.php b/src/RetryPlugin.php
@@ -13,6 +13,8 @@
  * By default will retry only one time.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\RetryPlugin} instead.
  */
 class RetryPlugin implements Plugin
 {
diff --git a/src/StopwatchPlugin.php b/src/StopwatchPlugin.php
@@ -11,6 +11,8 @@
  * Measure the duration of a request call with the stopwatch component.
  *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
+ *
+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\StopwatchPlugin} instead.
  */
 class StopwatchPlugin implements Plugin
 {

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`	`* Add schema and host to a request. Can be set to overwrite the schema and host if desired.`
`11`	`11`	`*`
`12`	`12`	`* @author Tobias Nyholm <[email protected]>`
	`13`	`+ *`
	`14`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\AddHostPlugin} instead.`
`13`	`15`	`*/`
`14`	`16`	`class AddHostPlugin implements Plugin`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`* Send an authenticated request.`
`10`	`10`	`*`
`11`	`11`	`* @author Joel Wurtz <[email protected]>`
	`12`	`+ *`
	`13`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\AuthenticationPlugin} instead.`
`12`	`14`	`*/`
`13`	`15`	`class AuthenticationPlugin implements Plugin`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`	`* Allow for caching a response.`
`14`	`14`	`*`
`15`	`15`	`* @author Tobias Nyholm <[email protected]>`
	`16`	`+ *`
	`17`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\CachePlugin} instead.`
`16`	`18`	`*/`
`17`	`19`	`class CachePlugin implements Plugin`
`18`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`* Allow to set the correct content length header on the request or to transfer it as a chunk if not possible.`
`10`	`10`	`*`
`11`	`11`	`* @author Joel Wurtz <[email protected]>`
	`12`	`+ *`
	`13`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\ContentLengthPlugin} instead.`
`12`	`14`	`*/`
`13`	`15`	`class ContentLengthPlugin implements Plugin`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`* Handle request cookies.`
`13`	`13`	`*`
`14`	`14`	`* @author Joel Wurtz <[email protected]>`
	`15`	`+ *`
	`16`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\CookiePlugin} instead.`
`15`	`17`	`*/`
`16`	`18`	`class CookiePlugin implements Plugin`
`17`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`* If Content-Encoding is not disabled, the plugin will add an Accept-Encoding header for the encoding methods it supports.`
`20`	`20`	`*`
`21`	`21`	`* @author Joel Wurtz <[email protected]>`
	`22`	`+ *`
	`23`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Plugin\DecoderPlugin} instead.`
`22`	`24`	`*/`
`23`	`25`	`class DecoderPlugin implements Plugin`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`	`* Thrown when circular redirection is detected.`
`9`	`9`	`*`
`10`	`10`	`* @author Joel Wurtz <[email protected]>`
	`11`	`+ *`
	`12`	`+ * @deprecated since since version 1.1, and will be removed in 2.0. Use {@link \Http\Client\Common\Exception\CircularRedirectionException} instead.`
`11`	`13`	`*/`
`12`	`14`	`class CircularRedirectionException extends HttpException`
`13`	`15`	`{`