Merge pull request ozgur#1 from ozgur/linkedin_oauth2

LinkedIn OAuth 2.0 Implementation

Author: ozgur

README.md

@@ -3,11 +3,8 @@ Python LinkedIn
 
 Python interface to the LinkedIn API
 
-.. image:: https://travis-ci.org/ozgur/python-linkedin.png?branch=master
-   :target: https://travis-ci.org/ozgur/python-linkedin
 
-
-This library provides a pure python interface for the LinkedIn **Connection**, **Profile**, **Search**, **Status**, **Messaging** and **Invitation** APIs.
+This library provides a pure Python interface to the LinkedIn **Profile**, **Group**, **Company**, **Jobs**, **Search**, **Share**, **Network** and **Invitation** REST APIs.
 
 `LinkedIn <http://developer.linkedin.com>`_ provides a service that lets people bring their LinkedIn profiles and networks with them to your site or application via their OAuth based API. This library provides a lightweight interface over a complicated LinkedIn OAuth based API to make it for python programmers easy to use.
 
@@ -20,9 +17,13 @@ You can install **python-linkedin** library via pip:
 
     $ pip install python-linkedin
 
-API Keys
---------------------
-In order to use the LinkedIn API, you have an **application key** and **application secret**. For debugging purposes I can provide you those. You can use the following as api key and secret:
+Authentication
+-----------------------
+
+LinkedIn REST API uses **Oauth 2.0** protocol for authentication. In
+order to use the LinkedIn API, you have an **application key** and **application secret**. You can get more detail from `here <http://developers.linkedin.com/documents/authentication>`_.
+
+For debugging purposes you can use the credentials below. It belongs to my test application. Nothing's harmful.
 
 .. code-block:: python
 
@@ -32,102 +33,51 @@ In order to use the LinkedIn API, you have an **application key** and **applicat
 You can also get those keys from `here <http://developer.linkedin.com/rest>`_.
 
 
-Quick Usage From Python Interpreter
----------------------------------------------------------
-
-For testing the library using an interpreter, use the quick helper.
-
-.. code-block:: python
-
-    from linkedin import helper
-    api = helper.quick_api(<Your KEY>, <Your SECRET>)
-
-This will print a url to the screen. Go into this URL using a browser, after you login, the method will return with an API object you can now use.
-
-.. code-block:: python
-
-    api.get_profile()
-
-Usage
-------------
-
-You can use **http://localhost** as the return url. Return URL is a url where LinkedIn redirects the user after he/she grants access to your application.
+LinkedIn redirects the user back to your website's URL after granting access (giving proper permissions) to your application. We call that url **RETURN URL**. Assuming your return url is **http://localhost:8000**, you can write something like this:
 
 .. code-block:: python
 
     from linkedin import linkedin
 
-    RETURN_URL = 'http://localhost'
-    api = linkedin.LinkedIn(<Your KEY>, <Your SECRET>, RETURN_URL)
-    result = api.request_token()
-    if result is True:
-        api.get_authorize_url() # open this url on your browser
+    API_KEY = 'wFNJekVpDCJtRPFX812pQsJee-gt0zO4X5XmG6wcfSOSlLocxodAXNMbl0_hw3Vl'
+    API_SECRET = 'daJDa6_8UcnGMw1yuq9TjoO_PMKukXMo8vEMo7Qv5J-G3SPgrAV0FqFCd0TNjQyG'
+    RETURN_URL = 'http://localhost:8000'
+    authentication = linkedin.LinkedInAuthentication(API_KEY, API_SECRET, RETURN_URL, linkedin.PERMISSIONS.enums.values())
+    print authentication.authorization_url # Open this url with your browser
+    application = linkedin.LinkedInApplication(authentication)
 
-When you grant access to the application, you will be redirected to the return url with the following query strings appended to your RETURN_URL:
+When you grant access to the application, you will be redirected to the return url with the following query strings appended to your **RETURN_URL**:
 
 .. code-block:: python
 
-    http://localhost/?oauth_token=0b27806e-feec-41d4-aac5-619ba43770f1&oauth_verifier=04874"
+    "http://localhost:8000/?code=AQTXrv3Pe1iWS0EQvLg0NJA8ju_XuiadXACqHennhWih7iRyDSzAm5jaf3R7I8&state=ea34a04b91c72863c82878d2b8f1836c"
 
 
-This means that the **auth_verifier** value is 04874. After you get the verifier, you call the **.access_token()** method to get the access token.
+This means that the value of the **authorization_code** is **AQTXrv3Pe1iWS0EQvLg0NJA8ju_XuiadXACqHennhWih7iRyDSzAm5jaf3R7I8**. After setting it by hand, we can call the **.get_access_token()** to get the actual token.
 
 .. code-block:: python
 
