linkedin-oauth2 0.1.1 → 1.0.0

data/lib/linked_in/people.rb

@@ -0,0 +1,141 @@
+require 'time'
+module LinkedIn
+  # People APIs
+  #
+  # @see http://developer.linkedin.com/documents/people People API
+  # @see http://developer.linkedin.com/documents/profile-fields 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
+  class People < APIResource
+
+    # @!macro multi_profile_options
+    #   @options opts [Array]  :urls A list of profile urls
+    #   @options opts [Array]  :ids List of LinkedIn IDs
+    #
+    # @!macro new profile_args
+    #   @overload profile()
+    #     Fetches your own profile
+    #   @overload profile(id_or_url, opts)
+    #     Fetches the profile of another user
+    #     @param [String] id_or_url a LinkedIn id or a profile URL
+    #     @param [Hash] opts more profile options
+    #     @macro profile_options
+    #   @overload profile(opts)
+    #     Fetches the profile of another user
+    #     @param [Hash] opts profile options
+    #     @macro profile_options
+    #   @return [LinkedIn::Mash]
+
+    # Retrieve a member's LinkedIn profile.
+    #
+    # Required permissions: r_basicprofile, r_fullprofile
+    #
+    # @see http://developer.linkedin.com/documents/profile-api
+    # @macro profile_args
+    # @macro multi_profile_options
+    def profile(id={}, options={})
+      options = parse_id(id, options)
+      path = profile_path(options)
+      get(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 profile_args
+    def connections(id={}, options={})
+      options = parse_id(id, options)
+      path = "#{profile_path(options, false)}/connections"
+      get(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, Fixnum, Time] modified_since timestamp in unix time
+    #   miliseconds indicating since when you want to retrieve new
+    #   connections
+    # @param [Hash] opts profile options
+    # @macro profile_options
+    # @return [LinkedIn::Mash]
+    def new_connections(since, options={})
+      since = parse_modified_since(since)
+      options.merge!('modified' => 'new', 'modified-since' => since)
+      path = "#{profile_path(options, false)}/connections"
+      get(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 = "#{profile_path(options)}/picture-urls::(#{picture_size})"
+      get(path, options)
+    end
+
+
+    protected ############################################################
+
+
+    def get(path, options)
+      options[:"secure-urls"] = true unless options[:secure] == false
+      super path, options
+    end
+
+
+    private ##############################################################
+
+
+    def parse_id(id, options)
+      if id.is_a? String
+        if id.downcase =~ /linkedin\.com/
+          options[:url] = id
+        else
+          options[:id] = id
+        end
+      elsif id.is_a? Hash
+        options = id
+      else
+        options = {}
+      end
+
+      return options
+    end
+
+    # Returns a unix time in miliseconds
+    def parse_modified_since(since)
+      if since.is_a? ::Fixnum
+        if ::Time.at(since).year < 2050
+          # Got passed in as seconds.
+          since = since * 1000
+        end
+      elsif since.is_a? ::String
+        since = utc_parse(since)
+      elsif since.is_a? ::Time
+        since = since.to_i * 1000
+      end
+      return since
+    end
+
+    def utc_parse(since)
+      t = ::Time.parse(since)
+      Time.utc(t.year, t.month, t.day, t.hour, t.min, t.sec).to_i * 1000
+    end
+
+  end
+end

data/lib/linked_in/search.rb

@@ -1,55 +1,70 @@
 module LinkedIn
-
-  module Search
+  # Search APIs
+  #
+  # @see https://developer.linkedin.com/documents/people-search-api
+  # @see https://developer.linkedin.com/documents/company-search
+  # @see https://developer.linkedin.com/documents/job-search-api
+  class Search < APIResource
+    # Search through People, Companies, and Jobs
+    #
+    # To search through people you need to be part of LinkedIn's Vetted
+    # API Access Program.
+    #
+    # @see https://developer.linkedin.com/documents/people-search-api
+    #
+    # You can use the same API to search through Companies and Jobs.
+    #
+    # @!macro search_options
+    #   @options opts [String] :type either "people", "companies", or
+    #     "jobs"
+    #   @options opts [String] :keywords various keywords to search for
+    #   @options opts [Array, Hash] :fields fields to fetch. The
+    #     list of fields can be found at
+    #     https://developer.linkedin.com/documents/field-selectors
+    #   @options opts various There are many more options you can search
+    #     by see https://developer.linkedin.com/documents/people-search-api
+    #     for more possibilities. All keys can be entered underscored and
+    #     they will be dasherized to match the field names on LinkedIn's
+    #     website
+    #
+    # @overload search
+    #   Grabs all people in your network
+    # @overload search(keyword_string)
+    #   Keyword search through people
+    #   @param [String] keywords search keywords
+    # @overload search(keyword_string, type)
+    #   Keyword search through people
+    #   @param [String] keywords search keywords
+    #   @param [String] type either "people", "companies", or "jobs"
+    # @overload search(opts)
+    #   Searches based on various options
+    #   @param [Hash] opts search options
+    #   @macro search_options
+    # @overload search(opts, type)
+    #   Searches for a type based on various options
+    #   @param [Hash] opts search options
+    #   @macro search_options
+    #   @param [String] type either "people", "companies", or "jobs"
     def search(options={}, type='people')
+      options, type = prepare_options(options, type)
       path = "/#{type.to_s}-search"
-
-      if options.is_a?(Hash)
-        fields = options.delete(:fields)
-        path += field_selector(fields) if fields
-      end
-
-      options = { :keywords => options } if options.is_a?(String)
-      options = format_options_for_query(options)
-
-      result_json = get(to_uri(path, options))
-
-      Mash.from_json(result_json)
+      get(path, options)
     end
 
-    private
+    private ##############################################################
 
-      def format_options_for_query(opts)
-        opts.inject({}) do |list, kv|
-          key, value = kv.first.to_s.gsub("_","-"), kv.last
-          list[key]  = sanitize_value(value)
-          list
-        end
+    def prepare_options(options, type)
+      options ||= {}
+      if options.is_a? String or options.is_a? Array
+        kw = options
+        options = {keywords: kw}
       end
 
-      def sanitize_value(value)
-        value = value.join("+") if value.is_a?(Array)
-        value = value.gsub(" ", "+") if value.is_a?(String)
-        value
+      if not options[:type].nil?
+        type = options.delete(:type)
       end
 
-      def field_selector(fields)
-        result = ":("
-        fields = fields.to_a.map do |field|
-          if field.is_a?(Hash)
-            innerFields = []
-            field.each do |key, value|
-              innerFields << key.to_s.gsub("_","-") + field_selector(value)
-            end
-            innerFields.join(',')
-          else
-            field.to_s.gsub("_","-")
-          end
-        end
-        result += fields.join(',')
-        result += ")"
-        result
-      end
+      return [options, type]
+    end
   end
-
 end

data/lib/linked_in/share_and_social_stream.rb

@@ -0,0 +1,128 @@
+module LinkedIn
+  # Share and Social Stream APIs
+  #
+  # @see http://developer.linkedin.com/documents/share-and-social-stream
+  # @see http://developer.linkedin.com/documents/share-api Share API
+  #
+  # The following API actions do not have corresponding methods in
+  # this module
+  #
+  #   * GET Network Statistics
+  #   * POST Post Network Update
+  #
+  # [(contribute here)](https://github.com/emorikawa/linkedin-oauth2)
+  class ShareAndSocialStream < APIResource
+    # Retrieve the authenticated users network updates
+    #
+    # Permissions: rw_nus
+    #
+    # @see http://developer.linkedin.com/documents/get-network-updates-and-statistics-api
+    # @see http://developer.linkedin.com/documents/network-update-types Network Update Types
+    #
+    # @macro profile_options
+    # @option options [String] :scope
+    # @option options [String] :type
+    # @option options [String] :count
+    # @option options [String] :start
+    # @option options [String] :after
+    # @option options [String] :before
+    # @option options [String] :show-hidden-members
+    # @return [LinkedIn::Mash]
+    def network_updates(options={})
+      path = "#{profile_path(options)}/network/updates"
+      get(path, options)
+    end
+
+    # TODO refactor to use #network_updates
+    def shares(options={})
+      path = "#{profile_path(options)}/network/updates"
+      get(path, {type: "SHAR", scope: "self"}.merge(options))
+    end
+
+    # Retrieve all comments for a particular network update
+    #
+    # @note The first 5 comments are included in the response to #network_updates
+    #
+    # Permissions: rw_nus
+    #
+    # @see http://developer.linkedin.com/documents/commenting-reading-comments-and-likes-network-updates
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular network update
+    # @macro profile_options
+    # @return [LinkedIn::Mash]
+    def share_comments(update_key, options={})
+      path = "#{profile_path(options)}/network/updates/key=#{update_key}/update-comments"
+      get(path, options)
+    end
+
+    # Retrieve all likes for a particular network update
+    #
+    # @note Some likes are included in the response to #network_updates
+    #
+    # Permissions: rw_nus
+    #
+    # @see http://developer.linkedin.com/documents/commenting-reading-comments-and-likes-network-updates
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular network update
+    # @macro profile_options
+    # @return [LinkedIn::Mash]
+    def share_likes(update_key, options={})
+      path = "#{profile_path(options)}/network/updates/key=#{update_key}/likes"
+      get(path, options)
+    end
+
+    # Create a share for the authenticated user
+    #
+    # Permissions: rw_nus
+    #
+    # @see http://developer.linkedin.com/documents/share-api
+    #
+    # @macro share_input_fields
+    # @return [void]
+    def add_share(share)
+      path = "/people/~/shares"
+      defaults = {visibility: {code: "anyone"}}
+      post(path, defaults.merge(share))
+    end
+
+    # Create a comment on an update from the authenticated user
+    #
+    # @see http://developer.linkedin.com/documents/commenting-reading-comments-and-likes-network-updates
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular network update
+    # @param [String] comment The text of the comment
+    # @return [void]
+    def update_comment(update_key, comment)
+      path = "/people/~/network/updates/key=#{update_key}/update-comments"
+      post(path, {comment: comment})
+    end
+
+    # (Update) like an update as the authenticated user
+    #
+    # @see http://developer.linkedin.com/documents/commenting-reading-comments-and-likes-network-updates
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular network update
+    # @return [void]
+    def like_share(update_key)
+      path = "/people/~/network/updates/key=#{update_key}/is-liked"
+      put(path, "true")
+    end
+
+    # (Destroy) unlike an update the authenticated user previously
+    # liked
+    #
+    # @see http://developer.linkedin.com/documents/commenting-reading-comments-and-likes-network-updates
+    #
+    # @param [String] update_key a update/update-key representing a
+    #   particular network update
+    # @return [void]
+    def unlike_share(update_key)
+      path = "/people/~/network/updates/key=#{update_key}/is-liked"
+      put(path, "false")
+    end
+  end
+end

data/lib/linked_in/version.rb

@@ -1,11 +1,3 @@
 module LinkedIn
-
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 1
-    PATCH = 1
-    PRE   = nil
-    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
-  end
-
+  VERSION = '1.0.0'
 end

data/lib/linkedin-oauth2.rb

@@ -1,32 +1,50 @@
-require 'oauth2'
+require "oauth2"
+
+require "linked_in/errors"
+require "linked_in/version"
+require "linked_in/configuration"
+
+# Responsible for all authentication
+# LinkedIn::OAuth2 inherits from OAuth2::Client
+require "linked_in/oauth2"
+
+# Coerces LinkedIn JSON to a nice Ruby hash
+# LinkedIn::Mash inherits from Hashie::Mash
+require "hashie"
+require "linked_in/mash"
+
+# Wraps a LinkedIn-specifc API connection
+# LinkedIn::Connection inherits from Faraday::Connection
+require "faraday"
+require "linked_in/connection"
+
+# Data object to wrap API access token
+require "linked_in/access_token"
+
+# Endpoints inherit from APIResource
+require "linked_in/api_resource"
+
+# All of the endpoints
+require "linked_in/jobs"
+require "linked_in/people"
+require "linked_in/search"
+require "linked_in/groups"
+require "linked_in/companies"
+require "linked_in/communications"
+require "linked_in/share_and_social_stream"
+
+# The primary API object that makes requests.
+# It composes in all of the endpoints
+require "linked_in/api"
 
 module LinkedIn
+  @config = Configuration.new
 
   class << self
-    attr_accessor :client_id, :client_secret, :default_profile_fields
-
-    # config/initializers/linkedin.rb (for instance)
-    #
-    # LinkedIn.configure do |config|
-    #   config.client_id = 'client_id'
-    #   config.client_secret = 'client_secret'
-    #   config.default_profile_fields = ['education', 'positions']
-    # end
-    #
-    # elsewhere
-    #
-    # client = LinkedIn::Client.new
-    def configure
-      yield self
-      true
-    end
+    attr_accessor :config
   end
 
-  autoload :Api,     "linked_in/api"
-  autoload :Client,  "linked_in/client"
-  autoload :Mash,    "linked_in/mash"
-  autoload :Errors,  "linked_in/errors"
-  autoload :Helpers, "linked_in/helpers"
-  autoload :Search,  "linked_in/search"
-  autoload :Version, "linked_in/version"
+  def self.configure
+    yield self.config
+  end
 end