linkedin 0.3.6 → 0.3.7

data/examples/authenticate.rb

@@ -18,4 +18,4 @@ client.authorize_from_request(rtoken, rsecret, pin)
 # 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
+# you're now free to move about the cabin, call any API method

data/examples/profile.rb

@@ -11,4 +11,8 @@ client.profile(:id => 'gNma67_AdI')
 # get a profile for someone via their public profile url
 client.profile(:url => 'http://www.linkedin.com/in/netherland')
 
+# provides the ability to access authenticated user's company field in the profile
+user = client.profile(:fields => %w(positions))
+companies = user.positions.all.map{|t| t.company}
+# Example: most recent company can be accessed via companies[0]
 

data/examples/sinatra.rb

@@ -0,0 +1,77 @@
+require "rubygems"
+require "haml"
+require "sinatra"
+require "linkedin"
+
+enable :sessions
+
+helpers do
+  def login?
+    !session[:atoken].nil?
+  end
+  
+  def profile
+    linkedin_client.profile unless session[:atoken].nil?
+  end
+  
+  def connections
+    linkedin_client.connections unless session[:atoken].nil?
+  end
+  
+  private
+  def linkedin_client
+    client = LinkedIn::Client.new(settings.api, settings.secret)
+    client.authorize_from_access(session[:atoken], session[:asecret])
+    client
+  end 
+  
+end
+
+configure do
+  # get your api keys at https://www.linkedin.com/secure/developer
+  set :api, "your_api_key"
+  set :secret, "your_secret"
+end
+
+get "/" do
+  haml :index
+end
+
+get "/auth" do
+  client = LinkedIn::Client.new(settings.api, settings.secret)
+  request_token = client.request_token(:oauth_callback => "http://#{request.host}:#{request.port}/auth/callback")
+  session[:rtoken] = request_token.token
+  session[:rsecret] = request_token.secret
+
+  redirect client.request_token.authorize_url
+end
+
+get "/auth/logout" do
+   session[:atoken] = nil
+   redirect "/"
+end
+
+get "/auth/callback" do
+  client = LinkedIn::Client.new(settings.api, settings.secret)
+  if session[:atoken].nil?
+    pin = params[:oauth_verifier]
+    atoken, asecret = client.authorize_from_request(session[:rtoken], session[:rsecret], pin)
+    session[:atoken] = atoken
+    session[:asecret] = asecret    
+  end
+  redirect "/"
+end
+
+
+__END__
+@@index
+-if login?
+  %p Welcome #{profile.first_name}!
+  %a{:href => "/auth/logout"} Logout
+  %p= profile.headline
+  %br
+  %div= "You have #{connections.total} connections!"
+  -connections.all.each do |c|
+    %div= "#{c.first_name} #{c.last_name} - #{c.headline}"
+-else
+  %a{:href => "/auth"} Login using LinkedIn

data/lib/linked_in/api/query_methods.rb

@@ -23,26 +23,35 @@ module LinkedIn
         simple_query(path, options)
       end
 
+      def group_memberships(options = {})
+        path = "#{person_path(options)}/group-memberships"
+        simple_query(path, options)
+      end
+
       private
 
         def simple_query(path, options={})
-          fields = options[:fields] || LinkedIn.default_profile_fields
+          fields = options.delete(:fields) || LinkedIn.default_profile_fields
 
-          if options[:public]
+          if options.delete(:public)
             path +=":public"
           elsif fields
             path +=":(#{fields.map{ |f| f.to_s.gsub("_","-") }.join(',')})"
           end
 
-          Mash.from_json(get(path))
+          headers = options.delete(:headers) || {}
+          params  = options.map { |k,v| "#{k}=#{v}" }.join("&")
+          path   += "?#{params}" if not params.empty?
+
+          Mash.from_json(get(path, headers))
         end
 
         def person_path(options)
           path = "/people/"
-          if options[:id]
-            path += "id=#{options[:id]}"
-          elsif options[:url]
-            path += "url=#{CGI.escape(options[:url])}"
+          if id = options.delete(:id)
+            path += "id=#{id}"
+          elsif url = options.delete(:url)
+            path += "url=#{CGI.escape(url)}"
           else
             path += "~"
           end
@@ -50,14 +59,14 @@ module LinkedIn
 
         def company_path(options)
           path = "/companies/"
-          if options[:id]
-            path += "id=#{options[:id]}"
-          elsif options[:url]
-            path += "url=#{CGI.escape(options[:url])}"
-          elsif options[:name]
-            path += "universal-name=#{CGI.escape(options[:name])}"
-          elsif options[:domain]
-            path += "email-domain=#{CGI.escape(options[:domain])}"
+          if id = options.delete(:id)
+            path += "id=#{id}"
+          elsif url = options.delete(:url)
+            path += "url=#{CGI.escape(url)}"
+          elsif name = options.delete(:name)
+            path += "universal-name=#{CGI.escape(name)}"
+          elsif domain = options.delete(:domain)
+            path += "email-domain=#{CGI.escape(domain)}"
           else
             path += "~"
           end
@@ -66,4 +75,4 @@ module LinkedIn
     end
 
   end
-end
+end

data/lib/linked_in/api/update_methods.rb

@@ -9,6 +9,12 @@ module LinkedIn
         post(path, defaults.merge(share).to_json, "Content-Type" => "application/json")
       end
 
