Merge branch 'master' of https://github.com/InterNetX/php-domainrobot-sdk

Author: adelholtz

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.3.7] - 2020-03-19
+
+* Rename all DomainRobot string to Domainrobot
+
+## [0.3.6] - 2020-03-19
+
+* Rename namespace from IXDomainRobot to Domainrobot
+
+## [0.3.5] - 2020-03-11
+
+* Add automatic sdk version resolution
+
 ## [0.3.4] - 2020-03-02
 
 * Fix DomainStudio->search() missing body

README.md

@@ -19,7 +19,9 @@ A php package for easy integration of the **Domainrobot API** powered by [InterN
 
 ## Preamble
 
-This Maven package is not available via known repositories. It must be manually installed into a local Maven repository.
+This composer package can be used within every composer project, including projects based on frameworks like [Laravel](https://laravel.com), [CodeIgniter](https://codeigniter.com/), [Symfony](https://symfony.com/) and many more.
+
+**Note:** Feel free to contribute by creating pull requests or file an issue for bugs, questions and feature requests.
 
 ## Install and Use
 
@@ -32,7 +34,7 @@ composer require internetx/php-domainrobot-sdk
 ### Basic Use
 
 ```php
-use IXDomainRobot\DomainRobot;
+use Domainrobot\Domainrobot;
 ```
 
 ## Usage
@@ -43,11 +45,11 @@ Before you can interact with the API you need to specify your authentication cre
 * Demo System: <https://api.demo.autodns.com/v1>
 
 ```php
-use IXDomainRobot\DomainRobot;
+use Domainrobot\Domainrobot;
 
-$domainRobot = new DomainRobot([
+$domainrobot = new Domainrobot([
     "url" => "https://api.autodns.com/v1",
-    "auth" => new DomainRobotAuth([
+    "auth" => new DomainrobotAuth([
         "user" => "user",
         "password" => "password",
         "context" => 4
@@ -61,11 +63,11 @@ This library is mainly meant to be used with synchronous request but also provid
 
 The basic difference is that the asynchronous requests will provide you with less guidance than the synchronous requests.
 
-A synchronous requests will return an Object as described in the official swagger documentation, whereas an asynchronous request will give you a DomainRobotResult Object which will only return the response as a plain array. You will then have to handle the data on your own.
+A synchronous requests will return an Object as described in the official swagger documentation, whereas an asynchronous request will give you a DomainrobotResult Object which will only return the response as a plain array. You will then have to handle the data on your own.
 
 Both methods provide certain advantages in certain situations.
 
-Be aware that synchronous request will give you access to the return status code and the plain array result through *DomainRobot::getLastDomainRobotResult()*
+Be aware that synchronous request will give you access to the return status code and the plain array result through *Domainrobot::getLastDomainrobotResult()*
 
 Please refer to the examples below for more details.
 
@@ -74,18 +76,18 @@ Please refer to the examples below for more details.
 ```php
 // Sends a synchronous request
 try {
-    $certData = $domainRobot->certificate->prepareOrder($body);
-}catch(DomainRobotException $exception){
+    $certData = $domainrobot->certificate->prepareOrder($body);
+}catch(DomainrobotException $exception){
     return response()->json($exception->getError(), $exception->getStatusCode());
 }
 
 // Access response values through the provided CertificateData object
 $certData->getName();
 
-// Access plain result and statuscode through DomainRobot::getLastDomainRobotResult
+// Access plain result and statuscode through Domainrobot::getLastDomainrobotResult
 return response()->json(
-    DomainRobot::getLastDomainRobotResult()->getResult(),
-    DomainRobot::getLastDomainRobotResult()->getStatusCode()
+    Domainrobot::getLastDomainrobotResult()->getResult(),
+    Domainrobot::getLastDomainrobotResult()->getStatusCode()
 );
 ```
 
@@ -94,14 +96,14 @@ return response()->json(
 ```php
 // Sends an asynchronous request
 try {
-    $promise = $domainRobot->certificate->prepareOrderAsync($body);
-    // Wait for the promise. This will return a DomainRobotResult object
+    $promise = $domainrobot->certificate->prepareOrderAsync($body);
+    // Wait for the promise. This will return a DomainrobotResult object
     $result = $promise->wait();
-}catch(DomainRobotException $exception){
+}catch(DomainrobotException $exception){
     return response()->json($exception->getError(), $exception->getStatusCode());
 }
 
-// Access response values through the provided DomainRobotResult object
+// Access response values through the provided DomainrobotResult object
 $statusCode = $result->getStatusCode();
 $data = $result->getData()
 ```
@@ -116,7 +118,7 @@ Modles are instantiated by using the provided Models in this package.
 See an example below:
 
 ```php
-use IXDomainRobot\Model\Certificate;
+use Domainrobot\Model\Certificate;
 
 $certificateModel = new Certificate();
 ```
@@ -133,7 +135,7 @@ Properties can be set while creating a new model or a after a model has been cre
 The following examples are valid:
 
 ```php
-use IXDomainRobot\Model\Certificate;
+use Domainrobot\Model\Certificate;
 
 $timePeriod = new TimePeriod([
     "unit" => "MONTH",
@@ -146,8 +148,8 @@ $certificateModel = new Certificate([
 ```
 
 ```php
-use IXDomainRobot\Model\Certificate;
-use IXDomainRobot\Model\TimePeriod;
+use Domainrobot\Model\Certificate;
+use Domainrobot\Model\TimePeriod;
 
 $certificateModel = new Certificate();
 $timePeriod = new TimePeriod([
@@ -265,14 +267,14 @@ function list(Query $body = null);
 
 ### Exception handling
 
-If there is any error response from the API, the services will throw a DomainRobotException, which contains information about the error.
+If there is any error response from the API, the services will throw a DomainrobotException, which contains information about the error.
 
 Example:
 
 ```php
  try {
-    $promise = $domainRobot->certificate->createRealtime($certificate);
-}catch(DomainRobotException $exception){
+    $promise = $domainrobot->certificate->createRealtime($certificate);
+}catch(DomainrobotException $exception){
     return response()->json($exception->getError(), $exception->getStatusCode());
 }
 ```
@@ -313,7 +315,7 @@ Array
 ### Use
 
 ```php
-use IXDomainRobot\Lib\DomainRobotHeaders;
+use Domainrobot\Lib\DomainrobotHeaders;
 ```
 
 ### Available Headers
@@ -347,11 +349,11 @@ Custom Headers (see available headers in [Available Headers](#available-headers)
 See example below.
 
 ```php
-use IXDomainRobot\Lib\DomainRobotHeaders;
+use Domainrobot\Lib\DomainrobotHeaders;
 
-$certificateData = $domainRobot->certificate
+$certificateData = $domainrobot->certificate
                        ->addHeaders(
-                            [DomainRobotHeaders::DOMAINROBOT_HEADER_2FA_TOKEN => "token"]
+                            [DomainrobotHeaders::DOMAINROBOT_HEADER_2FA_TOKEN => "token"]
                        )->prepareOrder($body);
 ```
 

composer.json

@@ -1,13 +1,13 @@
 {
     "name": "internetx/php-domainrobot-sdk",
-    "version": "0.3.5",
+    "version": "0.3.7",
     "description": "A php package for easy integration of the domainrobot API powered by InterNetX GmbH.",
     "type": "library",
     "license": "MIT",
     "autoload": {
         "psr-4": {
-            "IXDomainRobot\\": "src/",
-            "IXDomainRobot\\Model\\": "src/Model"
+            "Domainrobot\\": "src/",
+            "Domainrobot\\Model\\": "src/Model"
         }
     },
     "require": {

src/DomainRobot.php src/Domainrobot.phpsrc/DomainRobot.php renamed to src/Domainrobot.php

@@ -1,29 +1,29 @@
 <?php
 
-namespace IXDomainRobot;
-
-use IXDomainRobot\Lib\DomainRobotConfig;
-use IXDomainRobot\Service\CertificateService;
-use IXDomainRobot\Service\DomainStudioService;
-use IXDomainRobot\Service\DomainService;
-use IXDomainRobot\Service\SslContactService;
-use IXDomainRobot\Service\ContactService;
-use IXDomainRobot\Service\DomainCancelationService;
-use IXDomainRobot\Service\TransferOutService;
-use IXDomainRobot\Service\TrustedApplicationService;
-use IXDomainRobot\Service\ZoneService;
-use IXDomainRobot\Service\PollMessageService;
-
-class DomainRobot
+namespace Domainrobot;
+
+use Domainrobot\Lib\DomainrobotConfig;
+use Domainrobot\Service\CertificateService;
+use Domainrobot\Service\DomainStudioService;
+use Domainrobot\Service\DomainService;
+use Domainrobot\Service\SslContactService;
+use Domainrobot\Service\ContactService;
+use Domainrobot\Service\DomainCancelationService;
+use Domainrobot\Service\TransferOutService;
+use Domainrobot\Service\TrustedApplicationService;
+use Domainrobot\Service\ZoneService;
+use Domainrobot\Service\PollMessageService;
+
+class Domainrobot
 {
 
     /**
      *
-     * @var DomainRobotConfig
+     * @var DomainrobotConfig
      */
-    private $domainRobotConfig;
+    private $domainrobotConfig;
 
-    private static $lastDomainRobotResult;
+    private static $lastDomainrobotResult;
 
     /**
      * Interface for all Certificate related requests
@@ -101,38 +101,38 @@ class DomainRobot
     /**
      * [
      *   "url" => string, //optional
-     *   "auth" => DomainRobotAuth //optional
+     *   "auth" => DomainrobotAuth //optional
      * ]
      *
-     * @param array $domainRobotConfig
+     * @param array $domainrobotConfig
      */
-    public function __construct($domainRobotConfig = [])
+    public function __construct($domainrobotConfig = [])
     {
-        $this->setDomainRobotConfig(new DomainRobotConfig($domainRobotConfig));
-        $this->certificate = new CertificateService($this->domainRobotConfig);
-        $this->domainStudio = new DomainStudioService($this->domainRobotConfig);
-        $this->domain = new DomainService($this->domainRobotConfig);
-        $this->sslContact = new SslContactService($this->domainRobotConfig);
-        $this->contact = new ContactService($this->domainRobotConfig);
-        $this->domainCancelation = new DomainCancelationService($this->domainRobotConfig);
-        $this->poll = new PollMessageService($this->domainRobotConfig);
-        $this->transferOut = new TransferOutService($this->domainRobotConfig);
-        $this->trustedApp = new TrustedApplicationService($this->domainRobotConfig);
-        $this->zone = new ZoneService($this->domainRobotConfig);
+        $this->setDomainrobotConfig(new DomainrobotConfig($domainrobotConfig));
+        $this->certificate = new CertificateService($this->domainrobotConfig);
+        $this->domainStudio = new DomainStudioService($this->domainrobotConfig);
+        $this->domain = new DomainService($this->domainrobotConfig);
+        $this->sslContact = new SslContactService($this->domainrobotConfig);
+        $this->contact = new ContactService($this->domainrobotConfig);
+        $this->domainCancelation = new DomainCancelationService($this->domainrobotConfig);
+        $this->poll = new PollMessageService($this->domainrobotConfig);
+        $this->transferOut = new TransferOutService($this->domainrobotConfig);
+        $this->trustedApp = new TrustedApplicationService($this->domainrobotConfig);
+        $this->zone = new ZoneService($this->domainrobotConfig);
     }
 
-    public function setDomainRobotConfig(DomainRobotConfig $domainRobotConfig)
+    public function setDomainrobotConfig(DomainrobotConfig $domainrobotConfig)
     {
-        $this->domainRobotConfig = $domainRobotConfig;
+        $this->domainrobotConfig = $domainrobotConfig;
     }
 
-    public static function setLastDomainRobotResult($lastDomainRobotResult)
+    public static function setLastDomainrobotResult($lastDomainrobotResult)
     {
-        self::$lastDomainRobotResult = $lastDomainRobotResult;
+        self::$lastDomainrobotResult = $lastDomainrobotResult;
     }
 
-    public static function getLastDomainRobotResult()
+    public static function getLastDomainrobotResult()
     {
-        return self::$lastDomainRobotResult;
+        return self::$lastDomainrobotResult;
     }
 }

src/DomainRobotConstants.php src/DomainrobotConstants.phpsrc/DomainRobotConstants.php renamed to src/DomainrobotConstants.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace IXDomainRobot;
+namespace Domainrobot;
 
-class DomainRobotConstants{
+class DomainrobotConstants{
 
     const AUTODNS_URL = "https://api.autodns.com/v1";
 

src/Lib/ArrayHelper.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace IXDomainRobot\Lib;
+namespace Domainrobot\Lib;
 
 class ArrayHelper
 {

src/Lib/DomainRobotAuth.php src/Lib/DomainrobotAuth.phpsrc/Lib/DomainRobotAuth.php renamed to src/Lib/DomainrobotAuth.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace IXDomainRobot\Lib;
+namespace Domainrobot\Lib;
 
-use IXDomainRobot\Lib\ArrayHelper;
-use IXDomainRobot\DomainRobotConstants;
+use Domainrobot\Lib\ArrayHelper;
+use Domainrobot\DomainrobotConstants;
 
 
-class DomainRobotAuth
+class DomainrobotAuth
 {
     /**
      * AutoDNS User
@@ -31,7 +31,7 @@ public function __construct($config = [])
     {
         $this->setUser(ArrayHelper::getValueFromArray($config, 'user', ''));
         $this->setPassword(ArrayHelper::getValueFromArray($config, 'password', ''));
-        $this->setContext(ArrayHelper::getValueFromArray($config, 'context', DomainRobotConstants::AUTODNS_CONTEXT));
+        $this->setContext(ArrayHelper::getValueFromArray($config, 'context', DomainrobotConstants::AUTODNS_CONTEXT));
     }
 
     private function setUser($user)