linkedin-api2 1.1.13

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+load 'vcr/tasks/vcr.rake'
+
+require File.expand_path('../lib/linked_in/version', __FILE__)
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/linked_in/api.rb

@@ -0,0 +1,38 @@
+module LinkedIn
+  module Api
+
+    # @!macro person_path_options
+    #  @param [Hash] options identifies the user profile you want
+    #  @option options [String] :id a member token
+    #  @option options [String] :url a Public Profile URL
+    #  @option options [String] :email
+
+    # @!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
+
+    # @!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
+
+    autoload :QueryHelpers,  "linked_in/api/query_helpers"
+    autoload :People,  "linked_in/api/people"
+    autoload :Groups,  "linked_in/api/groups"
+    autoload :Companies,  "linked_in/api/companies"
+    autoload :Jobs,  "linked_in/api/jobs"
+    autoload :ShareAndSocialStream,  "linked_in/api/share_and_social_stream"
+    autoload :Communications, "linked_in/api/communications"
+  end
+end

data/lib/linked_in/api/communications.rb

@@ -0,0 +1,44 @@
+module LinkedIn
+  module Api
+
+    # Communications APIs
+    #
+    # @see http://developer.linkedin.com/documents/communications
+    module Communications
+
+      # (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
+      #   client.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, MultiJson.dump(message), "Content-Type" => "application/json")
+      end
+
+    end
+
+  end
+end

data/lib/linked_in/api/companies.rb

@@ -0,0 +1,129 @@
+module LinkedIn
+  module Api
+
+    # Companies API
+    #
+    # @see https://developer.linkedin.com/docs/company-pages Companies API
+    # @see https://developer.linkedin.com/docs/fields/companies 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/hexgnu/linkedin)
+    module Companies
+
+      # Retrieve a Company Profile
+      #
+      # @see https://developer.linkedin.com/docs/fields/company-profile Company Profile field
+      # @see https://developer.linkedin.com/docs/company-pages#company_profile Company Profile
+      #
+      # @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)
+        simple_query(path, options)
+      end
+
+      # Retrieve a feed of event items for a Company
+      #
+      # @see https://developer.linkedin.com/docs/company-pages#get_update Get Specific Company Update
+      #
+      # @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"
+        simple_query(path, options)
+      end
+
+      # Retrieve statistics for a particular company page
+      #
+      # Permissions: rw_company_admin
+      #
+      # @see https://developer.linkedin.com/docs/company-pages#statistics Get Company Statistics
+      #
+      # @macro company_path_options
+      # @return [LinkedIn::Mash]
+      def company_statistics(options={})
+        path = "#{company_path(options)}/company-statistics"
+        simple_query(path, options)
+      end
+
+      # Retrieve comments on a particular company update:
+      #
+      # @see https://developer.linkedin.com/docs/company-pages#get_update_comments Get comments for a specific Company update
+      #
+      # @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"
+        simple_query(path, options)
+      end
+
+      # Retrieve likes on a particular company update:
+      #
+      # @see https://developer.linkedin.com/docs/company-pages#get_update_likes Get likes for a specific Company update
+      #
+      # @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"
+        simple_query(path, options)
+      end
+
+      # Create a share for a company that the authenticated user
+      # administers
+      #
+      # Permissions: rw_company_admin
+      #
+      # @see https://developer.linkedin.com/docs/company-pages#company_share Create a company share
+      # @see https://developer.linkedin.com/docs/company-pages#targetting_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, MultiJson.dump(defaults.merge(share)), "Content-Type" => "application/json")
+      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"
+        body = { id: company_id }
+        post(path, MultiJson.dump(body), "Content-Type" => "application/json")
+      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
+    end
+  end
+end

data/lib/linked_in/api/groups.rb

