linkedin 0.1.0 → 0.1.1

data/README.markdown

@@ -1,9 +1,61 @@
-# linkedin
+# LinkedIn
+
+Ruby wrapper for the [LinkedIn API](http://developer.linkedin.com). Heavily inspired by [John Nunemaker's](http://github.com/jnunemaker) [Twitter gem](http://github.com/jnunemaker/twitter), the LinkedIn gem provides an easy-to-use wrapper for LinkedIn's Oauth/XML APIs.
+
+## Installation
+
+    sudo gem install gemcutter
+    gem tumble
+    sudo gem install linkedin
+    
+## Usage
+
+### Authenticate
+
+LinkedIn's API uses Oauth for authentication. Luckily, the LinkedIn gem hides most of the gory details from you.
+
+    require 'rubygems'
+    require 'linkedin'
+
+    # get your api keys at https://www.linkedin.com/secure/developer
+    client = LinkedIn::Client.new('your_consumer_key', 'your_consumer_secret')
+    rtoken = client.request_token.token
+    rsecret = client.request_token.secret
+
+    # to test from your desktop, open the following url in your browser
+    # and record the pin it gives you
+    client.request_token.authorize_url
+    => "https://api.linkedin.com/uas/oauth/authorize?oauth_token=<generated_token>"
+
+    # then fetch your access keys
+    client.authorize_from_request(rtoken, rsecret, pin)
+    => ["OU812", "8675309"] # <= save these for future requests
+
+    # or authorize from previously fetched access keys
+    c.authorize_from_access("OU812", "8675309")
+
+    # you're now free to move about the cabin, call any API method
+
+### Profile examples
+
+    # get the profile for the authenticated user
+    client.profile
+
+    # get a profile for someone found in network via ID
+    client.profile(:id => 'gNma67_AdI')
+
+    # get a profile for someone via their public profile url
+    client.profile(:url => 'http://www.linkedin.com/in/netherland')
+    
+
+
+More examples in the [examples folder](http://github.com/pengwynn/linkedin/blob/master/examples).
+
 
-Ruby wrapper for the [LinkedIn API](http://developer.linkedin.com)
 
 ## TODO
-* Implement Search, Status, Invitation APIs
+
+* Implement Messaging APIs
 
 ## Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/examples/authenticate.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'linkedin'
+
+# get your api keys at https://www.linkedin.com/secure/developer
+client = LinkedIn::Client.new('your_consumer_key', 'your_consumer_secret')
+rtoken = client.request_token.token
+rsecret = client.request_token.secret
+
+# to test from your desktop, open the following url in your browser
+# and record the pin it gives you
+client.request_token.authorize_url
+=> "https://api.linkedin.com/uas/oauth/authorize?oauth_token=<generated_token>"
+
+# then fetch your access keys
+client.authorize_from_request(rtoken, rsecret, pin)
+=> ["OU812", "8675309"] # <= save these for future requests
+
+# or authorize from previously fetched access keys
+c.authorize_from_access("OU812", "8675309")
+
+# you're now free to move about the cabin, call any API method 

data/examples/network.rb

@@ -0,0 +1,12 @@
+# AUTHENTICATE FIRST found in examples/authenticate.rb
+
+# client is a LinkedIn::Client
+
+# get network updates for the authenticated user
+client.network_updates
+
+# get profile picture changes
+client.network_updates(:type => 'PICT')
+
+# view connections for the currently authenticated user
+client.connections

data/examples/profile.rb

@@ -0,0 +1,14 @@
+# AUTHENTICATE FIRST found in examples/authenticate.rb
+
+# client is a LinkedIn::Client
+
+# get the profile for the authenticated user
+client.profile
+
+# get a profile for someone found in network via ID
+client.profile(:id => 'gNma67_AdI')
+
+# get a profile for someone via their public profile url
+client.profile(:url => 'http://www.linkedin.com/in/netherland')
+
+

data/examples/status.rb

@@ -0,0 +1,9 @@
+# AUTHENTICATE FIRST found in examples/authenticate.rb
+
+# client is a LinkedIn::Client
+
+# update status for the authenticated user
+client.update_status('is playing with the LinkedIn Ruby gem')
+
+# clear status for the currently logged in user
+client.clear_status

data/examples/wynn.rb

@@ -0,0 +1,10 @@
+require 'lib/linkedin'
+c = LinkedIn::Client.new('shSB1C3K_Xq0xZ0U9w2VqSoKYhv2ISwFfNpdgrU4rGX3uiaNwbeCYifuGBlJvIc1', 'Xy8dprsITio46xj4jonNE27ZyNILSbHmMVDN1aEzRWVQk-eHJ2aXIkk8vwZUSgJd')
+c.authorize_from_access("74f09d7b-3a41-4a01-8c6e-2b1072a046bc", "fcc8399e-3453-4328-9fe8-42021b73a110")
+
+require 'lib/linkedin'
+xml = File.open("test/fixtures/profile_full.xml", "r").read
+p = LinkedIn::Profile.from_xml(xml)
+
+
+

data/lib/linked_in/client.rb

@@ -29,7 +29,7 @@ module LinkedIn
     end
     
     # For web apps use params[:oauth_verifier], for desktop apps,
-    # use the verifier is the pin that twitter gives users.
+    # use the verifier is the pin that LinkedIn gives users.
     def authorize_from_request(rtoken, rsecret, verifier_or_pin)
       request_token = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
       access_token = request_token.get_access_token(:oauth_verifier => verifier_or_pin)
@@ -88,7 +88,7 @@ module LinkedIn
         if options[:public] 
           path +=":public"
         else
-          path +=":(#{options[:fields].map{|f| f.to_s}.join(',')})"
+          path +=":(#{options[:fields].map{|f| f.to_s.gsub("_","-")}.join(',')})"
         end
       end
       
@@ -145,15 +145,25 @@ module LinkedIn
       end
       
       def raise_errors(response)
+        # Even if the XML answer contains the HTTP status code, LinkedIn also sets this code
+        # in the HTTP answer (thankfully).
         case response.code.to_i
+          when 400
+            data = LinkedIn::Error.from_xml(response.body)
+            raise RateLimitExceeded.new(data), "(#{response.code}): #{response.message} - #{data.code if data}"
+          when 401
+            data = LinkedIn::Error.from_xml(response.body)
+            raise Unauthorized.new(data), "(#{response.code}): #{response.message} - #{data.code if data}"
+          when 403
+            data = LinkedIn::Error.from_xml(response.body)
+            raise General.new(data), "(#{response.code}): #{response.message} - #{data.code if data}"
+          when 404
+            raise NotFound, "(#{response.code}): #{response.message}"
+          when 500
+            raise InformLinkedIn, "LinkedIn had an internal error. Please let them know in the forum. (#{response.code}): #{response.message}"
           when 502..503
             raise Unavailable, "(#{response.code}): #{response.message}"
         end
-        
-        if response.body && response.body.include?("<error>")
-          error = LinkedIn::Error.from_xml(response.body)
-          Raise LinkedInError, "(#{error.status}): #{error.code} - #{error.message}"
-        end
       end
       
       def format_options_for_query(opts)

data/lib/linkedin.rb

@@ -38,6 +38,7 @@ require File.join(directory, 'linked_in', 'url_resource')
 require File.join(directory, 'linked_in', 'company')
 require File.join(directory, 'linked_in', 'country')
 require File.join(directory, 'linked_in', 'education')
+require File.join(directory, 'linked_in', 'error')
 require File.join(directory, 'linked_in', 'location')
 require File.join(directory, 'linked_in', 'position')
 require File.join(directory, 'linked_in', 'profile')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: linkedin
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Wynn Netherland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-25 00:00:00 -06:00
+date: 2009-12-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,11 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- examples/authenticate.rb
+- examples/network.rb
+- examples/profile.rb
+- examples/status.rb
+- examples/wynn.rb
 - lib/linked_in/api_standard_profile_request.rb
 - lib/linked_in/client.rb
 - lib/linked_in/company.rb
@@ -156,3 +161,7 @@ test_files:
 - test/client_test.rb
 - test/oauth_test.rb
 - test/test_helper.rb
+- examples/authenticate.rb
+- examples/network.rb
+- examples/profile.rb
+- examples/status.rb