cl_linkedin 0.2.3

data/lib/linkedin.rb

@@ -0,0 +1,83 @@
+require 'oauth'
+require 'nokogiri'
+
+require 'cgi'
+
+module LinkedIn
+  class LinkedInError < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+
+  class BadRequest     < LinkedInError; end
+  class Unauthorized   < LinkedInError; end
+  class Forbidden      < LinkedInError; end
+  class NotFound       < LinkedInError; end
+
+  class Unavailable    < StandardError; end
+  class InformLinkedIn < StandardError; end
+
+
+  class << self
+    attr_accessor :token, :secret, :default_profile_fields
+
+    # config/initializers/linkedin.rb (for instance)
+    #
+    # LinkedIn.configure do |config|
+    #   config.token = 'consumer_token'
+    #   config.secret = 'consumer_secret'
+    # end
+    #
+    # elsewhere
+    #
+    # client = LinkedIn::Client.new
+    def configure
+      yield self
+      true
+    end
+  end
+
+end
+
+
+require 'linked_in/base'
+
+require 'linked_in/to_xml_helpers'
+require 'linked_in/request_helpers'
+require 'linked_in/authorization_helpers'
+
+require 'linked_in/api_standard_profile_request'
+require 'linked_in/url_resource'
+require 'linked_in/company'
+require 'linked_in/country'
+require 'linked_in/education'
+require 'linked_in/error'
+require 'linked_in/location'
+require 'linked_in/position'
+require 'linked_in/profile'
+require 'linked_in/update'
+require 'linked_in/network'
+require 'linked_in/people'
+require 'linked_in/connections'
+require 'linked_in/client'
+require 'linked_in/person'
+require 'linked_in/recipient'
+require 'linked_in/recipients'
+require 'linked_in/message'
+require 'linked_in/group'
+require 'linked_in/birthdate'
+require 'linked_in/recommendations'
+require 'linked_in/current_share'
+require 'linked_in/short_profile'
+require 'linked_in/phone_number'
+require 'linked_in/languages'
+require 'linked_in/likes'
+require 'linked_in/skill'
+require 'linked_in/publications'
+require 'linked_in/patents'
+require 'linked_in/twitter_account'
+require 'linked_in/im_account'

