linkedin-client 0.0.8

data/.gitignore

@@ -0,0 +1,16 @@
+# Ignore the _creds.rb spec file
+spec/_creds.rb
+
+# Ignore tempfiles
+*.sw[op]
+.DS_Store
+
+# RVM
+.rvmrc
+
+# Gems
+*.gem
+
+# IDEs
+.idea
+.project

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--backtrace
+--require rspec/instafail
+--format RSpec::Instafail

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+script: rspec
+notifications:
+  email:
+    - mike.lewis@airbnb.com

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+#gem 'saddle', :path => '../saddle'
+gem 'saddle', '~> 0.0.38'
+gem 'simple_oauth', '~> 0.2.0'
+
+group :test do
+  gem 'rspec', '~> 2.13.0'
+  gem 'rspec-instafail', '~> 0.2'
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.10)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    i18n (0.6.4)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multipart-post (1.2.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.13.1)
+    saddle (0.0.38)
+      activesupport (>= 3.0)
+      faraday (~> 0.8.7)
+      faraday_middleware (~> 0.9.0)
+    simple_oauth (0.2.0)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 2.13.0)
+  rspec-instafail (~> 0.2)
+  saddle (~> 0.0.38)
+  simple_oauth (~> 0.2.0)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013, Mike Lewis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Ruby Linkedin OAuth 1+2 client
+
+
+## Usage
+
+### For OAuth 1.0
+
+    client = Linkedin::Client.create({
+      :oauth1 => {
+        :consumer_key => YOUR_CONSUMER_KEY,
+        :consumer_secret => YOUR_CONSUMER_SECRET,
+        :token => YOUR_OAUTH1_ACCESS_TOKEN,
+        :token_secret => YOUR_OAUTH1_ACCESS_TOKEN_SECRET
+      }
+    })
+    user = client.people.me
+
+
+### For OAuth 2.0
+
+    client = Linkedin::Client.create(
+      :oauth2_access_token => YOUR_USER_ACCESS_TOKEN
+    )
+    user = client.people.me
+
+
+## License
+(c) Airbnb 2013
+linkedin-client is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/linkedin-client.rb

@@ -0,0 +1,58 @@
+require 'saddle'
+require 'saddle/middleware/authentication/oauth1'
+require 'saddle/middleware/authentication/oauth2'
+
+require 'linkedin-client/exceptions'
+require 'linkedin-client/middleware/declare_format'
+require 'linkedin-client/middleware/exception_raiser'
+require 'linkedin-client/version'
+
+
+
+module Linkedin
+
+  class Client < Saddle::Client
+
+    def self.host
+      'api.linkedin.com'
+    end
+
+    def self.path_prefix
+      'v1'
+    end
+
+    def self.use_ssl
+      true
+    end
+
+    def self.num_retries
+      1
+    end
+
+    def self.timeout
+      5 # seconds
+    end
+
+
+    add_middleware({
+      :klass => Middleware::ExceptionRaiser,
+    })
+
+    add_middleware({
+      :klass => Middleware::DeclareFormat,
+      :args => [:json],
+    })
+
+
+    add_middleware({
+      :klass => Saddle::Middleware::Authentication::OAuth1,
+    })
+
+    add_middleware({
+      :klass => Saddle::Middleware::Authentication::OAuth2,
+      :args => ['oauth2_access_token'],
+    })
+
+  end
+
+end

data/lib/linkedin-client/endpoints/people.rb

@@ -0,0 +1,50 @@
+require 'saddle/endpoint'
+
+
+
+module Linkedin
+  module Endpoints
+
+    class People < Saddle::TraversalEndpoint
+
+      # If selectors is an Array, it can be used to request specific fields
+      def me(opts = {})
+        get(
+          url_with_selectors('~', opts[:selectors]),
+          {},
+          opts
+        )
+      end
+
+      def by_id(_id, opts = {})
+        get(
+          url_with_selectors("id=#{_id.to_s}", opts[:selectors]),
+          {},
+          opts
+        )
+      end
+
+      def by_url(_url, opts = {})
+        escaped_url = CGI::escape(_url.to_s)
+        get(
+          url_with_selectors("url=#{escaped_url}", opts[:selectors]),
+          {},
+          opts
+        )
+      end
+
+
+
+      private
+
+      def url_with_selectors(url, selectors)
+        if selectors.is_a?(Array)
+          url += ":(#{selectors.join(',')})"
+        end
+        url
+      end
+
+    end
+
+  end
+end

data/lib/linkedin-client/exceptions.rb

