linkedin-api2 1.1.13

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 = ['educations', 'positions']
+
+    LinkedIn.default_profile_fields.should == ['educations', '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 = ['educations', 'positions']
+    end
+
+    LinkedIn.token.should  == 'consumer_token'
+    LinkedIn.secret.should == 'consumer_secret'
+    LinkedIn.default_profile_fields.should == ['educations', 'positions']
+  end
+
+end

data/spec/cases/mash_spec.rb

@@ -0,0 +1,113 @@
+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,
+        'id' => 1345,
+        '_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
+
+    # this breaks data coming back from linkedIn
+    it "converts _key to id if there is an id column" do
+      mash._key.should == 1234
+      mash.id.should == 1345
+    end
+
+    context 'no collision' do
+      let(:mash) {
+        LinkedIn::Mash.new({
+          '_key' => 1234
+        })
+
+      }
+      it 'converts _key to id if there is no collision' do
+        mash.id.should == 1234
+        mash._key.should == 1234
+      end
+    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
+
+  describe "#all" do
+    let(:all_mash) do
+      LinkedIn::Mash.new({
+        :values => nil
+      })
+    end
+
+    it "should return an empty array if values is nil due to no results being found for a query" do
+      all_mash.all.should == []
+    end
+  end
+
+end

data/spec/cases/oauth_spec.rb

@@ -0,0 +1,178 @@
+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 "proxy oauth options" do
+      let(:proxy) { "http://dummy.proxy" }
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :proxy => proxy,
+        }).consumer
+      end
+
+      it "should send requests though proxy" do
+        consumer.proxy.should eq proxy
+      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
+    vcr_options = { :record => :new_episodes}
+    describe "with default options", vcr: vcr_options do
+
+      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", vcr: vcr_options do
+
+      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
+
+    vcr_options = { :record => :new_episodes, :match_requests_on => [ :uri, :method] }
+
+    it "should return a valid access token", vcr: vcr_options 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,234 @@
+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
+
+  vcr_options = { :record => :new_episodes}
+
+  describe "#search_company" do
+
+    describe "by keywords string parameter", vcr: vcr_options do
+
+      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", vcr: vcr_options do
+
+      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", vcr: vcr_options do
+
+      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", vcr: vcr_options do
+
+      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 == 'iSquare - Apple Authorized Distributor in Greece & Cyprus'
+        results.companies.all.first.id.should == 2135525
+        results.companies.all.last.name.should == 'Apple Crumble'
+        results.companies.all.last.id.should == 1049054
+      end
+    end
+
+    describe "by keywords options with fields", vcr: vcr_options do
+
+      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 OS X, iLife, iWork and professional software. Apple leads the digital music revolution with its iPods and iTunes online store. Apple has reinvented the mobile phone with its revolutionary iPhone and App Store, and is defining the future of mobile media and computing devices with iPad.'
+        results.companies.all.first.id.should == 162479
+      end
+    end
+
+  end
+
+  describe "#search" do
+
+    describe "by keywords string parameter", vcr: vcr_options do
+
+      let(:results) do
+        client.search('github')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 6
+        results.people.all.first.first_name.should == 'Shay'
+        results.people.all.first.last_name.should == 'Frendt'
+        results.people.all.first.id.should == 'ucXjUw4M9J'
+      end
+    end
+
+    describe "by single keywords option", vcr: vcr_options do
+
+      let(:results) do
+        client.search(:keywords => 'github')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 6
+        results.people.all.first.first_name.should == 'Shay'
+        results.people.all.first.last_name.should == 'Frendt'
+        results.people.all.first.id.should == 'ucXjUw4M9J'
+      end
+    end
+
+    describe "by single keywords option with pagination", vcr: vcr_options do
+
+      let(:results) do
+        client.search(:keywords => 'github', :start => 5, :count => 5)
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 1
+        results.people.all.first.first_name.should == 'Satish'
+        results.people.all.first.last_name.should == 'Talim'
+        results.people.all.first.id.should == 'V1FPuGot-I'
+      end
+    end
+
+    describe "by first_name and last_name options", vcr: vcr_options do
+
+      let(:results) do
+        client.search(:first_name => 'Charles', :last_name => 'Garcia')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 10
+        results.people.all.first.first_name.should == 'Charles'
+        results.people.all.first.last_name.should == 'Garcia, CFA'
+        results.people.all.first.id.should == '2zk34r8TvA'
+      end
+    end
+
+    describe "by email address", vcr: vcr_options do
+
+      let(:results) do
+        fields = ['id']
+        client.profile(:email => 'email=yy@zz.com', :fields => fields)
+      end
+
+      it "should perform a people search" do
+        results._total.should == 1
+        output = results["values"]
+        output.each do |record|
+          record.id.should == '96GVfLeWjU'
+          record._key.should == 'email=yy@zz.com'
+        end
+      end
+    end
+
+    describe "by multiple email address", vcr: vcr_options do
+      
+      let(:results) do
+        fields = ['id']
+        client.profile(:email => 'email=yy@zz.com,email=xx@yy.com', :fields => fields)
+      end
+
+      it "should perform a multi-email search" do
+        results._total.should == 2
+        output = results["values"]
+        output.count.should == 2
+      end
+    end
+
+    describe "email search returns unauthorized", vcr: vcr_options do
+
+      it "should raise an unauthorized error" do
+        fields = ['id']
+        expect {client.profile(:email => 'email=aa@bb.com', :fields => fields)}.to raise_error(LinkedIn::Errors::UnauthorizedError)
+      end
+    end
+
+    describe "by first_name and last_name options with fields", vcr: vcr_options do
+
+      let(:results) do
+        fields = [{:people => [:id, :first_name, :last_name, :public_profile_url, :picture_url]}, :num_results]
+        client.search(:first_name => 'Charles', :last_name => 'Garcia', :fields => fields)
+      end
+
+      it "should perform a search" do
+        first_person = results.people.all.first
+        results.people.all.size.should == 10
+        first_person.first_name.should == 'Charles'
+        first_person.last_name.should == 'Garcia, CFA'
+        first_person.id.should == '2zk34r8TvA'
+        first_person.picture_url.should be_nil
+        first_person.public_profile_url.should == 'http://www.linkedin.com/in/charlesgarcia'
+      end
+    end
+
+    describe "by company_name option", vcr: vcr_options do
+
+      let(:results) do
+        client.search(:company_name => 'IBM')
+      end
+
+      it "should perform a search" do
+        results.people.all.size.should == 6
+        results.people.all.first.first_name.should == 'Ryan'
+        results.people.all.first.last_name.should == 'Sue'
+        results.people.all.first.id.should == 'KHkgwBMaa-'
+      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