-    result = api.access_token(verifier='04874')
-    if result is True:
-        profile = api.get_profile()
-        print profile.id
+    authentication.authorization_code = 'AQTXrv3Pe1iWS0EQvLg0NJA8ju_XuiadXACqHennhWih7iRyDSzAm5jaf3R7I8'
+    authentication.get_access_token()
 
-If you know your public url, call the method above with your public url for more information.
 
-.. code-block:: python
-
-    profile = api.get_profile(member_id=None, url='http://www.linkedin.com/in/ozgurv')
-    print profile.id, profile.first_name, profile.last_name, profile.picture_url
-
-To fetch your connections, simply call:
-
-.. code-block:: python
-
-    connections = api.get_connections()
-
-You can set/clear your status by calling **.set_status()** or **.clear_status()** methods. If you get False as the result, you can get the error by calling **.get_error()** method. Status message should be less than 140 characters. If it is too long, it is shortened. For more information, you can take a look at `DOC-1007 <http://developer.linkedin.com/docs/DOC-1007>`_
-
-.. code-block:: python
-
-    result = api.set_status('This is my status.')
-    result = api.clear_status()
-
-You can send a message to yourself or your connections' inboxes by simply calling **.send_message()** method. You can send your message at most 10 connections at a time. If you give more than ten IDs, the IDs after 10th one are ignored. For more information, you can take a look at `DOC-1044 <http://developer.linkedin.com/docs/DOC-1044>`_.
-
-.. code-block:: python
-
-    result = api.send_message('This is a subject', 'This is the body')
-    if result is False:
-        print api.get_error()
-    u'Missing {mailbox-item/recipients/recipient} element'
+Quick Usage From Python Interpreter
+---------------------------------------------------------
 
-You can set the parameter **send_yourself** to True, so you can send the message to yourself.
+For testing the library using an interpreter, use the quick helper.
 
 .. code-block:: python
 
-    api.send_message('This is a subject', 'This is the body', ['ID1', 'ID2', 'ID3'], send_yourself=True)
+    from linkedin import server
+    application = server.quick_api(<Your KEY>, <Your SECRET>)
 
-You can send an invitation to your friend's email to invite them to join your LinkedIn network by simply calling **.send_invitation()** method.
+This will print the authorization url to the screen. Go into this URL using a browser, after you login, the method will return with an API object you can now use.
 
 .. code-block:: python
 
-    result = api.send_invitation('This is a subject', 'Join to my network', 'Ozgur', 'Vatansever', '[email protected]')
-    print result
-    True
-
-    result = api.send_invitation('This is a subject', 'Join to my network', 'Ozgur', 'Vatansever', 'ozgurvt')
-    if result is False:
-        print api.get_error()
-    u'Invalid argument(s): {emailAddress=invalid_email [ozgurvt]}'
+    api.get_profile()
 
-Throttle Limits
-----------------------------
 
-LinkedIn API keys are throttled by default. You should take a look at `DOC-1112 <http://developer.linkedin.com/docs/DOC-1112>`_ to get more information.
+More
+-----------------
+For more information, visit the `homepage <http://ozgur.github.com/python-linkedin/>`_ of the project.

README.rst

@@ -0,0 +1,12 @@
+from linkedin.linkedin import (LinkedInAuthentication, LinkedInApplication,
+                               PERMISSIONS)
+
+
+if __name__ == '__main__':
+    API_KEY = 'wFNJekVpDCJtRPFX812pQsJee-gt0zO4X5XmG6wcfSOSlLocxodAXNMbl0_hw3Vl'
+    API_SECRET = 'daJDa6_8UcnGMw1yuq9TjoO_PMKukXMo8vEMo7Qv5J-G3SPgrAV0FqFCd0TNjQyG'
+    RETURN_URL = 'http://localhost:8000'
+    authentication = LinkedInAuthentication(API_KEY, API_SECRET, RETURN_URL,
+                                            PERMISSIONS.enums.values())
+    print authentication.authorization_url
+    application = LinkedInApplication(authentication)

examples/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '1.8.1'
+__version__ = '2.0'
 VERSION = tuple(map(int, __version__.split('.')))

examples/authentication.py

@@ -0,0 +1,16 @@
+class BaseLinkedInError(Exception):
+    pass
+
+
+class LinkedInHTTPError(BaseLinkedInError):
+    pass
+
+
+class LinkedInError(BaseLinkedInError):
+    def __init__(self, error):
+        if 'error' in error:
+            Exception.__init__(self, u'%s: %s' % (error['error'],
+                                                  error['error_description']))
+        else:
+            Exception.__init__(self, u'%s: %s' % ('Request Error',
+                                                  error['message']))