linkedin-oauth2 0.1.1 → 1.0.0

data/lib/linked_in/api/update_methods.rb

@@ -1,76 +0,0 @@
-module LinkedIn
-  module Api
-
-    module UpdateMethods
-
-      def add_share(share)
-        path = "/people/~/shares"
-        defaults = {:visibility => {:code => "anyone"}}
-        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 add_job_bookmark(bookmark)
-        path = "/people/~/job-bookmarks"
-        body = {'job' => {'id' => bookmark}}
-        post(path, body.to_json, "Content-Type" => "application/json")
-      end
-
-      # def share(options={})
-      #   path = "/people/~/shares"
-      #   defaults = { :visability => 'anyone' }
-      #   post(path, share_to_xml(defaults.merge(options)))
-      # end
-      #
-      def update_comment(network_key, comment)
-        path = "/people/~/network/updates/key=#{network_key}/update-comments"
-        body = {'comment' => comment}
-        post(path, body.to_json, "Content-Type" => "application/json")
-      end
-      #
-      # def update_network(message)
-      #   path = "/people/~/person-activities"
-      #   post(path, network_update_to_xml(message))
-      # end
-      #
-
-      def like_share(network_key)
-        path = "/people/~/network/updates/key=#{network_key}/is-liked"
-        put(path, 'true', "Content-Type" => "application/json")
-      end
-
-      def unlike_share(network_key)
-        path = "/people/~/network/updates/key=#{network_key}/is-liked"
-        put(path, 'false', "Content-Type" => "application/json")
-      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"
-      #   delete(path).code
-      # end
-      #
-
-    end
-
-  end
-end

data/lib/linked_in/client.rb

@@ -1,31 +0,0 @@
-require 'cgi'
-
-module LinkedIn
-
-  class Client
-    include Helpers::Request
-    include Helpers::Authorization
-    include Api::QueryMethods
-    include Api::UpdateMethods
-    include Search
-
-    attr_reader :client_id, :client_secret, :access_token
-
-    # The first two arguments must be your client_id, and client_secret.
-    # The third option may either be an access_token or an options hash.
-    def initialize(client_id=LinkedIn.client_id,
-                   client_secret=LinkedIn.client_secret,
-                   initial_access_token=nil,
-                   options={})
-      @client_id     = client_id
-      @client_secret = client_secret
-      if initial_access_token.is_a? Hash
-        @client_options = initial_access_token
-      else
-        @client_options = options
-        self.set_access_token initial_access_token
-      end
-    end
-  end
-
-end

data/lib/linked_in/helpers.rb

@@ -1,6 +0,0 @@
-module LinkedIn
-  module Helpers
-    autoload :Authorization, "linked_in/helpers/authorization"
-    autoload :Request,       "linked_in/helpers/request"
-  end
-end

data/lib/linked_in/helpers/authorization.rb

@@ -1,106 +0,0 @@
-
-# TODO
-# `consumer` renamed to `client`
-#
-# rename OAuth to OAuth2
-#
-# deprecate `request_token`
-# deprecate `access_token`
-#
-# deprecate `authorize_from_request`
-# deprecate `authorize_from_access`
-#
-# cleanup bottom
-# deprecate `oauth_callback`
-#
-# DONE 
-# `consumer_token renamed to `client_id`
-# `consumer_secret renamed to `client_secret`
-# request_token_url is deprecated. Replaced with token_url
-# access_token_url is deprecated. Replaced with token_url
-# request_token_path is deprecated
-# access_token_path has changed
-# authorize_path has been deprecated
-
-module LinkedIn
-  module Helpers
-
-    module Authorization
-
-      DEFAULT_OAUTH2_OPTIONS = {
-        authorize_path: "/uas/oauth2/authorization",
-        access_token_path: "/uas/oauth2/accessToken",
-        api_host: "https://api.linkedin.com",
-        auth_host: "https://www.linkedin.com"
-      }
-
-      def oauth2_client
-        @oauth2_client ||= ::OAuth2::Client.new(@client_id,
-                                                @client_secret,
-                                                parse_oauth2_options)
-      end
-
-      # A way to fetch the authorize_url
-      # @param :redirect_uri - Where you want it to redirect to after
-      # @param :scope - A list of member permissions you would like to
-      # request.
-      def authorize_url(params={})
-        # response_type param included by default by using the OAuth 2.0
-        # auth_code strategy
-        # client_id param included automatically by the OAuth 2.0 gem
-        params[:state] ||= state
-        params[:redirect_uri] ||= "http://localhost"
-        oauth2_client.auth_code.authorize_url(params)
-      rescue OAuth2::Error => e
-        raise LinkedIn::Errors::UnauthorizedError.new(e.code), e.description
-      end
-
-      # Fetches the access_token given the auth_code fetched by
-      # navigating to `authorize_url`
-      # @param :redirect_uri - Where you want to redirect after you have
-      # fetched the token.
-      def request_access_token(code, params={})
-        params[:redirect_uri] ||= "http://localhost"
-        opts = {}
-        opts[:mode] = :query
-        opts[:param_name] = "oauth2_access_token"
-        @access_token = oauth2_client.auth_code.get_token(code, params, opts)
-      rescue OAuth2::Error => e
-        raise LinkedIn::Errors::UnauthorizedError.new(e.code), e.description
-      end
-
-      # If one already has an access_token string, it can be set here and
-      # turned into an OAuth2::AccessToken object.
-      def set_access_token(token, options={})
-        options[:access_token] = token
-        options[:mode] = :query
-        options[:param_name] = "oauth2_access_token"
-        @access_token = OAuth2::AccessToken.from_hash oauth2_client, options
-      end
-
-      # NOTE: There is an attr_reader for :access_token.
-
-      private
-
-        # The keys of this hash are designed to match the OAuth2
-        # initialize spec.
-        def parse_oauth2_options
-          default = {site: DEFAULT_OAUTH2_OPTIONS[:api_host],
-                     token_url: full_oauth_url_for(:access_token, :auth_host),
-                     authorize_url: full_oauth_url_for(:authorize, :auth_host)}
-          return default.merge(@client_options)
-        end
-
-        def full_oauth_url_for(url_type, host_type)
-          host = DEFAULT_OAUTH2_OPTIONS[host_type]
-          path = DEFAULT_OAUTH2_OPTIONS["#{url_type}_path".to_sym]
-          "#{host}#{path}"
-        end
-
-        def state
-          o = [('a'..'z'),('A'..'Z')].map{|i| i.to_a}.flatten
-          @state ||= (0...50).map{ o[rand(o.length)] }.join
-        end
-    end
-  end
-end

