Merge pull request #57 from KarimGeiger/patch-1

Add `withHeaders()` method to add custom SOAP headers

Author: clue

README.md

@@ -42,6 +42,7 @@ This project provides a *simple* API for invoking *async* RPCs to remote web ser
     * [getTypes()](#gettypes)
     * [getLocation()](#getlocation)
     * [withLocation()](#withlocation)
+    * [withHeaders()](#withheaders)
   * [Proxy](#proxy)
     * [Functions](#functions)
     * [Promises](#promises)
@@ -307,6 +308,17 @@ assert('http://example.com/soap' === $client->getLocation('echo'));
 As an alternative to this method, you can also set the `location` option
 in the `Client` constructor (such as when in non-WSDL mode).
 
+#### withHeaders()
+
+The `withHeaders(array $headers): self` method can be used to
+return a new `Client` with the updated headers for all functions.
+This allows to set specific headers required by some SOAP endpoints, like
+for authentication, etc.
+
+```php
+$client = $client->withHeaders([new SoapHeader(...)]);
+```
+
 ### Proxy
 
 The `Proxy` class wraps an existing [`Client`](#client) instance in order to ease calling

src/Client.php

@@ -322,4 +322,19 @@ public function withLocation(string $location): self
 
         return $client;
     }
+    
+    /**
+     * Returns a new `Client` with the given headers for all functions.
+     *
+     * @param array $headers
+     * @return self
+     */
+    public function withHeaders(array $headers): self
+    {
+        $client = clone $this;
+        $client->encoder = clone $this->encoder;
+        $client->encoder->__setSoapHeaders($headers);
+
+        return $client;
+    }
 }

tests/ClientTest.php

@@ -59,4 +59,29 @@ public function testNonWsdlClientSendsPostRequestToGivenLocationForAnySoapCall()
 
         $client->soapCall('ping', array());
     }
+
+    public function testWithHeaderProperlySetsHeadersInRequestBody()
+    {
+        $browser = $this->getMockBuilder('React\Http\Browser')->disableOriginalConstructor()->getMock();
+        $browser->expects($this->once())->method('withRejectErrorResponse')->willReturnSelf();
+        $browser->expects($this->once())->method('withFollowRedirects')->willReturnSelf();
+        $browser->expects($this->once())->method('request')->with('POST', 'http://example.com')
+            ->willReturnCallback(function ($method, $url, $headers, $body) {
+                // We expect the SOAP header to be present on the request body
+                $this->assertStringContainsString(
+                    '<SOAP-ENV:Header><ns2:echoMeStringRequest>hello world</ns2:echoMeStringRequest></SOAP-ENV:Header>',
+                    $body
+                );
+                return new Promise(function () { });
+            });
+
+        $client = new Client($browser, null, ['location' => 'http://example.com', 'uri' => 'http://example.com/uri']);
+        $client = $client->withHeaders([new \SoapHeader(
+            'http://soapinterop.org/echoheader/',
+            'echoMeStringRequest',
+            'hello world'
+        )]);
+
+        $client->soapCall('ping', []);
+    }
 }