feat: add support for OPTIONS requests (#13)

* feat: add support for OPTIONS requests

* feat(doc): add OPTIONS ref. to README

README.md

@@ -137,3 +137,19 @@ Example:
 ```php
 $client->call("my/endpoint")->params(["foo" => "bar"])->delete();
 ```
+
+### `OPTIONS` Request
+
+Make an `OPTIONS` request by chaining `options()` at the end of a method chain. This method will return a `Reflect\Response` object.
+
+Use this method to query Reflect for available request methods.
+
+```php
+Client->options(): Reflect\Response;
+```
+
+Example:
+
+```php
+$client->call("my/endpoint"))->options();
+```

src/Reflect/Client.php

@@ -9,19 +9,21 @@
     require_once "Response.php";
 
     class Client {
+        private string $params;
+        private string $endpoint;
+        private array $headers = [];
+        private ?array $payload = null;
+
         protected ?string $key;
         protected string $base_url;
         protected bool $https_verify_peer;
-
-        protected string $endpoint;
-        protected string $params;
             
         public function __construct(string $base_url, string $key = null, bool $verify_peer = true) {
-            // Optional API key
+            // Set optional API key and Authorization header
             $this->key = $key;
 
             // Append tailing "/" if absent
-            $this->base_url = substr($this->base_url, -1) === "/" ? $this->base_url : $this->base_url . "/";
+            $this->base_url = substr($base_url, -1) === "/" ? $base_url : $base_url . "/";
             // Flag which enables or disables SSL peer validation (for self-signed certificates)
             $this->https_verify_peer = $verify_peer;
         }
@@ -34,27 +36,25 @@
         // ----
 
         // Construct stream_context_create() compatible header string
-        private function http_headers(): string {
-            $headers = ["Content-Type: application/json"];
-
-            // Append Authentication header if API key is provided
-            if (!empty($this->key)) {
-                $headers[] = "Authorization: Bearer {$this->key}";
+        private function get_headers(): string {
+            // Set Authorization header if an API key is used
+            if ($this->key) {
+                $this->headers["Authorization"] = "Bearer {$this->key}";
             }
-
-            // Append new line chars to each header
-            $headers = array_map(fn($header): string => $header . "\r\n", $headers);
+            
+            // Construct HTTP headers string from array
+            $headers = array_map(fn(string $k, string $v): string => "{$k}: {$v}\r\n", array_keys($this->headers), array_values($this->headers));
             return implode("", $headers);
         }
 
         // Make request and return response over HTTP
-        private function http_call(Method $method, array $payload = null): array {
+        private function http_call(Method $method): array {
             $context = stream_context_create([
                 "http" => [
-                    "header"        => $this->http_headers(),
+                    "header"        => $this->get_headers(),
                     "method"        => $method->name,
                     "ignore_errors" => true,
-                    "content"       => !empty($payload) ? json_encode($payload) : ""
+                    "content"       => !empty($this->payload) ? json_encode($this->payload) : ""
                 ],
                 "ssl" => [
                     "verify_peer"       => $this->https_verify_peer,
@@ -63,7 +63,7 @@
                 ]
             ]);
 
-            $resp = file_get_contents($this->base_url . $this->endpoint, false, $context);
+            $resp = file_get_contents(implode("", [$this->base_url, $this->endpoint, $this->params]), false, $context);
 
             // Get HTTP response code from $http_response_header which materializes out of thin air after file_get_contents(). 
             // The first header line and second word will contain the status code.
@@ -73,6 +73,20 @@
             return [$resp, $resp_code];
         }
 
+        // Set request body to be JSON-stringified
+        private function set_request_body(?array $payload = null): self {
+            // Unset request body if no payload defined
+            if (empty($payload)) {
+                $this->payload = null;
+                return $this;
+            }
+
+            $this->headers["Content-Type"] = "application/json";
+
+            $this->payload = $payload;
+            return $this;
+        }
+
         // ----
 
         // Construct URL search parameters from array if set
@@ -84,12 +98,14 @@
         // Create a new call to an endpoint
         public function call(string $endpoint): self {
             // Remove leading "/" if present, as it's already present in $this->base_url
-            $this->endpoint = substr($this->endpoint, 0, 1) !== "/" 
-                ? $this->endpoint 
-                : substr($this->endpoint, 1, strlen($this->endpoint) - 1);
+            $this->endpoint = substr($endpoint, 0, 1) !== "/" 
+                ? $endpoint 
+                : substr($endpoint, 1, strlen($endpoint) - 1);
 
-            // Reset search parameters
+            // Reset initial values
             $this->params();
+            $this->headers = [];
+            $this->set_request_body();
 
             return $this;
         }
@@ -101,19 +117,27 @@
             return new Response(...$this->http_call(Method::GET));
         }
 
-        public function patch(array $payload): Response {
-            return new Response(...$this->http_call(Method::PATCH, $payload));
+        public function patch(?array $payload = []): Response {
+            $this->set_request_body($payload);
+            return new Response(...$this->http_call(Method::PATCH));
         }
 
-        public function put(array $payload): Response {
-            return new Response(...$this->http_call(Method::PUT, $payload));
+        public function put(?array $payload = []): Response {
+            $this->set_request_body($payload);
+            return new Response(...$this->http_call(Method::PUT));
         }
 
-        public function post(array $payload): Response {
-            return new Response(...$this->http_call(Method::POST, $payload));
+        public function post(?array $payload = []): Response {
+            $this->set_request_body($payload);
+            return new Response(...$this->http_call(Method::POST));
         }
 
         public function delete(?array $payload = []): Response {
-            return new Response(...$this->http_call(Method::DELETE, $payload));
+            $this->set_request_body($payload);
+            return new Response(...$this->http_call(Method::DELETE));
         }
-    }
+
+        public function options(): Response {
+            return new Response(...$this->http_call(Method::OPTIONS));
+        }
+    }