Simplify Client. Optimize error handlers. Update Readme files.

Add code improvements tools.

Author: zoonman

README.md

@@ -221,7 +221,7 @@ $share = $client->post(
 Setup custom API request headers
 
 ```php
-$client->setDefaultApiHeaders([
+$client->setApiHeaders([
   'Content-Type' => 'application/json',
   'x-li-format' => 'json',
   'x-li-src' => 'msdk' // set a src header to "msdk" to mimic a mobile SDK

README.ru.md

@@ -168,6 +168,45 @@ $share = $client->post(
 );
 ```
 
+Поделиться контентом на тестовой странице компаний
+
+```php
+// Вы можете увидеть сообщение на этой странице
+// https://www.linkedin.com/company/devtestco
+$companyId = '2414183'; // идентификатор страницы
+
+$share = $client->post(
+    'companies/' . $companyId . '/shares',
+    [
+        'comment' => 'Checkout this amazing PHP SDK for LinkedIn!',
+        'content' => [
+            'title' => 'PHP Client for LinkedIn API',
+            'description' => 'OAuth 2 flow, composer Package',
+            'submitted-url' => 'https://github.com/zoonman/linkedin-api-php-client',
+            'submitted-image-url' => 'https://github.com/fluidicon.png',
+        ],
+        'visibility' => [
+            'code' => 'anyone'
+        ]
+    ]
+);
+```
+
+Установить заголовки по умолчанию
+
+```php
+$client->setApiHeaders([
+  'Content-Type' => 'application/json',
+  'x-li-format' => 'json',
+  'x-li-src' => 'msdk' // например отправить "msdk" чтобы симулировать мобильное SDK
+]);
+```
+
+Изменить корневой адрес для API вызовов
+
+```php
+$client->setApiRoot('https://api.linkedin.com/v2/');
+```
 
 ## Помощь проекту
 

composer.json

@@ -46,7 +46,9 @@
     },
     "require-dev": {
         "vlucas/phpdotenv": "~2.0",
-        "phpunit/phpunit": "~4.0"
+        "phpunit/phpunit": "~4.0",
+        "phpmd/phpmd": "@stable",
+        "squizlabs/php_codesniffer": "@stable"
     },
     "archive": {
         "exclude": [

examples/index.php

@@ -22,6 +22,10 @@
 use LinkedIn\Scope;
 
 // import environment variables from the environment file
+// you need a .env file in the parent folder
+// read this document to learn how to create that file
+// https://github.com/zoonman/linkedin-api-php-client/blob/master/examples/README.md
+//
 $dotenv = new Dotenv\Dotenv(dirname(__DIR__));
 $dotenv->load();
 
@@ -31,6 +35,7 @@
 session_start();
 
 // instantiate the Linkedin client
+// you can setup keys using
 $client = new Client(
     getenv('LINKEDIN_CLIENT_ID'),
     getenv('LINKEDIN_CLIENT_SECRET')

src/AccessToken.php

@@ -135,6 +135,20 @@ public function setExpiresAt($expiresAt)
         return $this;
     }
 
+    /**
+     * Convert API response into AccessToken
+     *
+     * @param \Psr\Http\Message\ResponseInterface $response
+     *
+     * @return self
+     */
+    public static function fromResponse($response)
+    {
+        return static::fromResponseArray(
+            Client::responseToArray($response)
+        );
+    }
+
     /**
      * Instantiate access token object
      *

src/Client.php

@@ -128,7 +128,7 @@ public function setUseTokenParam($useTokenParam)
      *
      * @var array
      */
-    protected $defaultApiHeaders = [
+    protected $apiHeaders = [
         'Content-Type' => 'application/json',
         'x-li-format' => 'json',
     ];
@@ -138,21 +138,21 @@ public function setUseTokenParam($useTokenParam)
      *
      * @return array
      */
-    public function getDefaultApiHeaders()
+    public function getApiHeaders()
     {
-        return $this->defaultApiHeaders;
+        return $this->apiHeaders;
     }
 
     /**
      * Set list of default headers
      *
-     * @param array $defaultApiHeaders
+     * @param array $apiHeaders
      *
      * @return Client
      */
-    public function setDefaultApiHeaders($defaultApiHeaders)
+    public function setApiHeaders($apiHeaders)
     {
-        $this->defaultApiHeaders = $defaultApiHeaders;
+        $this->apiHeaders = $apiHeaders;
         return $this;
     }
 
@@ -290,20 +290,11 @@ public function getAccessToken($code = '')
             ]);
             try {
                 $response = $guzzle->get($uri);
-            } catch (RequestException $requestException) {
-                $json = self::responseToArray(
-                    $requestException->getResponse()
-                );
-                throw new Exception(
-                    $requestException->getMessage(),
-                    $requestException->getCode(),
-                    $requestException,
-                    static::extractErrorDescription($json)
-                );
+            } catch (RequestException $exception) {
+                throw Exception::fromRequestException($exception);
             }
-            $json = self::responseToArray($response);
             $this->setAccessToken(
-                AccessToken::fromResponseArray($json)
+                AccessToken::fromResponse($response)
             );
         }
         return $this->accessToken;
