Merge branch 'develop'

Author: mecha

CHANGELOG.md

@@ -4,5 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.2] - 2021-06-23
+### Changed
+- Using stable dependency versions
+
 ## [0.1] - 2021-06-23
 Initial version.

README.md

@@ -1,9 +1,9 @@
 # RebelCode - WP HTTP Client
 
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rebelcode/wp-http/Continuous%20Integration)
-![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/rebelcode/wp-http)
-![Packagist Version](https://img.shields.io/packagist/v/rebelcode/wp-http)
-![Packagist License](https://img.shields.io/packagist/l/rebelcode/wp-http)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rebelcode/wp-http/Continuous%20Integration)][github-ci]
+[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/rebelcode/wp-http)][packagist]
+[![Packagist Version](https://img.shields.io/packagist/v/rebelcode/wp-http)][packagist]
+[![Packagist License](https://img.shields.io/packagist/l/rebelcode/wp-http)][packagist]
 
 A WordPress HTTP client that complies with the [PSR-7 HTTP Message][psr7] and [PSR-18 HTTP client][psr18] standards.
 
@@ -163,6 +163,8 @@ $stack = new HandlerStack($baseHandler, [
 ]);
 ```
 
+[github-ci]: https://github.com/RebelCode/wp-http/actions/workflows/continuous-integration.yml
+[packagist]: https://packagist.org/packages/rebelcode/wp-http
 [psr7]: https://www.php-fig.org/psr/psr-7/
 [psr18]: https://www.php-fig.org/psr/psr-18/
 [guzzle]: https://github.com/guzzle/guzzle

composer.json

@@ -17,7 +17,7 @@
   "require": {
     "php": ">=7.1",
     "psr/http-client": "^1.0",
-    "rebelcode/psr7": "dev-master"
+    "rebelcode/psr7": "^1.0"
   },
   "require-dev": {
     "phpunit/phpunit": "^7.0 | ^8.0 | ^9.0",

composer.lock

@@ -16,6 +16,18 @@
  */
 class BadResponseException extends ResponseException
 {
+    /**
+     * Creates a bad response exception instance based on the status code of a response.
+     *
+     * @param RequestInterface  $request  The request that was dispatched to retrieve the response.
+     * @param ResponseInterface $response The response.
+     * @param Throwable|null    $previous Optional previous exception.
+     *
+     * @return BadResponseException An appropriately created exception:
+     *                              - a {@link ClientErrorException} for 4xx responses
+     *                              - a {@link ServerErrorException} for 5xx responses
+     *                              - a {@link BadResponseException} for other failed responses
+     */
     public static function create(
         RequestInterface $request,
         ResponseInterface $response,
@@ -54,7 +66,11 @@ public static function create(
     }
 
     /**
-     * Obfuscates URI if there is a username and a password present
+     * Obfuscates URI if there is a username and a password present.
+     *
+     * @param UriInterface $uri The URI to obfuscate.
+     *
+     * @return UriInterface The obfuscated URI.
      */
     protected static function obfuscateUri(UriInterface $uri): UriInterface
     {

src/Exception/BadResponseException.php

@@ -7,6 +7,9 @@
 use Psr\Http\Message\RequestInterface;
 use Throwable;
 
+/**
+ * An exception that is thrown in relation to a request.
+ */
 class RequestException extends HttpException
 {
     /** @var RequestInterface */

src/Exception/RequestException.php

@@ -8,6 +8,9 @@
 use Psr\Http\Message\ResponseInterface;
 use Throwable;
 
+/**
+ * An exception that is thrown in relation to a request its corresponding response.
+ */
 class ResponseException extends RequestException
 {
     /** @var ResponseInterface */

src/Exception/ResponseException.php

@@ -7,6 +7,9 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * Interface for an object that can handle a request and provide a response for it.
+ */
 interface HandlerInterface
 {
     /**

src/HandlerInterface.php

@@ -10,6 +10,8 @@
 use RebelCode\WordPress\Http\Middleware\PrepareBody;
 
 /**
+ * A handler implementation that composes a base handler and a set of middleware handlers.
+ *
  * @psalm-type        MiddlewareFactory = callable(HandlerInterface): Middleware
  * @psalm-import-type WpHandlerOptions from WpHandler
  */

src/HandlerStack.php

@@ -12,6 +12,8 @@
 use RebelCode\Psr7\UriResolver;
 
 /**
+ * The PSR-18 client implementation.
+ *
  * @psalm-import-type WpHandlerOptions from WpHandler
  */
 class WpClient implements ClientInterface