0.6.0

Author: adelholtz

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.6.0] - 2020-06-23
+
+* added possibility to gain direct access to response and request through callback methods
+* added User info and list tasks
+* added examples for some basic tasks
+    ** more examples (hopefully for all tasks) will be added in future versions
+* fixed some tasks that did not give correct access to the DomainrobotResult
+* improved documentation and readme
+
 ## [0.5.2] - 2020-06-16
 
 * Fixed printing null or empty values (#8)

README.md

@@ -8,14 +8,16 @@ A php package for easy integration of the **Domainrobot API** powered by [InterN
 2. [Install and Use](#install-and-use)
    * [Installation](#installation)
    * [Basic Use](#basic-use)
-3. [Usage](#usage)
+3. [Example Implementations](#example-implementations)
+4. [Usage](#usage)
+   * [Logging Requests and Responses](#logging-requests-and-responses)
    * [Asynchronous vs Synchronous Requests](#asynchronous-vs-synchronous-requests)
    * [Models](#models)
    * [Supported API calls](#supported-api-calls)
    * [Exception handling](#exception-handling)
    * [(Custom) Headers](#custom-headers)
-4. [Changelog](#changelog)
-5. [Copyright and license](#copyright-and-license)
+5. [Changelog](#changelog)
+6. [Copyright and license](#copyright-and-license)
 
 ## Preamble
 
@@ -37,6 +39,11 @@ composer require internetx/php-domainrobot-sdk
 use Domainrobot\Domainrobot;
 ```
 
+## Example Implementations
+
+You can find some example implemnation in the *example* Folder in the source code.
+We will add examples for all or at least most tasks in the next versions of this SDK.
+
 ## Usage
 
 Before you can interact with the API you need to specify your authentication credentials, the baseurl and the context.
@@ -46,6 +53,7 @@ Before you can interact with the API you need to specify your authentication cre
 
 ```php
 use Domainrobot\Domainrobot;
+use Domainrobot\Lib\DomainrobotAuth;
 
 $domainrobot = new Domainrobot([
     "url" => "https://api.autodns.com/v1",
@@ -57,6 +65,22 @@ $domainrobot = new Domainrobot([
 ]);
 ```
 
+### Logging Requests and Responses
+
+There may be certain circumstances where you may want to log your requests and responses.
+For this cases we provide you with two integrated callback methods you can use for this purpose.
+Find an example on how to use them below.
+
+```php
+$domainrobot->domain->logRequest(function($method, $url, $options) use ($user){
+    // execute your code here
+    print_r($method);
+})->logResponse(function($url, $response, $statusCode, $exectime) use ($user){
+    // execute your code here
+     print_r($user);
+})->info("example.com");
+```
+
 ### Asynchronous vs Synchronous Requests
 
 This library is mainly meant to be used with synchronous request but also provides the possibility to be used with asynchronous requests.
@@ -265,6 +289,13 @@ function answer($domain, $answer);
 function list(Query $body = null);
 ```
 
+#### User tasks
+
+```php
+function info($user, $context);
+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.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "internetx/php-domainrobot-sdk",
-    "version": "0.5.2",
+    "version": "0.6.0",
     "description": "A php package for easy integration of the domainrobot API powered by InterNetX GmbH.",
     "type": "library",
     "license": "MIT",

example/DomainUpdateForSubuser.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Example;
+
+use Domainrobot\Domainrobot;
+use Domainrobot\Lib\DomainrobotAuth;
+use Domainrobot\Lib\DomainrobotException;
+use Domainrobot\Lib\DomainrobotHeaders;
+use Domainrobot\Model\Contact;
+
+/**
+ * This example is focused on a domain update the general principle holds true
+ * for ALL tasks you want to execute for a subuser of your auth user
+ */
+class SDKController
+{
+    /**
+     * Inquire and update a domain for a subuser
+     * returns an ObjectJob since the task itself is asynchronous
+     *
+     * @return ObjectJob
+     */
+    public function updateDomain()
+    {
+        $domainrobot = new Domainrobot([
+            "url" => "https://api.autodns.com/v1",
+            "auth" => new DomainrobotAuth([
+                "user" => "username",
+                "password" => "password",
+                "context" => 4
+            ])
+        ]);
+
+        try {
+            $domain = $domainrobot->domain->info("example.com");
+
+            // update the domain model with the new data
+            // for example set a new admin contact
+            $domain->setAdminc(new Contact(["id" => 21365838]));
+
+            // to update the domain for the subuser set the following headers
+            $job = $domainrobot->domain->addHeaders([
+                DomainrobotHeaders::DOMAINROBOT_HEADER_OWNER => "ownername",
+                DomainrobotHeaders::DOMAINROBOT_HEADER_OWNER_CONTEXT => 797095  //owner context
+
+            ])->update($domain);
+
+        } catch (DomainrobotException $exception) {
+            return$exception;
+        }
+        
+        return $job;
+    }
+}

example/UserInfo.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Example;
+
+use Domainrobot\Domainrobot;
+use Domainrobot\Lib\DomainrobotAuth;
+use Domainrobot\Lib\DomainrobotException;
+use Domainrobot\Model\User;
+
+class SDKController
+{
+    /**
+     * Inquire user by context and return found user as model
+     *
+     * @return User
+     */
+    public function userInfo()
+    {
+        $domainrobot = new Domainrobot([
+            "url" => "https://api.autodns.com/v1",
+            "auth" => new DomainrobotAuth([
+                "user" => "username",
+                "password" => "password",
+                "context" => 4
+            ])
+        ]);
+
+        try {
+            // pass username and context to info command
+            // returns Domainrobot\Model\User
+            $user = $domainrobot->user->info("username", 4);
+        } catch (DomainrobotException $exception) {
+            return $exception;
+        }
+        
+        return $user;
+    }
+}

example/UserList.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Example;
+
+use Domainrobot\Domainrobot;
+use Domainrobot\Lib\DomainrobotAuth;
+use Domainrobot\Lib\DomainrobotException;
+use Domainrobot\Model\Query;
+use Domainrobot\Model\QueryFilter;
+use Domainrobot\Model\QueryView;
+use Domainrobot\Model\User;
+
+class SDKController
+{
+    /**
+     * Inquire a list of users
+     * returns an array of Domainrobot\Model\User
+     *
+     * @return [ User ]
+     */
+    public function userList()
+    {
+        $domainrobot = new Domainrobot([
+            "url" => "https://api.autodns.com/v1",
+            "auth" => new DomainrobotAuth([
+                "user" => "username",
+                "password" => "password",
+                "context" => 4
+            ])
+        ]);
+
+        try {
+            $query = new Query([
+                'filters' => [ new QueryFilter([
+                    'key' => 'user',
+                    'value' => 'username',
+                    'operator' => 'EQUAL'
+                ])],
+                'view' => new QueryView([
+                    'children' => 1,
+                    'limit' => 10
+                ])
+            ]);
+            $userList = $domainrobot->user->list($query);
+
+        } catch (DomainrobotException $exception) {
+            return $exception;
+        }
+        
+        return $userList;
+    }
+}

src/Domainrobot.php

@@ -13,6 +13,7 @@
 use Domainrobot\Service\TrustedApplicationService;
 use Domainrobot\Service\ZoneService;
 use Domainrobot\Service\PollMessageService;
+use Domainrobot\Service\UserService;
 
 class Domainrobot
 {
@@ -98,6 +99,13 @@ class Domainrobot
      */
     public $zone;
 
+    /**
+     * Interface for all zone related requests
+     *
+     * @var UserService
+     */
+    public $user;
+
     /**
      * [
      *   "url" => string, //optional
@@ -119,6 +127,7 @@ public function __construct($domainrobotConfig = [])
         $this->transferOut = new TransferOutService($this->domainrobotConfig);
         $this->trustedApp = new TrustedApplicationService($this->domainrobotConfig);
         $this->zone = new ZoneService($this->domainrobotConfig);
+        $this->user = new UserService($this->domainrobotConfig);
     }
 
     public function setDomainrobotConfig(DomainrobotConfig $domainrobotConfig)

src/Service/CertificateService.php

@@ -234,6 +234,7 @@ public function info($id)
         $domainrobotPromise = $this->infoAsync($id);
         $domainrobotResult = $domainrobotPromise->wait();
 
+        Domainrobot::setLastDomainrobotResult($domainrobotResult);
 
         return new Certificate(ArrayHelper::getValueFromArray($domainrobotResult->getResult(), 'data.0', []));
     }
@@ -264,6 +265,8 @@ public function delete($id)
         $domainrobotPromise = $this->deleteAsync($id);
         $domainrobotResult = $domainrobotPromise->wait();
 
+        Domainrobot::setLastDomainrobotResult($domainrobotResult);
+
         return new ObjectJob([
             "job" => ArrayHelper::getValueFromArray($domainrobotResult->getResult(), 'data.0.id', '')
         ]);

src/Service/ContactService.php

@@ -90,12 +90,15 @@ public function list(Query $body = null)
         $domainrobotResult = $domainrobotPromise->wait();
 
         Domainrobot::setLastDomainrobotResult($domainrobotResult);
+
         $data = $domainrobotResult->getResult()['data'];
         $contacts = array();
+
         foreach ($data as $d) {
             $c = new Contact($d);
             array_push($contacts, $c);
         }
+
         return $contacts;
     }
 
@@ -136,6 +139,7 @@ public function listAsync(Query $body = null)
         if ($body != null) {
             $data = $body->toArray();
         }
+
         return new DomainrobotPromise($this->sendRequest(
             $this->domainrobotConfig->getUrl() . "/contact/_search",
             'POST',
@@ -154,6 +158,7 @@ public function info($id)
         $domainrobotPromise = $this->infoAsync($id);
         $domainrobotResult = $domainrobotPromise->wait();
 
+        Domainrobot::setLastDomainrobotResult($domainrobotResult);
 
         return new Contact(ArrayHelper::getValueFromArray($domainrobotResult->getResult(), 'data.0', []));
     }

src/Service/DomainCancelationService.php

@@ -131,6 +131,7 @@ public function info($domain)
         $domainrobotPromise = $this->infoAsync($domain);
         $domainrobotResult = $domainrobotPromise->wait();
 
+        Domainrobot::setLastDomainrobotResult($domainrobotResult);
 
         return new DomainCancelation(ArrayHelper::getValueFromArray($domainrobotResult->getResult(), 'data.0', []));
     }
@@ -176,8 +177,10 @@ public function list(Query $body = null)
         $domainrobotResult = $domainrobotPromise->wait();
 
         Domainrobot::setLastDomainrobotResult($domainrobotResult);
+
         $data = $domainrobotResult->getResult()['data'];
         $domainCancelations = array();
+
         foreach ($data as $d) {
             $dc = new DomainCancelation($d);
             array_push($domainCancelations, $dc);
@@ -213,6 +216,7 @@ public function listAsync(Query $body = null)
         if ($body != null) {
             $data = $body->toArray();
         }
+        
         return new DomainrobotPromise($this->sendRequest(
             $this->domainrobotConfig->getUrl() . "/domain/cancelation/_search",
             'POST',