@@ -316,7 +307,7 @@ public function getAccessToken($code = '')
      *
      * @return array
      */
-    protected static function responseToArray($response)
+    public static function responseToArray($response)
     {
         return \GuzzleHttp\json_decode(
             $response->getBody()->getContents(),
@@ -491,7 +482,7 @@ protected function buildUrl($endpoint, $params)
      */
     public function api($endpoint, array $params = [], $method = Method::GET)
     {
-        $headers = $this->getDefaultApiHeaders();
+        $headers = $this->getApiHeaders();
         $uri = $endpoint;
         $options = [];
         if ($this->isUsingTokenParam()) {
@@ -524,34 +515,12 @@ public function api($endpoint, array $params = [], $method = Method::GET)
         try {
             $response = $guzzle->request($method, $uri, $options);
         } catch (RequestException $requestException) {
-            $json = self::responseToArray(
-                $requestException->getResponse()
-            );
-            throw new Exception(
-                $requestException->getMessage(),
-                $requestException->getCode(),
-                $requestException,
-                static::extractErrorDescription($json)
-            );
+            throw Exception::fromRequestException($requestException);
         }
         return self::responseToArray($response);
     }
 
-    /**
-     * @param $json
-     *
-     * @return null|string
-     */
-    private static function extractErrorDescription($json)
-    {
-        if (isset($json['error_description'])) {
-            return $json['error_description'];
-        } elseif (isset($json['message'])) {
-            return $json['message'];
-        } else {
-            return null;
-        }
-    }
+
 
     /**
      * Make API call to LinkedIn using GET method

src/Exception.php

@@ -16,6 +16,8 @@
 
 namespace LinkedIn;
 
+use GuzzleHttp\Exception\RequestException;
+
 /**
  * Class Exception
  * @package LinkedIn
@@ -40,7 +42,7 @@ public function __construct(
         $message = "",
         $code = 0,
         $previousException = null,
-        $description
+        $description = ''
     ) {
         parent::__construct($message, $code, $previousException);
         $this->description = $description;
@@ -55,4 +57,38 @@ public function getDescription()
     {
         return $this->description;
     }
+
+    /**
+     * @param RequestException $exception
+     *
+     * @return self
+     */
+    public static function fromRequestException($exception)
+    {
+        return new static(
+            $exception->getMessage(),
+            $exception->getCode(),
+            $exception,
+            static::extractErrorDescription($exception)
+        );
+    }
+
+    /**
+     * @param RequestException $exception
+     *
+     * @return null|string
+     */
+    private static function extractErrorDescription($exception)
+    {
+        $json = Client::responseToArray(
+            $exception->getResponse()
+        );
+        if (isset($json['error_description'])) {
+            return $json['error_description'];
+        } elseif (isset($json['message'])) {
+            return $json['message'];
+        } else {
+            return null;
+        }
+    }
 }