Minor improvements

Added marker exception interface.
Some code cleaning.

Closes #9, Closes #8, Closes #6, Closes #5

Author: mnavarrocarter

composer.json

@@ -14,7 +14,9 @@
         "psr-4": {
             "MNC\\Http\\": "src"
         },
-        "files": ["functions.php"]
+        "files": [
+            "src/functions.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

phpunit.xml.dist

@@ -6,14 +6,8 @@
     <coverage>
         <include>
             <directory>src</directory>
-            <file>functions.php</file>
         </include>
     </coverage>
-
-    <php>
-        <server name="TEST_SERVER" value="http://127.0.0.1:10000/server.php"/>
-    </php>
-
     <testsuites>
         <testsuite name="Main Test Suite">
             <directory>tests</directory>

src/FetchError.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the https://github.com/mnavarrocarter/php-fetch project.
+ * (c) Matías Navarro-Carter <[email protected]>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace MNC\Http;
+
+use Throwable;
+
+/**
+ * Interface FetchError its just a marker for this library exceptions.
+ */
+interface FetchError extends Throwable
+{
+}

src/HttpPartialResponse.php

@@ -21,7 +21,7 @@ final class HttpPartialResponse implements PartialResponse
     private Headers $headers;
 
     /**
-     * @param list<string> $lines
+     * @param array<string> $lines
      *
      * @return list<HttpPartialResponse>
      */
@@ -30,11 +30,13 @@ public static function parseLines(array $lines): array
         $partials = [];
         while ($lines !== []) {
             $line = array_shift($lines);
-            if (strpos($line, 'HTTP') === 0) {
-                $status = Status::fromStatusLine($line);
-                $headers = Headers::fromLines($lines);
-                $partials[] = new HttpPartialResponse($status, $headers);
+            if (strpos($line, 'HTTP') !== 0) {
+                continue;
             }
+            $partials[] = new HttpPartialResponse(
+                Status::fromStatusLine($line),
+                Headers::fromLines($lines)
+            );
         }
 
         return $partials;

src/ProtocolError.php

@@ -28,7 +28,7 @@
  * Not throwing exceptions means we are not following the rules of the protocol
  * we are trying to implement.
  */
-class ProtocolError extends Exception
+class ProtocolError extends Exception implements FetchError
 {
     private Response $response;
 

src/RedirectedHttpResponse.php

@@ -18,7 +18,7 @@ final class RedirectedHttpResponse implements Response, Redirected
 {
     private Response $response;
     /**
-     * @var list<PartialResponse>
+     * @var array<PartialResponse>
      */
     private array $previous;
 

src/SocketError.php

@@ -19,6 +19,6 @@
  * or network error), dns unable to resolve to an ip address or the server
  * being down.
  */
-class SocketError extends Exception
+class SocketError extends Exception implements FetchError
 {
 }

functions.php renamed to src/functions.php

@@ -2,20 +2,23 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the https://github.com/mnavarrocarter/php-fetch project.
+ * (c) Matías Navarro-Carter <[email protected]>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace MNC\Http;
 
 use MNC\Http\Io\Reader;
 use MNC\Http\Io\ResourceReader;
 
 /**
- * Fetches a url
- *
- * @param string $url
- * @param array $options
- * @return Response
+ * Fetches a url.
  *
  * @throws ProtocolError when the server responds with an error
- * @throws SocketError when a connection cannot be established
+ * @throws SocketError   when a connection cannot be established
  */
 function fetch(string $url, array $options = []): Response
 {
@@ -26,7 +29,6 @@ function fetch(string $url, array $options = []): Response
     $maxRedirects = $options['max_redirects'] ?? 20;
     $protocolVersion = $options['protocol_version'] ?? '1.1';
 
-    // TODO: Need to add more options like cache, redirects following and others
     $context = [
         'http' => [
             'method' => $method,
@@ -35,13 +37,13 @@ function fetch(string $url, array $options = []): Response
             'ignore_errors' => true,
             'follow_location' => $followRedirects ? 1 : 0,
             'max_redirects' => $maxRedirects,
-            'protocol_version' => (float) $protocolVersion
-        ]
+            'protocol_version' => (float) $protocolVersion,
+        ],
     ];
 
     $resource = @fopen($url, 'rb', false, stream_context_create($context));
     if (!is_resource($resource)) {
-        throw new SocketError(error_get_last()['message']);
+        throw new SocketError(error_get_last()['message'] ?? 'Unknown error');
     }
     stream_set_blocking($resource, false);
 
@@ -70,14 +72,16 @@ function fetch(string $url, array $options = []): Response
 }
 
 /**
- * @param Reader $reader
  * @return string The buffered string
+ *
  * @throws Io\ReaderError
  */
-function buffer(Reader $reader) {
+function buffer(Reader $reader)
+{
     $buffer = '';
     while (($chunk = $reader->read()) !== null) {
         $buffer .= $chunk;
     }
+
     return $buffer;
-}
+}