@@ -0,0 +1,37 @@
+
+##
+# Exceptions for using the Linkedin client
+# It is recommended that you handle these.
+##
+
+module Linkedin
+
+  class GeneralException < StandardError; end
+
+  class TimeoutError < GeneralException; end
+
+  # Some problems might take care of themselves if you try again later. Others won't.
+  class TemporaryError < GeneralException; end # fire warnings on these
+  class PermanentError < GeneralException; end # fire errors on these
+
+
+  ## http://developer.linkedin.com/documents/handling-errors-invalid-tokens
+
+  # 400
+  class BadRequest < PermanentError; end
+
+  # 401
+  class BadToken < PermanentError; end
+  class ExpiredToken < BadToken; end
+  class InvalidToken < BadToken; end
+
+  # 403
+  class ThrottleLimit < TemporaryError; end
+
+  # 404
+  class PageNotFound < PermanentError; end
+
+  # 500
+  class ServiceError < TemporaryError; end
+
+end

data/lib/linkedin-client/middleware/declare_format.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+
+
+
+module Linkedin
+  module Middleware
+
+    ## Declare the data format you would like to use. Defaults to JSON.
+    #
+    class DeclareFormat < Faraday::Middleware
+
+      def initialize(app, format=:json)
+        super(app)
+        @format = format
+      end
+
+      def call(env)
+        env[:request_headers]['x-li-format'] = 'json'
+        @app.call(env)
+      end
+
+    end
+
+  end
+end

data/lib/linkedin-client/middleware/exception_raiser.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+
+require 'linkedin-client/exceptions'
+
+
+
+module Linkedin
+  module Middleware
+
+    ## Raise beautiful exceptions
+    #
+    class ExceptionRaiser < Faraday::Middleware
+
+      ## For handling errors, the message that gets returned is of the following format:
+      # {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Faraday::Error::ClientError => e
+          exception =
+            case e.response[:status]
+            when 400
+              Linkedin::BadRequest
+            when 401
+              if e.response[:body] == 'This token has expired. Renew it'
+                Linkedin::ExpiredToken
+              elsif e.response[:body].start_with?('Throttle limit for calls to this resource')
+                Linkedin::InvalidToken
+              else
+                Linkedin::BadToken
+              end
+            when 403
+              Linkedin::ThrottleLimit
+            when 404
+              Linkedin::PageNotFound
+            when 500
+              Linkedin::ServiceError
+            else
+              Linkedin::GeneralException
+            end
+          raise exception, e.response
+        rescue Saddle::TimeoutError => e
+          raise Linkedin::TimeoutError, e.response
+        end
+      end
+
+    end
+
+  end
+end

data/lib/linkedin-client/version.rb

@@ -0,0 +1,3 @@
+module Linkedin
+  VERSION = '0.0.8'
+end

data/linkedin-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/linkedin-client/version', __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'linkedin-client'
+  s.version       = ::Linkedin::VERSION
+  s.authors       = ['Mike Lewis']
+  s.email         = ['mike.lewis@airbnb.com']
+  s.description   = %q{Linkedin OAuth1+2 client}
+  s.summary       = %q{
+    This is a Linkedin OAuth1+2 client implemented on Saddle
+  }
+  s.homepage      = 'https://github.com/airbnb/linkedin-client'
+  s.license       = 'MIT'
+
+  s.require_path  = 'lib'
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'saddle', '~> 0.0.38'
+  s.add_dependency 'simple_oauth',  '~> 0.2.0'
+end

data/spec/_creds.stub.rb

@@ -0,0 +1,10 @@
+TEST_API_KEY = 'XXX_YOUR_API_KEY_XXX'
+TEST_SECRET_KEY = 'XXX_YOUR_SECRET_KEY_XXX'
+
+TEST_OAUTH1_ACCESS_TOKEN = 'XXX_YOUR_OAUTH1_ACCESS_TOKEN_HERE_XXX'
+TEST_OAUTH1_ACCESS_TOKEN_SECRET = 'XXX_YOUR_OAUTH1_ACCESS_TOKEN_SECRET_HERE_XXX'
+
+TEST_OAUTH2_ACCESS_TOKEN = 'XXX_YOUR_OAUTH2_ACCESS_TOKEN_HERE_XXX'
+
+TEST_USER_ID = 'xxxabcxxx'
+TEST_USER_URL = 'http://www.linkedin.com/in/your_name_here'

