Merge pull request #18 from meng-tian/fix-tests

Fix unit tests

Author: meng-tian

.github/workflows/main.yaml

@@ -0,0 +1,39 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ['5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4']
+    
+    runs-on: ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+      
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+      
+      - name: Cache composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+      
+      - name: Install Composer dependencies
+        run: |
+          composer install --no-progress --prefer-dist --optimize-autoloader
+      
+      - name: Run Tests
+        run: vendor/bin/phpunit --coverage-text

README.md

@@ -1,8 +1,8 @@
-# PHP SOAP Interpreter [![Build Status](https://travis-ci.org/meng-tian/php-soap-interpreter.svg?branch=master)](https://travis-ci.org/meng-tian/php-soap-interpreter) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/meng-tian/php-soap-interpreter/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/meng-tian/php-soap-interpreter/?branch=master) [![codecov.io](https://codecov.io/github/meng-tian/php-soap-interpreter/coverage.svg?branch=master)](https://codecov.io/github/meng-tian/php-soap-interpreter?branch=master)
+# PHP SOAP Interpreter [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/meng-tian/php-soap-interpreter/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/meng-tian/php-soap-interpreter/?branch=master) [![codecov.io](https://codecov.io/github/meng-tian/php-soap-interpreter/coverage.svg?branch=master)](https://codecov.io/github/meng-tian/php-soap-interpreter?branch=master)
 
 A PHP library for interpreting `SOAP 1.1` and `SOAP 1.2` messages. It can be used in WSDL or non-WSDL mode. The implementation is built on the top of PHP's [SoapClient](http://php.net/manual/en/class.soapclient.php).
 
-### Requirement 
+### Prerequisite
 PHP 5.4 --enablelibxml --enable-soap
 
 ### Install
@@ -11,11 +11,11 @@ composer require meng-tian/php-soap-interpreter
 ```
 
 ### Usage
-An `Interpreter` instance is capable of generating SOAP request messages and translating SOAP response messages. Constructor of `Interpreter` class is the same as `SoapClient`. The first parameter is `wsdl`, the second parameter is an array of `options`. 
+An `Interpreter` is responsible for generating SOAP request messages and translating SOAP response messages. The constructor of `Interpreter` class is the same as `SoapClient`. The first parameter is `wsdl`, the second parameter is an array of `options`.
 
-It should be noted that *not* all `options` supported by `SoapClient` are supported by `Interpreter`. The responsibility of `Interpreter` is to interpreting SOAP messages, whereas the unsupported options are related to debugging or HTTP transportation. The supported `options` by `Interpreter` are: `location`, `uri`, `style`, `use`, `soap_version`, `encoding`, `exceptions`, `classmap`, `typemap`, `cache_wsdl` and `feature`. More detailed explanations of those options can be found in [SoapClient::SoapClient](http://php.net/manual/en/soapclient.soapclient.php).
+It should be noted that *not* all `options` supported by `SoapClient` are supported by `Interpreter`. The supported `options` of `Interpreter` are: `location`, `uri`, `style`, `use`, `soap_version`, `encoding`, `exceptions`, `classmap`, `typemap`, `cache_wsdl` and `features`. More detailed explanations of those options can be found in [SoapClient::SoapClient](http://php.net/manual/en/soapclient.soapclient.php). The unsupported options are related to debugging or HTTP transport, which are not the intended responsibility of `Interpreter`.
 
-### Examples
+### Basic Examples
 ###### Generate SOAP request message in WSDL mode
 
 ```php
@@ -35,6 +35,36 @@ Output:
 </SOAP-ENV:Envelope>
 ```
 
+###### Translate SOAP response message
+
+```php
+$interpreter = new Interpreter('http://www.webservicex.net/length.asmx?WSDL');
+$response = <<<EOD
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    <soap:Body>
+        <ChangeLengthUnitResponse xmlns="http://www.webserviceX.NET/">
+            <ChangeLengthUnitResult>0.025400000000000002</ChangeLengthUnitResult>
+        </ChangeLengthUnitResponse>
+    </soap:Body>
+</soap:Envelope>
+EOD;
+$response = $interpreter->response($response, 'ChangeLengthUnit');
+
+print_r($response);
+```
+Output:
+```php
+/*
+Output:
+stdClass Object
+(
+    [ChangeLengthUnitResult] => 0.0254
+)
+*/
+```
+
+### Advanced Examples
 ###### Generate SOAP request message in non-WSDL mode
 
 ```php
