linkedin-build 1.1.14

data/lib/linked_in/mash.rb

@@ -0,0 +1,95 @@
+require 'hashie'
+require 'multi_json'
+
+module LinkedIn
+
+  # The generalized pseudo-object that is returned for all query
+  # requests.
+  class Mash < ::Hashie::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
+    #
+    # @return [Date]
+    def to_date
+      if !self.has_key?('to_date') && contains_date_fields?
+        Date.civil(self.year, self.month, self.day)
+      else
+        super
+      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
+        value = value / 1000 if value > 9999999999
+        Time.at(value)
+      else
+        value
+      end
+    end
+
+    # Return the results array from the query
+    #
+    # @return [Array]
+    def all
+      super || []
+    end
+
+    protected
+
+      def contains_date_fields?
+        self.year? && self.month? && self.day?
+      end
+
+      # overload the convert_key mash method so that the LinkedIn
+      # keys are made a little more ruby-ish
+      def convert_key(key)
+        case key.to_s
+        when '_total'
+          'total'
+        when 'values'
+          'all'
+        when 'numResults'
+          'total_results'
+        else
+          underscore(key)
+        end
+      end
+
+      # borrowed from ActiveSupport
+      # no need require an entire lib when we only need one method
+      def underscore(camel_cased_word)
+        word = camel_cased_word.to_s.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+
+  end
+end

data/lib/linked_in/search.rb

@@ -0,0 +1,71 @@
+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"
+
+      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
+
+    private
+
+      def format_options_for_query(opts)
+        opts.inject({}) do |list, kv|
+          key, value = kv.first.to_s.gsub("_","-"), kv.last
+          list[key]  = sanitize_value(value)
+          list
+        end
+      end
+
+      def sanitize_value(value)
+        value = value.join("+") if value.is_a?(Array)
+        value = value.gsub(" ", "+") if value.is_a?(String)
+        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

data/lib/linked_in/version.rb

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

data/lib/linkedin.rb

@@ -0,0 +1,35 @@
+require 'oauth'
+
+module LinkedIn
+
+  class << self
+    attr_accessor :token, :secret, :default_profile_fields
+
+    # 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
+    end
+  end
+
+  autoload :Api,     "linked_in/api"
+  autoload :Client,  "linked_in/client"
+  autoload :Mash,    "linked_in/mash"
+  autoload :Errors,  "linked_in/errors"
+  autoload :Helpers, "linked_in/helpers"
+  autoload :Search,  "linked_in/search"
+  autoload :Version, "linked_in/version"
+end