data/spec/integration/oauth1_people_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+
+###
+# NOTE: This spec will actually hit Linkedin's servers
+###
+
+describe 'Linkedin::Endpoints::People' do
+  context "Test integration of /people endpoints" do
+
+    # Skip if the creds aren't setup
+    if defined?(TEST_OAUTH2_ACCESS_TOKEN)
+
+      before :each do
+        @client = Linkedin::Client.create({
+          :oauth1 => {
+            :consumer_key => TEST_CONSUMER_KEY,
+            :consumer_secret => TEST_CONSUMER_SECRET,
+            :token => TEST_OAUTH1_ACCESS_TOKEN,
+            :token_secret => TEST_OAUTH1_ACCESS_TOKEN_SECRET
+          }
+        })
+      end
+
+      it 'should get self profile' do
+        @client.people.me.should be_a(Hash)
+      end
+
+      it 'should get self profile with selectors' do
+        @client.people.me({:selectors => ['id']}).should be_a(Hash)
+      end
+
+      it 'should get another profile by id' do
+        @client.people.by_id(TEST_USER_ID).should be_a(Hash)
+      end
+
+      it 'should get another profile by url' do
+        @client.people.by_url(TEST_USER_URL).should be_a(Hash)
+      end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/integration/oauth2_people_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+
+###
+# NOTE: This spec will actually hit Linkedin's servers
+###
+
+describe 'Linkedin::Endpoints::People' do
+  context "Test integration of /people endpoints" do
+
+    # Skip if the creds aren't setup
+    if defined?(TEST_OAUTH2_ACCESS_TOKEN)
+
+      before :each do
+        @client = Linkedin::Client.create(:oauth2_access_token => TEST_OAUTH2_ACCESS_TOKEN)
+      end
+
+      it 'should get self profile' do
+        @client.people.me.should be_a(Hash)
+      end
+
+      it 'should get self profile with selectors' do
+        @client.people.me({:selectors => ['id']}).should be_a(Hash)
+      end
+
+      it 'should get another profile by id' do
+        @client.people.by_id(TEST_USER_ID).should be_a(Hash)
+      end
+
+      it 'should get another profile by url' do
+        @client.people.by_url(TEST_USER_URL).should be_a(Hash)
+      end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/middleware/exception_raiser_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+
+describe Linkedin::Middleware::ExceptionRaiser do
+
+  context "Test raising various exceptions using stubs" do
+
+    before :each do
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @client = Linkedin::Client.create(:stubs => @stubs)
+    end
+
+
+    it 'should detect a bad request' do
+      @stubs.get('/v1') { [ 400, {}, '' ] }
+      expect { @client.requester.get('') }.to raise_error(Linkedin::BadRequest)
+    end
+
+    it 'should detect an expired token' do
+      @stubs.get('/v1') { [ 401, {}, 'This token has expired. Renew it' ] }
+      expect { @client.requester.get('') }.to raise_error(Linkedin::ExpiredToken)
+    end
+
+    it 'should detect an expired token' do
+      @stubs.get('/v1') { [ 401, {}, 'Throttle limit for calls to this resource, x, is reached.' ] }
+      expect { @client.requester.get('') }.to raise_error(Linkedin::InvalidToken)
+    end
+
+    it 'should detect a throttle limit' do
+      @stubs.get('/v1') { [ 403, {}, '' ] }
+      expect { @client.requester.get('') }.to raise_error(Linkedin::ThrottleLimit)
+    end
+
+    it 'should detect a 404' do
+      @stubs.get('/v1') { [ 404, {}, '' ] }
+      expect { @client.requester.get('') }.to raise_error(Linkedin::PageNotFound)
+    end
+
+    it 'should detect a server error' do
+      @stubs.get('/v1') { [ 500, {}, '' ] }
+      expect { @client.requester.get('') }.to raise_error(Linkedin::ServiceError)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'linkedin-client'
+
+
+# Load credentials from ENV if possible, or load from _creds.rb
+if ENV['TEST_USER_TOKEN'] && ENV['TEST_USER_ID'] && ENV['TEST_USER_URL']
+  TEST_USER_TOKEN = ENV['TEST_USER_TOKEN']
+  TEST_USER_ID = ENV['TEST_USER_ID']
+  TEST_USER_URL = ENV['TEST_USER_URL']
+else
+  begin
+    require '_creds'
+  rescue LoadError
+    puts "Using _creds.stub.rb, create a _creds.rb with actual credentials for a live test."
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: linkedin-client
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Mike Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: saddle
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.38
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.38
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Linkedin OAuth1+2 client
+email:
+- mike.lewis@airbnb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/linkedin-client.rb
+- lib/linkedin-client/endpoints/people.rb
+- lib/linkedin-client/exceptions.rb
+- lib/linkedin-client/middleware/declare_format.rb
+- lib/linkedin-client/middleware/exception_raiser.rb
+- lib/linkedin-client/version.rb
+- linkedin-client.gemspec
+- spec/_creds.stub.rb
+- spec/integration/oauth1_people_spec.rb
+- spec/integration/oauth2_people_spec.rb
+- spec/middleware/exception_raiser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/airbnb/linkedin-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This is a Linkedin OAuth1+2 client implemented on Saddle
+test_files:
+- spec/_creds.stub.rb
+- spec/integration/oauth1_people_spec.rb
+- spec/integration/oauth2_people_spec.rb
+- spec/middleware/exception_raiser_spec.rb
+- spec/spec_helper.rb