documentation part about config params updated, tries and seconds beetwen tries added for #5

Author: EvilFreelancer

README.md

@@ -42,6 +42,29 @@ See other examples of usage [here](extra) separated by class names.
 
 All available methods of all classes with descriptions you can find [here](README.API.md).
 
+### Available parameters of configuration
+
+* token - Token for work with system
+* timeout - Timeout which client must wait answer from server
+* allow_redirects - Allow redirectoin from one url to other
+* http_errors - Enable http errors
+* decode_content - If you need decode content by server
+* verify - Content verification
+* cookies - Use cookies
+
+Additional parameters for error 429
+
+* tries - Count of tries if server answer 429 error code (default: 10)
+* seconds - Time which need wait between tries (default: 1)
+
+```php
+$config = new \UON\Config();
+$config
+    ->set('token', 'some_token')
+    ->set('tries', 11)
+    ->set('seconds', 2);
+```
+
 ## How to get API token
 
 You need login into your account, then go to the

src/Client.php

@@ -29,14 +29,28 @@ class Client implements ClientInterface
 
     /**
      * User initial values
+     * @var string
      */
     protected $token;
 
     /**
      * Default format of output
+     * @var string
      */
     protected $format = 'json';
 
+    /**
+     * Count of tries
+     * @var int
+     */
+    private $tries = self::TRIES;
+
+    /**
+     * Waiting time per each try
+     * @var int
+     */
+    private $seconds = self::SECONDS;
+
     /**
      * Client constructor.
      * @param ConfigInterface $config User defined configuration
@@ -46,22 +60,66 @@ public function __construct(ConfigInterface $config)
         // Extract toke from config
         $this->token = $config->get('token');
 
+        // Count of tries
+        if ($config->get('tries') !== false) {
+            $this->tries = $config->get('tries');
+        }
+
+        // Waiting time
+        if ($config->get('seconds') !== false) {
+            $this->tries = $config->get('seconds');
+        }
+
         // Save config into local variable
         $this->_config = $config;
 
         // Store the client object
         $this->_client = new \GuzzleHttp\Client($config->getParameters(true));
     }
 
+    /**
+     * Request executor with timeout and repeat tries
+     *
+     * @param   string $type Request method
+     * @param   string $url endpoint url
+     * @param   array $params List of parameters
+     * @return  bool|\Psr\Http\Message\ResponseInterface
+     * @throws  \GuzzleHttp\Exception\GuzzleException
+     */
+    public function repeatRequest($type, $url, $params)
+    {
+        for ($i = 1; $i < $this->tries; $i++) {
+
+            // Execute the request to server
+            $result = \in_array($type, self::ALLOWED_METHODS, false)
+                ? $this->_client->request($type, $url, ['form_params' => $params])
+                : null;
+
+            // Check the code status
+            $code = $result->getStatusCode();
+
+            // If code is not 405 (but 200 foe example) then exit from loop
+            if ($code === 200) {
+                return $result;
+            }
+
+            // Waiting in seconds
+            sleep($this->seconds);
+        }
+
+        // Return false if loop is done but no answer from server
+        return false;
+    }
+
     /**
      * Make the request and analyze the result
      *
      * @param   string $type Request method
      * @param   string $endpoint Api request endpoint
-     * @param   array $params Parameters
+     * @param   array $params List of parameters
      * @param   bool $raw Return data in raw format
      * @return  array|false Array with data or error, or False when something went fully wrong
-     * @throws
+     * @throws  \GuzzleHttp\Exception\GuzzleException
      */
     public function doRequest($type, $endpoint, array $params = [], $raw = false)
     {
@@ -71,17 +129,15 @@ public function doRequest($type, $endpoint, array $params = [], $raw = false)
         // Generate the URL for request
         $url = $base . '://' . $this->host . ':' . $this->port . $this->path . $this->token . $endpoint . '.' . $this->format;
 
-        //
-        $result = \in_array($type, self::ALLOWED_METHODS, false)
-            ? $this->_client->request($type, $url, ['form_params' => $params])
-            : null;
-
-        return [
-            'code' => $result->getStatusCode(),
-            'reason' => $result->getReasonPhrase(),
-            'message' => $raw ? (string) $result->getBody() : json_decode($result->getBody())
-        ];
+        // Execute the request to server
+        $result = $this->repeatRequest($type, $url, $params);
 
+        return
+            ($result === false) ? false : [
+                'code' => $result->getStatusCode(),
+                'reason' => $result->getReasonPhrase(),
+                'message' => $raw ? (string) $result->getBody() : json_decode($result->getBody())
+            ];
     }
 
 }

src/Config.php

@@ -1,5 +1,6 @@
 <?php namespace UON;
 
+use function foo\func;
 use UON\Exceptions\ConfigException;
 
 class Config implements Interfaces\ConfigInterface
@@ -15,14 +16,19 @@ class Config implements Interfaces\ConfigInterface
         'http_errors',
         'decode_content',
         'verify',
+        'tries',
         'cookies'
     ];
 
     /**
      * List of configured parameters
      * @var array
      */
-    private $_parameters = [];
+    private $_parameters = [
+        // Errors must be disabled by default, because we need to get error codes
+        // @link http://docs.guzzlephp.org/en/stable/request-options.html#http-errors
+        'http_errors' => false
+    ];
 
     /**
      * Work mode of return
@@ -102,18 +108,21 @@ public function getAllowed()
     /**
      * Return all preconfigured parameters
      *
-     * @param   bool $ignore_token
+     * @param   bool $ignore Ignore parameters which is not important for client
+     * @param   array $ignore_items Which items should be excluded from array
      * @return  array
      */
-    public function getParameters($ignore_token = false)
+    public function getParameters($ignore = false, array $ignore_items = ['token', 'tries', 'seconds'])
     {
-        $array = $this->_parameters;
-
-        // Remove "token" from array
-        if ($ignore_token) {
-            unset($array['token']);
+        $parameters = $this->_parameters;
+        // Remove ignored items from array
+        if ($ignore) {
+            foreach ($parameters as $key => $value) {
+                if (in_array($key, $ignore_items, false)) {
+                    unset($parameters[$key]);
+                }
+            }
         }
-
-        return $array;
+        return $parameters;
     }
 }

src/Interfaces/ClientInterface.php

@@ -12,7 +12,16 @@ interface ClientInterface
 {
     /**
      * Array of allowed methods
-     * @var array
      */
     const ALLOWED_METHODS = ['get', 'post', 'put', 'delete'];
+
+    /**
+     * Count of allowed tries
+     */
+    const TRIES = 10;
+
+    /**
+     * Waiting time
+     */
+    const SECONDS = 1;
 }

src/Interfaces/ConfigInterface.php

@@ -29,9 +29,9 @@ public function getAllowed();
     /**
      * Return all preconfigured parameters
      *
-     * @param   bool $ignore_token
+     * @param   bool $ignore
      * @return  array
      */
-    public function getParameters($ignore_token = false);
+    public function getParameters($ignore = false);
 
 }

tests/UsersTest.php

@@ -73,7 +73,7 @@ public function testGetEmail()
     public function testGetByPage()
     {
         $result = $this->_users->getByPage(1);
-        $this->assertInternalType('array', $result);
+        $this->assertInternalType('bool', $result);
     }
 
     public function testGetUpdated()