🚧 Rethinking structure of the lib

Author: Artem Shteltser

.gitignore

@@ -1 +1,2 @@
 /vendor/
+index.php

composer.json

@@ -17,5 +17,10 @@
     "require": {
         "ext-json": "*",
         "guzzlehttp/guzzle": "^7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "PowerLink\\": "src"
+        }
     }
 }

src/PowerLinkAPI.php renamed to src/Client.php

@@ -4,22 +4,12 @@
 
 use GuzzleHttp\Client as HTTPClient;
 
-abstract class Client
+class Client
 {
     /**
      * Host 
      */
-    const BASE_URL = 'https://api.powerlink.co.il/api/record/';
-
-    /**
-     * Error messages
-     */
-    const ERROR_INVALID_API_KEY = 'Invalid TokenID.';
-
-    /**
-     * @var string
-     */
-    protected $token_id;
+    const BASE_URL = 'https://api.powerlink.co.il/api/';
 
     /**
      * @var HTTPClient
@@ -31,16 +21,25 @@ abstract class Client
      *
      * @param string $token_id Token id for PowerLink account
      * @param string $base_uri (optional) Base URL for PowerLink API
+     * 
      */
-    public function __construct($token_id, $base_uri = self::BASE_URL)
+    public function __construct($token_id, $base_url = self::BASE_URL)
     {
-        $this->token_id = $token_id;
         $this->client = new HTTPClient([
-            'base_uri' => $base_uri,
+            'base_uri' => $base_url,
             'headers' => [
+                'tokenid'    => $token_id,
                 'User-Agent' => "stelzer/php-powerlink/" . PowerLink::VERSION,
                 'Accept'     => 'application/json'
             ]
         ]);
     }
+
+    /**
+     * Get Initialized Client
+     */
+    public function getClient()
+    {
+        return $this->client;
+    }
 }

src/Exceptions/PowerLinkException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Powerlink\Exceptions;
+
+/**
+ * Class PowerLinkException
+ */
+class PowerLinkException extends \Exception
+{
+}

src/Model/BaseModel.php

@@ -2,33 +2,113 @@
 
 namespace PowerLink;
 
+use PowerLink\Exceptions\PowerLinkException;
+
+use GuzzleHttp\Psr7;
+use GuzzleHttp\Exception\RequestException;
+
 class PowerLink
 {
+    /** @var string Package version */
+    const VERSION = '1.0.0';
+
+    /** @var string The API access token */
+    protected static $token = null;
+
     /**
-     * @var string
+     * @param string|null $token Token ID for authorization
+     * @param Client|null $client Custom Client
+     * @throws PowerLinkException When no token is provided
      */
-    protected $token_id;
+    public function __construct($token = null, $client = null)
+    {
+        if ($token === null) {
+            if (self::$token === null) {
+                $msg = 'No token provided, and none is globally set. ';
+                $msg .= 'Use PowerLink::setToken, or instantiate the Diffbot class with a $token parameter.';
+                throw new PowerLinkException($msg);
+            }
+        } else {
+            self::setToken($token);
+            $this->setHttpClient($client);
+        }
+    }
 
     /**
-     * @var string
+     * Sets the token for all future new instances
+     * @param string $token The API access token, as obtained on diffbot.com/dev
+     * @return void
      */
-    const VERSION = '1.0.0';
+    public static function setToken($token)
+    {
+        self::validateToken($token);
+        self::$token = $token;
+    }
+
+    private static function validateToken($token)
+    {
+        if (!is_string($token)) {
+            throw new \InvalidArgumentException('Token is not a string.');
+        }
+
+        if (strlen($token) < 36) {
+            throw new \InvalidArgumentException('Token "' . $token . '" is too short, and thus invalid.');
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns the token that has been defined.
+     * @return null|string
+     */
+    public function getToken()
+    {
+        return self::$token;
+    }
+
 
     /**
-     * Constructor for PowerLink.
+     * Sets the client to be used for querying the API endpoints
      *
-     * @param string $token_id Token ID for authorization
+     * @param Client|null $client
+     * @return $this
      */
-    public function __construct($token_id)
+    public function setHttpClient(Client $client = null)
     {
-        $this->token_id = $token_id;
+        if ($client === null) {
+            $client = new Client(self::$token);
+        }
+
+        $this->client = $client->getClient();
+        return $this;
     }
 
     /**
-     * @return string
+     * Returns either the instance of the Guzzle client that has been defined, or null
+     * @return Client|null
      */
-    public function getTokenID()
+    public function getHttpClient()
+    {
+        return $this->client;
+    }
+
+    public function query()
     {
-        return $this->token_id;
+        try {
+            $response = $this->client->post('/query', [
+                'json' => [
+                    'objecttype' => 'asdsdasdfgasddf',
+                    'page_size' => 50,
+                    'page_number' => 1,
+                    'fields' => '*',
+                ]
+            ]);
+        } catch (RequestException $e) {
+            echo Psr7\Message::toString($e->getRequest());
+            if ($e->hasResponse()) {
+                echo Psr7\Message::toString($e->getResponse());
+            }
+        }
     }
 }

src/PowerLink.php

@@ -1,55 +1,52 @@
 <?php
 
-namespace PowerLink\Model;
+namespace PowerLink;
 
 /**
  * Class defining a query request in PowerLink with methods to set
  * query settings
  */
-class QueryModel
+class Query
 {
-    public const ASC = 'asc';
-    public const DESC = 'DESC';
-
     /**
      * Object Type 
      * @var string
      */
-    public $object_type;
+    protected $object_type;
 
     /**
      * Number of items returned per page 
      * @var string
      */
-    public $page_size;
+    protected $page_size;
 
     /**
      * Number of requested page 
      * @var string
      */
-    public $page_number;
+    protected $page_number;
 
     /**
      * Array of requested fields 
      * @var array
      */
-    public $fields;
+    protected $fields;
 
     /**
      * SQL query for selecting ites 
      * @var string
      */
-    public $query;
+    protected $query;
 
     /**
      * Name of field to sort by 
      * @var string
      */
-    public $sort_by;
+    protected $sort_by;
 
     /**
      * Name of field to sort by 
      * @var ASC|DESC
      */
-    public $sort_type;
+    protected $sort_type;
 }

src/Model/QueryModel.php renamed to src/Query.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace PowerLink\Query\Syntax;
+namespace PowerLink\Query;
 
 /**
  * Class OrderBy.
@@ -11,7 +11,7 @@ class OrderBy
     const DESC = 'desc';
 
     /**
-     * @var Field
+     * @var string
      */
     protected $field;
 
@@ -20,14 +20,9 @@ class OrderBy
      */
     protected $direction;
 
-    /**
-     * @var bool
-     */
-    protected $useAlias;
-
     /**
      * @param string $field
-     * @param string $direction
+     * @param ASC|DESC|string $direction
      */
     public function __construct(string $field, $direction)
     {
@@ -44,7 +39,7 @@ public function getField()
     }
 
     /**
-     * @param Field $field
+     * @param string $field
      *
      * @return $this
      */