Added PhpDocumentor support + Separated configuration information management, decoupling it from library + Fixed some minor fixes (NEXWAY-1)

Author: shehi

.gitignore

@@ -4,3 +4,4 @@
 _ide_helper.php
 composer.lock
 vendor
+output

composer.json

@@ -21,7 +21,8 @@
 		"zendframework/zend-soap": "2.3.*"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "4.1.*"
+		"phpunit/phpunit": "4.1.*",
+		"phpdocumentor/phpdocumentor": "2.*"
 	},
 	"config": {
 		"preferred-install": "dist"

src/Audith/Providers/Nexway.php

@@ -6,6 +6,15 @@
  */
 class Nexway
 {
+    private $config = array();
+
+
+    public function __construct($config)
+    {
+        $this->config = $config;
+    }
+
+
     /**
      * Wrapper to process Nexway API Methods (single-run version)
      *
@@ -55,7 +64,7 @@ public function run(Nexway\Data\Request $data)
 
     private function exceptionHandler($msg, $code, $responseObject)
     {
-        $_globalExceptionMappings = \Audith\Providers\Nexway\Exception::$exceptionCodeMapping;
+        $_globalExceptionMappings = Nexway\Exception::$exceptionCodeMapping;
 
         $_responseObjectNamespace = '\\' . get_class($responseObject);
         $_localExceptionMappings  = $_responseObjectNamespace::$exceptionCodeMapping;
@@ -78,20 +87,18 @@ private function exceptionHandler($msg, $code, $responseObject)
      */
     private function sendRequest(Nexway\Data\Request $data)
     {
-        $_config = \Audith\Providers\Nexway\Data::getConfig("Nexway");
-
         $_wsdlHttpBinding = "";
         $_wsdlServiceName = "";
-        if ($data->request instanceof \Audith\Providers\Nexway\Data\Request\CatalogApi) {
+        if ($data->request instanceof Nexway\Data\Request\CatalogApi) {
             $_wsdlServiceName = "CatalogApi";
-        } elseif ($data->request instanceof \Audith\Providers\Nexway\Data\Request\OrderApi) {
+        } elseif ($data->request instanceof Nexway\Data\Request\OrderApi) {
             $_wsdlServiceName = "OrderApi";
-        } elseif ($data->request instanceof \Audith\Providers\Nexway\Data\Request\CustomerApi) {
+        } elseif ($data->request instanceof Nexway\Data\Request\CustomerApi) {
             $_wsdlServiceName = "CustomerApi";
         }
 
-        if (isset($_config['service']['nexway']['url'][lcfirst($_wsdlServiceName)])) {
-            $_wsdlHttpBinding = $_config['service']['nexway']['url'][lcfirst($_wsdlServiceName)];
+        if (isset($this->config['service']['nexway']['url'][lcfirst($_wsdlServiceName)])) {
+            $_wsdlHttpBinding = $this->config['service']['nexway']['url'][lcfirst($_wsdlServiceName)];
         }
 
         $client = new \Zend\Soap\Client();

src/Audith/Providers/Nexway/Data.php

@@ -36,34 +36,6 @@ abstract class Data
     );
 
 
-    /**
-     * Returns contents of config.ini file for working environment
-     *
-     * @param  string $providerName
-     *
-     * @return array
-     * @throws \Audith\Providers\Nexway\Exception\ConfigFileNotReadableException
-     */
-    public static function getConfig($providerName)
-    {
-        $_environment = "development";
-
-        if (isset($_ENV['APPLICATION_ENV']) and !empty($_ENV['APPLICATION_ENV'])) {
-            $_environment = $_ENV['APPLICATION_ENV'];
-        }
-
-        $_zendConfigReader   = new \Zend\Config\Reader\Ini();
-        $_configFileLocation = dirname(dirname(__FILE__)) . "/" . ucfirst($providerName) . "/config.ini";
-        try {
-            $_configInformationFromIniFile = $_zendConfigReader->fromFile($_configFileLocation);
-        } catch (\Zend\Config\Exception\RuntimeException $e) {
-            throw new \Audith\Providers\Nexway\Exception\ConfigFileNotReadableException("Error reading INI file at location " . $_configFileLocation);
-        }
-
-        return $_configInformationFromIniFile[$_environment];
-    }
-
-
     /**
      * Maps PHP-DOMNode to Provider Response Object
      *

src/Audith/Providers/Nexway/Data/Request.php

@@ -1,38 +1,33 @@
 <?php
 namespace Audith\Providers\Nexway\Data;
 
-use \Audith\Providers\Nexway\Data;
-
 /**
  * @author    Shahriyar Imanov <[email protected]>
  */
 class Request extends \Audith\Providers\Nexway\Data
 {
-    const SALES_TERRITORY_EU = "EU";
+    const SALES_TERRITORY_EU = "eu";
 
-    const SALES_TERRITORY_UK = "UK";
+    const SALES_TERRITORY_UK = "uk";
 
-    const SALES_TERRITORY_US = "US";
+    const SALES_TERRITORY_US = "us";
 
     /**
      * @var string
      */
     public $secret;
 
     /**
-     * @var Data
+     * @var \Audith\Providers\Nexway\Data
      */
     public $request;
 
 
     /**
      * Creates Request struct for any operation
      */
-    public function __construct(Data $data, $salesTerritory = self::SALES_TERRITORY_EU)
+    public function __construct(\Audith\Providers\Nexway\Data $data)
     {
-        $config = \Audith\Providers\Nexway\Data::getConfig("Nexway");
-
-        $this->secret  = $config['service']['nexway']['secret'][strtolower($salesTerritory)];
         $this->request = $data;
 
         return $this;

src/Audith/Providers/Nexway/Data/Response/CatalogApi/getCategories/subcategory.php

@@ -11,7 +11,6 @@ class subcategory extends \Audith\Providers\Nexway\Data
      */
     public $id;
 
-
     /**
      * @var string
      */

src/Audith/Providers/Nexway/Data/Response/CustomerApi.php

@@ -4,6 +4,6 @@
 /**
  * @author Shahriyar Imanov <[email protected]>
  */
-class CustomerApi extends \Audith\Providers\Nexway\Data
+class CustomerApi extends \Audith\Providers\Nexway\Data\Response
 {
 }

src/Audith/Providers/Nexway/Data/Response/OrderApi/updateDownloadTime.php

@@ -29,11 +29,6 @@ class updateDownloadTime extends \Audith\Providers\Nexway\Data\Response\OrderApi
      */
     public $newDownloadEndDate;
 
-    /**
-     * @var getDownloadInfo\orderLines[]
-     */
-    public $orderLines = array();
-
     /**
      * @var integer
      */

src/Audith/Providers/Nexway/Exception.php

@@ -8,8 +8,8 @@
 class Exception extends \Exception
 {
     public static $exceptionCodeMapping = array(
-        70   => "SecretIsMissingException",
-        71   => "SecretNotValidException"
+        70 => "SecretIsMissingException",
+        71 => "SecretNotValidException"
     );