octokit 4.6.0 → 4.21.0

data/lib/octokit/client/checks.rb

@@ -0,0 +1,191 @@
+module Octokit
+  class Client
+
+    # Methods for the Checks API
+    #
+    # @see https://developer.github.com/v3/checks/
+    module Checks
+
+      # Methods for Check Runs
+      #
+      # @see https://developer.github.com/v3/checks/runs/
+
+      # Create a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] The name of the check
+      # @param head_sha [String] The SHA of the commit to check
+      # @return [Sawyer::Resource] A hash representing the new check run
+      # @see https://developer.github.com/v3/checks/runs/#create-a-check-run
+      # @example Create a check run
+      #   check_run = @client.create_check_run("octocat/Hello-World", "my-check", "7638417db6d59f3c431d3e1f261cc637155684cd")
+      #   check_run.name # => "my-check"
+      #   check_run.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   check_run.status # => "queued"
+      def create_check_run(repo, name, head_sha, options = {})
+        options[:name] = name
+        options[:head_sha] = head_sha
+
+        post "#{Repository.path repo}/check-runs", options
+      end
+
+      # Update a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Sawyer::Resource] A hash representing the updated check run
+      # @see https://developer.github.com/v3/checks/runs/#update-a-check-run
+      # @example Update a check run
+      #   check_run = @client.update_check_run("octocat/Hello-World", 51295429, status: "in_progress")
+      #   check_run.id # => 51295429
+      #   check_run.status # => "in_progress"
+      def update_check_run(repo, id, options = {})
+        patch "#{Repository.path repo}/check-runs/#{id}", options
+      end
+
+      # List check runs for a specific ref
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param ref [String] A SHA, branch name, or tag name
+      # @param options [Hash] A set of optional filters
+      # @option options [String] :check_name Returns check runs with the specified <tt>name</tt>
+      # @option options [String] :status Returns check runs with the specified <tt>status</tt>
+      # @option options [String] :filter Filters check runs by their <tt>completed_at</tt> timestamp
+      # @return [Sawyer::Resource] A hash representing a collection of check runs
+      # @see https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref
+      # @example List check runs for a specific ref
+      #   result = @client.check_runs_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", status: "in_progress")
+      #   result.total_count # => 1
+      #   result.check_runs.count # => 1
+      #   result.check_runs[0].id # => 51295429
+      #   result.check_runs[0].status # => "in_progress"
+      def check_runs_for_ref(repo, ref, options = {})
+        get "#{Repository.path repo}/commits/#{ref}/check-runs", options
+      end
+      alias :list_check_runs_for_ref :check_runs_for_ref
+
+      # List check runs in a check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @param options [Hash] A set of optional filters
+      # @option options [String] :check_name Returns check runs with the specified <tt>name</tt>
+      # @option options [String] :status Returns check runs with the specified <tt>status</tt>
+      # @option options [String] :filter Filters check runs by their <tt>completed_at</tt> timestamp
+      # @return [Sawyer::Resource] A hash representing a collection of check runs
+      # @see https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite
+      # @example List check runs in a check suite
+      #   result = @client.check_runs_for_check_suite("octocat/Hello-World", 50440400, status: "in_progress")
+      #   result.total_count # => 1
+      #   result.check_runs.count # => 1
+      #   result.check_runs[0].check_suite.id # => 50440400
+      #   result.check_runs[0].status # => "in_progress"
+      def check_runs_for_check_suite(repo, id, options = {})
+        get "#{Repository.path repo}/check-suites/#{id}/check-runs", options
+      end
+      alias :list_check_runs_for_check_suite :check_runs_for_check_suite
+
+      # Get a single check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Sawyer::Resource] A hash representing the check run
+      # @see https://developer.github.com/v3/checks/runs/#get-a-single-check-run
+      def check_run(repo, id, options = {})
+        get "#{Repository.path repo}/check-runs/#{id}", options
+      end
+
+      # List annotations for a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Array<Sawyer::Resource>] An array of hashes representing check run annotations
+      # @see https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run
+      # @example List annotations for a check run
+      #   annotations = @client.check_run_annotations("octocat/Hello-World", 51295429)
+      #   annotations.count # => 1
+      #   annotations[0].path # => "README.md"
+      #   annotations[0].message # => "Looks good!"
+      def check_run_annotations(repo, id, options = {})
+        get "#{Repository.path repo}/check-runs/#{id}/annotations", options
+      end
+
+      # Methods for Check Suites
+      #
+      # @see https://developer.github.com/v3/checks/suites/
+
+      # Get a single check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @return [Sawyer::Resource] A hash representing the check suite
+      # @see https://developer.github.com/v3/checks/suites/#get-a-single-check-suite
+      def check_suite(repo, id, options = {})
+        get "#{Repository.path repo}/check-suites/#{id}", options
+      end
+
+      # List check suites for a specific ref
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param ref [String] A SHA, branch name, or tag name
+      # @param options [Hash] A set of optional filters
+      # @option options [Integer] :app_id Filters check suites by GitHub App <tt>id</tt>
+      # @option options [String] :check_name Filters checks suites by the <tt>name</tt> of the check run
+      # @return [Sawyer::Resource] A hash representing a collection of check suites
+      # @see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref
+      # @example List check suites for a specific ref
+      #   result = @client.check_suites_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", app_id: 76765)
+      #   result.total_count # => 1
+      #   result.check_suites.count # => 1
+      #   result.check_suites[0].id # => 50440400
+      #   result.check_suites[0].app.id # => 76765
+      def check_suites_for_ref(repo, ref, options = {})
+        get "#{Repository.path repo}/commits/#{ref}/check-suites", options
+      end
+      alias :list_check_suites_for_ref :check_suites_for_ref
+
+      # Set preferences for check suites on a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Preferences to set
+      # @return [Sawyer::Resource] A hash representing the repository's check suite preferences
+      # @see https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository
+      # @example Set preferences for check suites on a repository
+      #   result = @client.set_check_suite_preferences("octocat/Hello-World", auto_trigger_checks: [{ app_id: 76765, setting: false }])
+      #   result.preferences.auto_trigger_checks.count # => 1
+      #   result.preferences.auto_trigger_checks[0].app_id # => 76765
+      #   result.preferences.auto_trigger_checks[0].setting # => false
+      #   result.repository.full_name # => "octocat/Hello-World"
+      def set_check_suite_preferences(repo, options = {})
+        patch "#{Repository.path repo}/check-suites/preferences", options
+      end
+
+      # Create a check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param head_sha [String] The SHA of the commit to check
+      # @return [Sawyer::Resource] A hash representing the new check suite
+      # @see https://developer.github.com/v3/checks/suites/#create-a-check-suite
+      # @example Create a check suite
+      #   check_suite = @client.create_check_suite("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd")
+      #   check_suite.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   check_suite.status # => "queued"
+      def create_check_suite(repo, head_sha, options = {})
+        options[:head_sha] = head_sha
+
+        post "#{Repository.path repo}/check-suites", options
+      end
+
+      # Rerequest check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @return [Boolean] True if successful, raises an error otherwise
+      # @see https://developer.github.com/v3/checks/suites/#rerequest-check-suite
+      def rerequest_check_suite(repo, id, options = {})
+        post "#{Repository.path repo}/check-suites/#{id}/rerequest", options
+        true
+      end
+    end
+  end
+end

