linkedin 0.4.6 → 0.4.7

data/lib/linked_in/client.rb

@@ -5,8 +5,13 @@ module LinkedIn
   class Client
     include Helpers::Request
     include Helpers::Authorization
-    include Api::QueryMethods
-    include Api::UpdateMethods
+    include Api::QueryHelpers
+    include Api::People
+    include Api::Groups
+    include Api::Companies
+    include Api::Jobs
+    include Api::ShareAndSocialStream
+    include Api::Communications
     include Search
 
     attr_reader :consumer_token, :consumer_secret, :consumer_options

data/lib/linked_in/errors.rb

@@ -8,12 +8,22 @@ module LinkedIn
       end
     end
 
+    # Raised when a 401 response status code is received
     class UnauthorizedError      < LinkedInError; end
+
+    # Raised when a 400 response status code is received
     class GeneralError           < LinkedInError; end
+
+    # Raised when a 403 response status code is received
     class AccessDeniedError      < LinkedInError; end
 
-    class UnavailableError       < StandardError; end
-    class InformLinkedInError    < StandardError; end
+    # Raised when a 404 response status code is received
     class NotFoundError          < StandardError; end
+
+    # Raised when a 500 response status code is received
+    class InformLinkedInError    < StandardError; end
+
+    # Raised when a 502 or 503 response status code is received
+    class UnavailableError       < StandardError; end
   end
 end

data/lib/linked_in/mash.rb

@@ -2,15 +2,23 @@ require 'hashie'
 require 'multi_json'
 
 module LinkedIn
+
+  # The generalized pseudo-object that is returned for all query
+  # requests.
   class Mash < ::Hashie::Mash
 
-    # a simple helper to convert a json string to a Mash
+    # Convert a json string to a Mash
+    #
+    # @param [String] json_string
+    # @return [LinkedIn::Mash]
     def self.from_json(json_string)
       result_hash = ::MultiJson.decode(json_string)
       new(result_hash)
     end
 
-    # returns a Date if we have year, month and day, and no conflicting key
+    # Returns a Date if we have year, month and day, and no conflicting key
+    #
+    # @return [Date]
     def to_date
       if !self.has_key?('to_date') && contains_date_fields?
         Date.civil(self.year, self.month, self.day)
@@ -19,6 +27,20 @@ module LinkedIn
       end
     end
 
+    # Returns the id of the object from LinkedIn
+    #
+    # @return [String]
+    def id
+      if self['id']
+        self['id']
+      else
+        self['_key']
+      end
+    end
+
+    # Convert the 'timestamp' field from a string to a Time object
+    #
+    # @return [Time]
     def timestamp
       value = self['timestamp']
       if value.kind_of? Integer
@@ -29,6 +51,13 @@ module LinkedIn
       end
     end
 
+    # Return the results array from the query
+    #
+    # @return [Array]
+    def all
+      super || []
+    end
+
     protected
 
       def contains_date_fields?
@@ -39,8 +68,6 @@ module LinkedIn
       # keys are made a little more ruby-ish
       def convert_key(key)
         case key.to_s
-        when '_key'
-          'id'
         when '_total'
           'total'
         when 'values'

data/lib/linked_in/search.rb

@@ -1,6 +1,21 @@
 module LinkedIn
 
   module Search
+
+    # Retrieve search results of the given object type
+    #
+    # Permissions: (for people search only) r_network
+    #
+    # @note People Search API is a part of the Vetted API Access Program. You
+    #   must apply and get approval before using this API
+    #
+    # @see http://developer.linkedin.com/documents/people-search-api People Search
+    # @see http://developer.linkedin.com/documents/job-search-api Job Search
+    # @see http://developer.linkedin.com/documents/company-search Company Search
+    #
+    # @param [Hash] options search input fields
+    # @param [String] type type of object to return ('people', 'job' or 'company')
+    # @return [LinkedIn::Mash]
     def search(options={}, type='people')
 
       path = "/#{type.to_s}-search"
@@ -53,4 +68,4 @@ module LinkedIn
       end
   end
 
-end
+end

