linkedin-oauth2 0.1.1 → 1.0.0

data/Rakefile

@@ -1,26 +1,19 @@
-#!/usr/bin/env rake
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
+# Adds the following task:
+#   spec - Run RSpec tests & setup $LOAD_PATH properly
+#
+# We recommend you set the following RSpec options in your own ~/.rspec
+# --color
+# --format documentation
+# --profile
+# --order rand
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
-
-task :compile_and_test do
-  puts "Compiling"
-  puts `gem build linkedin-oauth2.gemspec && gem install ./linkedin-oauth2*.gem`
-  puts "Testing"
-  Rake::Task["test"].invoke
-end
+# Adds the following tasks:
+#   build   - Build gem in pkg/ directory
+#   install - Build and install gem
+#   release - Create tag, build gem, and push it to Rubygems
+require 'bundler/gem_helper'
+Bundler::GemHelper.install_tasks
 
-require 'rdoc/task'
-require File.expand_path('../lib/linked_in/version', __FILE__)
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "linkedin #{LinkedIn::VERSION::STRING}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: :spec

data/lib/linked_in/access_token.rb

@@ -0,0 +1,24 @@
+module LinkedIn
+  # A simple data object to contain the token string and expiration data.
+  class AccessToken
+    attr_accessor :token, :expires_in, :expires_at
+
+    # Creates a simple data wrapper for an access token.
+    #
+    # LinkedIn returns only an `expires_in` value. This calculates and
+    # sets and `expires_at` field for convenience.
+    #
+    # @param [String] token the access token
+    # @param [FixNum] expires_in number of seconds the token lasts for
+    # @param [Time] expires_at when the token will expire.
+    def initialize(token=nil, expires_in=nil, expires_at=nil)
+      self.token = token
+      self.expires_in = expires_in
+      if expires_at.nil? and not self.expires_in.nil?
+        self.expires_at = Time.now + expires_in
+      else
+        self.expires_at = expires_at
+      end
+    end
+  end
+end

data/lib/linked_in/api.rb

@@ -1,6 +1,99 @@
 module LinkedIn
-  module Api
-    autoload :QueryMethods,  "linked_in/api/query_methods"
-    autoload :UpdateMethods, "linked_in/api/update_methods"
+  class API
+
+    attr_accessor :access_token
+
+    def initialize(access_token=nil)
+      access_token = parse_access_token(access_token)
+      verify_access_token!(access_token)
+      @access_token = access_token
+
+      @connection = LinkedIn::Connection.new params: default_params,
+                                             headers: default_headers
+
+      initialize_endpoints
+    end
+
+    extend Forwardable # Composition over inheritance
+    def_delegators :@jobs, :job,
+                           :job_bookmarks,
+                           :job_suggestions,
+                           :add_job_bookmark
+
+    def_delegators :@people, :profile,
+                             :connections,
+                             :picture_urls,
+                             :new_connections
+
+    def_delegators :@search, :search
+
+    def_delegators :@groups, :join_group,
+                             :group_posts,
+                             :group_profile,
+                             :add_group_share,
+                             :group_suggestions,
+                             :group_memberships,
+                             :post_group_discussion
+
+    def_delegators :@companies, :company,
+                                :follow_company,
+                                :company_updates,
+                                :unfollow_company,
+                                :add_company_share,
+                                :company_statistics,
+                                :company_updates_likes,
+                                :company_updates_comments
+
+    def_delegators :@communications, :send_message
+
+    def_delegators :@share_and_social_stream, :shares,
+                                              :add_share,
+                                              :like_share,
+                                              :share_likes,
+                                              :unlike_share,
+                                              :share_comments,
+                                              :update_comment,
+                                              :network_updates
+
+    private ##############################################################
+
+    def initialize_endpoints
+      @jobs = LinkedIn::Jobs.new(@connection)
+      @people = LinkedIn::People.new(@connection)
+      @search = LinkedIn::Search.new(@connection)
+      @groups = LinkedIn::Groups.new(@connection)
+      @companies = LinkedIn::Companies.new(@connection)
+      @communications = LinkedIn::Communications.new(@connection)
+      @share_and_social_stream = LinkedIn::ShareAndSocialStream.new(@connection)
+    end
+
+    def default_params
+      # https//developer.linkedin.com/documents/authentication
+      return {oauth2_access_token: @access_token.token}
+    end
+
+    def default_headers
+      # https://developer.linkedin.com/documents/api-requests-json
+      return {"x-li-format" => "json"}
+    end
+
+    def verify_access_token!(access_token)
+      if not access_token.is_a? LinkedIn::AccessToken
+        raise no_access_token_error
+      end
+    end
+
+    def parse_access_token(access_token)
+      if access_token.is_a? LinkedIn::AccessToken
+        return access_token
+      elsif access_token.is_a? String
+        return LinkedIn::AccessToken.new(access_token)
+      end
+    end
+
+    def no_access_token_error
+      msg = LinkedIn::ErrorMessages.no_access_token
+      LinkedIn::InvalidRequest.new(msg)
+    end
   end
 end

