brienw-linkedin 0.3.7

data/linkedin.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require File.expand_path('../lib/linked_in/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'hashie', '~> 1.2.0'
+  gem.add_dependency 'multi_json', '~> 1.0.3'
+  gem.add_dependency 'oauth', '~> 0.4.5'
+  gem.add_development_dependency 'json', '~> 1.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rdoc', '~> 3.8'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.5'
+  gem.add_development_dependency 'vcr', '~> 1.10'
+  gem.add_development_dependency 'webmock', '~> 1.7'
+  gem.authors = ["Wynn Netherland", "Josh Kalderimis"]
+  gem.description = %q{Ruby wrapper for the LinkedIn API}
+  gem.email = ['wynn.netherland@gmail.com', 'josh.kalderimis@gmail.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'http://github.com/pengwynn/linkedin'
+  gem.name = 'brienw-linkedin'
+  gem.require_paths = ['lib']
+  gem.summary = gem.description
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version = LinkedIn::VERSION::STRING
+end

data/spec/cases/api_spec.rb

@@ -0,0 +1,92 @@
+require 'helper'
+
+describe LinkedIn::Api do
+  before do
+    LinkedIn.default_profile_fields = nil
+    client.stub(:consumer).and_return(consumer)
+    client.authorize_from_access('atoken', 'asecret')
+  end
+
+  let(:client){LinkedIn::Client.new('token', 'secret')}
+  let(:consumer){OAuth::Consumer.new('token', 'secret', {:site => 'https://api.linkedin.com'})}
+
+  it "should be able to view the account profile" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~").to_return(:body => "{}")
+    client.profile.should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view public profiles" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/id=123").to_return(:body => "{}")
+    client.profile(:id => 123).should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view connections" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/connections").to_return(:body => "{}")
+    client.connections.should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view network_updates" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/network/updates").to_return(:body => "{}")
+    client.network_updates.should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to search with a keyword if given a String" do
+    stub_request(:get, "https://api.linkedin.com/v1/people-search?keywords=business").to_return(:body => "{}")
+    client.search("business").should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to search with an option" do
+    stub_request(:get, "https://api.linkedin.com/v1/people-search?first-name=Javan").to_return(:body => "{}")
+    client.search(:first_name => "Javan").should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to search with an option and fetch specific fields" do
+    stub_request(:get, "https://api.linkedin.com/v1/people-search:(num-results,total)?first-name=Javan").to_return(:body => "{}")
+    client.search(:first_name => "Javan", :fields => ["num_results", "total"]).should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to share a new status" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/shares").to_return(:body => "", :status => 201)
+    response = client.add_share(:comment => "Testing, 1, 2, 3")
+    response.body.should == ""
+    response.code.should == "201"
+  end
+
+  context "Company API" do
+    use_vcr_cassette
+
+    it "should be able to view a company profile" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/id=1586").to_return(:body => "{}")
+      client.company(:id => 1586).should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view a company by universal name" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/universal-name=acme").to_return(:body => "{}")
+      client.company(:name => 'acme').should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view a company by e-mail domain" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/email-domain=acme.com").to_return(:body => "{}")
+      client.company(:domain => 'acme.com').should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should load correct company data" do
+      client.company(:id => 1586).name.should == "Amazon"
+
+      data = client.company(:id => 1586, :fields => %w{ id name industry locations:(address:(city state country-code) is-headquarters) employee-count-range })
+      data.id.should == 1586
+      data.name.should == "Amazon"
+      data.employee_count_range.name.should == "10001+"
+      data.industry.should == "Internet"
+      data.locations.all[0].address.city.should == "Seattle"
+      data.locations.all[0].is_headquarters.should == true
+    end
+  end
+
+  context "Errors" do
+    it "should raise AccessDeniedError when LinkedIn returns 403 status code" do
+      stub_request(:get, "https://api.linkedin.com/v1/people-search?first-name=Javan").to_return(:body => "{}", :status => 403)
+      expect{ client.search(:first_name => "Javan") }.to raise_error(LinkedIn::Errors::AccessDeniedError)
+    end
+  end
+end

data/spec/cases/linkedin_spec.rb

@@ -0,0 +1,37 @@
+require '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/mash_spec.rb