data/lib/linked_in/helpers/request.rb

@@ -1,93 +0,0 @@
-module LinkedIn
-  module Helpers
-
-    module Request
-
-      DEFAULT_HEADERS = {
-        'x-li-format' => 'json'
-      }
-
-      API_PATH = '/v1'
-
-      protected
-
-        def get(path, options={})
-          response = access_token.get("#{API_PATH}#{path}", headers: DEFAULT_HEADERS.merge(options))
-          raise_errors(response)
-          response.body
-        rescue OAuth2::Error => e
-          raise LinkedIn::Errors::AccessDeniedError.new(e.code), e.description
-        end
-
-        def post(path, body='', options={})
-          response = access_token.post("#{API_PATH}#{path}", body: body, headers: DEFAULT_HEADERS.merge(options))
-          raise_errors(response)
-          response
-        rescue OAuth2::Error => e
-          raise LinkedIn::Errors::AccessDeniedError.new(e.code), e.description
-        end
-
-        def put(path, body, options={})
-          response = access_token.put("#{API_PATH}#{path}", body: body, headers: DEFAULT_HEADERS.merge(options))
-          raise_errors(response)
-          response
-        rescue OAuth2::Error => e
-          raise LinkedIn::Errors::AccessDeniedError.new(e.code), e.description
-        end
-
-        def delete(path, options={})
-          response = access_token.delete("#{API_PATH}#{path}", headers: DEFAULT_HEADERS.merge(options))
-          raise_errors(response)
-          response
-        rescue OAuth2::Error => e
-          raise LinkedIn::Errors::AccessDeniedError.new(e.code), e.description
-        end
-
-      private
-
-        def raise_errors(response)
-          # Even if the json answer contains the HTTP status code, LinkedIn also sets this status
-          # in the HTTP answer (thankfully).
-          case response.status.to_i
-          when 401
-            data = Mash.from_json(response.body)
-            raise LinkedIn::Errors::UnauthorizedError.new(data), "(#{data.status}): #{data.message}"
-          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.status}): #{response.message}"
-          when 500
-            raise LinkedIn::Errors::InformLinkedInError, "LinkedIn had an internal error. Please let them know in the forum. (#{response.status}): #{response.message}"
-          when 502..503
-            raise LinkedIn::Errors::UnavailableError, "(#{response.status}): #{response.message}"
-          end
-        end
-
-
-        # Stolen from Rack::Util.build_query
-        def to_query(params)
-          params.map { |k, v|
-            if v.class == Array
-              to_query(v.map { |x| [k, x] })
-            else
-              v.nil? ? escape(k) : "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
-            end
-          }.join("&")
-        end
-
-        def to_uri(path, options)
-          uri = URI.parse(path)
-
-          if options && options != {}
-            uri.query = to_query(options)
-          end
-          uri.to_s
-        end
-    end
-
-  end
-end

data/spec/cases/api_spec.rb

@@ -1,192 +0,0 @@
-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