data/lib/octokit/client/commit_branches.rb

@@ -0,0 +1,20 @@
+module Octokit
+  class Client
+
+    # Methods for the Branches for HEAD API
+    #
+    # @see https://developer.github.com/v3/repos/commits/
+    module CommitBranches
+
+      # List branches for a single HEAD commit
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit whose branches will be fetched
+      # @return [Array]  List of branches
+      # @see https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit
+      def commit_branches(repo, sha, options = {})
+        paginate "#{Repository.path repo}/commits/#{sha}/branches-where-head", options
+      end
+    end
+  end
+end

data/lib/octokit/client/commit_pulls.rb

@@ -0,0 +1,20 @@
+module Octokit
+  class Client
+
+    # Methods for the Commit Pulls API
+    #
+    # @see https://developer.github.com/v3/repos/comments/
+    module CommitPulls
+
+      # List pulls for a single commit
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit whose pulls will be fetched
+      # @return [Array]  List of commit pulls
+      # @see https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit
+      def commit_pulls(repo, sha, options = {})
+        paginate "#{Repository.path repo}/commits/#{sha}/pulls", options
+      end
+    end
+  end
+end

data/lib/octokit/client/community_profile.rb

@@ -0,0 +1,22 @@
+module Octokit
+  class Client
+
+    # Methods for the Community Profile API
+    #
+    # @see https://developer.github.com/v3/repos/community/
+    module CommunityProfile
+
+      # Get community profile metrics for a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Sawyer::Resource] Community profile metrics
+      # @see https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics
+      # @example Get community profile metrics for octokit/octokit.rb
+      #   @client.community_profile('octokit/octokit.rb')
+      def community_profile(repo, options = {})
+        options = ensure_api_media_type(:community_profile, options)
+        get "#{Repository.path repo}/community/profile", options
+      end
+    end
+  end
+end