@@ -0,0 +1,85 @@
+require 'helper'
+
+describe LinkedIn::Mash do
+
+  describe ".from_json" do
+    it "should convert a json string to a Mash" do
+      json_string = "{\"name\":\"Josh Kalderimis\"}"
+      mash = LinkedIn::Mash.from_json(json_string)
+
+      mash.should have_key('name')
+      mash.name.should == 'Josh Kalderimis'
+    end
+  end
+
+  describe "#convert_keys" do
+    let(:mash) do
+      LinkedIn::Mash.new({
+        'firstName' => 'Josh',
+        'LastName' => 'Kalderimis',
+        '_key' => 1234,
+        '_total' => 1234,
+        'values' => {},
+        'numResults' => 'total_results'
+      })
+    end
+
+    it "should convert camal cased hash keys to underscores" do
+      mash.should have_key('first_name')
+      mash.should have_key('last_name')
+    end
+
+    it "should convert the key _key to id" do
+      mash.should have_key('id')
+    end
+
+    it "should convert the key _total to total" do
+      mash.should have_key('total')
+    end
+
+    it "should convert the key values to all" do
+      mash.should have_key('all')
+    end
+
+    it "should convert the key numResults to total_results" do
+      mash.should have_key('total_results')
+    end
+  end
+
+  describe '#timestamp' do
+    it "should return a valid Time if a key of timestamp exists and the value is an int" do
+      time_mash = LinkedIn::Mash.new({ 'timestamp' => 1297083249 })
+
+      time_mash.timestamp.should be_a_kind_of(Time)
+      time_mash.timestamp.to_i.should  == 1297083249
+    end
+
+    it "should return a valid Time if a key of timestamp exists and the value is an int which is greater than 9999999999" do
+      time_mash = LinkedIn::Mash.new({ 'timestamp' => 1297083249 * 1000 })
+
+      time_mash.timestamp.should be_a_kind_of(Time)
+      time_mash.timestamp.to_i.should  == 1297083249
+    end
+
+    it "should not try to convert to a Time object if the value isn't an Integer" do
+      time_mash = LinkedIn::Mash.new({ 'timestamp' => 'Foo' })
+
+      time_mash.timestamp.class.should be String
+    end
+  end
+
+  describe "#to_date" do
+    let(:date_mash) do
+      LinkedIn::Mash.new({
+        'year' => 2010,
+        'month' => 06,
+        'day' => 23
+      })
+    end
+
+    it "should return a valid Date if the keys year, month, day all exist" do
+      date_mash.to_date.should == Date.civil(2010, 06, 23)
+    end
+  end
+
+end

data/spec/cases/oauth_spec.rb

