Merge pull request #20 from pimlie/master

Added tests, removed html output when in console, added env variables for configuration and refactored library code

Author: Silentscripter

composer.json

@@ -13,6 +13,11 @@
       "Protechstudio\\PrestashopWebService\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Protechstudio\\PrestashopWebService\\Tests\\": "tests/"
+    }
+  },
   "extra": {
     "laravel": {
         "providers": [
@@ -22,6 +27,13 @@
             "Prestashop": "Protechstudio\\PrestashopWebService\\PrestashopWebServiceFacade"
         }
     }
-}
-  
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "^3.2",
+    "Orchestra/Testbench": "^3.5"
+  },
+  "scripts": {
+    "test": "vendor/bin/phpunit",
+    "cs": "vendor/bin/phpcs src/*"
+  }
 }

phpcs.xml.dist

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="LaravelPrestashopWebservice">
+
+    <description>A basic coding standard.</description>
+
+    <exclude-pattern>vendor/*</exclude-pattern>
+
+    <rule ref="PSR1" />
+    <rule ref="PSR2" />
+
+</ruleset>

phpunit.xml renamed to phpunit.xml.dist

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit backupGlobals="false"
          backupStaticAttributes="false"
-         bootstrap="../../../bootstrap/autoload.php"
+         bootstrap="vendor/autoload.php"
          colors="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
@@ -18,6 +18,9 @@
         <whitelist>
             <directory suffix=".php">app/</directory>
         </whitelist>
+        <blacklist>
+            <directory suffix=".php">./vendor</directory>
+        </blacklist>
     </filter>
     <php>
         <env name="APP_ENV" value="testing"/>

src/Exceptions/PrestashopWebServiceException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Protechstudio\PrestashopWebService\Exceptions;
+
+use Protechstudio\PrestashopWebService\PrestaShopWebserviceException as PSWException;
+
+class PrestashopWebServiceException extends PSWException
+{
+
+}

src/Exceptions/PrestashopWebServiceRequestException.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Protechstudio\PrestashopWebService\Exceptions;
+
+class PrestashopWebServiceRequestException extends PrestashopWebServiceException
+{
+    static protected $label = 'This call to PrestaShop Web Services failed and returned an HTTP status of %d. That means: %s.';
+
+    protected $response;
+
+    public function __construct($message = null, $code = null, $response = null)
+    {
+        parent::__construct(sprintf(static::$label, $code, $message), $code);
+
+        $this->response = $response;
+    }
+
+    public function hasResponse()
+    {
+        return isset($this->response) && !empty($this->response);
+    }
+
+    public function getResponse()
+    {
+        return $this->response;
+    }
+}

src/PrestaShopWebserviceException.php

@@ -5,4 +5,4 @@
 class PrestaShopWebserviceException extends \Exception
 {
 
-}
+}

src/PrestashopWebService.php

@@ -15,31 +15,36 @@ class PrestashopWebService extends PrestashopWebServiceLibrary
      * @return SimpleXMLElement
      * @throws PrestaShopWebserviceException
      */
-    public function getSchema($resource , $schema = 'blank')
+    public function getSchema($resource, $schema = 'blank')
     {
         return $this->get(['resource' => $resource . "?schema=$schema"]);
     }
 
     /**
-     * Fill the provided schema with an associative array data, also remove the useless XML nodes if the corresponding flag is true
+     * Fill the provided schema with an associative array data, also remove the useless XML nodes if
+     * the corresponding flag is true
      *
      * @param SimpleXMLElement $xmlSchema
      * @param array $data
      * @param bool $removeUselessNodes set true if you want to remove nodes that are not present in the data array
-     * @param array $removeSpecificNodes If $removeUselessNodes is false you may add here the first level nodes that you want to remove
+     * @param array $removeSpecificNodes If $removeUselessNodes is false you may add here the first level nodes that
+     *                                   you want to remove
      * @return SimpleXMLElement
      */
-    public function fillSchema(SimpleXMLElement $xmlSchema, $data, $removeUselessNodes = true, $removeSpecificNodes=array())
-    {
+    public function fillSchema(
+        SimpleXMLElement $xmlSchema,
+        $data,
+        $removeUselessNodes = true,
+        $removeSpecificNodes = array()
+    ) {
         $resource = $xmlSchema->children()->children();
         foreach ($data as $key => $value) {
             $this->processNode($resource, $key, $value);
         }
         if ($removeUselessNodes) {
             $this->checkForUselessNodes($resource, $data);
-        }
-        else{
-            $this->removeSpecificNodes($resource,$removeSpecificNodes);
+        } else {
+            $this->removeSpecificNodes($resource, $removeSpecificNodes);
         }
         return $xmlSchema;
     }
@@ -80,13 +85,12 @@ private function fillLanguageNode($node, $data)
      */
     private function processNode(SimpleXMLElement $node, $dataKey, $dataValue)
     {
-        if(is_int($dataKey)){
-            if($dataKey===0){
+        if (is_int($dataKey)) {
+            if ($dataKey===0) {
                 $this->emptyNode($node);
             }
-            $this->createNode($node,$dataValue);
-        }
-        elseif (property_exists($node->$dataKey, 'language')) {
+            $this->createNode($node, $dataValue);
+        } elseif (property_exists($node->$dataKey, 'language')) {
             $this->fillLanguageNode($node->$dataKey, $dataValue);
         } elseif (is_array($dataValue)) {
             foreach ($dataValue as $key => $value) {
@@ -134,17 +138,15 @@ private function removeSpecificNodes($resource, $removeSpecificNodes)
     private function createNode(SimpleXMLElement $node, $dataValue)
     {
         foreach ($dataValue as $key => $value) {
-            if(is_array($value)){
-                if(is_int($key)){
-                    $this->createNode($node,$value);
-                }
-                else{
+            if (is_array($value)) {
+                if (is_int($key)) {
+                    $this->createNode($node, $value);
+                } else {
                     $childNode=$node->addChild($key);
-                    $this->createNode($childNode,$value);
+                    $this->createNode($childNode, $value);
                 }
-            }
-            else{
-                $node->addChild($key,$value);
+            } else {
+                $node->addChild($key, $value);
             }
         }
     }
@@ -162,4 +164,4 @@ private function emptyNode(SimpleXMLElement $node)
             unset($node->$nodeName);
         }
     }
-}
+}

src/PrestashopWebServiceFacade.php

@@ -2,7 +2,6 @@
 
 namespace Protechstudio\PrestashopWebService;
 
-
 use Illuminate\Support\Facades\Facade;
 
 class PrestashopWebServiceFacade extends Facade
@@ -12,5 +11,4 @@ protected static function getFacadeAccessor()
     {
         return PrestashopWebService::class;
     }
-
-}
+}