linkedin 0.4.6 → 0.4.7

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,72 @@
+module LinkedIn
+  module Api
+
+    # 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
+    module People
+
+      # Retrieve a member's LinkedIn profile.
+      #
+      # Permissions: r_basicprofile, r_fullprofile
+      #
+      # @see http://developer.linkedin.com/documents/profile-api
+      # @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'
+      #
+      # 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

data/lib/linked_in/api/query_helpers.rb

@@ -0,0 +1,86 @@
+module LinkedIn
+  module Api
+
+    module QueryHelpers
+      private
+
+      def group_path(options)
+        path = "/groups"
+        if id = options.delete(:id)
+          path += "/#{id}"
+        end
+      end
+
+      def simple_query(path, options={})
+        fields = options.delete(:fields) || LinkedIn.default_profile_fields
+
+        if options.delete(:public)
+          path +=":public"
+        elsif fields
+          path +=":(#{build_fields_params(fields)})"
+        end
+
+        headers = options.delete(:headers) || {}
+        params  = to_query(options)
+        path   += "#{path.include?("?") ? "&" : "?"}#{params}" if !params.empty?
+
+        Mash.from_json(get(path, headers))
+      end
+
+      def build_fields_params(fields)
+        if fields.is_a?(Hash) && !fields.empty?
+          fields.map {|index,value| "#{index}:(#{build_fields_params(value)})" }.join(',')
+        elsif fields.respond_to?(:each)
+          fields.map {|field| build_fields_params(field) }.join(',')
+        else
+          fields.to_s.gsub("_", "-")
+        end
+      end
+
+      def person_path(options)
+        path = "/people"
+        if id = options.delete(:id)
+          path += "/id=#{id}"
+        elsif url = options.delete(:url)
+          path += "/url=#{CGI.escape(url)}"
+        elsif email = options.delete(:email)
+          path += "::(#{email})"
+        else
+          path += "/~"
+        end
+      end
+
+      def company_path(options)
+        path = "/companies"
+
+        if domain = options.delete(:domain)
+          path += "?email-domain=#{CGI.escape(domain)}"
+        elsif id = options.delete(:id)
+          path += "/id=#{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
+
+      def picture_urls_path(options)
+        path = person_path(options)
+        path += "/picture-urls"
+      end
+
+      def jobs_path(options)
+        path = "/jobs"
+        if id = options.delete(:id)
+          path += "/id=#{id}"
+        else
+          path += "/~"
+        end
+      end
+    end
+  end
+end

data/lib/linked_in/api/share_and_social_stream.rb

@@ -0,0 +1,133 @@
+module LinkedIn
+  module Api
+
+    # 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/hexgnu/linkedin)
+    module ShareAndSocialStream
+
+      # 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 person_path_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 = "#{person_path(options)}/network/updates"
+        simple_query(path, options)
+      end
+
+      # TODO refactor to use #network_updates
+      def shares(options={})
+        path = "#{person_path(options)}/network/updates"
+        simple_query(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 person_path_options
+      # @return [LinkedIn::Mash]
+      def share_comments(update_key, options={})
+        path = "#{person_path(options)}/network/updates/key=#{update_key}/update-comments"
+        simple_query(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 person_path_options
+      # @return [LinkedIn::Mash]
+      def share_likes(update_key, options={})
+        path = "#{person_path(options)}/network/updates/key=#{update_key}/likes"
+        simple_query(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, MultiJson.dump(defaults.merge(share)), "Content-Type" => "application/json")
+      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"
+        body = {'comment' => comment}
+        post(path, MultiJson.dump(body), "Content-Type" => "application/json")
+      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', "Content-Type" => "application/json")
+      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', "Content-Type" => "application/json")
+      end
+    end
+  end
+end