@@ -0,0 +1,115 @@
+module LinkedIn
+  module Api
+
+    # Groups API
+    #
+    # @see http://developer.linkedin.com/documents/groups-api Groups API
+    # @see http://developer.linkedin.com/documents/groups-fields Groups Fields
+    #
+    # The following API actions do not have corresponding methods in
+    # this module
+    #
+    #   * PUT Change my Group Settings
+    #   * POST Change my Group Settings
+    #   * DELETE Leave a group
+    #   * PUT Follow/unfollow a Group post
+    #   * PUT Flag a Post as a Promotion or Job
+    #   * DELETE Delete a Post
+    #   * DELETE Flag a post as inappropriate
+    #   * DELETE A comment or flag comment as inappropriate
+    #   * DELETE Remove a Group Suggestion
+    #
+    # [(contribute here)](https://github.com/hexgnu/linkedin)
+    module Groups
+
+      # Retrieve group suggestions for the current user
+      #
+      # Permissions: r_fullprofile
+      #
+      # @see http://developer.linkedin.com/documents/job-bookmarks-and-suggestions
+      #
+      # @macro person_path_options
+      # @return [LinkedIn::Mash]
+      def group_suggestions(options = {})
+        path = "#{person_path(options)}/suggestions/groups"
+        simple_query(path, options)
+      end
+
+      # Retrieve the groups a current user belongs to
+      #
+      # Permissions: rw_groups
+      #
+      # @see http://developer.linkedin.com/documents/groups-api
+      #
+      # @macro person_path_options
+      # @return [LinkedIn::Mash]
+      def group_memberships(options = {})
+        path = "#{person_path(options)}/group-memberships"
+        simple_query(path, options)
+      end
+
+      # Retrieve the profile of a group
+      #
+      # Permissions: rw_groups
+      #
+      # @see http://developer.linkedin.com/documents/groups-api
+      #
+      # @param [Hash] options identifies the group or groups
+      # @optio options [String] :id identifier for the group
+      # @return [LinkedIn::Mash]
+      def group_profile(options)
+        path = group_path(options)
+        simple_query(path, options)
+      end
+
+      # Retrieve the posts in a group
+      #
+      # Permissions: rw_groups
+      #
+      # @see http://developer.linkedin.com/documents/groups-api
+      #
+      # @param [Hash] options identifies the group or groups
+      # @optio options [String] :id identifier for the group
+      # @optio options [String] :count
+      # @optio options [String] :start
+      # @return [LinkedIn::Mash]
+      def group_posts(options)
+        path = "#{group_path(options)}/posts"
+        simple_query(path, options)
+      end
+
+      # @deprecated Use {#add_group_share} instead
+      def post_group_discussion(group_id, discussion)
+        warn 'Use add_group_share over post_group_discussion. This will be taken out in future versions'
+        add_group_share(group_id, discussion)
+      end
+
+      # Create a share for a company that the authenticated user
+      # administers
+      #
+      # Permissions: rw_groups
+      #
+      # @see http://developer.linkedin.com/documents/groups-api#create
+      #
+      # @param [String] group_id Group ID
+      # @macro share_input_fields
+      # @return [void]
+      def add_group_share(group_id, share)
+        path = "/groups/#{group_id}/posts"
+        post(path, MultiJson.dump(share), "Content-Type" => "application/json")
+      end
+
+      # (Update) User joins, or requests to join, a group
+      #
+      # @see http://developer.linkedin.com/documents/groups-api#membergroups
+      #
+      # @param [String] group_id Group ID
+      # @return [void]
+      def join_group(group_id)
+        path = "/people/~/group-memberships/#{group_id}"
+        body = {'membership-state' => {'code' => 'member' }}
+        put(path, MultiJson.dump(body), "Content-Type" => "application/json")
+      end
+    end
+  end
+end

data/lib/linked_in/api/jobs.rb

