Next steps to version 1 (#176)

* Complete Redesign

* Add examples.

* Next step to stable version

* Update README and composer.

* Write tests, move autoloiad correct.

Author: panvid

.gitignore

@@ -1,5 +1,5 @@
 index.php
-tools
-logs
 config.json
-.idea
+.idea
+composer.lock
+vendor

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.4.0
+- Complete ReDesign.
+
 # 0.2.0 (15.08.2016)
 
 ## Enhancements
@@ -11,7 +14,7 @@
 
 ## Bugfixes
 - #122 Move InformationTrait file.
-- #143 Delete InputValidator::isRESTCommand function.
+- #143 Delete ::isRESTCommand function.
 - #156 Fix using other shop locale.
 
 ## Features

README.md

@@ -2,61 +2,44 @@
 
 This is the PHP REST SDK to easily connect to an ePages shop.
 You can use it as a developer to develop apps for ePages.
-Just sign up for the [ePages Developer Program](http://www.epages.cloud/developer/) and create a free developer test shop.
+Just sign up for the [ePages Developer Program](https://developer.epages.com/) and create a free developer test shop.
 
 ## Requirements
 
 To use this SDK, you'll need:
 
-* at least **PHP 5.5**
+* at least **PHP 7.0**
 
 All dependencies comes automatically with the client and could be updated via composer.
 
-## Installation
+## Installation via composer
 
-### Via composer
-Its recommended to get the client via **Composer**.
+Its easy to get the client via **Composer**.
 Just search for [epages/rest-sdk](https://packagist.org/packages/epages/rest-sdk) and put this to you composer.yml file:
 
 ```php
 {
    "require": {
-      "php": ">=5.4.0",
       "epages/rest-sdk": ">=0.2"
     }
 }
 ```
 
-### Direct download
-To use the client directly without getting composer just download the **.phar** archive and include it.
-
-```
-wget https://raw.githubusercontent.com/ePages-de/epages-rest-php/master/build/epages-rest-php.phar -O epages-rest-php.phar
-```
-
-It is also possible to download the PHP file archive manually.
-Check for the latest **.phar** release in the [releases area](https://github.com/ePages-de/epages-rest-php/releases).
-
-To use the SDK, you simply have to include it.
-**Warning:** It is not recommended to do this in live system!
-```php
-require_once("libraries/epages-rest-php.phar");
-```
-
 ## Configuration
 You can configure it with putting a **config.json** into you main directory.
 Just copy the **config.example.json** from GitHub or create a new one:
 ```javascript
 {
-    "logging":
-    {
-        "level":        "NONE",
-        "output":       "SCREEN",
-        "outputfile":   null
+    "Client": {
+        "host": "www.some.host",
+        "shop": "shopName",
+        "isSSL": true,
+        "userAgent": "UserAgent",
+        "token": "TheTokenIfExists"
     },
-    "formatting":
-    {
-        "format":   "HTML"
+    "Logger": {
+        "level": "ERROR",
+        "output": "SCREEN"
     }
 }
 ```
@@ -115,24 +98,24 @@ $products = $productFilter->getProducts();
 // print the products
 foreach ($products as $product) {
 
-	echo "<h2>" . htmlentities($product->getName()) . "</h2>";
-	echo "<p>";
-	echo "<img style=\"float:left\" src=\"" . $product->getSmallImage()->getOriginURL() . "\"/>";
-	echo "<strong>ProductID:</strong> " . $product->getID() . "<br/>";
-	echo "<strong>Description:</strong> " . htmlentities($product->getDescription()) . "<br/><br/>";
-	echo "<strong>This product is ";
-	if (!$product->isForSale()) {
-		echo "NOT ";
-	}
-	echo "for sale and is ";
-	if ($product->isSpecialOffer()) {
-		echo "<u>a</u> ";
-	}
-	else {
-		echo "not a ";
-	}
-	echo "special offer.</strong>";
-	echo "</p><hr style=\"clear:both\"/>";
+    echo "<h2>" . htmlentities($product->getName()) . "</h2>";
+    echo "<p>";
+    echo "<img style=\"float:left\" src=\"" . $product->getSmallImage()->getOriginURL() . "\"/>";
+    echo "<strong>ProductID:</strong> " . $product->getID() . "<br/>";
+    echo "<strong>Description:</strong> " . htmlentities($product->getDescription()) . "<br/><br/>";
+    echo "<strong>This product is ";
+    if (!$product->isForSale()) {
+        echo "NOT ";
+    }
+    echo "for sale and is ";
+    if ($product->isSpecialOffer()) {
+        echo "<u>a</u> ";
+    }
+    else {
+        echo "not a ";
+    }
+    echo "special offer.</strong>";
+    echo "</p><hr style=\"clear:both\"/>";
 }
 ```
 

circle.yml

@@ -7,5 +7,11 @@
   "license": "MIT",
   "require": {
     "php": ">=7.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "6.4.4"
+  },
+  "autoload": {
+    "classmap": ["src/"]
   }
 }

composer.json

@@ -1,33 +1,13 @@
 {
-    "logging":
-    {
-        "level":        "NOTIFICATION",
-        "output":       "SCREEN",
-        "outputfile":   null
+    "Client": {
+        "host": "www.some.host",
+        "shop": "shopName",
+        "isSSL": true,
+        "userAgent": "UserAgent",
+        "token": "TheTokenIfExists"
     },
-    "formatting":
-    {
-        "image":
-        {
-            "formatters": ["IMAGE", "NEWLINE"],
-            "classes": ["testClass1", "testClass2"],
-            "id": "testID",
-            "attributes":
-            {
-                "testAttribute1": "testValue1",
-                "testAttribute2": "testValue2"
-            }
-        },
-        "bold":
-        {
-            "formatters": ["BOLD", "NEWLINE"],
-            "classes": ["testClass1", "testClass2"],
-            "id": "testID",
-            "attributes":
-            {
-                "testAttribute1": "testValue1",
-                "testAttribute2": "testValue2"
-            }
-        }
+    "Logger": {
+        "level": "ERROR",
+        "output": "SCREEN"
     }
 }

config.example.json

@@ -17,15 +17,15 @@
  *
  * This can throw a JSONDecodingException. If everything works correct this function will return the value true.
  */
-Configuration::addConfigurationFromFile('/path/to/a/JSON/file');
+Configuration::addFromFile('/path/to/a/JSON/file');
 
 /**
  * Solution 2.1: Define it via array.
  *
  * To connect to more different shops in one script call (e.g. having Crons) there is also the possibility to load
  * Configuration via array.
  */
-Configuration::setConfiguration([
+Configuration::set([
     'Client'    =>  [
         'host'      =>  'www.example.com',
         'shop'      =>  'MyCoolShop',
@@ -40,7 +40,7 @@
  *
  * There is also the possibility to only right a specific module with adding the Configuration with array.
  */
-Configuration::setConfiguration(
+Configuration::set(
     [
         'host'      =>  'www.example.com',
         'shop'      =>  'MyCoolShop',
@@ -55,7 +55,7 @@
  * If you want to change some Client configuration, like host, but not change the other Client Configurations you can
  * extend the Configuration.
  */
-Configuration::extendConfiguration(
+Configuration::extend(
     [
         'host'      =>  'www.example.org'
     ],
@@ -67,5 +67,5 @@
  *
  * To delete the static Configuration settings just use the reset function.
  */
-Configuration::resetConfiguration();            // Reset complete Configuration
-Configuration::resetConfiguration('Client');    // Only reset the Client configuration
+Configuration::reset();            // Reset complete Configuration
+Configuration::reset('Client');    // Only reset the Client configuration

examples/connectingSettings.php

@@ -16,8 +16,8 @@
  *
  * The Logger can be configured via JSON file or array.
  */
-Configuration::addConfigurationFromFile('dir/and/filename.json');   // configure via JSON
-Configuration::setConfiguration(
+Configuration::addFromFile('dir/and/filename.json');   // configure via JSON
+Configuration::set(
     [
         'Logger'   =>   [
             'level'     =>  LogLevel::ERROR,

examples/logMessages.php

@@ -1,49 +1,7 @@
-<phpunit bootstrap="src/Shop.class.php" colors="always">
- 	<testsuites>
-		<testsuite name="RESTClient Test">
-			<file>tests/util/RESTClientTest.php</file>
-		</testsuite>
-		<testsuite name="Shop Test">
-			<file>tests/ShopTest.php</file>
-		</testsuite>
-		<testsuite name="InputValidator Test">
-			<file>tests/util/InputValidatorTest.php</file>
-		</testsuite>
-		<testsuite name="Contact Information Test">
-			<file>tests/shopobjects/information/ContactInformationTest.php</file>
-		</testsuite>
-		<testsuite name="Privacy Policy Information Test">
-			<file>tests/shopobjects/information/PrivacyPolicyInformationTest.php</file>
-		</testsuite>
-		<testsuite name="Right Of Withdrawal Information Test">
-			<file>tests/shopobjects/information/RightOfWithdrawalInformationTest.php</file>
-		</testsuite>
-		<testsuite name="Shipping Information Test">
-			<file>tests/shopobjects/information/ShippingInformationTest.php</file>
-		</testsuite>
-		<testsuite name="Terms And Condition Information Test">
-			<file>tests/shopobjects/information/TermsAndConditionInformationTest.php</file>
-		</testsuite>
-		<testsuite name="Address Test">
-			<file>tests/shopobjects/address/AddressTest.php</file>
-		</testsuite>
-		<testsuite name="Date Test">
-			<file>tests/shopobjects/date/DateTest.php</file>
-		</testsuite>
-		<testsuite name="Payment Method Test">
-			<file>tests/shopobjects/method/PaymentMethodTest.php</file>
-		</testsuite>
-		<testsuite name="Shipping Method Test">
-			<file>tests/shopobjects/method/ShippingMethodTest.php</file>
-		</testsuite>
-		<testsuite name="Shipping Method Test">
-			<file>tests/shopobjects/order/OrderTest.php</file>
-		</testsuite>
-	</testsuites>
-	<groups>
-		<include>
-			<group>utility</group>
-			<group>shopobjects</group>
-		</include>
-	</groups>
+<phpunit bootstrap="vendor/autoload.php" colors="always">
+    <testsuites>
+        <testsuite name="Configuration Test">
+            <file>tests/EpSDKTest/Configuration/ConfigurationTest.php</file>
+        </testsuite>
+    </testsuites>
 </phpunit>

phpunit.xml

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace EpSDK\Configuration;
 
 use EpSDK\Exception\JSONDecodingException;
@@ -28,7 +30,7 @@ class Configuration
      * @throws  JSONDecodingException   Thrown if the file cannot be found or is no valid JSON.
      * @since   0.4.0
      */
-    public static function addConfigurationFromFile(string $pathToFile): bool
+    public static function addFromFile(string $pathToFile): bool
     {
         $configurationArray = \json_decode(\file_get_contents($pathToFile), true);
         if (null === $configurationArray) {
@@ -37,7 +39,7 @@ public static function addConfigurationFromFile(string $pathToFile): bool
         }
         /** @var array $configurationArray */
         foreach ($configurationArray as $module => $configuration) {
-            self::extendConfiguration($configuration, $module);
+            self::extend($configuration, $module);
         }
         return true;
     }
@@ -50,12 +52,12 @@ public static function addConfigurationFromFile(string $pathToFile): bool
      * @return  bool
      * @since   0.4.0
      */
-    public static function extendConfiguration(array $configuration, string $module): bool
+    public static function extend(array $configuration, string $module): bool
     {
         if (isset(self::$configuration[$module])) {
             self::$configuration[$module] = \array_merge(self::$configuration[$module], $configuration);
         } else {
-            self::setConfiguration($configuration, $module);
+            self::set($configuration, $module);
         }
         return true;
     }
@@ -67,12 +69,11 @@ public static function extendConfiguration(array $configuration, string $module)
      * @return  array
      * @since   0.4.0
      */
-    public static function getConfiguration(string $module = null): array
+    public static function get(string $module = null): array
     {
-        if (null === $module) {
-            return self::$configuration;
-        }
-        return self::$configuration[$module] ?? [];
+        return null === $module
+            ? self::$configuration
+            : self::$configuration[$module] ?? [];
     }
 
     /**
@@ -102,7 +103,7 @@ public static function saveToFile(string $fileName, string $module = null): bool
      * @return  bool
      * @since   0.4.0
      */
-    public static function setConfiguration(array $configuration, string $module = null): bool
+    public static function set(array $configuration, string $module = null): bool
     {
         if (null === $module) {
             self::$configuration = $configuration;
@@ -115,10 +116,11 @@ public static function setConfiguration(array $configuration, string $module = n
     /**
      * Reset the configuration.
      *
+     * @param   string  $module
      * @return  bool
      * @since   0.4.0
      */
-    public static function resetConfiguration(string $module = null): bool
+    public static function reset(string $module = null): bool
     {
         if (null !== $module) {
             unset(self::$configuration[$module]);