Merge branch '0.2'

src/BeSimple/SoapBundle/DependencyInjection/BeSimpleSoapExtension.php

@@ -98,6 +98,23 @@ class BeSimpleSoapExtension extends Extension
                 }
             }
 
+            $proxy = $options['proxy'];
+            if (false !== $proxy['host']) {
+                if (null !== $proxy['auth']) {
+                    if ('basic' === $proxy['auth']) {
+                        $proxy['auth'] = \CURLAUTH_BASIC;
+                    } elseif ('ntlm' === $proxy['auth']) {
+                        $proxy['auth'] = \CURLAUTH_NTLM;
+                    }
+                }
+
+                $definition->addMethodCall('withProxy', array(
+                    $proxy['host'], $proxy['port'],
+                    $proxy['login'], $proxy['password'],
+                    $proxy['auth']
+                ));
+            }
+
             if (isset($defOptions['cache_type'])) {
                 $defOptions['cache_type'] = $this->getCacheType($defOptions['cache_type']);
             }

src/BeSimple/SoapBundle/DependencyInjection/Configuration.php

@@ -24,6 +24,7 @@ use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 class Configuration
 {
     private $cacheTypes = array('none', 'disk', 'memory', 'disk_memory');
+    private $proxyAuth = array('basic', 'ntlm');
 
     /**
      * Generates the configuration tree.
@@ -85,12 +86,33 @@ class Configuration
                                 ->scalarNode('cache_type')
                                     ->validate()
                                         ->ifNotInArray($this->cacheTypes)
-                                        ->thenInvalid(sprintf('The cache type has to be either %s', implode(', ', $this->cacheTypes)))
+                                        ->thenInvalid(sprintf('The cache type has to be either: %s', implode(', ', $this->cacheTypes)))
                                     ->end()
                                 ->end()
                                 ->arrayNode('classmap')
                                     ->useAttributeAsKey('name')->prototype('scalar')->end()
                                 ->end()
+                                ->arrayNode('proxy')
+                                    ->info('proxy configuration')
+                                    ->addDefaultsIfNotSet()
+                                    ->beforeNormalization()
+                                        ->ifTrue(function ($v) { return !is_array($v); })
+                                        ->then(function ($v) { return array('host' => null === $v ? false : $v); })
+                                    ->end()
+                                    ->children()
+                                        ->scalarNode('host')->defaultFalse()->end()
+                                        ->scalarNode('port')->defaultValue(3128)->end()
+                                        ->scalarNode('login')->defaultNull()->end()
+                                        ->scalarNode('password')->defaultNull()->end()
+                                        ->scalarNode('auth')
+                                            ->defaultNull()
+                                            ->validate()
+                                                ->ifNotInArray($this->proxyAuth)
+                                                ->thenInvalid(sprintf('The proxy auth has to be either: %s', implode(', ', $this->proxyAuth)))
+                                            ->end()
+                                        ->end()
+                                    ->end()
+                                ->end()
                             ->end()
                         ->end()
                     ->end()

src/BeSimple/SoapBundle/Resources/doc/soapclient/configuration.rst

@@ -1,8 +1,8 @@
 Configuration
 =============
 
-Minimal client configuration
+Client configuration
-----------------------------
+--------------------
 
 Configure your first client in your config file:
 
@@ -12,8 +12,20 @@ Configure your first client in your config file:
     be_simple_soap:
         clients:
             DemoApi:
-                wsdl: http://localhost:8086/app_dev.php/ws/DemoApi?wsdl
+                # required
+                wsdl: http://localhost/app_dev.php/ws/DemoApi?wsdl
 
+                # classmap (optional)
+                classmap:
+                    type_name: "Full\Class\Name"
+
+                # proxy (optional)
+                proxy:
+                    host:     proxy.domain.name # required to enable proxy configuration
+                    port:     3128
+                    login:    ~
+                    password: ~
+                    auth:     ~ # can be 'basic' or 'ntlm'
 
 Using client
 ------------

src/BeSimple/SoapClient/Curl.php

@@ -80,6 +80,7 @@ class Curl
         if (isset($options['connection_timeout'])) {
             curl_setopt($this->ch, CURLOPT_CONNECTTIMEOUT, $options['connection_timeout']);
         }
+
         if (isset($options['proxy_host'])) {
             if (false !== $options['proxy_host']) {
                 $proxyHost = $options['proxy_host'].(isset($options['proxy_port']) ? $options['proxy_port'] : 8080);
@@ -88,10 +89,16 @@ class Curl
             }
 
             curl_setopt($this->ch, CURLOPT_PROXY, $proxyHost);
+
+            if (false !== $proxyHost && isset($options['proxy_login'])) {
+                curl_setopt($this->ch, CURLOPT_PROXYUSERPWD, $options['proxy_login'].':'.$options['proxy_password']);
+
+                if (isset($options['proxy_auth'])) {
+                    curl_setopt($this->ch, CURLOPT_PROXYAUTH, $options['proxy_auth']);
+                }
+            }
         }
-        if (isset($options['proxy_user'])) {
+
-            curl_setopt($this->ch, CURLOPT_PROXYUSERPWD, $options['proxy_user'] . ':' . $options['proxy_password']);
-        }
         if (isset($options['login'])) {
             curl_setopt($this->ch, CURLOPT_HTTPAUTH, isset($options['extra_options']['http_auth']) ? $options['extra_options']['http_auth'] : CURLAUTH_ANY);
             curl_setopt($this->ch, CURLOPT_USERPWD, $options['login'].':'.$options['password']);

src/BeSimple/SoapClient/SoapClientBuilder.php

@@ -175,19 +175,28 @@ class SoapClientBuilder extends AbstractSoapBuilder
      *
      * @param string $host     Host
      * @param int    $port     Port
-     * @param string $username Username
+     * @param string $login    Login
      * @param string $password Password
+     * @param int    $auth     Authentication method
      *
      * @return \BeSimple\SoapClient\SoapClientBuilder
      */
-    public function withProxy($host, $port, $username = null, $password = null)
+    public function withProxy($host, $port, $login = null, $password = null, $auth = null)
     {
         $this->soapOptions['proxy_host'] = $host;
         $this->soapOptions['proxy_port'] = $port;
 
-        if ($username) {
+        if ($login) {
-            $this->soapOptions['proxy_login']    = $username;
+            $this->soapOptions['proxy_login'] = $login;
             $this->soapOptions['proxy_password'] = $password;
+
+            if ($auth) {
+                if (!in_array($auth, array(\CURLAUTH_BASIC, \CURLAUTH_NTLM), true)) {
+                    throw new \InvalidArgumentException('Invalid authentication method: CURLAUTH_BASIC or CURLAUTH_NTLM constants are availables.');
+                }
+
+                $this->soapOptions['proxy_auth'] = $auth;
+            }
         }
 
         return $this;

src/BeSimple/SoapClient/Tests/AxisInterop/MtomAxisInteropTest.php

@@ -28,6 +28,7 @@ class MtomAxisInteropTest extends TestCase
             'base64Binary'      => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\base64Binary',
             'AttachmentRequest' => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\AttachmentRequest',
         ),
+        'proxy_host' => false,
     );
 
     public function testAttachment()

src/BeSimple/SoapClient/Tests/AxisInterop/SwaAxisInteropTest.php

@@ -37,6 +37,7 @@ class SwaAxisInteropTest extends TestCase
             'uploadFile'           => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\uploadFile',
             'uploadFileResponse'   => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\uploadFileResponse',
         ),
