linkedin-oauth2 0.1.1

data/lib/linked_in/mash.rb

@@ -0,0 +1,68 @@
+require 'hashie'
+require 'multi_json'
+
+module LinkedIn
+  class Mash < ::Hashie::Mash
+
+    # a simple helper to convert a json string to a 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
+    def to_date
+      if !self.has_key?('to_date') && contains_date_fields?
+        Date.civil(self.year, self.month, self.day)
+      else
+        super
+      end
+    end
+
+    def timestamp
+      value = self['timestamp']
+      if value.kind_of? Integer
+        value = value / 1000 if value > 9999999999
+        Time.at(value)
+      else
+        value
+      end
+    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 '_key'
+          'id'
+        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,55 @@
+module LinkedIn
+
+  module Search
+    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 = 0
+    MINOR = 1
+    PATCH = 1
+    PRE   = nil
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+
+end

data/lib/linkedin-oauth2.rb

@@ -0,0 +1,32 @@
+require 'oauth2'
+
+module LinkedIn
+
+  class << self
+    attr_accessor :client_id, :client_secret, :default_profile_fields
+
+    # config/initializers/linkedin.rb (for instance)
+    #
+    # LinkedIn.configure do |config|
+    #   config.client_id = 'client_id'
+    #   config.client_secret = 'client_secret'
+    #   config.default_profile_fields = ['education', 'positions']
+    # end
+    #
+    # elsewhere
+    #
+    # 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-oauth2.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', '< 2.1']
+  gem.add_dependency 'multi_json', '~> 1.0'
+  gem.add_dependency 'oauth2', '~> 0.8'
+  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.9'
+  gem.authors = ["Evan Morikawa", "Wynn Netherland", "Josh Kalderimis"]
+  gem.description = %q{Ruby wrapper for the LinkedIn OAuth 2.0 API}
+  gem.email = ['evan@evanmorikawa.com', 'wynn.netherland@gmail.com', 'josh.kalderimis@gmail.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'http://github.com/emorikawa/linkedin-oauth2'
+  gem.name = 'linkedin-oauth2'
+  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,192 @@
+require 'helper'
+
+describe LinkedIn::Api do
+  before do
+    LinkedIn.default_profile_fields = nil
+  end
+
+  let(:client){LinkedIn::Client.new('stub_client_id',
+                                    'stub_client_secret',
+                                    'stub_access_token')}
+
+  it "should be able to view the account profile" do
+    stub_request(:get, "https://api.linkedin.com/v1/people/~?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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&oauth2_access_token=#{client.access_token.token}").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&oauth2_access_token=#{client.access_token.token}").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&oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").to_return(:body => "", :status => 201)
+    response = client.add_share(:comment => "Testing, 1, 2, 3")
+    response.body.should == ""
+    response.status.should == 201
+  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?oauth2_access_token=#{client.access_token.token}").to_return(
+        :body => "", :status => 201)
+    response = client.update_comment('SOMEKEY', "Testing, 1, 2, 3")
+    response.body.should == ""
+    response.status.should == 201
+  end
+
+  it "should be able to send a message" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/mailbox?oauth2_access_token=#{client.access_token.token}").to_return(:body => "", :status => 201)
+    response = client.send_message("subject", "body", ["recip1", "recip2"])
+    response.body.should == ""
+    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?oauth2_access_token=#{client.access_token.token}").
+      with(:body => "true").to_return(:body => "", :status => 201)
+    response = client.like_share('SOMEKEY')
+    response.body.should == ""
+    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?oauth2_access_token=#{client.access_token.token}").
+      with(:body => "false").to_return(:body => "", :status => 201)
+    response = client.unlike_share('SOMEKEY')
+    response.body.should == ""
+    response.status.should == 201
+  end
+
+  it "should be able to pass down the additional arguments to OAuth's request_access_token" do
+# 
+#     stub_request(:post, "https://www.linkedin.com/uas/oauth2/accessToken").with { |r| r.body == "grant_type=authorization_code&code=auth_code&client_id=stub_client_id&client_secret=stub_client_secret&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fauth%2Fcallback" }
+# 
+#     access_token = client.request_access_token("auth_code",
+#       {:redirect_uri => "http://localhost:3000/auth/callback"})
+
+    c = LinkedIn::Client.new('stub_client_id',
+                             'stub_client_secret',
+                             'stub_access_token',
+                             {site: "some_other_site"})
+
+    c.oauth2_client.site == "some_other_site"
+  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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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&oauth2_access_token=#{client.access_token.token}").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 "Job API" do
+    use_vcr_cassette
+
+    it "should be able to view a job listing" do
+      stub_request(:get, "https://api.linkedin.com/v1/jobs/id=1586?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").to_return(:body => "", :status => 201)
+      response = client.add_job_bookmark(:id => 1452577)
+      response.body.should == ""
+      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?oauth2_access_token=#{client.access_token.token}").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?oauth2_access_token=#{client.access_token.token}").to_return(:body => "", :status => 201)
+
+      response = client.join_group(123)
+      response.body.should == ""
+      response.status.should == 201
+    end
+
+  end
+
+  context "errors" do
+    it "should raise access denied error when linkedin returns 403 status code" do
+      stub_request(:get, "https://api.linkedin.com/v1/people-search?first-name=javan&oauth2_access_token=#{client.access_token.token}").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.client_id = nil
+    LinkedIn.client_secret = nil
+    LinkedIn.default_profile_fields = nil
+  end
+
+  it "should be able to set the client_id and client_secret" do
+    LinkedIn.client_id  = 'client_id'
+    LinkedIn.client_secret = 'client_secret'
+
+    LinkedIn.client_id.should  == 'client_id'
+    LinkedIn.client_secret.should == 'client_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 client_id and client_secret via a configure block" do
+    LinkedIn.configure do |config|
+      config.client_id  = 'client_id'
+      config.client_secret = 'client_secret'
+      config.default_profile_fields = ['education', 'positions']
+    end
+
+    LinkedIn.client_id.should  == 'client_id'
+    LinkedIn.client_secret.should == 'client_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