Merge branch 'release/1.0.0'

mikaelcom · mikaelcom · commit 8dd9e79a3186 · 2015-09-01T13:03:58.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,7 @@ before_install:
     - composer self-update
 
 install:
-    - composer install
+    - composer install --no-dev
 
 script:
     - phpunit --coverage-text --coverage-clover=coverage.clover
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+1.0.0
+---------
+- First major release, code coverage improved to reach 100% from the 1.0.0RC02 release.
+
 1.0.0RC02
 ---------
 - Major: update source code structure, put all classes under ```src``` folder, rename Tests to tests, update composer and phpunit accordingly
diff --git a/README.md b/README.md
@@ -44,8 +44,8 @@ So, basically, you MUST at least override the methods declared by the PHP interf
 #### Description
 This interface must be used to define a new [SoapClient](http://php.net/manual/en/class.soapclient.php) base class for any ```ServiceType``` class generated by [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator).
 
-#### What has to be implemented?
-Here are the constants defined by this interface and their utility:
+#### Options
+Here are the constants/options defined by this interface and their utility:
 - **DEFAULT_SOAP_CLIENT_CLASS = '\SoapClient'**: this is the default [SoapClient](http://php.net/manual/en/class.soapclient.php) class that is used to send the request. Feel free to override it if you want to use another [SoapClient](http://php.net/manual/en/class.soapclient.php) class
 - **OPTION_PREFIX**: this is the prefix used for any constant's option name
 - **WSDL_URL**: option index used to pass the WSDL url
@@ -73,6 +73,7 @@ Here are the constants defined by this interface and their utility:
 - **WSDL_AUTHENTICATION**: authentication method may be either ```SOAP_AUTHENTICATION_BASIC``` (default) or ```SOAP_AUTHENTICATION_DIGEST```
 - **WSDL_SSL_METHOD**: one of ```SOAP_SSL_METHOD_TLS```, ```SOAP_SSL_METHOD_SSLv2```, ```SOAP_SSL_METHOD_SSLv3``` or ```SOAP_SSL_METHOD_SSLv23```
 
+#### What has to be implemented?
 Here are the methods that must be implemented and why:
 - **__construct(array $wsdlOptions = array(), $resetSoapClient = true)**: the constructor must be able to handl one of the listed constants above
 - **getSoapClient()**: must return the [SoapClient](http://php.net/manual/en/class.soapclient.php) object that is responsible fo sending the requests.
diff --git a/src/AbstractSoapClientBase.php b/src/AbstractSoapClientBase.php
@@ -67,7 +67,7 @@ public function initSoapClient(array $options)
     {
         $wsdlOptions = array();
         $defaultWsdlOptions = self::getDefaultWsdlOptions();
-        foreach ($defaultWsdlOptions as $optioName=>$optionValue) {
+        foreach ($defaultWsdlOptions as $optioName => $optionValue) {
             if (array_key_exists($optioName, $options) && !empty($options[$optioName])) {
                 $wsdlOptions[str_replace(self::OPTION_PREFIX, '', $optioName)] = $options[$optioName];
             } elseif (!empty($optionValue)) {
@@ -292,8 +292,8 @@ public function setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false,
     {
         if (self::getSoapClient()) {
             $defaultHeaders = (isset(self::getSoapClient()->__default_headers) && is_array(self::getSoapClient()->__default_headers)) ? self::getSoapClient()->__default_headers : array();
-            foreach ($defaultHeaders as $index=>$soapheader) {
-                if ($soapheader->name === $name) {
+            foreach ($defaultHeaders as $index => $soapHeader) {
+                if ($soapHeader->name === $name) {
                     unset($defaultHeaders[$index]);
                     break;
                 }
@@ -319,6 +319,7 @@ public function setSoapHeader($nameSpace, $name, $data, $mustUnderstand = false,
      */
     public function setHttpHeader($headerName, $headerValue)
     {
+        $state = false;
         if (self::getSoapClient() && !empty($headerName)) {
             $streamContext = (isset(self::getSoapClient()->_stream_context) && is_resource(self::getSoapClient()->_stream_context)) ? self::getSoapClient()->_stream_context : null;
             if (!is_resource($streamContext)) {
@@ -327,17 +328,11 @@ public function setHttpHeader($headerName, $headerValue)
                 $options['http']['header'] = '';
             } else {
                 $options = stream_context_get_options($streamContext);
-                if (is_array($options)) {
-                    if (!array_key_exists('http', $options) || !is_array($options['http'])) {
-                        $options['http'] = array();
-                        $options['http']['header'] = '';
-                    } elseif (!array_key_exists('header', $options['http'])) {
-                        $options['http']['header'] = '';
-                    }
-                } else {
-                    $options = array();
+                if (!array_key_exists('http', $options) || !is_array($options['http'])) {
                     $options['http'] = array();
                     $options['http']['header'] = '';
+                } elseif (!array_key_exists('header', $options['http'])) {
+                    $options['http']['header'] = '';
                 }
             }
             if (count($options) && array_key_exists('http', $options) && is_array($options['http']) && array_key_exists('header', $options['http']) && is_string($options['http']['header'])) {
@@ -363,17 +358,16 @@ public function setHttpHeader($headerName, $headerValue)
                  * Create context if it does not exist
                  */
                 if (!is_resource($streamContext)) {
-                    return (self::getSoapClient()->_stream_context = stream_context_create($options)) ? true : false;
+                    $state = (self::getSoapClient()->_stream_context = stream_context_create($options)) ? true : false;
                 } else {
                     /**
                      * Set the new context http header option
                      */
-                    return stream_context_set_option(self::getSoapClient()->_stream_context, 'http', 'header', $options['http']['header']);
+                    $state = stream_context_set_option(self::getSoapClient()->_stream_context, 'http', 'header', $options['http']['header']);
                 }
             }
-            return false;
         }
-        return false;
+        return $state;
     }
     /**
      * Method returning last errors occured during the calls
diff --git a/tests/SoapClientTest.php b/tests/SoapClientTest.php
@@ -214,6 +214,143 @@ public function testSetHeaders()
             ),
         ), stream_context_get_options(SoapClient::getSoapClient()->_stream_context));
     }
+    /**
+     *
+     */
+    public function testSetHeadersOnExistingHeaders()
+    {
+        $soapClient = new SoapClient(array(
+                SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
+                SoapClient::WSDL_CLASSMAP => self::classMap(),
+        ));
+
+        $this->assertTrue($soapClient->setHttpHeader('X-Header-Name', 'X-Header-Value'));
+        $this->assertTrue($soapClient->setHttpHeader('X-Header-ID', 'X-Header-ID-Value'));
+
+        $this->assertTrue(is_resource(SoapClient::getSoapClient()->_stream_context));
+
+        $this->assertSame(array(
+            'http' => array(
+                'header' => 'X-Header-Name: X-Header-Value' . "\r\n" .
+                            'X-Header-ID: X-Header-ID-Value',
+            ),
+        ), stream_context_get_options(SoapClient::getSoapClient()->_stream_context));
+    }
+    /**
+     *
+     */
+    public function testSetHeadersOnExistingHttpsHeaders()
+    {
+        $streamContext = stream_context_create(array(
+            'https' => array(
+                'header' => array(
+                    'X-HEADER' => 'X-VALUE',
+                ),
+            ),
+        ));
+        $soapClient = new SoapClient(array(
+                SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
+                SoapClient::WSDL_CLASSMAP => self::classMap(),
+                SoapClient::WSDL_STREAM_CONTEXT => $streamContext,
+        ));
+
+        $this->assertTrue($soapClient->setHttpHeader('X-Header-Name', 'X-Header-Value'));
+        $this->assertTrue($soapClient->setHttpHeader('X-Header-ID', 'X-Header-ID-Value'));
+
+        $this->assertTrue(is_resource(SoapClient::getSoapClient()->_stream_context));
+
+        $this->assertSame(array(
+            'https' => array(
+                'header' => array(
+                    'X-HEADER' => 'X-VALUE',
+                ),
+            ),
+            'http' => array(
+                'header' => 'X-Header-Name: X-Header-Value' . "\r\n" .
+                            'X-Header-ID: X-Header-ID-Value',
+            ),
+        ), stream_context_get_options(SoapClient::getSoapClient()->_stream_context));
+    }
+    /**
+     *
+     */
+    public function testSetHeadersOnExistingHttpHeaders()
+    {
+        $streamContext = stream_context_create(array(
+            'http' => array(
+                'Auth' => array(
+                    'X-HEADER' => 'X-VALUE',
+                ),
+            ),
+        ));
+        $soapClient = new SoapClient(array(
+                SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
+                SoapClient::WSDL_CLASSMAP => self::classMap(),
+                SoapClient::WSDL_STREAM_CONTEXT => $streamContext,
+        ));
+
+        $this->assertTrue($soapClient->setHttpHeader('X-Header-Name', 'X-Header-Value'));
+        $this->assertTrue($soapClient->setHttpHeader('X-Header-ID', 'X-Header-ID-Value'));
+
+        $this->assertTrue(is_resource(SoapClient::getSoapClient()->_stream_context));
+
+        $this->assertSame(array(
+            'http' => array(
+                'Auth' => array(
+                    'X-HEADER' => 'X-VALUE',
+                ),
+                'header' => 'X-Header-Name: X-Header-Value' . "\r\n" .
+                            'X-Header-ID: X-Header-ID-Value',
+            ),
+        ), stream_context_get_options(SoapClient::getSoapClient()->_stream_context));
+    }
+    /**
+     *
+     */
+    public function testSetSoapHeader()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
+            SoapClient::WSDL_CLASSMAP => self::classMap(),
+        ));
+
+        $soapClient->setSoapHeader('urn:namespace', 'HeaderAuth', 'the-data', false, null);
+
+        $this->assertEquals(array(
+            new \SoapHeader('urn:namespace', 'HeaderAuth', 'the-data', false),
+        ), SoapClient::getSoapClient()->__default_headers);
+    }
+    /**
+     *
+     */
+    public function testSetSoapHeaderModified()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
+            SoapClient::WSDL_CLASSMAP => self::classMap(),
+        ));
+
+        $soapClient->setSoapHeader('urn:namespace', 'HeaderAuth', 'the-data', false, null);
+        $soapClient->setSoapHeader('urn:namespace', 'HeaderAuth', 'the-data-modified', false, null);
+
+        $this->assertEquals(new \SoapHeader('urn:namespace', 'HeaderAuth', 'the-data-modified', false), array_pop(SoapClient::getSoapClient()->__default_headers));
+    }
+    /**
+     *
+     */
+    public function testSetSoapActor()
+    {
+        $soapClient = new SoapClient(array(
+            SoapClient::WSDL_URL => __DIR__ . '/resources/bingsearch.wsdl',
+            SoapClient::WSDL_CLASSMAP => self::classMap(),
+        ));
+
+        $soapClient->setSoapHeader('urn:namespace', 'HeaderAuth', 'the-data', false, 'actor');
+
+        $this->assertEquals(array(
+            new \SoapHeader('urn:namespace', 'HeaderAuth', 'the-data', false, 'actor'),
+        ), SoapClient::getSoapClient()->__default_headers);
+    }
     /**
      * @return string[]
      */
