Merge pull request #63 from elecena/http-test

Implement HTTP tests using httpbin.org
elecena · Sep 1, 2021 · c8ba1e5 · c8ba1e5
2 parents 6044078 + 6b50a46
commit c8ba1e5
Show file tree

Hide file tree

Showing 7 changed files with 1,636 additions and 1,578 deletions.
diff --git a/classes/http/Response.class.php b/classes/http/Response.class.php
@@ -57,7 +57,7 @@ public function setHeaders($headers)
      */
     public function getHeader($name)
     {
-        return isset($this->headers[$name]) ? $this->headers[$name] : null;
+        return $this->headers[$name] ?? null;
     }
 
     /**
@@ -71,7 +71,7 @@ public function setResponseCode($responseCode)
     /**
      * Get response code
      */
-    public function getResponseCode()
+    public function getResponseCode(): int
     {
         return $this->responseCode;
     }

diff --git a/classes/utils/Http.class.php b/classes/utils/Http.class.php
@@ -1,5 +1,7 @@
 <?php
 
+use Nano\Http\Response;
+
 /**
  * Class with helper methods for HttpClient
  */
@@ -14,7 +16,7 @@ class Http
      * @return Nano\Http\Response
      * @throws Nano\Http\ResponseException
      */
-    public static function get($url, $query = [])
+    public static function get(string $url, array $query = []): Response
     {
         $client = new HttpClient();
         $ret = $client->get($url, $query);
@@ -31,7 +33,7 @@ public static function get($url, $query = [])
      * @return Nano\Http\Response
      * @throws Nano\Http\ResponseException
      */
-    public static function post($url, $fields = [])
+    public static function post(string $url, array $fields = []): Response
     {
         $client = new HttpClient();
         $ret = $client->post($url, $fields);
@@ -48,7 +50,7 @@ public static function post($url, $fields = [])
      * @return Nano\Http\Response
      * @throws Nano\Http\ResponseException
      */
-    public static function head($url, $query = [])
+    public static function head(string $url, array $query = []): Response
     {
         $client = new HttpClient();
         $ret = $client->head($url, $query);

diff --git a/classes/utils/HttpClient.class.php b/classes/utils/HttpClient.class.php
@@ -50,13 +50,15 @@ public function __construct()
         $info = curl_version();
         $this->version = $info['version'];
 
+        $phpVersion = phpversion();
+
         // set up cURL library
         $this->handle = curl_init();
 
         $this->logger = self::getLogger();
 
         // set user agent
-        $this->setUserAgent('NanoPortal/' . Nano::VERSION . " libcurl/{$this->version}");
+        $this->setUserAgent('NanoPortal/' . Nano::VERSION . " libcurl/{$this->version}" . " php/{$phpVersion}");
 
         curl_setopt_array($this->handle, [
             CURLOPT_ENCODING => 'gzip',
@@ -84,10 +86,8 @@ public function __construct()
 
     /**
      * Get logger instance
-     *
-     * @return \Monolog\Logger
      */
-    protected static function getLogger()
+    protected static function getLogger(): \Monolog\Logger
     {
         static $logger;
 
@@ -113,7 +113,7 @@ public function close()
      * @param string $proxy
      * @param int $type
      */
-    public function setProxy($proxy, $type = CURLPROXY_HTTP)
+    public function setProxy(string $proxy, int $type = CURLPROXY_HTTP)
     {
         curl_setopt($this->handle, CURLOPT_PROXY, $proxy);
         curl_setopt($this->handle, CURLOPT_PROXYTYPE, $type);
@@ -123,10 +123,8 @@ public function setProxy($proxy, $type = CURLPROXY_HTTP)
 
     /**
      * Set user agent identification used by HTTP client
-     *
-     * @param string $userAgent
      */
-    public function setUserAgent($userAgent)
+    public function setUserAgent(string $userAgent)
     {
         $this->userAgent = $userAgent;
 
@@ -145,11 +143,8 @@ public function getUserAgent()
 
     /**
      * Set request headers
-     **
-     * @param string $header
-     * @param string $value
      */
-    public function setRequestHeader($header, $value)
+    public function setRequestHeader(string $header, string $value)
     {
         $this->reqHeaders[] = "$header: $value";
 
@@ -158,10 +153,8 @@ public function setRequestHeader($header, $value)
 
     /**
      * Set timeout for a single request
-     *
-     * @param int $timeout
      */
-    public function setTimeout($timeout)
+    public function setTimeout(int $timeout)
     {
         $this->timeout = $timeout;
 
@@ -170,10 +163,8 @@ public function setTimeout($timeout)
 
     /**
      * Use given cookie jar file
-     *
-     * @param string $jarFile
      */
-    public function useCookieJar($jarFile)
+    public function useCookieJar(string $jarFile)
     {
         $this->logger->debug(__METHOD__, ['jar' => $jarFile]);
 
@@ -185,11 +176,8 @@ public function useCookieJar($jarFile)
 
     /**
      * Manually sets request cookie
-     *
-     * @param string $name
-     * @param string $value
      */
-    public function setCookie($name, $value)
+    public function setCookie(string $name, string $value)
     {
         $this->cookies[$name] = $value;
 
@@ -199,12 +187,12 @@ public function setCookie($name, $value)
     /**
      * Send GET HTTP request for a given URL
      *
-     * @param $url
+     * @param string $url
      * @param array $query
      * @return Response
      * @throws Nano\Http\ResponseException
      */
-    public function get($url, array $query = [])
+    public function get(string $url, array $query = []): Response
     {
         // add request params
         if (!empty($query) && is_array($query)) {
@@ -222,7 +210,7 @@ public function get($url, array $query = [])
      * @return Response
      * @throws Nano\Http\ResponseException
      */
-    public function post($url, $fields = false)
+    public function post(string $url, $fields = false): Response
     {
         // add request POST fields
         if (is_array($fields)) {
@@ -237,12 +225,12 @@ public function post($url, $fields = false)
     /**
      * Send HEAD HTTP request for a given URL
      *
-     * @param $url
+     * @param string $url
      * @param array $query
      * @return Response
      * @throws Nano\Http\ResponseException
      */
-    public function head($url, array $query = [])
+    public function head(string $url, array $query = []): Response
     {
         // add request params
         if (!empty($query)) {
@@ -260,7 +248,7 @@ public function head($url, array $query = [])
      * @return Response
      * @throws Nano\Http\ResponseException
      */
-    private function sendRequest($method, $url)
+    private function sendRequest(string $method, string $url): Response
     {
         // send requested type of HTTP request
         curl_setopt($this->handle, CURLOPT_POST, false);

diff --git a/composer.json b/composer.json
@@ -15,12 +15,12 @@
     "ext-curl": "*",
     "ext-mbstring": "*",
     "ext-gd": "*",
+    "ext-json": "*",
     "ext-xml": "*",
     "predis/predis": "^1.1",
     "monolog/monolog": "2.3.2",
     "macbre/monolog-utils": "^2.1",
-    "tedivm/jshrink": "^1.2",
-    "phpunit/phpunit": "9.x"
+    "tedivm/jshrink": "^1.2"
   },
   "autoload": {
     "classmap": ["classes/", "classes/utils/", "tests/app/classes/", "tests/CacheTest.php"],
@@ -33,10 +33,10 @@
   },
   "scripts": {
     "test": [
-      "phpunit --verbose"
+      "phpunit --testdox --verbose"
     ],
     "coverage": [
-      "XDEBUG_MODE=coverage phpunit --coverage-html=.coverage --coverage-clover=.coverage.xml --coverage-text --verbose"
+      "XDEBUG_MODE=coverage phpunit --coverage-html=.coverage --coverage-clover=.coverage.xml --coverage-text --testdox --verbose"
     ],
     "lint": [
       "php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --verbose",
@@ -47,7 +47,9 @@
     ]
   },
   "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3.0",
+    "psr/cache": "^1.0.0",
     "phpstan/phpstan": "^0.12.82",
-    "friendsofphp/php-cs-fixer": "^3.0"
+    "phpunit/phpunit": "9.x"
   }
 }