@@ -0,0 +1,166 @@
+require 'helper'
+
+describe "LinkedIn::Client" do
+
+  let(:client) do
+    key    = ENV['LINKED_IN_CONSUMER_KEY'] || '1234'
+    secret = ENV['LINKED_IN_CONSUMER_SECRET'] || '1234'
+    LinkedIn::Client.new(key, secret)
+  end
+
+  describe "#consumer" do
+    describe "default oauth options" do
+      let(:consumer) { client.consumer }
+
+      it "should return a configured OAuth consumer" do
+        consumer.site.should == 'https://api.linkedin.com'
+        consumer.request_token_url.should == 'https://api.linkedin.com/uas/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.linkedin.com/uas/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.linkedin.com/uas/oauth/authorize'
+      end
+    end
+
+    describe "different api and auth hosts options" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :api_host => 'https://api.josh.com',
+          :auth_host => 'https://www.josh.com'
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.site.should == 'https://api.josh.com'
+        consumer.request_token_url.should == 'https://api.josh.com/uas/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.josh.com/uas/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.josh.com/uas/oauth/authorize'
+      end
+    end
+
+    describe "different oauth paths" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :request_token_path => "/secure/oauth/requestToken",
+          :access_token_path  => "/secure/oauth/accessToken",
+          :authorize_path     => "/secure/oauth/authorize",
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.site.should == 'https://api.linkedin.com'
+        consumer.request_token_url.should == 'https://api.linkedin.com/secure/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.linkedin.com/secure/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.linkedin.com/secure/oauth/authorize'
+      end
+    end
+
+    describe "specify oauth urls" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :request_token_url => "https://api.josh.com/secure/oauth/requestToken",
+          :access_token_url  => "https://api.josh.com/secure/oauth/accessToken",
+          :authorize_url     => "https://www.josh.com/secure/oauth/authorize",
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.site.should == 'https://api.linkedin.com'
+        consumer.request_token_url.should == 'https://api.josh.com/secure/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.josh.com/secure/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.josh.com/secure/oauth/authorize'
+      end
+    end
+
+    describe "use the :site option to specify the host of all oauth urls" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :site => "https://api.josh.com"
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.site.should == 'https://api.josh.com'
+        consumer.request_token_url.should == 'https://api.josh.com/uas/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.josh.com/uas/oauth/accessToken'
+        consumer.authorize_url.should == 'https://api.josh.com/uas/oauth/authorize'
+      end
+    end
+  end
+
+  describe "#request_token" do
+    describe "with default options" do
+      use_vcr_cassette :record => :new_episodes
+
+      it "should return a valid request token" do
+        request_token = client.request_token
+
+        request_token.should be_a_kind_of OAuth::RequestToken
+        request_token.authorize_url.should include("https://www.linkedin.com/uas/oauth/authorize?oauth_token=")
+
+        a_request(:post, "https://api.linkedin.com/uas/oauth/requestToken").should have_been_made.once
+      end
+    end
+
+    describe "with a callback url" do
+      use_vcr_cassette :record => :new_episodes
+
+      it "should return a valid access token" do
+        request_token = client.request_token(:oauth_callback => 'http://www.josh.com')
+
+        request_token.should be_a_kind_of OAuth::RequestToken
+        request_token.authorize_url.should include("https://www.linkedin.com/uas/oauth/authorize?oauth_token=")
+        request_token.callback_confirmed?.should == true
+
+        a_request(:post, "https://api.linkedin.com/uas/oauth/requestToken").should have_been_made.once
+      end
+    end
+  end
+
+  describe "#authorize_from_request" do
+    let(:access_token) do
+      # if you remove the related casssette you will need to do the following
+      # authorize_from_request request manually
+      #
+      # request_token = client.request_token
+      # puts "token    : #{request_token.token} - secret #{request_token.secret}"
+      # puts "auth url : #{request_token.authorize_url}"
+      # raise 'keep note of the token and secret'
+      #
+      client.authorize_from_request('dummy-token', 'dummy-secret', 'dummy-pin')
+    end
+
+    use_vcr_cassette :record => :new_episodes, :match_requests_on => [:uri, :method]
+
+    it "should return a valid access token" do
+      access_token.should be_a_kind_of Array
+      access_token[0].should be_a_kind_of String
+      access_token[1].should be_a_kind_of String
+
+      a_request(:post, "https://api.linkedin.com/uas/oauth/accessToken").should have_been_made.once
+    end
+  end
+
+  describe "#access_token" do
+    let(:access_token) do
+      client.authorize_from_access('dummy-token', 'dummy-secret')
+      client.access_token
+    end
+
+    it "should return a valid auth token" do
+      access_token.should be_a_kind_of OAuth::AccessToken
+      access_token.token.should be_a_kind_of String
+    end
+  end
+
+  describe "#authorize_from_access" do
+    let(:auth_token) do
+      client.authorize_from_access('dummy-token', 'dummy-secret')
+    end
+
+    it "should return a valid auth token" do
+      auth_token.should be_a_kind_of Array
+      auth_token[0].should be_a_kind_of String
+      auth_token[1].should be_a_kind_of String
+    end
+  end
+
+end

data/spec/cases/search_spec.rb