+        'proxy_host' => false,
     );
 
     public function testUploadDownloadText()

src/BeSimple/SoapClient/Tests/AxisInterop/WsAddressingAxisInteropTest.php

@@ -32,6 +32,7 @@ class WsAddressingAxisInteropTest extends TestCase
     private $options = array(
         'soap_version' => SOAP_1_2,
         'features'     => SOAP_SINGLE_ELEMENT_ARRAYS, // make sure that result is array for size=1
+        'proxy_host' => false,
     );
 
     public function testSession()

src/BeSimple/SoapClient/Tests/AxisInterop/WsSecuritySigEncAxisInteropTest.php

@@ -64,6 +64,7 @@ class WsSecuritySigEncAxisInteropTest extends TestCase
             'addBookResponse'        => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\addBookResponse',
             'BookInformation'        => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\BookInformation',
         ),
+        'proxy_host' => false,
     );
 
     public function testSigEnc()

src/BeSimple/SoapClient/Tests/AxisInterop/WsSecurityUserPassAxisInteropTest.php

@@ -40,6 +40,7 @@ class WsSecurityUserPassAxisInteropTest extends TestCase
             'addBookResponse'        => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\addBookResponse',
             'BookInformation'        => 'BeSimple\SoapClient\Tests\AxisInterop\Fixtures\BookInformation',
         ),
+        'proxy_host' => false,
     );
 
     public function testUserPassText()

src/BeSimple/SoapClient/Tests/CurlTest.php

