linkedin-v2 0.1.3

data/lib/linked_in/organizations.rb

@@ -0,0 +1,217 @@
+module LinkedIn
+  # Organizations API
+  #
+  # @see https://developer.linkedin.com/docs/guide/v2/organizations
+  #
+  # [(contribute here)](https://github.com/mdesjardins/linkedin-v2)
+  class Organizations < APIResource
+    # Retrieve an Organization
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/organization-lookup-api
+    #
+    # @macro organization_path_options
+    # @option options [String] :scope
+    # @option options [String] :type
+    # @option options [String] :count
+    # @option options [String] :start
+    # @return [LinkedIn::Mash]
+    def organization(options = {})
+      path = organization_path(options)
+      get(path, options)
+    end
+
+    # Retrieve an Organization Brand
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/organization-lookup-api
+    #
+    # @macro brand_path_options
+    # @option options [String] :scope
+    # @option options [String] :type
+    # @option options [String] :count
+    # @option options [String] :start
+    # @return [LinkedIn::Mash]
+    def brand(options = {})
+      path = brand_path(options)
+      get(path, options)
+    end
+
+    # Retrieve Organization Access Control informaion
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/organization-lookup-api#acls
+    #
+    def organization_acls(options = {})
+      path = '/organizationalEntityAcls'
+      get(path, options)
+    end
+
+    # Perform a keyword-based Organization search sorted by relevance
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/organization-search
+    #
+    # @macro organization_path_options
+    # @option options [String] :scope
+    # @option options [String] :type
+    # @option options [String] :count
+    # @option options [String] :start
+    # @return [LinkedIn::Mash]
+    def organization_search(options = {})
+      path = "/search?q=companiesV2&baseSearchParams.keywords=#{CGI.escape(options[:keyword])}&projection=(metadata,elements*(entity~),paging)"
+      get(path, options)
+    end
+
+    # TODO MOVE TO SHARES FOR EVERYTHING.
+    # # Retrieve a feed of event shares for an Organization
+    # #
+    # # @see http://developer.linkedin.com/reading-company-shares
+    # #
+    # # @macro organization_path_options
+    # # @option options [String] :event-type
+    # # @option options [String] :count
+    # # @option options [String] :start
+    # # @return [LinkedIn::Mash]
+    # def organization_shares(options={})
+    #   path = "#{organization_path(options)}/updates"
+    #   get(path, options)
+    # end
+
+    # Retrieve statistics for a particular organization page
+    #
+    # Permissions: rw_organization
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/page-statistics
+    #
+    # @option urn [String] organization URN
+    # @return [LinkedIn::Mash]
+    def organization_page_statistics(options = {})
+      path = "/organizationPageStatistics?q=organization&organization=#{options.delete(:urn)}"
+      get(path, options)
+    end
+
+    # Retrieve statistics for a particular organization followers
+    #
+    # Permissions: rw_organization
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/follower-statistics
+    #
+    # @option urn [String] organization URN
+    # @return [LinkedIn::Mash]
+    def organization_follower_statistics(options = {})
+      path = "/organizationalEntityFollowerStatistics?q=organizationalEntity&organizationalEntity=#{options.delete(:urn)}"
+      get(path, options)
+    end
+
+    # Retrieve statistics for a particular organization shares
+    #
+    # Permissions: rw_organization
+    #
+    # @see https://developer.linkedin.com/docs/guide/v2/organizations/share-statistics
+    #
+    # @option urn [String] organization URN
+    # @return [LinkedIn::Mash]
+    def organization_share_statistics(options = {})
+      path = "/organizationalEntityShareStatistics?q=organizationalEntity&organizationalEntity=#{options.delete(:urn)}"
+      get(path, options)
+    end
+
+    # TODO MOVE TO SOCIAL ACTIONS.
+    #
+    # # 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 organization_path_options
+    # # @return [LinkedIn::Mash]
+    # def company_updates_comments(update_key, options={})
+    #   path = "#{organization_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 organization_path_options
+    # # @return [LinkedIn::Mash]
+    # def company_updates_likes(update_key, options={})
+    #   path = "#{organization_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?format=json"
+    #   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"
+    #   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 organization_path(options)
+      path = '/organizations'
+
+      if email_domain = options.delete(:email_domain)
+        path += "?q=emailDomain&emailDomain=#{CGI.escape(email_domain)}"
+      elsif id = options.delete(:id)
+        path += "/#{id}"
+      elsif urn = options.delete(:urn)
+        path += "/#{urn_to_id(urn)}"
+      elsif vanity_name = options.delete(:vanity_name)
+        path += "?q=vanityName&vanityName=#{CGI.escape(vanity_name)}"
+      else
+        path += "/me"
+      end
+    end
+
+    def brand_path(options)
+      path = '/organizationBrands'
+
+      if id = options.delete(:id)
+        path += "/#{id}"
+      elsif vanity_name = options.delete(:vanity_name)
+        path += ">q=vanityName&vanityName=#{CGI.escape(vanity_name)}"
+      elsif parent_id = options.delete(:parent_id)
+        path = "/organizations?q=parentOrganization&parent=#{CGI.escape(parent_id)}"
+      else
+        path += "/me"
+      end
+    end
+  end
+end

data/lib/linked_in/people.rb

@@ -0,0 +1,151 @@
+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
+
+    # Retrieve the skills
+    #
+    # Permissions: r_fullprofile
+    def skills(id={}, options={})
+      options = parse_id(id, options)
+      path = "#{profile_path(options, false)}/skills"
+      get(path, options)
+    end
+
+
+    protected ############################################################
+
+
+    def get(path, options)
+# TODO LIv2 : Investigate, not sure this is needed, secure is always on?
+#      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/raise_error.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+
+module LinkedIn
+  class RaiseError < Faraday::Response::RaiseError
+    def on_complete(response)
+      data = Mash.from_json(response.body)
+      case response.status.to_i
+      when 400
+        raise LinkedIn::InvalidRequest.new(data), "(#{data.status}): #{data.message}"
+      when 401
+        raise LinkedIn::UnauthorizedError.new(data), "(#{data.status}): #{data.message}"
+      when 403
+        raise LinkedIn::AccessDeniedError.new(data), "(#{data.status}): #{data.message}"
+      when 404
+        raise LinkedIn::NotFoundError.new(data), "(#{data.status}): #{data.message}"
+      when 500
+        raise LinkedIn::InformLinkedInError.new(data),
+          "LinkedIn had an internal error. Please let them know in the forum. (#{data.status}): #{data.message}"
+      when 502..504
+        raise LinkedIn::UnavailableError.new(data), "(#{data.status}): #{data.message}"
+      else
+        super
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware :linkedin_raise_error => LinkedIn::RaiseError

data/lib/linked_in/search.rb

@@ -0,0 +1,70 @@
+module LinkedIn
+  # 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", "company", or
+    #     "job"
+    #   @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", "company", or "job"
+    # @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", "company", or "job"
+    def search(options={}, type='people')
+      options, type = prepare_options(options, type)
+      path = "/#{type.to_s}-search"
+      get(path, options)
+    end
+
+    private ##############################################################
+
+    def prepare_options(options, type)
+      options ||= {}
+      if options.is_a? String or options.is_a? Array
+        kw = options
+        options = {keywords: kw}
+      end
+
+      if not options[:type].nil?
+        type = options.delete(:type)
+      end
+
+      return [options, type]
+    end
+  end
+end