Add ability to override API root and headers list

Author: zoonman

README.md

@@ -150,8 +150,9 @@ $client->get('ENDPOINT', ['param' => 'value']);
 $client->post('ENDPOINT', ['param' => 'value']);
 ```
 
+#### Examples
 
-To perform api call to get profile information
+Perform api call to get profile information
 
 ```php
 $profile = $client->get(
@@ -160,7 +161,7 @@ $profile = $client->get(
 print_r($profile);
 ```
 
-To list companies where you are an admin
+List companies where you are an admin
 
 ```php
 $profile = $client->get(
@@ -170,7 +171,7 @@ $profile = $client->get(
 print_r($profile);
 ```
 
-To share content on a personal profile
+Share content on a personal profile
 
 ```php
 $share = $client->post(
@@ -190,6 +191,46 @@ $share = $client->post(
 );
 ```
 
+Share content on a LinkedIn business page
+
+```php
+// set sandboxed company page to work with
+// you can check updates at
+// 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'
+        ]
+    ]
+);
+```
+
+Setup custom API request headers
+
+```php
+$client->setDefaultApiHeaders([
+  'Content-Type' => 'application/json',
+  'x-li-format' => 'json',
+  'x-li-src' => 'msdk' // set a src header to "msdk" to mimic a mobile SDK
+]);
+```
+
+Change default API root
+
+```php
+$client->setApiRoot('https://api.linkedin.com/v2/');
+```
 
 ## Contributing
 

src/Client.php

@@ -30,8 +30,14 @@
 class Client
 {
 
+    /**
+     * Grant type
+     */
     const OAUTH2_GRANT_TYPE = 'authorization_code';
 
+    /**
+     * Response type
+     */
     const OAUTH2_RESPONSE_TYPE = 'code';
 
     /**
@@ -63,11 +69,103 @@ class Client
     protected $redirectUrl;
 
     /**
+     * Default authorization URL
      * string
      */
     const OAUTH2_API_ROOT = 'https://www.linkedin.com/oauth/v2/';
+
+    /**
+     * Default API root URL
+     * string
+     */
     const API_ROOT = 'https://api.linkedin.com/v1/';
 
+    /**
+     * API Root URL
+     *
+     * @var string
+     */
+    protected $apiRoot = self::API_ROOT;
+
+    /**
+     * OAuth API URL
+     *
+     * @var string
+     */
+    protected $oAuthApiRoot = self::OAUTH2_API_ROOT;
+
+    /**
+     * List of default headers
+     * @var array
+     */
+    protected $defaultApiHeaders = [
+        'Content-Type' => 'application/json',
+        'x-li-format' => 'json'
+    ];
+
+    /**
+     * Get list of headers
+     * @return array
+     */
+    public function getDefaultApiHeaders()
+    {
+        return $this->defaultApiHeaders;
+    }
+
+    /**
+     * Set list of default headers
+     * @param array $defaultApiHeaders
+     *
+     * @return Client
+     */
+    public function setDefaultApiHeaders($defaultApiHeaders)
+    {
+        $this->defaultApiHeaders = $defaultApiHeaders;
+        return $this;
+    }
+
+    /**
+     * Obtain API root URL
+     * @return string
+     */
+    public function getApiRoot()
+    {
+        return $this->apiRoot;
+    }
+
+    /**
+     * Specify API root URL
+     * @param string $apiRoot
+     *
+     * @return Client
+     */
+    public function setApiRoot($apiRoot)
+    {
+        $this->apiRoot = $apiRoot;
+        return $this;
+    }
+
+    /**
+     * Get OAuth API root
+     * @return string
+     */
+    public function getOAuthApiRoot()
+    {
+        return $this->oAuthApiRoot;
+    }
+
+    /**
+     * Set OAuth API root
+     * @param string $oAuthApiRoot
+     *
+     * @return Client
+     */
+    public function setOAuthApiRoot($oAuthApiRoot)
+    {
+        $this->oAuthApiRoot = $oAuthApiRoot;
+        return $this;
+    }
+
     /**
      * Client constructor.
      *
@@ -81,6 +179,7 @@ public function __construct($clientId = '', $clientSecret = '')
     }
 
     /**
+     * Get ClientId
      * @return string
      */
     public function getClientId()
@@ -89,6 +188,7 @@ public function getClientId()
     }
 
     /**
+     * Set ClientId
      * @param string $clientId
      *
      * @return Client
@@ -100,6 +200,7 @@ public function setClientId($clientId)
     }
 
     /**
+     * Get Client Secret
      * @return string
      */
     public function getClientSecret()
@@ -108,6 +209,7 @@ public function getClientSecret()
     }
 
     /**
+     * Set Client Secret
      * @param string $clientSecret
      *
      * @return Client
@@ -140,7 +242,7 @@ public function getAccessToken($code = '')
             ];
             $uri = $this->buildUrl('accessToken', $params);
             $guzzle = new GuzzleClient([
-               'base_uri' => self::OAUTH2_API_ROOT,
+               'base_uri' => $this->getOAuthApiRoot(),
                'headers' => [
                     'Content-Type' => 'application/json',
                     'x-li-format' => 'json'
@@ -169,7 +271,7 @@ public function getAccessToken($code = '')
     }
 
     /**
-     *
+     * Convert API response into Array
      *
      * @param \Psr\Http\Message\ResponseInterface $response
      *
@@ -203,6 +305,8 @@ public function setAccessToken($accessToken)
     }
 
     /**
+     * Retrieve current active scheme
+     *
      * @return string
      */
     protected function getCurrentScheme()
@@ -215,6 +319,7 @@ protected function getCurrentScheme()
     }
 
     /**
+     * Get current URL
      * @return string
      */
     public function getCurrentUrl()
@@ -225,6 +330,7 @@ public function getCurrentUrl()
     }
 
     /**
+     * Get unique state or specified state
      * @return string
      */
     public function getState()
@@ -241,7 +347,8 @@ public function getState()
     }
 
     /**
-     * @param mixed $state
+     * Set State
+     * @param string $state
      *
      * @return Client
      */
@@ -252,6 +359,9 @@ public function setState($state)
     }
 
     /**
+     * Retrieve URL which will be used to send User to LinkedIn
+     * for authentication
+     *
      * @param array  $scope       Permissions that your application requires
      *
      * @return string
@@ -310,9 +420,10 @@ public function setRedirectUrl($redirectUrl)
      */
     protected function buildUrl($endpoint, $params)
     {
-        $scheme = parse_url(self::OAUTH2_API_ROOT, PHP_URL_SCHEME);
-        $authority = parse_url(self::OAUTH2_API_ROOT, PHP_URL_HOST);
-        $path = parse_url(self::OAUTH2_API_ROOT, PHP_URL_PATH);
+        $url = $this->getOAuthApiRoot();
+        $scheme = parse_url($url, PHP_URL_SCHEME);
+        $authority = parse_url($url, PHP_URL_HOST);
+        $path = parse_url($url, PHP_URL_PATH);
         $path .= trim($endpoint, '/');
         $fragment = '';
         $uri = Uri::composeComponents(
@@ -336,13 +447,11 @@ protected function buildUrl($endpoint, $params)
      */
     public function api($endpoint, array $params = array(), $method = Method::GET)
     {
+        $headers = $this->getDefaultApiHeaders();
+        $headers['Authorization'] = 'Bearer ' . $this->accessToken->getToken();
         $guzzle = new GuzzleClient([
-            'base_uri' => self::API_ROOT,
-            'headers' => [
-                'Authorization' => 'Bearer ' . $this->accessToken->getToken(),
-                'Content-Type' => 'application/json',
-                'x-li-format' => 'json'
-            ]
+            'base_uri' => $this->getApiRoot(),
+            'headers' => $headers
         ]);
         $uri = $endpoint;
         $options = [];
@@ -382,6 +491,11 @@ public function api($endpoint, array $params = array(), $method = Method::GET)
         return self::responseToArray($response);
     }
 
+    /**
+     * @param $json
+     *
+     * @return null|string
+     */
     private static function extractErrorDescription($json)
     {
       if (isset($json['error_description'])) {