Merge pull request #138 from Gman98ish/filter-properties

bluemorbo · web-flow · commit 9bb5a70b5d5b · 2019-11-22T08:48:26.000Z
Friendly-name filter properties
diff --git a/src/Client.php b/src/Client.php
@@ -243,4 +243,44 @@ protected function getUserAgent()
             'php/'.PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION
         ]);
     }
+
+    /**
+     * @param array|Entity $item
+     * @param array $map
+     * @return array
+     */
+    public function apiToFriendly($item, $map)
+    {
+        $newItem = [];
+        if ($item instanceof Entity) {
+            $item = $item->toArray();
+        }
+        foreach ($item as $apiName => $value) {
+            $filter = "";
+            if (strpos($apiName, ':') !== false) {
+                list($apiName, $filter) = explode(":", $apiName);
+                $filter = ":$filter";
+            }
+
+            $apiName = $apiName.$filter;
+            if (isset($map[$apiName])) {
+                $newItem[$map[$apiName]] = $value;
+                continue;
+            }
+
+            $newItem[$apiName] = $value;
+        }
+
+        return $newItem;
+    }
+
+    /**
+     * @param array|Entity $item
+     * @param array $map
+     * @return array
+     */
+    public function friendlyToApi($item, $map)
+    {
+        return $this->apiToFriendly($item, array_flip($map));
+    }
 }
diff --git a/src/Entity.php b/src/Entity.php
@@ -2,13 +2,17 @@
 
 namespace UKFast\SDK;
 
+use DateTime;
+
 abstract class Entity
 {
     /**
      * @var array
      */
     protected $attributes = [];
 
+    protected $dates = [];
+
     /**
      * @param array $attributes
      */
@@ -17,8 +21,8 @@ public function __construct($attributes = [])
         if (is_object($attributes)) {
             $attributes = (array) $attributes;
         }
-        
-        $this->attributes = $attributes;
+
+        $this->fill($attributes);
     }
 
     /**
@@ -48,6 +52,10 @@ public function get($attr, $default = null)
      */
     public function set($attr, $value)
     {
+        if (in_array($attr, $this->dates)) {
+            $value = DateTime::createFromFormat(DateTime::ISO8601, $value);
+        }
+
         $this->attributes[$attr] = $value;
     }
 
@@ -68,7 +76,7 @@ public function all()
     public function fill($attributes)
     {
         foreach ($attributes as $name => $value) {
-            $this->attributes[$name] = $value;
+            $this->set($name, $value);
         }
     }
 
diff --git a/src/PSS/Entities/Author.php b/src/PSS/Entities/Author.php
@@ -2,34 +2,15 @@
 
 namespace UKFast\SDK\PSS\Entities;
 
