Token updates, added license, doc update

Author: zoonman

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Philipp Tkachev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,6 @@
-LinkedIn API Client with OAuth 2 authorization witten on PHP
+LinkedIn API Client with OAuth 2 authorization written on PHP
 ============================================================
-[![Build Status](https://travis-ci.org/zoonman/linkedin-client.svg)](https://travis-ci.org/zoonman/linkedin-client) [![Code Climate](https://codeclimate.com/github/zoonman/linkedin-client/badges/gpa.svg)](https://codeclimate.com/github/zoonman/linkedin-client) [![Packagist](https://img.shields.io/packagist/dt/zoonman/linkedin-client.svg)](https://packagist.org/packages/zoonman/linkedin-client) [![GitHub license](https://img.shields.io/github/license/zoonman/linkedin-client.svg)](https://github.com/zoonman/linkedin-client/LICENSE.md)
+[![Build Status](https://travis-ci.org/zoonman/linkedin-client.svg)](https://travis-ci.org/zoonman/linkedin-api-php-client) [![Code Climate](https://codeclimate.com/github/zoonman/linkedin-api-php-client/badges/gpa.svg)](https://codeclimate.com/github/zoonman/linkedin-api-php-client) [![Packagist](https://img.shields.io/packagist/dt/zoonman/linkedin-api-php-client.svg)](https://packagist.org/packages/zoonman/linkedin-api-php-client) [![GitHub license](https://img.shields.io/github/license/zoonman/linkedin-api-php-client.svg)](https://github.com/zoonman/linkedin-api-php-client/LICENSE.md)
 
 
 
@@ -49,23 +49,30 @@ $client = new Client(
 
 #### Getting local redirect URL
 
-Get current redirect url use
+To start linking process you have to setup redirect url. 
+You can set your own or use current one.
+SDK provides you a `getRedirectUrl()` helper for your convenience:
 
 ```php
-$client->getRedirectUrl();
+$redirectUrl = $client->getRedirectUrl();
 ```
 
+We recommend you to have it stored during the linking session 
+because you will need to use it when you will be getting access token.
 
 #### Setting local redirect URL 
 
-To set redirect url use
+Set a custom redirect url use:
 
 ```php
 $client->setRedirectUrl('http://your.domain.tld/path/to/script/');
 ```
 
 #### Getting LinkedIn redirect URL 
 
+In order of performing OAUTH 2.0 flow, you should get LinkedIn login URL.
+During this procedure you have to define scope of requested permissions.
+Use `Scope` enum class to get scope names.
 To get redirect url to LinkedIn, use the following approach:
 
 ```php
@@ -76,9 +83,11 @@ $scopes = [
     'rw_company_admin',
     'w_share',
 ];
-$loginUrl = $client->getLoginUrl(); // get url on LinkedIn to start linking
+$loginUrl = $client->getLoginUrl($scopes); // get url on LinkedIn to start linking
 ```
 
+Now you can take user to LinkedIn. You can use link or rely on Location HTTP header.
+
 #### Getting Access Token 
 
 To get access token use (don't forget to set redirect url)
@@ -99,6 +108,17 @@ $profile = $client->api(
 );
 ```
 
+There are two helper methods:
+
+```php
+// get method
+$client->get('ENDPOINT', ['param' => 'value']);
+
+//post
+$client->post('ENDPOINT', ['param' => 'value']);
+```
+
+
 To perform api call to get profile information
 
 ```php
@@ -108,31 +128,42 @@ $profile = $client->get(
 print_r($profile);
 ```
 
-To list companies where you an admin
+To list companies where you are an admin
 
 ```php
 $profile = $client->get(
-    'people/~:(id,email-address,first-name,last-name)'
+    'companies',
+    ['is-company-admin' => true]
 );
 print_r($profile);
 ```
 
-To share content
+To share content on a personal profile
 
 ```php
 $share = $client->post(
-                'people/~/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'
-                    ]
-                ]
-            );
+    'people/~/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'
+        ]
+    ]
+);
 ```
+
+
+## Contributing
+
+Please, open PR with your changes linked to an GitHub issue.
+You code must follow [PSR](http://www.php-fig.org/psr/) standards and have PHPUnit tests. 
+
+## License
+
+[MIT](LICENSE.md)

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "zoonman/linkedin-client",
+    "name": "zoonman/linkedin-api-php-client",
     "description": "Client for LinkedIn API v2",
     "type": "library",
     "require": {

src/AccessToken.php

@@ -30,20 +30,30 @@ class AccessToken
     protected $token;
 
     /**
+     * When token will expire.
+     *
+     * Please, pay attention that LinkedIn API always returns "expires in" time,
+     * which is amount of seconds before token will expire since now.
+     * If you are going to store token somewhere, you have to keep "expires at"
+     * or two values - "expires in" and "token created".
+     * Using "expires at" approach lets you have efficient queries to find
+     * tokens will soon expire and be proactive with regards to your
+     * B2C communication.
+     *
      * @var int
      */
-    protected $expiresIn;
+    protected $expiresAt;
 
     /**
      * AccessToken constructor.
      *
      * @param string $token
-     * @param int    $expiresIn
+     * @param int    $expiresAt
      */
-    public function __construct($token = '', $expiresIn = 0)
+    public function __construct($token = '', $expiresAt = 0)
     {
         $this->setToken($token);
-        $this->setExpiresIn($expiresIn);
+        $this->setExpiresAt($expiresAt);
     }
 
     /**
@@ -76,7 +86,7 @@ public function setToken($token)
      */
     public function getExpiresIn()
     {
-        return $this->expiresIn;
+        return $this->expiresAt - time();
     }
 
     /**
@@ -88,7 +98,7 @@ public function getExpiresIn()
      */
     public function setExpiresIn($expiresIn)
     {
-        $this->expiresIn = $expiresIn;
+        $this->expiresAt = $expiresIn + time();
         return $this;
     }
 
@@ -103,6 +113,27 @@ public function __toString()
     }
 
     /**
+     * @return int
+     */
+    public function getExpiresAt()
+    {
+        return $this->expiresAt;
+    }
+
+    /**
+     * @param int $expiresAt
+     *
+     * @return AccessToken
+     */
+    public function setExpiresAt($expiresAt)
+    {
+        $this->expiresAt = $expiresAt;
+        return $this;
+    }
+
+    /**
+     * Instantiate token object
+     *
      * @param $responseArray
      *
      * @return \LinkedIn\AccessToken
@@ -126,7 +157,7 @@ public static function fromResponseArray($responseArray)
         }
         return new static(
             $responseArray['access_token'],
-            $responseArray['expires_in']
+            $responseArray['expires_in'] + time()
         );
     }
 }