octokit 4.6.2 → 6.1.1

data/lib/octokit/client/apps.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Apps API
+    module Apps
+      # Get the authenticated App
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-the-authenticated-app
+      #
+      # @return [Sawyer::Resource] App information
+      def app(options = {})
+        get 'app', options
+      end
+
+      # Find all installations that belong to an App
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#list-installations
+      #
+      # @return [Array<Sawyer::Resource>] the total_count and an array of installations
+      def find_app_installations(options = {})
+        paginate 'app/installations', options
+      end
+      alias find_installations find_app_installations
+
+      def find_integration_installations(options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#find_integration_installations ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#find_app_installations before the next major ' \
+          'Octokit version update.'
+        )
+        find_app_installations(options)
+      end
+
+      # Find all installations that are accessible to the authenticated user
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#list-installations-for-a-user
+      #
+      # @return [Sawyer::Resource] the total_count and an array of installations
+      def find_user_installations(options = {})
+        paginate('user/installations', options) do |data, last_response|
+          data.installations.concat last_response.data.installations
+        end
+      end
+
+      # Get a single installation
+      #
+      # @param id [Integer] Installation id
+      #
+      # @see https://developer.github.com/v3/apps/#get-an-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def installation(id, options = {})
+        get "app/installations/#{id}", options
+      end
+
+      # Create a new installation token
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#create-a-new-installation-token
+      #
+      # @return [<Sawyer::Resource>] An installation token
+      def create_app_installation_access_token(installation, options = {})
+        post "app/installations/#{installation}/access_tokens", options
+      end
+      alias create_installation_access_token create_app_installation_access_token
+
+      def create_integration_installation_access_token(installation, options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#create_integration_installation_access_token ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#create_app_installation_access_token before the next major ' \
+          'Octokit version update.'
+        )
+        create_app_installation_access_token(installation, options)
+      end
+
+      # Enables an app to find the organization's installation information.
+      #
+      # @param organization [String] Organization GitHub login
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-an-organization-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def find_organization_installation(organization, options = {})
+        get "#{Organization.path(organization)}/installation", options
+      end
+
+      # Enables an app to find the repository's installation information.
+      #
+      # @param repo [String] A GitHub repository
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-a-repository-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def find_repository_installation(repo, options = {})
+        get "#{Repository.path(repo)}/installation", options
+      end
+
+      # Enables an app to find the user's installation information.
+      #
+      # @param user [String] GitHub user login
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#get-a-user-installation
+      #
+      # @return [Sawyer::Resource] Installation information
+      def find_user_installation(user, options = {})
+        get "#{User.path(user)}/installation", options
+      end
+
+      # List repositories that are accessible to the authenticated installation
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#list-repositories
+      #
+      # @return [Sawyer::Resource] the total_count and an array of repositories
+      def list_app_installation_repositories(options = {})
+        paginate('installation/repositories', options) do |data, last_response|
+          data.repositories.concat last_response.data.repositories
+        end
+      end
+      alias list_installation_repos list_app_installation_repositories
+
+      def list_integration_installation_repositories(options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#list_integration_installation_repositories ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#list_app_installation_repositories before the next major ' \
+          'Octokit version update.'
+        )
+        list_app_installation_repositories(options)
+      end
+
+      # Add a single repository to an installation
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#add-repository-to-installation
+      #
+      # @return [Boolean] Success
+      def add_repository_to_app_installation(installation, repo, options = {})
+        boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", options
+      end
+      alias add_repo_to_installation add_repository_to_app_installation
+
+      def add_repository_to_integration_installation(installation, repo, options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#add_repository_to_integration_installation ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#add_repository_to_app_installation before the next major ' \
+          'Octokit version update.'
+        )
+        add_repository_to_app_installation(installation, repo, options)
+      end
+
+      # Remove a single repository to an installation
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#remove-repository-from-installation
+      #
+      # @return [Boolean] Success
+      def remove_repository_from_app_installation(installation, repo, options = {})
+        boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", options
+      end
+      alias remove_repo_from_installation remove_repository_from_app_installation
+
+      def remove_repository_from_integration_installation(installation, repo, options = {})
+        octokit_warn(
+          'Deprecated: Octokit::Client::Apps#remove_repository_from_integration_installation ' \
+          'method is deprecated. Please update your call to use ' \
+          'Octokit::Client::Apps#remove_repository_from_app_installation before the next major ' \
+          'Octokit version update.'
+        )
+        remove_repository_from_app_installation(installation, repo, options)
+      end
+
+      # List repositories accessible to the user for an installation
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation
+      #
+      # @return [Sawyer::Resource] the total_count and an array of repositories
+      def find_installation_repositories_for_user(installation, options = {})
+        paginate("user/installations/#{installation}/repositories", options) do |data, last_response|
+          data.repositories.concat last_response.data.repositories
+        end
+      end
+
+      # Delete an installation and uninstall a GitHub App
+      #
+      # @param installation [Integer] The id of a GitHub App Installation
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/#delete-an-installation
+      #
+      # @return [Boolean] Success
+      def delete_installation(installation, options = {})
+        boolean_from_response :delete, "app/installations/#{installation}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/checks.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+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 = {})
+        paginate "#{Repository.path repo}/commits/#{ref}/check-runs", options do |data, last_response|
+          data.check_runs.concat last_response.data.check_runs
+          data.total_count += last_response.data.total_count
+        end
+      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 = {})
+        paginate "#{Repository.path repo}/check-suites/#{id}/check-runs", options do |data, last_response|
+          data.check_runs.concat last_response.data.check_runs
+          data.total_count += last_response.data.total_count
+        end
+      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 = {})
+        paginate "#{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 = {})
+        paginate "#{Repository.path repo}/commits/#{ref}/check-suites", options do |data, last_response|
+          data.check_suites.concat last_response.data.check_suites
+          data.total_count += last_response.data.total_count
+        end
+      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 @@
+# frozen_string_literal: true
+
+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_comments.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Comments API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitComments
-
       # List all commit comments
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -53,12 +53,12 @@ module Octokit
       #   comment.path # => "README.md"
       #   comment.line # => 10
       #   comment.position # => 1