data/lib/linked_in/version.rb

@@ -3,7 +3,7 @@ module LinkedIn
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 4
-    PATCH = 6
+    PATCH = 7
     PRE   = nil
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

data/lib/linkedin.rb

@@ -7,15 +7,18 @@ module LinkedIn
 
     # config/initializers/linkedin.rb (for instance)
     #
+    # ```ruby
     # LinkedIn.configure do |config|
     #   config.token = 'consumer_token'
     #   config.secret = 'consumer_secret'
     #   config.default_profile_fields = ['educations', 'positions']
     # end
-    #
+    # ```
     # elsewhere
     #
+    # ```ruby
     # client = LinkedIn::Client.new
+    # ```
     def configure
       yield self
       true

data/linkedin.gemspec

@@ -2,12 +2,13 @@
 require File.expand_path('../lib/linked_in/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_dependency 'hashie', ['>= 1.2', '< 2.1']
+  gem.add_dependency 'hashie', '~> 2.0'
   gem.add_dependency 'multi_json', '~> 1.0'
   gem.add_dependency 'oauth', '~> 0.4'
   # gem.add_development_dependency 'json', '~> 1.6'
   gem.add_development_dependency 'rake', '~> 10'
-  gem.add_development_dependency 'rdoc', '~> 4.0'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'kramdown'
   gem.add_development_dependency 'rspec', '~> 2.13'
   gem.add_development_dependency 'simplecov', '~> 0.7'
   gem.add_development_dependency 'vcr', '~> 2.5'
@@ -18,8 +19,9 @@ Gem::Specification.new do |gem|
   gem.files = `git ls-files`.split("\n")
   gem.homepage = 'http://github.com/hexgnu/linkedin'
   gem.name = 'linkedin'
+  gem.licenses = %w[MIT]
   gem.require_paths = ['lib']
-  gem.summary = gem.description
+  gem.summary = 'This gem interfaces with the Linkedin XML and JSON APis'
   gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.version = LinkedIn::VERSION::STRING
 end

data/spec/cases/api_spec.rb

@@ -30,6 +30,12 @@ describe LinkedIn::Api do
     client.connections.should be_an_instance_of(LinkedIn::Mash)
   end
 
+  it "should be able to view new connections" do
+    modified_since = Time.now.to_i * 1000
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/connections?modified=new&modified-since=#{modified_since}").to_return(:body => "{}")
+    client.new_connections(modified_since).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)
@@ -116,8 +122,7 @@ describe LinkedIn::Api do
     request_token.should == "request_token"
   end
 
-  context "Company API" do
-    use_vcr_cassette
+  context "Company API", :vcr do
 
     it "should be able to view a company profile" do
       stub_request(:get, "https://api.linkedin.com/v1/companies/id=1586").to_return(:body => "{}")
@@ -194,8 +199,7 @@ describe LinkedIn::Api do
 
   end
 
-  context "Job API" do
-    use_vcr_cassette
+  context "Job API", :vcr do
 
     it "should be able to view a job listing" do
       stub_request(:get, "https://api.linkedin.com/v1/jobs/id=1586").to_return(:body => "{}")
@@ -227,9 +231,15 @@ describe LinkedIn::Api do
       client.group_memberships.should be_an_instance_of(LinkedIn::Mash)
     end
 
+    it "should be able to list suggested groups for a profile" do
+      stub_request(:get, "https://api.linkedin.com/v1/people/~/suggestions/groups").to_return(:body => '{"id": "123"}')
+      response = client.group_suggestions
+      response.id.should == '123'
+    end
+
     it "should be able to parse nested fields" do
       stub_request(:get, "https://api.linkedin.com/v1/people/~/group-memberships:(group:(id,name,small-logo-url,short-description))").to_return(:body => "{}")
-      client.group_memberships(fields: [{group: ['id', 'name', 'small-logo-url', 'short-description']}]).should be_an_instance_of(LinkedIn::Mash)
+      client.group_memberships(:fields => [{:group => ['id', 'name', 'small-logo-url', 'short-description']}]).should be_an_instance_of(LinkedIn::Mash)
     end
 
     it "should be able to join a group" do

