feat(laravel-soap-199): add working ray

Author: Gregor Becker

.gitignore

@@ -1,4 +1,5 @@
 .idea
+.env
 .php_cs
 .php_cs.cache
 .phpunit.result.cache
@@ -12,3 +13,4 @@ testbench.yaml
 vendor
 node_modules
 .php-cs-fixer.cache
+ray.php

composer.json

@@ -27,7 +27,9 @@
         "robrichards/wse-php": "^2.0",
         "php-soap/psr18-transport": "^1.2",
         "php-soap/psr18-wsse-middleware": "^1.1",
-        "veewee/xml": "^1.3"
+        "veewee/xml": "^1.3",
+        "spatie/laravel-package-tools": "^1.11",
+        "illuminate/contracts": "^9.0"
     },
     "require-dev": {
         "symfony/options-resolver": "^5.4.3",

composer.lock

@@ -16,6 +16,18 @@
         'namespace' => 'App\\Soap',
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | SOAP Code Generation directory
+    |--------------------------------------------------------------------------
+    |
+    | Define the destination for the code generator under the app directory
+    */
+
+    'ray' => [
+        'send_soap_client_requests' => false
+    ],
+
     /*
     |--------------------------------------------------------------------------
     | SOAP Client Configuration

config/soap.php

@@ -10,7 +10,3 @@ parameters:
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: false
-    ignoreErrors:
-        - '#on an unknown class Spatie\\RayBundle\\Ray#'
-        - '#on an unknown class Spatie\\WordPressRay\\Ray#'
-        - '#on an unknown class Spatie\\YiiRay\\Ray#'

phpstan.neon

@@ -4,6 +4,8 @@
 
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use Illuminate\Support\Traits\Macroable;
+use LogicException;
 use Psr\Http\Message\RequestInterface;
 use Soap\Psr18Transport\HttpBinding\SoapActionDetector;
 use Soap\Xml\Locator\SoapBodyLocator;
@@ -18,8 +20,18 @@
  */
 class Request
 {
+    use Macroable;
+
+    /**
+     * The underlying PSR request.
+     */
     protected RequestInterface $request;
 
+    /**
+     * The decoded payload for the request.
+     */
+    protected array $data;
+
     /**
      * Create a new request instance.
      *
@@ -44,6 +56,90 @@ public function getRequest(): RequestInterface
         return $this->request;
     }
 
+    /**
+     * Get the URL of the request.
+     */
+    public function url(): string
+    {
+        return (string) $this->request->getUri();
+    }
+
+    /**
+     * Determine if the request has a given header.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return bool
+     */
+    public function hasHeader($key, $value = null)
+    {
+        if (is_null($value)) {
+            return ! empty($this->request->getHeaders()[$key]);
+        }
+
+        $headers = $this->headers();
+
+        if (! Arr::has($headers, $key)) {
+            return false;
+        }
+
+        $value = is_array($value) ? $value : [$value];
+
+        return empty(array_diff($value, $headers[$key]));
+    }
+
+    /**
+     * Determine if the request has the given headers.
+     *
+     * @param  array|string  $headers
+     * @return bool
+     */
+    public function hasHeaders($headers)
+    {
+        if (is_string($headers)) {
+            $headers = [$headers => null];
+        }
+
+        foreach ($headers as $key => $value) {
+            if (! $this->hasHeader($key, $value)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the values for the header with the given name.
+     *
+     * @param  string  $key
+     * @return array
+     */
+    public function header($key)
+    {
+        return Arr::get($this->headers(), $key, []);
+    }
+
+    /**
+     * Get the request headers.
+     *
+     * @return array
+     */
+    public function headers()
+    {
+        return $this->request->getHeaders();
+    }
+
+    /**
+     * Get the body of the request.
+     *
+     * @return string
+     */
+    public function body()
+    {
+        return (string) $this->request->getBody();
+    }
+
     /**
      * Return complete xml request body.
      */
@@ -61,7 +157,82 @@ public function arguments(): array
     {
         $doc = Document::fromXmlString($this->xmlContent());
         $method = $doc->locate(new SoapBodyLocator())?->firstElementChild;
+        return Arr::wrap(Arr::get(element_decode($method, traverse(new RemoveNamespaces())), 'node', []));
+    }
+
+    /**
+     * Set the decoded data on the request.
+     *
+     * @param  array  $data
+     * @return $this
+     */
+    public function withData(array $data)
+    {
+        $this->data = $data;
+
+        return $this;
+    }
+
+    /**
+     * Get the underlying PSR compliant request instance.
+     *
+     * @return \Psr\Http\Message\RequestInterface
+     */
+    public function toPsrRequest()
+    {
+        return $this->request;
+    }
+
+    /**
+     * Determine if the given offset exists.
+     *
+     * @param  string  $offset
+     * @return bool
+     *
+     * @throws EncodingException
+     */
+    public function offsetExists(string $offset): bool
+    {
+        return isset($this->arguments()[$offset]);
+    }
+
+    /**
+     * Get the value for a given offset.
+     *
+     * @param  string  $offset
+     * @return mixed
+     *
+     * @throws EncodingException
+     */
+    public function offsetGet($offset): mixed
+    {
+        return $this->arguments()[$offset];
+    }
 
-        return Arr::get(element_decode($method, traverse(new RemoveNamespaces())), 'node', []);
+    /**
+     * Set the value at the given offset.
+     *
+     * @param  string  $offset
+     * @param  mixed  $value
+     * @return void
+     *
+     * @throws LogicException
+     */
+    public function offsetSet($offset, $value): void
+    {
+        throw new LogicException('Request data may not be mutated using array access.');
+    }
+
+    /**
+     * Unset the value at the given offset.
+     *
+     * @param  string  $offset
+     * @return void
+     *
+     * @throws LogicException
+     */
+    public function offsetUnset($offset): void
+    {
+        throw new LogicException('Request data may not be mutated using array access.');
     }
 }

src/Client/Request.php

@@ -5,6 +5,7 @@
 use ArrayAccess;
 use CodeDredd\Soap\Exceptions\RequestException;
 use GuzzleHttp\Psr7\Response as Psr7Response;
+use GuzzleHttp\TransferStats;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
@@ -16,6 +17,9 @@
 
 /**
  * Class Response.
+ *
+ * @property ?TransferStats $transferStats
+ * @property array $cookies
  */
 class Response implements ResultInterface, ArrayAccess
 {
@@ -214,6 +218,16 @@ public function onError(callable $callback)
         return $this;
     }
 
+    /**
+     * Get the handler stats of the response.
+     *
+     * @return array
+     */
+    public function handlerStats()
+    {
+        return $this->transferStats?->getHandlerStats() ?? [];
+    }
+
     /**
      * Get the JSON decoded body of the response as an array.
      */
@@ -230,6 +244,22 @@ public function json($key = null, $default = null): ?array
         return data_get($this->decoded, $key, $default);
     }
 
+    /**
+     * Get a header from the response.
+     */
+    public function header(string $header): string
+    {
+        return $this->response->getHeaderLine($header);
+    }
+
+    /**
+     * Get the headers from the response.
+     */
+    public function headers(): array
+    {
+        return $this->response->getHeaders();
+    }
+
     /**
      * Determine if the given offset exists.
      *