data/lib/linked_in/api_resource.rb

@@ -0,0 +1,165 @@
+module LinkedIn
+  # The abstract class all API endpoints inherit from. Providers common
+  # builder methods across all endpoints.
+  #
+  # @!macro profile_options
+  #   @options opts [String] :id LinkedIn ID to fetch profile for
+  #   @options opts [String] :url The profile url
+  #   @options opts [String] :lang Requests the language of the profile.
+  #     Options are: en, fr, de, it, pt, es
+  #   @options opts [Array, Hash] :fields fields to fetch. The list of
+  #     fields can be found at
+  #     https://developer.linkedin.com/documents/profile-fields
+  #   @options opts [String] :secure (true) specify if urls in the
+  #     response should be https
+  #   @options opts [String] :"secure-urls" (true) alias to secure option
+  #
+  # @!macro share_input_fields
+  #   @param [Hash] share content of the share
+  #   @option share [String] :comment
+  #   @option share [String] :content
+  #   @option share [String] :title
+  #   @option share [String] :submitted-url
+  #   @option share [String] :submitted-image-url
+  #   @option share [String] :description
+  #   @option share [String] :visibility
+  #   @option share [String] :code
+  #
+  # @!macro company_path_options
+  #   @param [Hash] options identifies the user profile you want
+  #   @option options [String] :domain company email domain
+  #   @option options [String] :id company ID
+  #   @option options [String] :url
+  #   @option options [String] :name company universal name
+  #   @option options [String] :is_admin list all companies that the
+  #     authenticated is an administrator of
+  class APIResource
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    protected ############################################################
+
+    def get(path, options={})
+      url, params, headers = prepare_connection_params(path, options)
+
+      response = @connection.get(url, params, headers)
+
+      return Mash.from_json(response.body)
+    end
+
+    def post(path=nil, body=nil, headers=nil, &block)
+      @connection.post(prepend_prefix(path), body, headers, &block)
+    end
+
+    def put(path=nil, body=nil, headers=nil, &block)
+      @connection.put(prepend_prefix(path), body, headers, &block)
+    end
+
+    def delete(path=nil, params=nil, headers=nil, &block)
+      @connection.delete(prepend_prefix(path), params, headers, &block)
+    end
+
+    def deprecated
+      LinkedIn::Deprecated.new(LinkedIn::ErrorMessages.deprecated)
+    end
+
+    private ##############################################################
+
+    def prepend_prefix(path)
+      return @connection.path_prefix + path
+    end
+
+    def prepare_connection_params(path, options)
+      path = prepend_prefix(path)
+      path += generate_field_selectors(options)
+
+      headers = options.delete(:headers) || {}
+
+      params = format_options_for_query(options)
+
+      return [path, params, headers]
+    end
+
+    # Dasherizes the param keys
+    def format_options_for_query(options)
+      options.reduce({}) do |list, kv|
+        key, value = kv.first.to_s.gsub("_","-"), kv.last
+        list[key]  = value
+        list
+      end
+    end
+
+    def generate_field_selectors(options)
+      default = LinkedIn.config.default_profile_fields || {}
+      fields = options.delete(:fields) || default
+
+      if options.delete(:public)
+        return ":public"
+      elsif fields.empty?
+        return ""
+      else
+        return ":(#{build_fields_params(fields)})"
+      end
+    end
+
+    def build_fields_params(fields)
+      if fields.is_a?(Hash) && !fields.empty?
+        fields.map {|i,v| "#{i}:(#{build_fields_params(v)})" }.join(',')
+      elsif fields.respond_to?(:each)
+        fields.map {|field| build_fields_params(field) }.join(',')
+      else
+        fields.to_s.gsub("_", "-")
+      end
+    end
+
+    def profile_path(options={}, allow_multiple=true)
+      path = "/people"
+
+      id = options.delete(:id)
+      url = options.delete(:url)
+
+      ids = options.delete(:ids)
+      urls = options.delete(:urls)
+
+      if options.delete(:email) then raise deprecated end
+
+      if (id or url)
+        path += single_person_path(id, url)
+      elsif allow_multiple and (ids or urls)
+        path += multiple_people_path(ids, urls)
+      else
+        path += "/~"
+      end
+    end
+
+    def single_person_path(id=nil, url=nil)
+      if id
+        return "/id=#{id}"
+      elsif url
+        return "/url=#{CGI.escape(url)}"
+      else
+        return "/~"
+      end
+    end
+
+    # See syntax here: https://developer.linkedin.com/documents/field-selectors
+    def multiple_people_path(ids=[], urls=[])
+      if ids.nil? then ids = [] end
+      if urls.nil? then urls = [] end
+
+      ids = ids.map do |id|
+        if is_self(id) then "~" else "id=#{id}" end
+      end
+      urls = urls.map do |url|
+        if is_self(url) then "~" else "url=#{CGI.escape(url)}" end
+      end
+      return "::(#{(ids+urls).join(",")})"
+    end
+
+    def is_self(str)
+      str == "self" or str == "~"
+    end
+  end
+end