@@ -61,41 +91,36 @@ Output:
 
 ```
 
-###### Translate SOAP response message
 
-```php
-$interpreter = new Interpreter('http://www.webservicex.net/length.asmx?WSDL');
-$response = <<<EOD
-<?xml version="1.0" encoding="utf-8"?>
-<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
-    <soap:Body>
-        <ChangeLengthUnitResponse xmlns="http://www.webserviceX.NET/">
-            <ChangeLengthUnitResult>0.025400000000000002</ChangeLengthUnitResult>
-        </ChangeLengthUnitResponse>
-    </soap:Body>
-</soap:Envelope>
-EOD;
-$response = $interpreter->response($response, 'ChangeLengthUnit');
+###### SOAP input headers
 
-print_r($response);
-```
-Output:
 ```php
-/*
+$interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL');
+$request = $interpreter->request('ConversionRate', [['FromCurrency' => 'AFA', 'ToCurrency' => 'ALL']], null, [new SoapHeader('www.namespace.com', 'test_header', 'header_data')]);
+print_r($request->getSoapMessage());
+```
 Output:
-stdClass Object
-(
-    [ChangeLengthUnitResult] => 0.0254
-)
-*/
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.webserviceX.NET/" xmlns:ns2="www.namespace.com">
+<SOAP-ENV:Header><ns2:test_header>header_data</ns2:test_header></SOAP-ENV:Header>
+<SOAP-ENV:Body><ns1:ConversionRate><ns1:FromCurrency>AFA</ns1:FromCurrency><ns1:ToCurrency>ALL</ns1:ToCurrency></ns1:ConversionRate></SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
 ```
+
+###### SOAP output headers
+TODO
+
+###### Class map
+TODO
+
+###### Type map
+TODO
+
 ### Relevant
 - [SOAP HTTP Binding](https://github.com/meng-tian/soap-http-binding): binding SOAP messages to PSR-7 HTTP messages.
 - [PHP Asynchronous SOAP](https://github.com/meng-tian/php-async-soap): asynchronous SOAP clients.
 
-### Credits
-Thanks the free SOAP web serivices hosted from http://www.webservicex.net. They are used for testing this library.
-
 ### License
 This library is released under [MIT](https://github.com/meng-tian/php-soap-interpreter/blob/master/LICENSE.md) license.
 

src/Interpreter.php

@@ -10,7 +10,7 @@ class Interpreter
     /**
      * @param mixed  $wsdl              URI of the WSDL file or NULL if working in non-WSDL mode.
      * @param array  $options           Supported options: location, uri, style, use, soap_version, encoding,
-     *                                  exceptions, classmap, typemap, cache_wsdl and feature.
+     *                                  exceptions, classmap, typemap, cache_wsdl and features.
      */
     public function __construct($wsdl, array $options = [])
     {

tests/InterpreterTest.php

@@ -10,7 +10,7 @@ class InterpreterTest extends PHPUnit_Framework_TestCase
      */
     public function requestWsdlArrayArguments()
     {
-        $interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL');
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl');
         $request = $interpreter->request('ConversionRate', [['FromCurrency' => 'AFA', 'ToCurrency' => 'ALL']]);
         $this->assertEquals('http://www.webservicex.net/CurrencyConvertor.asmx', $request->getEndpoint());
         $this->assertEquals('http://www.webserviceX.NET/ConversionRate', $request->getSoapAction());
@@ -29,7 +29,7 @@ public function requestWsdlArrayArguments()
      */
     public function requestWsdlObjectArguments()
     {
-        $interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL');
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl');
         $rate = new ConversionRate;
         $rate->FromCurrency = 'AFA';
         $rate->ToCurrency = 'ALL';
@@ -51,7 +51,7 @@ public function requestWsdlObjectArguments()
      */
     public function requestWsdlInputHeaders()
     {
-        $interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL');
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl');
         $request = $interpreter->request(
             'ConversionRate',
             [['FromCurrency' => 'AFA', 'ToCurrency' => 'ALL']],
@@ -79,7 +79,7 @@ public function requestWsdlInputHeaders()
     public function requestTypeMapToXML()
     {
         $interpreter = new Interpreter(
-            'http://www.webservicex.net/CurrencyConvertor.asmx?WSDL',
+            dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl',
             [
                 'typemap' => [
                     [
@@ -121,7 +121,7 @@ public function responseWsdl()
   </soap:Body>
 </soap:Envelope>
 EOD;
-        $interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL');
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl');
         $responseMessage = $interpreter->response($responseMessage, 'ConversionRate');
         $this->assertInstanceOf('\StdClass', $responseMessage);
         $this->assertEquals(['ConversionRateResult' => '-1'], (array)$responseMessage);
@@ -147,7 +147,7 @@ public function responseWsdlOutputHeaders()
   </soap:Body>
 </soap:Envelope>
 EOD;
-        $interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL');
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl');
         $outputHeaders = [];
         $responseMessage = $interpreter->response($responseMessage, 'ConversionRate', $outputHeaders);
         $this->assertInstanceOf('\StdClass', $responseMessage);
@@ -170,7 +170,7 @@ public function responseWsdlClassMap()
   </soap:Body>
 </soap:Envelope>
 EOD;
-        $interpreter = new Interpreter('http://www.webservicex.net/CurrencyConvertor.asmx?WSDL', ['classmap' => ['ConversionRateResponse' => '\ConversionRateResponse']]);
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl', ['classmap' => ['ConversionRateResponse' => '\ConversionRateResponse']]);
         $responseMessage = $interpreter->response($responseMessage, 'ConversionRate');
         $this->assertInstanceOf('\ConversionRateResponse', $responseMessage);
         $this->assertEquals(['ConversionRateResult' => '-1'], (array)$responseMessage);
@@ -192,7 +192,7 @@ public function responseTypeMapFromXML()
 </soap:Envelope>
 EOD;
         $interpreter = new Interpreter(
-            'http://www.webservicex.net/CurrencyConvertor.asmx?WSDL',
+            dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'currency.wsdl',
             [
                 'typemap' => [
                     [
@@ -249,7 +249,7 @@ public function responseWsdlDisableExceptions()
      */
     public function requestWsdlSoapV12()
     {
-        $interpreter = new Interpreter('http://www.webservicex.net/airport.asmx?WSDL', ['soap_version' => SOAP_1_2]);
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'airport.wsdl', ['soap_version' => SOAP_1_2]);
         $request = $interpreter->request('GetAirportInformationByCountry', [['country' => 'United Kingdom']]);
         $this->assertEquals('http://www.webservicex.net/airport.asmx', $request->getEndpoint());
         $this->assertEquals('http://www.webserviceX.NET/GetAirportInformationByCountry', $request->getSoapAction());
@@ -275,7 +275,7 @@ public function responseWsdlSoapV12()
     </soap:Body>
 </soap:Envelope>
 EOD;
-        $interpreter = new Interpreter('http://www.webservicex.net/airport.asmx?WSDL', ['soap_version' => SOAP_1_2]);
+        $interpreter = new Interpreter(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'wsdl' . DIRECTORY_SEPARATOR . 'airport.wsdl', ['soap_version' => SOAP_1_2]);
         $responseMessage = $interpreter->response($responseMessage, 'GetAirportInformationByCountry');
         $this->assertEquals(['GetAirportInformationByCountryResult' => '<NewDataSet />'], (array)$responseMessage);
     }