data/lib/octokit/client/contents.rb

@@ -16,6 +16,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/contents/#get-the-readme
       # @example Get the readme file for a repo
       #   Octokit.readme("octokit/octokit.rb")
+      # @example Get the readme file for a particular branch of the repo
+      #   Octokit.readme("octokit/octokit.rb", :query => {:ref => 'some-other-branch'})
       def readme(repo, options={})
         get "#{Repository.path repo}/readme", options
       end
@@ -29,7 +31,10 @@ module Octokit
       # @see https://developer.github.com/v3/repos/contents/#get-contents
       # @example List the contents of lib/octokit.rb
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
+      # @example Lists the contents of lib /octokit.rb on a particular branch
+      #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb', :query => {:ref => 'some-other-branch'})
       def contents(repo, options={})
+        options = options.dup
         repo_path = options.delete :path
         url = "#{Repository.path repo}/contents/#{repo_path}"
         get url, options
@@ -54,6 +59,7 @@ module Octokit
       #                    "File content",
       #                    :branch => "my-new-feature")
       def create_contents(*args)
+        args    = args.map { |item| item && item.dup }
         options = args.last.is_a?(Hash) ? args.pop : {}
         repo    = args.shift
         path    = args.shift

data/lib/octokit/client/deployments.rb

@@ -6,6 +6,16 @@ module Octokit
     # @see https://developer.github.com/v3/repos/commits/deployments/
     module Deployments
 
+      # Fetch a single deployment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param deployment_id [Integer, String, Repository, Hash] A GitHub repository
+      # @return <Sawyer::Resource> A single deployment
+      # @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment
+      def deployment(repo, deployment_id, options = {})
+        get("#{Repository.path repo}/deployments/#{deployment_id}", options)
+      end
+
       # List all deployments for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -33,6 +43,16 @@ module Octokit
         post("#{Repository.path repo}/deployments", options)
       end
 
+      # Delete a Deployment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param deployment_id [Integer, String, Repository, Hash] A GitHub repository
+      # @return [No Content]
+      # @see https://developer.github.com/v3/repos/deployments/#delete-a-deployment
+      def delete_deployment(repo, deployment_id, options = {})
+        delete("#{Repository.path repo}/deployments/#{deployment_id}", options)
+      end
+
       # List all statuses for a Deployment
       #
       # @param deployment_url [String] A URL for a deployment resource

data/lib/octokit/client/events.rb

@@ -131,6 +131,7 @@ module Octokit
       # @example List all issues events for issue #38 on octokit/octokit.rb
       #   Octokit.issue_events("octokit/octokit.rb", 38)
       def issue_events(repo, number, options = {})
+        options = ensure_api_media_type(:project_card_events, options)
         paginate "#{Repository.path repo}/issues/#{number}/events", options
       end
 

data/lib/octokit/client/gists.rb

@@ -50,6 +50,7 @@ module Octokit
       # @see https://developer.github.com/v3/gists/#get-a-single-gist
       # @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
       def gist(gist, options = {})
+        options = options.dup
         if sha = options.delete(:sha)
           get "gists/#{Gist.new(gist)}/#{sha}", options
         else