data/lib/linked_in/communications.rb

@@ -0,0 +1,40 @@
+module LinkedIn
+  # Communications APIs
+  #
+  # @see http://developer.linkedin.com/documents/communications
+  class Communications < APIResource
+
+    # (Create) send a message from the authenticated user to a
+    # connection
+    #
+    # Permissions: w_messages
+    #
+    # @see http://developer.linkedin.com/documents/messaging-between-connections-api
+    # @see http://developer.linkedin.com/documents/invitation-api Invitation API
+    #
+    # @example
+    #   api.send_message("subject", "body", ["person_1_id", "person_2_id"])
+    #
+    # @param [String] subject Subject of the message
+    # @param [String] body Body of the message, plain text only
+    # @param [Array<String>] recipient_paths a collection of
+    #  profile paths that identify the users who will receive the
+    #  message
+    # @return [void]
+    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)
+    end
+  end
+end

data/lib/linked_in/companies.rb

@@ -0,0 +1,146 @@
+module LinkedIn
+  # Companies API
+  #
+  # @see http://developer.linkedin.com/documents/companies Companies API
+  # @see http://developer.linkedin.com/documents/company-lookup-api-and-fields Company Fields
+  #
+  # The following API actions do not have corresponding methods in
+  # this module
+  #
+  #   * Permissions Checking Endpoints for Company Shares
+  #   * GET Suggested Companies to Follow
+  #   * GET Company Products
+  #
+  # [(contribute here)](https://github.com/emorikawa/linkedin-oauth2)
+  class Companies < APIResource
+
+    # Retrieve a Company Profile
+    #
+    # @see http://developer.linkedin.com/documents/company-lookup-api-and-fields
+    #
+    # @macro company_path_options
+    # @option options [String] :scope
+    # @option options [String] :type
+    # @option options [String] :count
+    # @option options [String] :start
+    # @return [LinkedIn::Mash]
+    def company(options = {})
+      path = company_path(options)
+      get(path, options)
+    end
+
+    # Retrieve a feed of event items for a Company
+    #
+    # @see http://developer.linkedin.com/reading-company-shares
+    #
+    # @macro company_path_options
+    # @option options [String] :event-type
+    # @option options [String] :count
+    # @option options [String] :start
+    # @return [LinkedIn::Mash]
+    def company_updates(options={})
+      path = "#{company_path(options)}/updates"
+      get(path, options)
+    end
+
+    # Retrieve statistics for a particular company page
+    #
+    # Permissions: rw_company_admin
+    #
+    # @see http://developer.linkedin.com/documents/company-statistics
+    #
+    # @macro company_path_options
+    # @return [LinkedIn::Mash]
+    def company_statistics(options={})
+      path = "#{company_path(options)}/company-statistics"
+      get(path, options)
+    end
+
+    # Retrieve comments on a particular company update:
+    #
+    # @see http://developer.linkedin.com/reading-company-shares
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular company update
+    # @macro company_path_options
+    # @return [LinkedIn::Mash]
+    def company_updates_comments(update_key, options={})
+      path = "#{company_path(options)}/updates/key=#{update_key}/update-comments"
+      get(path, options)
+    end
+
+    # Retrieve likes on a particular company update:
+    #
+    # @see http://developer.linkedin.com/reading-company-shares
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular company update
+    # @macro company_path_options
+    # @return [LinkedIn::Mash]
+    def company_updates_likes(update_key, options={})
+      path = "#{company_path(options)}/updates/key=#{update_key}/likes"
+      get(path, options)
+    end
+
+    # Create a share for a company that the authenticated user
+    # administers
+    #
+    # Permissions: rw_company_admin
+    #
+    # @see http://developer.linkedin.com/creating-company-shares
+    # @see http://developer.linkedin.com/documents/targeting-company-shares Targeting Company Shares
+    #
+    # @param [String] company_id Company ID
+    # @macro share_input_fields
+    # @return [void]
+    def add_company_share(company_id, share)
+      path = "/companies/#{company_id}/shares"
+      defaults = {visibility: {code: "anyone"}}
+      post(path, defaults.merge(share))
+    end
+
+    # (Create) authenticated user starts following a company
+    #
+    # @see http://developer.linkedin.com/documents/company-follow-and-suggestions
+    #
+    # @param [String] company_id Company ID
+    # @return [void]
+    def follow_company(company_id)
+      path = "/people/~/following/companies"
+      post(path, {id: company_id})
+    end
+
+    # (Destroy) authenticated user stops following a company
+    #
+    # @see http://developer.linkedin.com/documents/company-follow-and-suggestions
+    #
+    # @param [String] company_id Company ID
+    # @return [void]
+    def unfollow_company(company_id)
+      path = "/people/~/following/companies/id=#{company_id}"
+      delete(path)
+    end
+
+
+    private ##############################################################
+
+
+    def company_path(options)
+      path = "/companies"
+
+      if domain = options.delete(:domain)
+        path += "?email-domain=#{CGI.escape(domain)}"
+      elsif id = options.delete(:id)
+        path += "/#{id}"
+      elsif url = options.delete(:url)
+        path += "/url=#{CGI.escape(url)}"
+      elsif name = options.delete(:name)
+        path += "/universal-name=#{CGI.escape(name)}"
+      elsif is_admin = options.delete(:is_admin)
+        path += "?is-company-admin=#{CGI.escape(is_admin)}"
+      else
+        path += "/~"
+      end
+    end
+  end
+end