data/spec/cases/mash_spec.rb

@@ -18,6 +18,7 @@ describe LinkedIn::Mash do
         'firstName' => 'Josh',
         'LastName' => 'Kalderimis',
         '_key' => 1234,
+        'id' => 1345,
         '_total' => 1234,
         'values' => {},
         'numResults' => 'total_results'
@@ -29,8 +30,23 @@ describe LinkedIn::Mash do
       mash.should have_key('last_name')
     end
 
-    it "should convert the key _key to id" do
-      mash.should have_key('id')
+    # 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
@@ -82,4 +98,16 @@ describe LinkedIn::Mash do
     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

@@ -100,8 +100,8 @@ describe "LinkedIn::Client" do
   end
 
   describe "#request_token" do
-    describe "with default options" do
-      use_vcr_cassette :record => :new_episodes
+    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
@@ -113,8 +113,7 @@ describe "LinkedIn::Client" do
       end
     end
 
-    describe "with a callback url" do
-      use_vcr_cassette :record => :new_episodes
+    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')
@@ -141,9 +140,9 @@ describe "LinkedIn::Client" do
       client.authorize_from_request('dummy-token', 'dummy-secret', 'dummy-pin')
     end
 
-    use_vcr_cassette :record => :new_episodes, :match_requests_on => [:uri, :method]
+    vcr_options = { :record => :new_episodes, :match_requests_on => [ :uri, :method] }
 
-    it "should return a valid access token" do
+    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

data/spec/cases/search_spec.rb

@@ -16,10 +16,11 @@ describe LinkedIn::Search do
     client
   end
 
+  vcr_options = { :record => :new_episodes}
+
   describe "#search_company" do
 
-    describe "by keywords string parameter" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by keywords string parameter", vcr: vcr_options do
 
       let(:results) do
         client.search('apple', :company)
@@ -32,8 +33,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by single keywords option" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by single keywords option", vcr: vcr_options do
 
       let(:results) do
         options = {:keywords => 'apple'}
@@ -47,8 +47,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by single keywords option with facets to return" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by single keywords option with facets to return", vcr: vcr_options do
 
       let(:results) do
         options = {:keywords => 'apple', :facets => [:industry]}
@@ -60,8 +59,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by single keywords option with pagination" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by single keywords option with pagination", vcr: vcr_options do
 
       let(:results) do
         options = {:keywords => 'apple', :start => 5, :count => 5}
@@ -77,8 +75,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by keywords options with fields" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by keywords options with fields", vcr: vcr_options do
 
       let(:results) do
         fields = [{:companies => [:id, :name, :industries, :description, :specialties]}, :num_results]
@@ -96,8 +93,7 @@ describe LinkedIn::Search do
 
   describe "#search" do
 
-    describe "by keywords string parameter" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by keywords string parameter", vcr: vcr_options do
 
       let(:results) do
         client.search('github')
@@ -111,8 +107,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by single keywords option" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by single keywords option", vcr: vcr_options do
 
       let(:results) do
         client.search(:keywords => 'github')
@@ -126,8 +121,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by single keywords option with pagination" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by single keywords option with pagination", vcr: vcr_options do
 
       let(:results) do
         client.search(:keywords => 'github', :start => 5, :count => 5)
@@ -141,8 +135,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by first_name and last_name options" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by first_name and last_name options", vcr: vcr_options do
 
       let(:results) do
         client.search(:first_name => 'Charles', :last_name => 'Garcia')
@@ -156,8 +149,46 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by first_name and last_name options with fields" do
-      use_vcr_cassette :record => :new_episodes
+    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]
@@ -175,8 +206,7 @@ describe LinkedIn::Search do
       end
     end
 
-    describe "by company_name option" do
-      use_vcr_cassette :record => :new_episodes
+    describe "by company_name option", vcr: vcr_options do
 
       let(:results) do
         client.search(:company_name => 'IBM')
@@ -201,4 +231,4 @@ describe LinkedIn::Search do
 
   end
 
-end
+end