Better exceptions, Pipeable trait, Laravel 8 and Symfony 5

Author: ivan770

.gitignore

@@ -1,2 +1,3 @@
 vendor/
-.idea/
+.idea/
+/composer.lock

README.md

@@ -6,7 +6,7 @@
 // Obtaining instance via Facade alias
 use HttpClient;
 // You can use Facade class to access HttpClient
-use Ivan770\HttpClient\Facade;
+use Ivan770\HttpClient\Facades\HttpClient;
 // Or, you can obtain HttpClient instance directly
 use Ivan770\HttpClient\HttpClient;
 public function method(HttpClient $client)

composer.json

@@ -4,9 +4,16 @@
     "type": "library",
     "license": "MIT",
     "require": {
-        "symfony/http-client": "^4.3",
-        "symfony/browser-kit": "^4.3",
-        "illuminate/support": "^5.8|^6.0|^7.0"
+        "symfony/http-client": "^5.0",
+        "symfony/browser-kit": "^5.0",
+        "illuminate/support": "^8.0",
+        "php": "^7.3"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.0",
+        "illuminate/container": "^8.0",
+        "illuminate/cache": "^8.0",
+        "illuminate/pipeline": "^8.0"
     },
     "suggest": {
         "illuminate/pipeline": "Allows to send response data through pipelines",
@@ -22,7 +29,7 @@
     "extra": {
         "laravel": {
             "aliases": {
-                "HttpClient": "Ivan770\\HttpClient\\Facade"
+                "HttpClient": "Ivan770\\HttpClient\\Facades\\HttpClient"
             },
             "providers": [
                 "Ivan770\\HttpClient\\ServiceProvider"

src/Builder.php

@@ -2,7 +2,10 @@
 
 namespace Ivan770\HttpClient;
 
+use Closure;
 use Illuminate\Contracts\Support\Arrayable;
+use JsonSerializable;
+use Traversable;
 
 class Builder
 {
@@ -93,7 +96,7 @@ public function headers($headers)
     /**
      * Add body to request
      *
-     * @param array|string|resource|\Traversable|\Closure $body Request body
+     * @param array|string|resource|Traversable|Closure $body Request body
      * @return $this
      */
     public function body($body)
@@ -105,7 +108,7 @@ public function body($body)
     /**
      * Add JSON to request
      *
-     * @param array|\JsonSerializable $json JSON-compatible value
+     * @param array|JsonSerializable $json JSON-compatible value
      * @return $this
      */
     public function json($json)
@@ -140,11 +143,11 @@ public function withoutRedirects()
     /**
      * Change proxy for this request
      *
-     * @param string $proxy Proxy value for CURLOPT_PROXY
-     * @param string $noproxy Comma-separated list of hosts, that do not require proxy
+     * @param  string  $proxy  Proxy value for CURLOPT_PROXY
+     * @param  string  $noproxy  Comma-separated list of hosts, that do not require proxy
      * @return $this
      */
-    public function proxy($proxy = null, $noproxy = null)
+    public function proxy(string $proxy, string $noproxy): Builder
     {
         $this->applyRequestOptions(['proxy' => $proxy, 'no_proxy' => $noproxy]);
         return $this;

src/Commands/HttpRequestMakeCommand.php

@@ -55,10 +55,8 @@ protected function getStub()
     /**
      * Build the class with the given name.
      *
-     * @param string $name
+     * @param  string  $name
      * @return string
-     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
-     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
      */
     protected function buildClass($name)
     {

src/Contracts/Request.php

@@ -3,14 +3,16 @@
 
 namespace Ivan770\HttpClient\Contracts;
 
+use Closure;
+use Illuminate\Support\Collection;
 use Ivan770\HttpClient\Response\Response;
 
 interface Request
 {
     /**
      * Attach builder properties. HttpClient instance is passed into Closure
      *
-     * @param \Closure $callback
+     * @param Closure $callback
      * @return Request
      */
     public function attach($callback);
@@ -25,7 +27,7 @@ public function execute();
     /**
      * Run request, and retrieve response contents
      *
-     * @return \Illuminate\Support\Collection|string
+     * @return Collection|string
      */
     public function get();
 }

src/Contracts/Response.php

@@ -2,29 +2,31 @@
 
 namespace Ivan770\HttpClient\Contracts;
 
-use Illuminate\Pipeline\Pipeline;
+use Closure;
+use Illuminate\Contracts\Pipeline\Pipeline;
+use Illuminate\Support\Collection;
 
 interface Response
 {
     /**
      * Create collection from response
      *
-     * @return \Illuminate\Support\Collection
+     * @return Collection
      */
     public function toCollection();
 
     /**
      * Get body of response, or collection, if response is JSON-compatible
      *
      * @param bool $throw
-     * @return \Illuminate\Support\Collection|string
+     * @return Collection|string
      */
     public function getContent($throw = true);
 
     /**
      * Pass response content to function
      *
-     * @param \Closure $function Function to call
+     * @param Closure $function Function to call
      */
     public function then($function);
 

src/Exceptions/Cache/BrowserKitCache.php

@@ -2,13 +2,12 @@
 
 namespace Ivan770\HttpClient\Exceptions\Cache;
 
-use Exception;
+use Ivan770\HttpClient\Exceptions\ClientException;
 
-class BrowserKitCache extends Exception
+class BrowserKitCache extends ClientException
 {
-    protected $message = "BrowserKit caching is not supported";
-
-    public function __toString() {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    protected function getBaseMessage(): string
+    {
+        return 'BrowserKit caching is not supported';
     }
 }

src/Exceptions/Cache/NullRepository.php

@@ -2,13 +2,12 @@
 
 namespace Ivan770\HttpClient\Exceptions\Cache;
 
-use Exception;
+use Ivan770\HttpClient\Exceptions\ClientException;
 
-class NullRepository extends Exception
+class NullRepository extends ClientException
 {
-    protected $message = "Cache repository was not provided";
-
-    public function __toString() {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    protected function getBaseMessage(): string
+    {
+        return 'Cache repository was not provided';
     }
 }

src/Exceptions/ClassIsNotModel.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Ivan770\HttpClient\Exceptions;
+
+use Exception;
+
+abstract class ClientException extends Exception
+{
+    /**
+     * Get base exception message, without any context
+     *
+     * @return string
+     */
+    abstract protected function getBaseMessage(): string;
+
+    public function __toString() {
+        return sprintf('%s: %s', __CLASS__, $this->getBaseMessage());
+    }
+}

src/Exceptions/ClientException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Ivan770\HttpClient\Exceptions;
+
+class ContainerNotAvailable extends ClientException
+{
+    protected function getBaseMessage(): string
+    {
+        return 'Container not available';
+    }
+}

src/Exceptions/ContainerNotAvailable.php

@@ -2,15 +2,10 @@
 
 namespace Ivan770\HttpClient\Exceptions;
 
-use Exception;
-
-class DataIsNotCollection extends Exception
+class DataIsNotCollection extends ClientException
 {
-    public function __construct($message, $code = 0, Exception $previous = null) {
-        parent::__construct($message, $code, $previous);
-    }
-
-    public function __toString() {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    protected function getBaseMessage(): string
+    {
+        return 'Passed data has to be collection instance';
     }
-}
+}

src/Exceptions/DataIsNotCollection.php

@@ -2,16 +2,10 @@
 
 namespace Ivan770\HttpClient\Exceptions;
 
-use Exception;
-
-class PipelineNotAvailable extends Exception
+class PipelineNotAvailable extends ClientException
 {
-    public function __construct($message, $code = 0, Exception $previous = null) {
-        parent::__construct($message, $code, $previous);
-    }
-
-    public function __toString() {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    protected function getBaseMessage(): string
+    {
+        return 'Pipeline class not found';
     }
-
 }

src/Exceptions/EloquentNotAvailable.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Ivan770\HttpClient\Facades;
+
+use Illuminate\Support\Facades\Facade as Base;
+use Ivan770\HttpClient\HttpClient as BaseClient;
+
+class HttpClient extends Base
+{
+    protected static function getFacadeAccessor()
+    {
+        return BaseClient::class;
+    }
+}

src/Exceptions/PipelineNotAvailable.php

@@ -2,21 +2,24 @@
 
 namespace Ivan770\HttpClient;
 
+use Closure;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Traits\Macroable;
 use Ivan770\HttpClient\Response\Response;
 use Ivan770\HttpClient\Traits\InteractsWithEloquent;
 use Ivan770\HttpClient\Traits\Requestable;
+use JsonSerializable;
 use Symfony\Component\HttpClient\HttpClient as Client;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Traversable;
 
 /**
  * @method HttpClient auth(string $type, array|string $credentials) Authentication credentials
  * @method HttpClient authBasic(array|string $credentials) Add HTTP basic auth to request
  * @method HttpClient authBearer(string $credentials) Add Bearer token to request
  * @method HttpClient headers(array $headers) Add headers to request
- * @method HttpClient body(array|string|resource|\Traversable|\Closure $body) Add body to request
- * @method HttpClient json(array|\JsonSerializable $json) Add JSON to request
+ * @method HttpClient body(array|string|resource|Traversable|Closure $body) Add body to request
+ * @method HttpClient json(array|JsonSerializable $json) Add JSON to request
  * @method HttpClient query(array $query) Add query string values to request
  * @method HttpClient withoutRedirects() Ignore all redirects for this request
  * @method HttpClient proxy(string $proxy, string $noproxy) Change proxy for this request