-      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
+      def create_commit_comment(repo, sha, body, path = nil, line = nil, position = nil, options = {})
         params = {
-          :body => body,
-          :path => path,
-          :line => line,
-          :position => position
+          body: body,
+          path: path,
+          line: line,
+          position: position
         }
         post "#{Repository.path repo}/commits/#{sha}/comments", options.merge(params)
       end
@@ -76,7 +76,7 @@ module Octokit
       #   comment.body # => "Updated commit comment"
       def update_commit_comment(repo, id, body, options = {})
         params = {
-          :body => body
+          body: body
         }
         patch "#{Repository.path repo}/comments/#{id}", options.merge(params)
       end

data/lib/octokit/client/commit_pulls.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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/commits.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module Octokit
   class Client
-
     # Methods for the Commits API
     #
     # @see https://developer.github.com/v3/repos/commits/
     module Commits
-
       # List commits
       #
       # @overload commits(repo, sha_or_branch, options = {})
@@ -23,12 +23,10 @@ module Octokit
       def commits(*args)
         arguments = Octokit::RepoArguments.new(args)
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          arguments.options[:sha] = sha_or_branch
-        end
+        arguments.options[:sha] = sha_or_branch if sha_or_branch
         paginate "#{Repository.new(arguments.repo).path}/commits", arguments.options
       end
-      alias :list_commits :commits
+      alias list_commits commits
 
       # Get commits after a specified date
       #
@@ -48,13 +46,11 @@ module Octokit
       #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
       def commits_since(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
-        params.merge!(:since => iso8601(date))
+        params.merge!(since: iso8601(date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -74,13 +70,11 @@ module Octokit
       #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
       def commits_before(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
-        params.merge!(:until => iso8601(date))
+        params.merge!(until: iso8601(date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -100,14 +94,12 @@ module Octokit
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01')
       def commits_on(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
         end_date = date + 1
-        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        params.merge!(since: iso8601(date), until: iso8601(end_date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -129,16 +121,16 @@ module Octokit
       #   Octokit.commits_between('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date       = parse_date(arguments.shift)
-        end_date   = parse_date(arguments.shift)
-        raise ArgumentError, "Start date #{date} does not precede #{end_date}" if date > end_date
+        date = parse_date(arguments.shift)
+        end_date = parse_date(arguments.shift)
+        if date > end_date
+          raise ArgumentError, "Start date #{date} does not precede #{end_date}"
+        end
 
         params = arguments.options
-        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        params.merge!(since: iso8601(date), until: iso8601(end_date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -181,21 +173,26 @@ module Octokit
       #   commit.tree.sha # => "827efc6d56897b048c772eb4087f854f46256132"
       #   commit.message # => "My commit message"
       #   commit.committer # => { "name" => "Wynn Netherland", "email" => "wynn@github.com", ... }
-      def create_commit(repo, message, tree, parents=nil, options = {})
-        params = { :message => message, :tree => tree }
+      def create_commit(repo, message, tree, parents = nil, options = {})
+        params = { message: message, tree: tree }
         params[:parents] = [parents].flatten if parents
         post "#{Repository.path repo}/git/commits", options.merge(params)
       end
 
       # Compare two commits
       #
+      # When using auto_pagination, commits from all pages will be concatenated
+      # into the <tt>commits</tt> attribute of the first page's response.
+      #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param start [String] The sha of the starting commit
       # @param endd [String] The sha of the ending commit
       # @return [Sawyer::Resource] A hash representing the comparison
       # @see https://developer.github.com/v3/repos/commits/#compare-two-commits
       def compare(repo, start, endd, options = {})
-        get "#{Repository.path repo}/compare/#{start}...#{endd}", options
+        paginate "#{Repository.path repo}/compare/#{start}...#{endd}", options do |data, last_response|
+          data.commits.concat last_response.data.commits
+        end
       end
 
       # Merge a branch or sha
@@ -208,8 +205,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/merging/#perform-a-merge
       def merge(repo, base, head, options = {})
         params = {
-          :base => base,
-          :head => head
+          base: base,
+          head: head
         }.merge(options)
         post "#{Repository.path repo}/merges", params
       end
@@ -220,7 +217,7 @@ module Octokit
         if date.respond_to?(:iso8601)
           date.iso8601
         else
-          date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+          date.strftime('%Y-%m-%dT%H:%M:%S%Z')
         end
       end