@@ -195,7 +196,7 @@ module Octokit
       # @example
       #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options = {})
-        options.merge!({:body => comment})
+        options = options.merge({:body => comment})
         post "gists/#{gist_id}/comments", options
       end
 
@@ -211,7 +212,7 @@ module Octokit
       # @example
       #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
       def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
-        options.merge!({:body => comment})
+        options = options.merge({:body => comment})
         patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
       end
 

data/lib/octokit/client/issues.rb

@@ -81,6 +81,7 @@ module Octokit
       # @param body [String] An optional concise description
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
+      # @option options [Array<String>] :assignees User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Sawyer::Resource] Your newly created issue
@@ -120,6 +121,7 @@ module Octokit
       # @param number [Integer] Number ID of the issue
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
+      # @option options [Array<String>] :assignees User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
       # @return [Sawyer::Resource] The updated Issue
@@ -136,6 +138,7 @@ module Octokit
       # @param number [Integer] Number ID of the issue
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
+      # @option options [Array<String>] :assignees User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
       # @return [Sawyer::Resource] The updated Issue
@@ -179,6 +182,7 @@ module Octokit
       #   @param body [String] Updated body of the issue
       #   @param options [Hash] A customizable set of options.
       #   @option options [String] :assignee User login.
+      #   @option options [Array<String>] :assignees User login.
       #   @option options [Integer] :milestone Milestone number.
       #   @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
@@ -190,6 +194,7 @@ module Octokit
       #   @option options [String] :title Updated title for the issue
       #   @option options [String] :body Updated body of the issue
       #   @option options [String] :assignee User login.
+      #   @option options [Array<String>] :assignees User login.
       #   @option options [Integer] :milestone Milestone number.
       # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
       #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
@@ -261,7 +266,7 @@ module Octokit
       # @return [Sawyer::Resource] The specific comment in question
       # @see https://developer.github.com/v3/issues/comments/#get-a-single-comment
       # @example Get comment #1194549 from an issue on octokit/octokit.rb
-      #   Octokit.issue_comments("octokit/octokit.rb", 1194549)
+      #   Octokit.issue_comment("octokit/octokit.rb", 1194549)
       def issue_comment(repo, number, options = {})
         paginate "#{Repository.path repo}/issues/comments/#{number}", options
       end
@@ -316,6 +321,48 @@ module Octokit
         options = ensure_api_media_type(:issue_timelines, options)
         paginate "#{Repository.path repo}/issues/#{number}/timeline", options
       end
+
+      # Lists the available assignees for issues in a repository.
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] List of GitHub users.
+      # @see https://developer.github.com/v3/issues/assignees/#list-assignees
+      # @example Get available assignees on repository octokit/octokit.rb
+      #   Octokit.list_assignees("octokit/octokit.rb")
+      def list_assignees(repo, options = {})
+        paginate "#{Repository.path repo}/assignees", options
+      end
+
+      # Add assignees to an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Issue number
+      # @param assignees [Array<String>] Assignees to be added
+      # @return [Sawyer::Resource] Issue
+      # @see https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue
+      # @example Add assignees "pengwynn" and "joeyw" to Issue #23 on octokit/octokit.rb
+      #   Octokit.add_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"])
+      def add_assignees(repo, number, assignees, options = {})
+        post "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+      end
+
+      # Remove assignees from an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Issue number
+      # @param assignees [Array<String>] Assignees to be removed
+      # @param options [Hash] Header params for request
+      # @return [Sawyer::Resource] Issue
+      # @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue
+      # @example Remove assignees "pengwynn" and "joeyw" from Issue #23 on octokit/octokit.rb
+      #   Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"])
+      #
+      # @example Remove assignees "pengwynn" from Issue #23 on octokit/octokit.rb
+      #   Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn"],
+      #     :accept => "application/vnd.github.v3+json")
+      def remove_assignees(repo, number, assignees, options = {})
+        delete "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+      end
     end
   end
 end

data/lib/octokit/client/labels.rb