@@ -0,0 +1,64 @@
+module LinkedIn
+  module Api
+
+    # Jobs API
+    #
+    # @see http://developer.linkedin.com/documents/job-lookup-api-and-fields Job Lookup API and Fields
+    # @see http://developer.linkedin.com/documents/job-bookmarks-and-suggestions Job Bookmarks and Suggestions
+    #
+    # The following API actions do not have corresponding methods in
+    # this module
+    #
+    #   * DELETE a Job Bookmark
+    #
+    # [(contribute here)](https://github.com/hexgnu/linkedin)
+    module Jobs
+
+      # Retrieve likes on a particular company update:
+      #
+      # @see http://developer.linkedin.com/reading-company-shares
+      #
+      # @param [Hash] options identifies the job
+      # @option options [String] id unique identifier for a job
+      # @return [LinkedIn::Mash]
+      def job(options = {})
+        path = jobs_path(options)
+        simple_query(path, options)
+      end
+
+      # Retrieve the current members' job bookmarks
+      #
+      # @see http://developer.linkedin.com/documents/job-bookmarks-and-suggestions
+      #
+      # @macro person_path_options
+      # @return [LinkedIn::Mash]
+      def job_bookmarks(options = {})
+        path = "#{person_path(options)}/job-bookmarks"
+        simple_query(path, options)
+      end
+
+      # Retrieve job suggestions for the current user
+      #
+      # @see http://developer.linkedin.com/documents/job-bookmarks-and-suggestions
+      #
+      # @macro person_path_options
+      # @return [LinkedIn::Mash]
+      def job_suggestions(options = {})
+        path = "#{person_path(options)}/suggestions/job-suggestions"
+        simple_query(path, options)
+      end
+
+      # Create a job bookmark for the authenticated user
+      #
+      # @see http://developer.linkedin.com/documents/job-bookmarks-and-suggestions
+      #
+      # @param [String] job_id Job ID
+      # @return [void]
+      def add_job_bookmark(job_id)
+        path = "/people/~/job-bookmarks"
+        body = {'job' => {'id' => job_id}}
+        post(path, MultiJson.dump(body), "Content-Type" => "application/json")
+      end
+    end
+  end
+end

data/lib/linked_in/api/people.rb

@@ -0,0 +1,73 @@
+module LinkedIn
+  module Api
+
+    # People APIs
+    #
+    #
+    # @see https://developer.linkedin.com/docs/fields/basic-profile Profile Fields
+    # @see http://developer.linkedin.com/documents/field-selectors Field Selectors
+    # @see http://developer.linkedin.com/documents/accessing-out-network-profiles Accessing Out of Network Profiles
+    module People
+
+      # Retrieve a member's LinkedIn profile.
+      #
+      # Permissions: r_basicprofile, r_fullprofile
+      #
+      # @see https://developer.linkedin.com/docs/signin-with-linkedin#content-par_componenttabbedlist_resource_1_resourceparagraph_6
+      # @macro person_path_options
+      # @option options [string] :secure-urls if 'true' URLs in responses will be HTTPS
+      # @return [LinkedIn::Mash]
+      def profile(options={})
+        path = person_path(options)
+        simple_query(path, options)
+      end
+
+      # Retrieve a list of 1st degree connections for a user who has
+      # granted access to his/her account
+      #
+      # Permissions: r_network
+      #
+      # @see http://developer.linkedin.com/documents/connections-api
+      #
+      # @macro person_path_options
+      # @return [LinkedIn::Mash]
+      def connections(options={})
+        path = "#{person_path(options)}/connections"
+        simple_query(path, options)
+      end
+
+      # Retrieve a list of the latest set of 1st degree connections for a
+      # user
+      #
+      # Permissions: r_network
+      #
+      # @see http://developer.linkedin.com/documents/connections-api
+      #
+      # @param [String] modified_since timestamp indicating since when
+      #   you want to retrieve new connections
+      # @macro person_path_options
+      # @return [LinkedIn::Mash]
+      def new_connections(modified_since, options={})
+        options.merge!('modified' => 'new', 'modified-since' => modified_since)
+        path = "#{person_path(options)}/connections"
+        simple_query(path, options)
+      end
+
+      # Retrieve the picture url
+      # http://api.linkedin.com/v1/people/~/picture-urls::(original)
+      #
+      # Permissions: r_network
+      #
+      # @options [String] :id, the id of the person for whom you want the profile picture
+      # @options [String] :picture_size, default: 'original'
+      # @options [String] :secure, default: 'false', options: ['false','true']
+      #
+      # example for use in code: client.picture_urls(:id => 'id_of_connection')
+      def picture_urls(options={})
+        picture_size = options.delete(:picture_size) || 'original'
+        path = "#{picture_urls_path(options)}::(#{picture_size})"
+        simple_query(path, options)
+      end
+    end
+  end
+end