data/linkedin-build.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require File.expand_path('../lib/linked_in/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'hashie', '3.5.6' #'~> 3.0'
+  gem.add_dependency 'multi_json', '~> 1.0'
+  gem.add_dependency 'oauth', '0.5.1' # '~> 0.4'
+  gem.add_dependency 'oauth2', '1.4.0'
+  # gem.add_development_dependency 'json', '~> 1.6'
+  gem.add_development_dependency 'rake', '~> 10'
+  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'
+  gem.add_development_dependency 'webmock', '~> 1.11'
+  gem.authors = ['Matthew Kirk', 'Wynn Netherland', 'Josh Kalderimis']
+  gem.description = 'Ruby wrapper for the LinkedIn API'
+  gem.email = ['meteor.kirk@gmail.com', 'wynn.netherland@gmail.com', 'josh.kalderimis@gmail.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'http://github.com/hexgnu/linkedin'
+  gem.name = 'linkedin-build'
+  gem.licenses = %w[MIT]
+  gem.require_paths = ['lib']
+  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

@@ -0,0 +1,308 @@
+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 the picture urls" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/picture-urls::(original)").to_return(:body => "{}")
+    client.picture_urls.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 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)
+  end
+
+  it "should be able to view network_update's comments" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/network/updates/key=network_update_key/update-comments").to_return(:body => "{}")
+    client.share_comments("network_update_key").should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view network_update's likes" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/network/updates/key=network_update_key/likes").to_return(:body => "{}")
+    client.share_likes("network_update_key").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 == nil
+    response.status.should == "201"
+  end
+
+  it "should be able to share a new company status" do
+    stub_request(:post, "https://api.linkedin.com/v1/companies/123456/shares").to_return(:body => "", :status => 201)
+    response = client.add_company_share("123456", { :comment => "Testing, 1, 2, 3" })
+    response.body.should == nil
+    response.status.should == "201"
+  end
+
+  it "returns the shares for a person" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/network/updates?type=SHAR&scope=self&after=1234&count=35").to_return(
+      :body => "{}")
+    client.shares(:after => 1234, :count => 35)
+  end
+
+  it "should be able to fetch a single share" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~/network/updates/key=network_update_key").to_return(:body => "{}")
+    client.share("network_update_key").should be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to comment on network update" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/network/updates/key=SOMEKEY/update-comments").to_return(
+        :body => "", :status => 201)
+    response = client.update_comment('SOMEKEY', "Testing, 1, 2, 3")
+    response.body.should == nil
+    response.status.should == "201"
+  end
+
+  it "should be able to like a network update" do
+    stub_request(:put, "https://api.linkedin.com/v1/people/~/network/updates/key=SOMEKEY/is-liked").
+      with(:body => "true").to_return(:body => "", :status => 201)
+    response = client.like_share('SOMEKEY')
+    response.body.should == nil
+    response.status.should == "201"
+  end
+
+  it "should be able to unlike a network update" do
+    stub_request(:put, "https://api.linkedin.com/v1/people/~/network/updates/key=SOMEKEY/is-liked").
+      with(:body => "false").to_return(:body => "", :status => 201)
+    response = client.unlike_share('SOMEKEY')
+    response.body.should == nil
+    response.status.should == "201"
+  end
+
+  it "should be able to pass down the additional arguments to OAuth's get_request_token" do
+    consumer.should_receive(:get_request_token).with(
+      {:oauth_callback => "http://localhost:3000/auth/callback"},  :scope => "rw_nus").and_return("request_token")
+
+    request_token = client.request_token(
+      {:oauth_callback => "http://localhost:3000/auth/callback"},  :scope => "rw_nus"
+    )
+
+    request_token.should == "request_token"
+  end
+
+  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 => "{}")
+      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 be able to view a user's company pages" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies?is-company-admin=true").to_return(:body => "{}")
+      client.company(:is_admin => 'true').should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to page a user's company pages" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies?is-company-admin=true&count=10&start=0").to_return(:body => "{}")
+      client.company(:is_admin => 'true', :count => 10, :start => 0).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
+
+    it "should be able to view company_updates" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/id=1586/updates").to_return(:body => "{}")
+      client.company_updates(:id => 1586).should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view company_statistic" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/id=1586/company-statistics").to_return(:body => "{}")
+      client.company_statistics(:id => 1586).should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view company updates comments" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/id=1586/updates/key=company_update_key/update-comments").to_return(:body => "{}")
+      client.company_updates_comments("company_update_key", :id => 1586).should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view company updates likes" do
+      stub_request(:get, "https://api.linkedin.com/v1/companies/id=1586/updates/key=company_update_key/likes").to_return(:body => "{}")
+      client.company_updates_likes("company_update_key", :id => 1586).should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to follow a company" do
+      stub_request(:post, "https://api.linkedin.com/v1/people/~/following/companies").to_return(:body => "", :status => 201)
+
+      response = client.follow_company(1586)
+      response.body.should == nil
+      response.status.should == "201"
+    end
+
+    it "should be able to unfollow a company" do
+      stub_request(:delete, "https://api.linkedin.com/v1/people/~/following/companies/id=1586").to_return(:body => "", :status => 201)
+
+      response = client.unfollow_company(1586)
+      response.body.should == nil
+      response.status.should == "201"
+    end
+
+  end
+
+  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 => "{}")
+      client.job(:id => 1586).should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view its job bookmarks" do
+      stub_request(:get, "https://api.linkedin.com/v1/people/~/job-bookmarks").to_return(:body => "{}")
+      client.job_bookmarks.should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to view its job suggestion" do
+      stub_request(:get, "https://api.linkedin.com/v1/people/~/suggestions/job-suggestions").to_return(:body => "{}")
+      client.job_suggestions.should be_an_instance_of(LinkedIn::Mash)
+    end
+
+    it "should be able to add a bookmark" do
+      stub_request(:post, "https://api.linkedin.com/v1/people/~/job-bookmarks").to_return(:body => "", :status => 201)
+      response = client.add_job_bookmark(:id => 1452577)
+      response.body.should == nil
+      response.status.should == "201"
+    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 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)
+    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 == nil
+      response.status.should == "201"
+    end
+
+    it "should be able to list a group profile" do
+      stub_request(:get, "https://api.linkedin.com/v1/groups/123").to_return(:body => '{"id": "123"}')
+      response = client.group_profile(:id => 123)
+      response.id.should == '123'
+    end
+
+    it "should be able to list group posts" do
+      stub_request(:get, "https://api.linkedin.com/v1/groups/123/posts").to_return(:body => '{"id": "123"}')
+      response = client.group_posts(:id => 123)
+      response.id.should == '123'
+    end
+
+    it 'should be able to post a discussion to a group' do
+      expected = {
+        'title' => 'New Discussion',
+        'summary' => 'New Summary',
+        'content' => {
+          "submitted-url" => "http://www.google.com"
+        }
+      }
+
+      stub_request(:post, "https://api.linkedin.com/v1/groups/123/posts").with(:body => expected).to_return(:body => "", :status => 201)
+      response = client.post_group_discussion(123, expected)
+      response.body.should == nil
+      response.status.should == '201'
+    end
+
+    it "should be able to share a new group status" do
+      stub_request(:post, "https://api.linkedin.com/v1/groups/1/posts").to_return(:body => "", :status => 201)
+      response = client.add_group_share(1, :comment => "Testing, 1, 2, 3")
+      response.body.should == nil
+      response.status.should == "201"
+    end
+  end
+
+  context "Communication API" do
+    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 == nil
+      response.status.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