data/linkedin.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{cl_linkedin}
+  s.version  = "0.2.3"
+  s.platform = Gem::Platform::RUBY
+
+  s.authors = ["Wynn Netherland", "Josh Kalderimis"]
+  s.email   = ["wynn.netherland@gmail.com", "josh.kalderimis@gmail.com"]
+
+  s.homepage    = %q{http://github.com/pengwynn/linkedin}
+  s.summary     = %q{Ruby wrapper for the LinkedIn API}
+  s.description = %q{Ruby wrapper for the LinkedIn API}
+
+  s.date = %q{2010-03-01}
+
+  s.rdoc_options  = ["--charset=UTF-8"]
+  s.extra_rdoc_files = ["README.markdown", "LICENSE"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<oauth>,       ["~> 0.4.0"])
+      s.add_runtime_dependency(%q<nokogiri>,    ["~> 1.4.4"])
+      s.add_development_dependency(%q<rspec>,   ["~> 2.4.0"])
+      s.add_development_dependency(%q<rake>,    ["~> 0.8.7"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.6.0"])
+    else
+      s.add_dependency(%q<oauth>,     ["~> 0.4.0"])
+      s.add_dependency(%q<nokogiri>,  ["~> 1.4.4"])
+      s.add_dependency(%q<rspec>,     ["~> 2.4.0"])
+      s.add_dependency(%q<rake>,      ["~> 0.8.7"])
+      s.add_dependency(%q<webmock>,   ["~> 1.6.0"])
+    end
+  else
+    s.add_dependency(%q<oauth>,     ["~> 0.4.0"])
+    s.add_dependency(%q<nokogiri>,  ["~> 1.4.4"])
+    s.add_dependency(%q<rspec>,     ["~> 2.4.0"])
+    s.add_dependency(%q<rake>,      ["~> 0.8.7"])
+    s.add_dependency(%q<webmock>,   ["~> 1.6.0"])
+  end
+end
+

data/spec/cases/client_spec.rb

@@ -0,0 +1,230 @@
+require 'spec_helper'
+
+describe LinkedIn::Client do
+  context "when hitting the LinkedIn API" do
+    before(:each) do
+      LinkedIn.token = nil
+      LinkedIn.secret = nil
+      LinkedIn.default_profile_fields = nil
+    end
+
+    let(:client) do
+      client = LinkedIn::Client.new('token', 'secret')
+      consumer = OAuth::Consumer.new('token', 'secret', {:site => 'https://api.linkedin.com'})
+      client.stub(:consumer).and_return(consumer)
+      client.authorize_from_access('atoken', 'asecret')
+      client
+    end
+
+    context "when the response is a 403" do
+      before { stub_get("/v1/people/~", "403.xml", 403) }
+
+      it "should raise that error correctly" do
+        expect { client.profile }.to raise_error(LinkedIn::Forbidden, "(403): Throttle limit for calls to this resource is reached. - 0") do |e|
+          e.data.message.should == "Throttle limit for calls to this resource is reached."
+        end
+      end
+    end
+
+    context "when the response is a 404" do
+      before { stub_get("/v1/people/~", "404.xml", 404) }
+
+      it "should raise that error correctly" do
+        expect { client.profile }.to raise_error(LinkedIn::NotFound, "(404): Could not find person based on: ~~ - 11") do |e|
+          e.data.message.should == "Could not find person based on: ~~"
+        end
+      end
+    end
+
+    describe "#profile" do
+      context "for the currently authenticated user" do
+        context "with all profile fields" do
+          before { stub_get("/v1/people/~", "profile_full.xml") }
+          let(:profile) { client.profile }
+
+          it_should_behave_like "a full profile fetch"
+        end
+
+        context "with field selection" do
+          it "should accept field selectors when retrieving a profile" do
+            stub_get("/v1/people/~:(first-name,last-name)", "profile.xml")
+
+            profile = client.profile(:fields => [:first_name, :last_name])
+            profile.first_name.should == 'Wynn'
+            profile.last_name.should == 'Netherland'
+          end
+        end
+
+        describe "#connections" do
+          it "should retrieve connections for the authenticated user" do
+            stub_get("/v1/people/~/connections", "connections.xml")
+
+            cons = client.connections
+            cons.size.should == 146
+            cons.last.last_name.should == 'Yuchnewicz'
+          end
+        end
+      end
+
+      context "by id" do
+        before { stub_get("/v1/people/id=gNma67_AdI", "profile_full.xml") }
+        let(:profile) { client.profile(:id => "gNma67_AdI") }
+
+        it_should_behave_like "a full profile fetch"
+      end
+
+      context "by url" do
+        before { stub_get("/v1/people/url=http%3A%2F%2Fwww.linkedin.com%2Fin%2Fnetherland", "profile_full.xml") }
+        let(:profile) { client.profile(:url => "http://www.linkedin.com/in/netherland") }
+
+        it_should_behave_like "a full profile fetch"
+      end
+    end
+
+    describe "#search" do
+      context "by single keyword" do
+        it "should perform a search" do
+          stub_get("/v1/people?keywords=github", "search.xml")
+
+          results = client.search(:keywords => 'github')
+          results.start.should == 0
+          results.count.should == 10
+          results.profiles.first.first_name.should == 'Zach'
+          results.profiles.first.last_name.should  == 'Inglis'
+        end
+      end
+
+      context "by multiple keywords" do
+        it "should perform a search" do
+          stub_get("/v1/people?keywords=ruby+rails", "search.xml")
+
+          results = client.search(:keywords => ["ruby", "rails"])
+          results.start.should == 0
+          results.count.should == 10
+          results.profiles.first.first_name.should == 'Zach'
+          results.profiles.first.last_name.should  == 'Inglis'
+        end
+      end
+
+      context "by name" do
+        it "should perform a search" do
+          stub_get("/v1/people?name=Zach+Inglis", "search.xml")
+
+          results = client.search(:name => "Zach Inglis")
+          results.start.should == 0
+          results.count.should == 10
+          results.profiles.first.first_name.should == 'Zach'
+          results.profiles.first.last_name.should  == 'Inglis'
+        end
+      end
+    end
+
+    describe "#update_status" do
+      it "should update a user's current status" do
+        stub_put("/v1/people/~/current-status", "blank.xml")
+
+        client.update_status("Testing out the LinkedIn API").code.should == "200"
+      end
+    end
+
+    describe "#update_network" do
+      it "should post to a user's network stream" do
+        stub_post("/v1/people/~/person-activities", "blank.xml")
+
+        client.update_network("Testing out the LinkedIn API").code.should == "201"
+      end
+    end
+
+    describe "#clear_status" do
+      it "should clear a user's current status" do
+        stub_delete("/v1/people/~/current-status", "blank.xml")
+
+        client.clear_status.should == "200"
+      end
+    end
+
+    describe "#current_status" do
+      it "should retrieve the authenticated user's current status" do
+        stub_get("/v1/people/~/current-status", "status.xml")
+
+        client.current_status.should == "New blog post: What makes a good API wrapper? http://wynnnetherland.com/2009/11/what-makes-a-good-api-wrapper/"
+      end
+    end
+
+    describe "#network_statuses" do
+      it "should retrieve status updates for the authenticated user's network" do
+        stub_get("/v1/people/~/network?type=STAT", "network_statuses.xml")
+
+        stats = client.network_statuses
+        stats.updates.first.timestamp.should == 1259179809524
+        stats.updates.first.should be_is_commentable
+        stats.updates.first.profile.id.should == "19408512"
+        stats.updates.first.profile.first_name.should == 'Vahid'
+        stats.updates.first.profile.connections.first.id.should == "28072758"
+        stats.updates.first.profile.connections.first.last_name.should == 'Varone'
+        stats.updates.first.likes.size.should == 2
+        stats.updates.first.likes.last.profile.first_name.should == 'Napoleon'
+        stats.updates.last.likes.should be_empty
+      end
+    end
+
+    describe "#network_updates" do
+      it "should retrieve network updates" do
+        stub_get("/v1/people/~/network?type=PICT", "picture_updates.xml")
+
+        stats = client.network_updates(:type => "PICT")
+        stats.updates.size.should == 4
+        stats.updates.last.profile.headline.should == "Creative Director for Intridea"
+      end
+    end
+
+    describe "#send_message" do
+      it "should send a message to recipients" do
+        stub_post("/v1/people/~/mailbox", "mailbox_items.xml")
+
+        recipients = ["~", "abcdefg"]
+        subject    = "Congratulations on your new position."
+        body       = "You're certainly the best person for the job!"
+
+        client.send_message(subject, body, recipients).should == "201"
+
+        expect_post("/v1/people/~/mailbox", "mailbox_items.xml")
+      end
+    end
+
+    describe "#share" do
+      it "should share a link" do
+        stub_post("/v1/people/~/shares", "blank.xml")
+
+        client.share({
+          :comment => "Testing out the LinkedIn API",
+          :title => "Share",
+          :url => "http://www.linkedin.com",
+          :image_url => "http://www.linkedin.com/pretty_logo.jpg"
+        }).code.should == "201"
+
+        expect_post("/v1/people/~/shares", "shares.xml")
+      end
+    end
+
+    describe "#likes" do
+      it "should retrieve likes for a network update" do
+        stub_get("/v1/people/~/network/updates/key=gNma67_AdI/likes","likes.xml")
+
+        likes = client.likes("gNma67_AdI")
+        likes.size.should == 2
+        likes.first.profile.first_name.should == "George"
+      end
+    end
+
+    describe "#like" do
+      it "should put a like to a network update" do
+        stub_put("/v1/people/~/network/updates/key=gNma67_AdI/is-liked","blank.xml", 201)
+
+        result = client.like("gNma67_AdI")
+        result.code.should == "201"
+      end
+    end
+
+  end
+end

data/spec/cases/linkedin_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe LinkedIn do
+
+  before(:each) do
+    LinkedIn.token = nil
+    LinkedIn.secret = nil
+    LinkedIn.default_profile_fields = nil
+  end
+
+  it "should be able to set the consumer token and consumer secret" do
+    LinkedIn.token = 'consumer_token'
+    LinkedIn.secret = 'consumer_secret'
+
+    LinkedIn.token.should == 'consumer_token'
+    LinkedIn.secret.should == 'consumer_secret'
+  end
+
+  it "should be able to set the default profile fields" do
+    LinkedIn.default_profile_fields = ['education', 'positions']
+
+    LinkedIn.default_profile_fields.should == ['education', 'positions']
+  end
+
+  it "should be able to set the consumer token and consumer secret via a configure block" do
+    LinkedIn.configure do |config|
+      config.token = 'consumer_token'
+      config.secret = 'consumer_secret'
+      config.default_profile_fields = ['education', 'positions']
+    end
+
+    LinkedIn.token.should == 'consumer_token'
+    LinkedIn.secret.should == 'consumer_secret'
+    LinkedIn.default_profile_fields.should == ['education', 'positions']
+  end
+
+end

data/spec/cases/oauth_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe "LinkedIn::Client OAuth" do
+  let(:client) { LinkedIn::Client.new('token', 'secret') }
+  
+  it "should initialize with consumer token and secret" do
+    client.ctoken.should == 'token'
+    client.csecret.should == 'secret'
+  end
+
+  it "should set authorization path to '/uas/oauth/authorize' by default" do
+    client.consumer.options[:authorize_path].should == '/uas/oauth/authorize'
+  end
+
+  it "should have a consumer" do
+    consumer = mock('oauth consumer')
+    options = {
+      :request_token_path => "/uas/oauth/requestToken",
+      :access_token_path  => "/uas/oauth/accessToken",
+      :authorize_path     => "/uas/oauth/authorize",
+      :site => 'https://api.linkedin.com'
+    }
+    OAuth::Consumer.should_receive(:new).with('token', 'secret', options).and_return(consumer)
+
+    client.consumer.should == consumer
+  end
+
+  it "should have a request token from the consumer" do
+    options = {
+      :request_token_path => "/uas/oauth/requestToken",
+      :access_token_path  => "/uas/oauth/accessToken",
+      :authorize_path     => "/uas/oauth/authorize",
+      :site => 'https://api.linkedin.com'
+    }
+    consumer = mock('oauth consumer')
+    request_token = mock('request token')
+    consumer.should_receive(:get_request_token).and_return(request_token)
+    OAuth::Consumer.should_receive(:new).with('token', 'secret', options).and_return(consumer)
+
+    client.request_token.should == request_token
+  end
+
+  it "#set_callback_url should clear the request token and set the callback url" do
+    consumer = mock('oauth consumer')
+    request_token = mock('request token')
+    options = {
+            :request_token_path => "/uas/oauth/requestToken",
+            :access_token_path  => "/uas/oauth/accessToken",
+            :authorize_path     => "/uas/oauth/authorize",
+            :site => 'https://api.linkedin.com'
+          }
+    OAuth::Consumer.
+      should_receive(:new).
+      with('token', 'secret', options).
+      and_return(consumer)
+
+    linkedin = LinkedIn::Client.new('token', 'secret')
+
+    consumer.
+      should_receive(:get_request_token).
+      with({:oauth_callback => 'http://myapp.com/oauth_callback'})
+
+    linkedin.set_callback_url('http://myapp.com/oauth_callback')
+  end
+
+  it "should be able to create access token from request token, request secret and verifier" do
+    consumer = OAuth::Consumer.new('token', 'secret', {:site => 'https://api.linkedin.com'})
+    client.stub(:consumer).and_return(consumer)
+
+    access_token  = mock('access token', :token => 'atoken', :secret => 'asecret')
+    request_token = mock('request token')
+    request_token.
+      should_receive(:get_access_token).
+      with(:oauth_verifier => 'verifier').
+      and_return(access_token)
+
+    OAuth::RequestToken.
+      should_receive(:new).
+      with(consumer, 'rtoken', 'rsecret').
+      and_return(request_token)
+
+    client.authorize_from_request('rtoken', 'rsecret', 'verifier')
+    client.access_token.class.should be(OAuth::AccessToken)
+    client.access_token.token.should == 'atoken'
+    client.access_token.secret.should == 'asecret'
+  end
+
+  it "should be able to create access token from access token and secret" do
+    consumer = OAuth::Consumer.new('token', 'secret', {:site => 'https://api.linkedin.com'})
+    client.stub(:consumer).and_return(consumer)
+
+    client.authorize_from_access('atoken', 'asecret')
+    client.access_token.class.should be(OAuth::AccessToken)
+    client.access_token.token.should == 'atoken'
+    client.access_token.secret.should == 'asecret'
+  end
+
+  it "should be able to configure consumer token and consumer secret without passing to initialize" do
+    LinkedIn.configure do |config|
+      config.token = 'consumer_token'
+      config.secret = 'consumer_secret'
+    end
+
+    linkedin = LinkedIn::Client.new
+    linkedin.ctoken.should == 'consumer_token'
+    linkedin.csecret.should == 'consumer_secret'
+  end
+
+end