@@ -74,7 +74,9 @@ class CurlTest extends AbstractWebserverTest
 
     public function testGetResponseBody()
     {
-        $curl = new Curl();
+        $curl = new Curl(array(
+            'proxy_host' => false,
+        ));
 
         $curl->exec(sprintf('http://localhost:%d/curl.txt', WEBSERVER_PORT));
         $this->assertEquals('This is a testfile for cURL.', $curl->getResponseBody());
@@ -82,7 +84,9 @@ class CurlTest extends AbstractWebserverTest
 
     public function testGetResponseContentType()
     {
-        $curl = new Curl();
+        $curl = new Curl(array(
+            'proxy_host' => false,
+        ));
 
         $curl->exec(sprintf('http://localhost:%d/curl.txt', WEBSERVER_PORT));
         $this->assertEquals('text/plain; charset=UTF-8', $curl->getResponseContentType());
@@ -93,7 +97,9 @@ class CurlTest extends AbstractWebserverTest
 
     public function testGetResponseHeaders()
     {
-        $curl = new Curl();
+        $curl = new Curl(array(
+            'proxy_host' => false,
+        ));
 
         $curl->exec(sprintf('http://localhost:%d/curl.txt', WEBSERVER_PORT));
         $this->assertEquals(117 + self::$websererPortLength, strlen($curl->getResponseHeaders()));
@@ -104,7 +110,9 @@ class CurlTest extends AbstractWebserverTest
 
     public function testGetResponseStatusCode()
     {
-        $curl = new Curl();
+        $curl = new Curl(array(
+            'proxy_host' => false,
+        ));
 
         $curl->exec(sprintf('http://localhost:%d/curl.txt', WEBSERVER_PORT));
         $this->assertEquals(200, $curl->getResponseStatusCode());

src/BeSimple/SoapClient/Tests/ServerInterop/MtomServerInteropTest.php

@@ -20,6 +20,7 @@ class MtomServerInteropTest extends TestCase
             'base64Binary'      => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\base64Binary',
             'AttachmentRequest' => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\AttachmentRequest',
         ),
+        'proxy_host' => false,
     );
 
     public function testAttachment()

src/BeSimple/SoapClient/Tests/ServerInterop/SwaServerInteropTest.php

@@ -23,6 +23,7 @@ class SwaServerInteropTest extends TestCase
             'uploadFile'           => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\uploadFile',
             'uploadFileResponse'   => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\uploadFileResponse',
         ),
+        'proxy_host' => false,
     );
 
     public function testUploadDownloadText()

src/BeSimple/SoapClient/Tests/ServerInterop/WsSecuritySigEncServerInteropTest.php

@@ -30,6 +30,7 @@ class WsSecuritySigEncServerInteropTest extends TestCase
             'addBookResponse'        => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\addBookResponse',
             'BookInformation'        => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\BookInformation',
         ),
+        'proxy_host' => false,
     );
 
     public function testSigEnc()

src/BeSimple/SoapClient/Tests/ServerInterop/WsSecurityUserPassServerInteropTest.php

@@ -29,6 +29,7 @@ class WsSecurityUserPassServerInteropTest extends TestCase
             'addBookResponse'        => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\addBookResponse',
             'BookInformation'        => 'BeSimple\SoapClient\Tests\ServerInterop\Fixtures\BookInformation',
         ),
+        'proxy_host' => false,
     );
 
     public function testUserPassText()

src/BeSimple/SoapClient/Tests/SoapClientBuilderTest.php

@@ -96,6 +96,20 @@ class SoapClientBuilderTest extends \PHPUnit_Framework_TestCase
 
         $builder->withProxy('127.0.0.1', 8585, 'foo', 'bar');
         $this->assertEquals($this->mergeOptions(array('proxy_host' => '127.0.0.1', 'proxy_port' => 8585, 'proxy_login' => 'foo', 'proxy_password' => 'bar')), $builder->getSoapOptions());
+
+        $builder->withProxy('127.0.0.1', 8585, 'foo', 'bar', \CURLAUTH_BASIC);
+        $this->assertEquals($this->mergeOptions(array('proxy_host' => '127.0.0.1', 'proxy_port' => 8585, 'proxy_login' => 'foo', 'proxy_password' => 'bar', 'proxy_auth' => \CURLAUTH_BASIC)), $builder->getSoapOptions());
+
+        $builder->withProxy('127.0.0.1', 8585, 'foo', 'bar', \CURLAUTH_NTLM);
+        $this->assertEquals($this->mergeOptions(array('proxy_host' => '127.0.0.1', 'proxy_port' => 8585, 'proxy_login' => 'foo', 'proxy_password' => 'bar', 'proxy_auth' => \CURLAUTH_NTLM)), $builder->getSoapOptions());
+
+        try {
+            $builder->withProxy('127.0.0.1', 8585, 'foo', 'bar', -100);
+
+            $this->fail('An expected exception has not been raised.');
+        } catch (\Exception $e) {
+            $this->assertInstanceOf('InvalidArgumentException', $e);
+        }
     }
 
     public function testCreateWithDefaults()

src/BeSimple/SoapClient/Tests/WsdlDownloaderTest.php

@@ -115,7 +115,9 @@ class WsdlDownloaderTest extends AbstractWebserverTest
         Cache::setDirectory($wsdlCacheUrl);
         $cacheDirForRegExp = preg_quote($wsdlCacheUrl, '#');
 
-        $wsdlDownloader = new WsdlDownloader(new Curl());
+        $wsdlDownloader = new WsdlDownloader(new Curl(array(
+            'proxy_host' => false,
+        )));
         $r = new \ReflectionClass($wsdlDownloader);
         $m = $r->getMethod('resolveRemoteIncludes');
         $m->setAccessible(true);
@@ -178,7 +180,9 @@ class WsdlDownloaderTest extends AbstractWebserverTest
         Cache::setDirectory($wsdlCacheUrl);
         $cacheDirForRegExp = preg_quote($wsdlCacheUrl, '#');
 
-        $wsdlDownloader = new WsdlDownloader(new Curl());
+        $wsdlDownloader = new WsdlDownloader(new Curl(array(
+            'proxy_host' => false,
+        )));
         $r = new \ReflectionClass($wsdlDownloader);
         $m = $r->getMethod('resolveRemoteIncludes');
         $m->setAccessible(true);