linkedin-saddle-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1b9ff5918bbb5a2541647584c70e78f20838ac9
+  data.tar.gz: f6761aac0888ceee401f978b524ecf44c55d6346
+SHA512:
+  metadata.gz: ceb21c6b7d9ed0ae4c06e80c3d3193fe1370790af8e555c049d5e479d3f9ba7b415de28b01a5e176a8f40e58a18963771dfb3637af2d54382df0ab7242e8dff8
+  data.tar.gz: ba5279931619b62d4128170cbd9f408309df60744106c1b09e514ea9baedaba52e54fba029abb2028e4743d310d4837f4296fc9d56dfa6a3f0c1e3e04984e47a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2'
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014, Roman Fuchs
+
+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,13 @@
+# Ruby LinkedIn OAuth 2 client
+
+
+## Usage
+
+    client = LinkedIn::Client.create(
+      :access_token => YOUR_OAUTH2_ACCESS_TOKEN
+    )
+    profile = client.account.get_profile
+
+
+## License
+linkedin-client is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/linkedin-client.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+
+require 'saddle'
+require 'saddle/middleware/authentication/oauth2'
+
+require 'linkedin-client/stub'
+require 'linkedin-client/version'
+
+
+module LinkedIn
+
+  class Client < Saddle::Client
+    extend LinkedIn::Stub
+
+    def initialize args
+        args.each do |k,v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+    end
+
+    def self.host
+      @host || 'api.linkedin.com'
+    end
+
+    def self.path_prefix
+      @path_prefix || ''
+    end
+
+    def self.use_ssl
+      @use_ssl || true
+    end
+
+    def self.num_retries
+      @num_retries || 1
+    end
+
+    def self.timeout
+      # seconds
+      @timeout || 5
+    end
+
+    def self.request_style
+      @request_style || :json 
+    end
+
+    def self.option_fields
+      @option_fields = ['id', 'email-address', 'first-name', 'last-name', 'num-connections', 'positions', 'three-current-positions', 'three-past-positions', 'educations']
+    end 
+
+    add_middleware({
+      :klass => Saddle::Middleware::Authentication::OAuth2,
+      :args => ['oauth2_access_token'],
+    })
+
+  end
+
+end

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

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require 'saddle/endpoint'
+
+module LinkedIn
+  module Endpoints
+
+    class V1 < Saddle::TraversalEndpoint
+
+      def get_profile(id, opts = {})
+        get_with_format("people/id=#{id}", {}, opts)
+      end
+
+      def get_info_by_fields(fields = LinkedIn::Client.option_fields, opts = {})
+        get_with_format("people/~:(#{fields.join(',')})", {}, opts)
+      end
+
+      private
+
+      def get_with_format(url, params={}, options={})
+        get(url, params.merge({:format => LinkedIn::Client.request_style}), options)
+      end
+    end
+
+  end
+end

data/lib/linkedin-client/exceptions.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+##
+# Exceptions for using the LinkedIn client
+# It is recommended that you handle these.
+##
+
+module LinkedIn
+
+  class GenericException < StandardError; end
+
+  class TimeoutError < GenericException; end
+
+  # Some problems might take care of themselves if you try again later. Others won't.
+  class TemporaryError < GenericException; end # fire warnings on these
+  class PermanentError < GenericException; end # fire errors on these
+
+end

data/lib/linkedin-client/stub.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require 'linkedin-client/endpoints/v1'
+
+# This allows us to stub out live calls when testing from calling projects
+
+module LinkedIn
+  module Stub
+
+    # Setup stubbing for all endpoints
+    def stub!
+      LinkedIn::Endpoints::V1.any_instance.stub(:get_profile).and_return( Stub::Data::PROFILE )
+    end
+
+    # Test data for stubs to return
+    module Data
+
+      PROFILE = {
+        "firstName"=>"Henry",
+         "headline"=>"Software Engineer, Growth at Airbnb",
+         "lastName"=>"Cai 蔡明航",
+         "siteStandardProfileRequest"=> {
+            "url"=> "https://www.linkedin.com/profile/view?id=17907854&authType=name&authToken=Y7oQ&trk=api*a4138181*s4202511*"}
+        }.freeze
+    end
+
+  end
+end