@@ -26,7 +26,7 @@ module Octokit
       # @return [Sawyer::Resource] A single label from the repository
       # @see https://developer.github.com/v3/issues/labels/#get-a-single-label
       # @example Get the "V3 Addition" label from octokit/octokit.rb
-      #   Octokit.labels("octokit/octokit.rb", "V3 Addition")
+      #   Octokit.label("octokit/octokit.rb", "V3 Addition")
       def label(repo, name, options = {})
         get "#{Repository.path repo}/labels/#{name}", options
       end
@@ -78,7 +78,7 @@ module Octokit
       # This removes the label from the Issue
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param label [String] String name of the label
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
@@ -93,7 +93,7 @@ module Octokit
       # This removes the label from the Issue
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @return [Boolean] Success of operation
       # @see https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
       # @example Remove all labels from Issue #23
@@ -105,7 +105,7 @@ module Octokit
       # List labels for a given issue
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
       # @example List labels for octokit/octokit.rb, issue # 1
@@ -117,7 +117,7 @@ module Octokit
       # Add label(s) to an Issue
       #
       # @param repo [Integer, String, Repository, Hash] A Github repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param labels [Array] An array of labels to apply to this Issue
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
@@ -130,7 +130,7 @@ module Octokit
       # Replace all labels on an Issue
       #
       # @param repo [Integer, String, Repository, Hash] A Github repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param labels [Array] An array of labels to use as replacement
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
@@ -143,7 +143,7 @@ module Octokit
       # Get labels for every issue in a milestone
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the milestone
+      # @param number [Integer] Number ID of the milestone
       # @return [Array<Sawyer::Resource>] A list of the labels across the milestone
       # @see  http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
       # @example List all labels for milestone #2 on octokit/octokit.rb

data/lib/octokit/client/licenses.rb

@@ -35,7 +35,7 @@ module Octokit
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to 'master'.
       # @return [Sawyer::Resource] The detail of the license file
       # @example
-      #   Octokit.license_contents 'benbalter/licensee'
+      #   Octokit.repository_license_contents 'benbalter/licensee'
       def repository_license_contents(repo, options = {})
         options = ensure_api_media_type(:licenses, options)
         get "#{Repository.path repo}/license", options

data/lib/octokit/client/marketplace.rb

@@ -0,0 +1,56 @@
+module Octokit
+  class Client
+
+    # Methods for the Marketplace Listing API
+    #
+    # @see https://developer.github.com/v3/apps/marketplace/
+    module Marketplace
+
+      # List all plans for an app's marketplace listing
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing
+      #
+      # @return [Array<Sawyer::Resource>] A list of plans
+      def list_plans(options = {})
+        paginate "/marketplace_listing/plans", options
+      end
+
+      # List all GitHub accounts on a specific plan
+      #
+      # @param plan_id [Integer] The id of the GitHub plan
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan
+      #
+      # @return [Array<Sawyer::Resource>] A list of accounts
+      def list_accounts_for_plan(plan_id, options = {})
+        paginate "/marketplace_listing/plans/#{plan_id}/accounts", options
+      end
+
+      # Get the plan associated with a given GitHub account
+      #
+      # @param account_id [Integer] The id of the GitHub account
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing
+      #
+      # @return <Sawyer::Resource> Account with plan details, or nil
+      def plan_for_account(account_id, options = {})
+        get "/marketplace_listing/accounts/#{account_id}", options
+      end
+
+      # Get user's Marketplace purchases
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#get-a-users-marketplace-purchases
+      #
+      # @return [Array<Sawyer::Resource>] A list of Marketplace purchases
+      def marketplace_purchases(options = {})
+        get "/user/marketplace_purchases", options
+      end
+    end
+  end
+end

data/lib/octokit/client/notifications.rb

@@ -108,10 +108,6 @@ module Octokit
       # Mark thread as read
       #
       # @param thread_id [Integer] Id of the thread to update.
-      # @param options [Hash] Optional parameters.
-      # @option options [Boolean] :unread Changes the unread status of the
-      #   threads.
-      # @option options [Boolean] :read Inverse of 'unread'.
       # @return [Boolean] True if updated, false otherwise.
       # @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
       # @example