+      def join_group(group_id)
+        path = "/people/~/group-memberships/#{group_id}"
+        body = {'membership-state' => {'code' => 'member' }}
+        put(path, body.to_json, "Content-Type" => "application/json")
+      end
+
       # def share(options={})
       #   path = "/people/~/shares"
       #   defaults = { :visability => 'anyone' }
@@ -25,23 +31,20 @@ module LinkedIn
       #   post(path, network_update_to_xml(message))
       # end
       #
-      # def send_message(subject, body, recipient_paths)
-      #   path = "/people/~/mailbox"
-      #
-      #   message         = LinkedIn::Message.new
-      #   message.subject = subject
-      #   message.body    = body
-      #   recipients      = LinkedIn::Recipients.new
-      #
-      #   recipients.recipients = recipient_paths.map do |profile_path|
-      #     recipient             = LinkedIn::Recipient.new
-      #     recipient.person      = LinkedIn::Person.new
-      #     recipient.person.path = "/people/#{profile_path}"
-      #     recipient
-      #   end
-      #   message.recipients = recipients
-      #   post(path, message_to_xml(message)).code
-      # end
+      def send_message(subject, body, recipient_paths)
+        path = "/people/~/mailbox"
+      
+        message = {
+            'subject' => subject, 
+            'body' => body,
+            'recipients' => {
+                'values' => recipient_paths.map do |profile_path| 
+                  { 'person' => { '_path' => "/people/#{profile_path}" } } 
+                end
+            }
+        }
+        post(path, message.to_json, "Content-Type" => "application/json")
+      end
       #
       # def clear_status
       #   path = "/people/~/current-status"

data/lib/linked_in/errors.rb

@@ -8,9 +8,9 @@ module LinkedIn
       end
     end
 
-    class RateLimitExceededError < LinkedInError; end
     class UnauthorizedError      < LinkedInError; end
     class GeneralError           < LinkedInError; end
+    class AccessDeniedError      < LinkedInError; end
 
     class UnavailableError       < StandardError; end
     class InformLinkedInError    < StandardError; end

data/lib/linked_in/helpers/request.rb

@@ -44,9 +44,12 @@ module LinkedIn
           when 401
             data = Mash.from_json(response.body)
             raise LinkedIn::Errors::UnauthorizedError.new(data), "(#{data.status}): #{data.message}"
-          when 400, 403
+          when 400
             data = Mash.from_json(response.body)
             raise LinkedIn::Errors::GeneralError.new(data), "(#{data.status}): #{data.message}"
+          when 403
+            data = Mash.from_json(response.body)
+            raise LinkedIn::Errors::AccessDeniedError.new(data), "(#{data.status}): #{data.message}"
           when 404
             raise LinkedIn::Errors::NotFoundError, "(#{response.code}): #{response.message}"
           when 500

data/lib/linked_in/search.rb

@@ -1,18 +1,20 @@
 module LinkedIn
 
   module Search
+    def search(options={}, type='people')
 
-    def search(options={})
-      path = "/people-search"
-      options = { :keywords => options } if options.is_a?(String)
-      
-      if fields = options.delete(:fields)
-        path +=":(#{fields.map{ |f| f.to_s.gsub("_","-") }.join(',')})"
+      path = "/#{type.to_s}-search"
+
+      if options.is_a?(Hash)
+        fields = options.delete(:fields)
+        path += field_selector(fields) if fields
       end
-      
+
+      options = { :keywords => options } if options.is_a?(String)
       options = format_options_for_query(options)
 
       result_json = get(to_uri(path, options))
+
       Mash.from_json(result_json)
     end
 
@@ -32,6 +34,23 @@ module LinkedIn
         value
       end
 
+      def field_selector(fields)
+        result = ":("
+        fields = fields.to_a.map do |field|
+          if field.is_a?(Hash)
+            innerFields = []
+            field.each do |key, value|
+              innerFields << key.to_s.gsub("_","-") + field_selector(value)
+            end
+            innerFields.join(',')
+          else
+            field.to_s.gsub("_","-")
+          end
+        end
+        result += fields.join(',')
+        result += ")"
+        result
+      end
   end
 
-end
+end

data/lib/linked_in/version.rb

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

data/linkedin.gemspec

@@ -2,9 +2,9 @@
 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_dependency 'hashie', '~> 1.2'
+  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', '~> 0.9'
   gem.add_development_dependency 'rdoc', '~> 3.8'

data/spec/cases/api_spec.rb

@@ -52,6 +52,14 @@ describe LinkedIn::Api do
     response.code.should == "201"
   end
 
+  it "should be able to send a message" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/mailbox").to_return(:body => "", :status => 201)
+    response = client.send_message("subject", "body", ["recip1", "recip2"])
+    response.body.should == ""
+    response.code.should == "201"
+  end
+
+
   context "Company API" do
     use_vcr_cassette
 
@@ -83,4 +91,27 @@ describe LinkedIn::Api do
     end
   end
 
+  context "Group API" do
+
+    it "should be able to list group memberships for a profile" do
+      stub_request(:get, "https://api.linkedin.com/v1/people/~/group-memberships").to_return(:body => "{}")
+      client.group_memberships.should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to join a group" do
+      stub_request(:put, "https://api.linkedin.com/v1/people/~/group-memberships/123").to_return(:body => "", :status => 201)
+
+      response = client.join_group(123)
+      response.body.should == ""
+      response.code.should == "201"
+    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/oauth_spec.rb

@@ -148,7 +148,6 @@ describe "LinkedIn::Client" do
     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
-      access_token.token.should be_a_kind_of String
     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