data/lib/linkedin-client/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module LinkedIn
+  VERSION = '0.0.1'
+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-saddle-client'
+  s.version       = ::LinkedIn::VERSION
+  s.authors       = ['Henry Cai']
+  s.email         = ['minghangcai@gmail.com']
+  s.description   = %q{LinkedIn OAuth2 client}
+  s.summary       = %q{
+    This is a LinkedIn OAuth2 client implemented on Saddle
+  }
+  s.homepage      = 'https://github.com/hcai/linkedin-client.git'
+  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.46'
+  s.add_dependency 'simple_oauth', '~> 0.2.0'
+end

data/spec/_creds.stub.rb

@@ -0,0 +1,3 @@
+# encoding: UTF-8
+
+TEST_ACCESS_TOKEN = 'AQXgINs0jPUDHYnMI5lKBZi3tPOHSeYF7skE_2DXL_oth5-yo-Me2kRWjat_5Tes3iVQAGDYButMTceGBwFWj4kNK72B3glOb4jQyccWPOSUwfrgcXA5UqsDW4TgTlxaByFAlvoVQBbwc9WgXieTlDT0MmAFgehtIWOrg4LQUW7N4iEUUyA'

data/spec/integration/v1_spec.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'pp'
+
+
+###
+# NOTE: This spec will actually hit LinkedIn's servers
+###
+
+describe 'LinkedIn::Endpoints::People' do
+  context "Test integration of people endpoint" do
+
+    # Skip if the creds aren't setup
+    if defined?(TEST_ACCESS_TOKEN)
+
+      before :each do
+        @client = LinkedIn::Client.create(:oauth2_access_token => TEST_ACCESS_TOKEN)
+      end
+
+      it 'get my profile' do
+        response = @client.v1.get_profile('ARz7eS698N')
+        response.should be_a(Hash)
+        response['firstName'].should_not be_nil
+      end
+
+      it 'gets default fields' do
+        response = @client.v1.get_info_by_fields()
+        response.should be_a(Hash)
+        pp response
+        response['threeCurrentPositions'].should_not be_nil
+      end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+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']
+else
+  begin
+    require '_creds'
+  rescue LoadError
+    puts "Using _creds.stub.rb, create a _creds.rb with actual credentials for a live test."
+  end
+end

data/spec/stub/stub_spec.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe LinkedIn::Stub do
+  context "can stub out calls" do
+
+    let (:client) { LinkedIn::Client.create }
+
+    before :each do
+      LinkedIn::Client.stub!
+    end
+
+    describe "and return test data" do
+
+      it "for client.people.profile_basic" do
+        client.poeple.get_profile.should == LinkedIn::Stub::Data::PROFILE
+      end
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: linkedin-saddle-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henry Cai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: saddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.46
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.46
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: LinkedIn OAuth2 client
+email:
+- minghangcai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/linkedin-client.rb
+- lib/linkedin-client/endpoints/v1.rb
+- lib/linkedin-client/exceptions.rb
+- lib/linkedin-client/stub.rb
+- lib/linkedin-client/version.rb
+- linkedin-client.gemspec
+- spec/_creds.stub.rb
+- spec/integration/v1_spec.rb
+- spec/spec_helper.rb
+- spec/stub/stub_spec.rb
+homepage: https://github.com/hcai/linkedin-client.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This is a LinkedIn OAuth2 client implemented on Saddle
+test_files:
+- spec/_creds.stub.rb
+- spec/integration/v1_spec.rb
+- spec/spec_helper.rb
+- spec/stub/stub_spec.rb