@@ -0,0 +1,206 @@
+require 'helper'
+
+describe LinkedIn::Search do
+
+  # if you remove the related cassettes you will need to inform valid
+  # tokens and secrets to regenerate them
+  #
+  let(:client) do
+    consumer_token  = ENV['LINKED_IN_CONSUMER_KEY'] || 'key'
+    consumer_secret = ENV['LINKED_IN_CONSUMER_SECRET'] || 'secret'
+    client = LinkedIn::Client.new(consumer_token, consumer_secret)
+
+    auth_token      = ENV['LINKED_IN_AUTH_KEY'] || 'key'
+    auth_secret     = ENV['LINKED_IN_AUTH_SECRET'] || 'secret'
+    client.authorize_from_access(auth_token, auth_secret)
+    client
+  end
+
+  describe "#search_company" do
+
+    describe "by keywords string parameter" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        client.search('apple', :company)
+      end
+
+      it "should perform a company search" do
+        results.companies.all.size.should == 10
+        results.companies.all.first.name.should == 'Apple'
+        results.companies.all.first.id.should == 162479
+      end
+    end
+
+    describe "by single keywords option" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        options = {:keywords => 'apple'}
+        client.search(options, :company)
+      end
+
+      it "should perform a company search" do
+        results.companies.all.size.should == 10
+        results.companies.all.first.name.should == 'Apple'
+        results.companies.all.first.id.should == 162479
+      end
+    end
+
+    describe "by single keywords option with facets to return" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        options = {:keywords => 'apple', :facets => [:industry]}
+        client.search(options, :company)
+      end
+
+      it "should return a facet" do
+        results.facets.all.first.buckets.all.first.name.should == 'Information Technology and Services'
+      end
+    end
+
+    describe "by single keywords option with pagination" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        options = {:keywords => 'apple', :start => 5, :count => 5}
+        client.search(options, :company)
+      end
+
+      it "should perform a search" do
+        results.companies.all.size.should == 5
+        results.companies.all.first.name.should == 'Apple Vacations'
+        results.companies.all.first.id.should == 19271
+        results.companies.all.last.name.should == 'Micro Center'
+        results.companies.all.last.id.should == 15552
+      end
+    end
+
+    describe "by keywords options with fields" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        fields = [{:companies => [:id, :name, :industries, :description, :specialties]}, :num_results]
+        client.search({:keywords => 'apple', :fields => fields}, 'company')
+      end
+
+      it "should perform a search" do
+        results.companies.all.first.name.should == 'Apple'
+        results.companies.all.first.description.should == 'Apple designs Macs, the best personal computers in the world, along with Mac OS X, iLife, iWork, and professional software. Apple leads the digital music revolution with its iPods and iTunes online store. Apple is reinventing the mobile phone with its revolutionary iPhone and App Store, and has recently introduced its magical iPad which is defining the future of mobile media and computing devices.'
+        results.companies.all.first.id.should == 162479
+      end
+    end
+
+  end
+
+  describe "#search" do
+
+    describe "by keywords string parameter" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        client.search('github')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 10
+        results.people.all.first.first_name.should == 'Giliardi'
+        results.people.all.first.last_name.should == 'Pires'
+        results.people.all.first.id.should == 'YkdnFl04s_'
+      end
+    end
+
+    describe "by single keywords option" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        client.search(:keywords => 'github')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 10
+        results.people.all.first.first_name.should == 'Giliardi'
+        results.people.all.first.last_name.should == 'Pires'
+        results.people.all.first.id.should == 'YkdnFl04s_'
+      end
+    end
+
+    describe "by single keywords option with pagination" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        client.search(:keywords => 'github', :start => 5, :count => 5)
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 5
+        results.people.all.first.first_name.should == 'Stephen'
+        results.people.all.first.last_name.should == 'M.'
+        results.people.all.first.id.should == 'z2XMcxa_dR'
+        results.people.all.last.first_name.should == 'Pablo'
+        results.people.all.last.last_name.should == 'C.'
+        results.people.all.last.id.should == 'pdzrGpyP0h'
+      end
+    end
+
+    describe "by first_name and last_name options" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        client.search(:first_name => 'Giliardi', :last_name => 'Pires')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 1
+        results.people.all.first.first_name.should == 'Giliardi'
+        results.people.all.first.last_name.should == 'Pires'
+        results.people.all.first.id.should == 'YkdnFl04s_'
+      end
+    end
+
+    describe "by first_name and last_name options with fields" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        fields = [{:people => [:id, :first_name, :last_name, :public_profile_url, :picture_url]}, :num_results]
+        client.search(:first_name => 'Giliardi', :last_name => 'Pires', :fields => fields)
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 1
+        results.people.all.first.first_name.should == 'Giliardi'
+        results.people.all.first.last_name.should == 'Pires'
+        results.people.all.first.id.should == 'YkdnFl04s_'
+        results.people.all.first.picture_url == 'http://media.linkedin.com/mpr/mprx/0_Oz05kn9xkWziAEOUKtOVkqzjXd8Clf7UyqIVkqchR2NtmwZRt1fWoN_aobhg-HmB09jUwPLKrAhU'
+        results.people.all.first.public_profile_url == 'http://www.linkedin.com/in/gibanet'
+      end
+    end
+
+    describe "by company_name option" do
+      use_vcr_cassette :record => :new_episodes
+
+      let(:results) do
+        client.search(:company_name => 'linkedin')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 10
+        results.people.all.first.first_name.should == 'Donald'
+        results.people.all.first.last_name.should == 'Denker'
+        results.people.all.first.id.should == 'VQcsz5Hp_h'
+      end
+    end
+
+    describe "#field_selector" do
+      it "should not modify the parameter object" do
+        fields = [{:people => [:id, :first_name]}]
+        fields_dup = fields.dup
+        client.send(:field_selector, fields)
+        fields.should eq fields_dup
+      end
+    end
+
+  end
+
+end