-class Author
+use UKFast\SDK\Entity;
+
+/**
+ * @property int $id
+ * @property string $name
+ * @property string $type
+ */
+class Author extends Entity
 {
-    /**
-     * @var int
-     */
-    public $id;
-
-    /**
-     * @var string
-     */
-    public $name;
-
-    /**
-     * @var string
-     */
-    public $type;
-
-    public function __construct($item = null)
-    {
-        if (is_null($item)) {
-            return;
-        }
-
-        $this->id = $item->id;
-        $this->name = $item->name;
-        $this->type = $item->type;
-    }
-
     /**
      * @return bool
      */
diff --git a/src/PSS/Entities/Request.php b/src/PSS/Entities/Request.php
@@ -2,98 +2,32 @@
 
 namespace UKFast\SDK\PSS\Entities;
 
-class Request
+use UKFast\SDK\Entity;
+
+/**
+ * @property int $id
+ * @property \UKFast\SDK\PSS\Entities\Author $author
+ * @property string $type
+ * @property string $subject
+ * @property bool $secure
+ * @property \DateTime $createdAt
+ * @property string $priority
+ * @property bool $archived
+ * @property string $status
+ * @property bool $requestSms
+ * @property string $customerReference
+ * @property \UKFast\SDK\PSS\Entities\Product $product
+ * @property \DateTime $lastRepliedAt
+ * @property string $systemReference
+ * @property string $details
+ * @property array $cc
+ * @property int $unreadReplies
+ * @property string $contactMethod
+ */
+class Request extends Entity
 {
-    /**
-     * @var int
-     */
-    public $id;
-
-    /**
-     * @var \UKFast\SDK\Pss\Entities\Author
-     */
-    public $author;
-
-    /**
-     * @var string
-     */
-    public $type;
-
-    /**
-     * @var string
-     */
-    public $subject;
-
-    /**
-     * @var bool
-     */
-    public $secure = true;
-
-    /**
-     * @var \Datetime
-     */
-    public $createdAt;
-
-    /**
-     * @var string
-     */
-    public $priority = 'Normal';
-
-    /**
-     * @var bool
-     */
-    public $archived;
-
-    /**
-     * @var string
-     */
-    public $status;
-
-    /**
-     * @var bool
-     */
-    public $requestSms = false;
-
-    /**
-     * @var string
-     */
-    public $customerReference;
-
-    /**
-     * @var \UKFast\SDK\Pss\Entities\Author
-     */
-    public $product;
-
-    /**
-     * @var \DateTime
-     */
-    public $lastRepliedAt;
-
-    /**
-     * @var string
-     */
-    public $systemReference;
-
-    /**
-     * @var string
-     */
-    public $details;
-
-    /**
-     * @var array
-     */
-    public $cc = [];
-
-    /**
-     * @var integer
-     */
-    public $unreadReplies;
-
-    /**
-     * @var string
-     */
-    public $contactMethod;
-
+    protected $dates = ['createdAt', 'lastRepliedAt'];
+    
     public function isCompleted()
     {
         return in_array($this->status, ['Completed', 'Replied and Completed']);
diff --git a/src/PSS/RequestClient.php b/src/PSS/RequestClient.php
@@ -10,6 +10,16 @@ class RequestClient extends BaseClient
 {
     protected $basePath = 'pss/';
 
+    protected $requestMap = [
+        'created_at' => 'createdAt',
+        'request_sms' => 'requestSms',
+        'customer_reference' => 'customerReference',
+        'last_replied_at' => 'lastRepliedAt',
+        'system_reference' => 'systemReference',
+        'unread_replies' => 'unreadReplies',
+        'contact_method' => 'contactMethod',
+    ];
+
     /**
      * Gets a paginated response of all PSS requests
      *
@@ -20,6 +30,8 @@ class RequestClient extends BaseClient
      */
     public function getPage($page = 1, $perPage = 15, $filters = [])
     {
+        $filters = $this->friendlyToApi($filters, $this->requestMap);
+
         $page = $this->paginatedRequest('v1/requests', $page, $perPage, $filters);
         $page->serializeWith(function ($item) {
             return $this->serializeRequest($item);
@@ -138,31 +150,9 @@ public function getFeedback($id)
      */
     protected function serializeRequest($item)
     {
-        $request = new Entities\Request;
-
-        $request->id = $item->id;
-        $request->author = new Entities\Author($item->author);
-        $request->type = $item->type;
-        $request->secure = $item->secure;
-        $request->subject = $item->subject;
-        $request->createdAt = DateTime::createFromFormat(DateTime::ISO8601, $item->created_at);
-        $request->priority = $item->priority;
-        $request->archived = $item->archived;
-        $request->status = $item->status;
-        $request->requestSms = $item->request_sms;
-        $request->customerReference = $item->customer_reference;
-        $request->product = new Entities\Product($item->product);
-        $request->lastRepliedAt = null;
-        $request->systemReference = $item->system_reference;
-        $request->unreadReplies = $item->unread_replies;
-        $request->contactMethod = $item->contact_method;
-        if ($item->last_replied_at) {
-            $request->lastRepliedAt = DateTime::createFromFormat(DateTime::ISO8601, $item->last_replied_at);
-        }
-
-        if (!empty($item->cc)) {
-            $request->cc = $item->cc;
-        }
+        $request = new Entities\Request($this->apiToFriendly($item, $this->requestMap));
+        $request->author = new Entities\Author($item);
+        $request->product = new Entities\Product($item);
 
         return $request;
     }
@@ -184,41 +174,16 @@ public function serializeFeedback($item)
 
     protected function requestToJson($request)
     {
-        $payload = [
-            'subject' => $request->subject,
-            'details' => $request->details,
-            'priority' => $request->priority,
-            'secure' => $request->secure,
-            'author' => [
-                'id' => $request->author->id
-            ],
-            'request_sms' => $request->requestSms,
-            'archived' => $request->archived,
-        ];
-
-        if (isset($request->status)) {
-            $payload['status'] = $request->status;
-        }
+        $json = $this->friendlyToApi($request, $this->requestMap);
 
-        if ($request->product) {
-            $payload['product'] = [
-                'type' => $request->product->type,
-                'id' => $request->product->id,
-            ];
+        if ($request->author) {
+            $json['author'] = $request->author->toArray();
         }
 
-        if (!empty($request->cc)) {
-            $payload['cc'] = $request->cc;
-        }
-
-        if (!empty($request->contactMethod)) {
-            $payload['contact_method'] = $request->contactMethod;
-        }
-
-        if ($request->customerReference) {
-            $payload['customer_reference'] = $request->customerReference;
+        if ($request->product) {
+            $json['product'] = $request->product->toArray();
         }
-
-        return json_encode($payload);
+        
+        return json_encode($json);
     }
 }
diff --git a/src/eCloud/Entities/Iops.php b/src/eCloud/Entities/Iops.php
@@ -5,7 +5,7 @@
 use UKFast\SDK\Entity;
 
 /**
- * @property int $id
+ * @property string $id
  * @property string $name
  * @property int $limit
  */
diff --git a/tests/ClientTest.php b/tests/ClientTest.php

Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,17 @@`
`2`	`2`
`3`	`3`	`namespace UKFast\SDK;`
`4`	`4`
	`5`	`+use DateTime;`
	`6`	`+`
`5`	`7`	`abstract class Entity`
`6`	`8`	`{`
`7`	`9`	`/**`
`8`	`10`	`* @var array`
`9`	`11`	`*/`
`10`	`12`	`protected $attributes = [];`
`11`	`13`
	`14`	`+ protected $dates = [];`
	`15`	`+`
`12`	`16`	`/**`
`13`	`17`	`* @param array $attributes`
`14`	`18`	`*/`
`@@ -17,8 +21,8 @@ public function __construct($attributes = [])`
`17`	`21`	`if (is_object($attributes)) {`
`18`	`22`	`$attributes = (array) $attributes;`
`19`	`23`	`}`
`20`		`-`
`21`		`- $this->attributes = $attributes;`
	`24`	`+`
	`25`	`+ $this->fill($attributes);`
`22`	`26`	`}`
`23`	`27`
`24`	`28`	`/**`
`@@ -48,6 +52,10 @@ public function get($attr, $default = null)`
`48`	`52`	`*/`
`49`	`53`	`public function set($attr, $value)`
`50`	`54`	`{`
	`55`	`+ if (in_array($attr, $this->dates)) {`
	`56`	`+ $value = DateTime::createFromFormat(DateTime::ISO8601, $value);`
	`57`	`+ }`
	`58`	`+`
`51`	`59`	`$this->attributes[$attr] = $value;`
`52`	`60`	`}`
`53`	`61`
`@@ -68,7 +76,7 @@ public function all()`
`68`	`76`	`public function fill($attributes)`
`69`	`77`	`{`
`70`	`78`	`foreach ($attributes as $name => $value) {`
`71`		`- $this->attributes[$name] = $value;`
	`79`	`+ $this->set($name, $value);`
`72`	`80`	`}`
`73`	`81`	`}`
`74`	`82`