octokit 4.15.0 → 6.0.0

data/lib/octokit/client/checks.rb

@@ -1,11 +1,11 @@
+# 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/
@@ -23,7 +23,6 @@ module Octokit
       #   check_run.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
       #   check_run.status # => "queued"
       def create_check_run(repo, name, head_sha, options = {})
-        ensure_api_media_type(:checks, options)
         options[:name] = name
         options[:head_sha] = head_sha
 
@@ -41,8 +40,6 @@ module Octokit
       #   check_run.id # => 51295429
       #   check_run.status # => "in_progress"
       def update_check_run(repo, id, options = {})
-        ensure_api_media_type(:checks, options)
-
         patch "#{Repository.path repo}/check-runs/#{id}", options
       end
 
@@ -63,11 +60,12 @@ module Octokit
       #   result.check_runs[0].id # => 51295429
       #   result.check_runs[0].status # => "in_progress"
       def check_runs_for_ref(repo, ref, options = {})
-        ensure_api_media_type(:checks, options)
-
-        get "#{Repository.path repo}/commits/#{ref}/check-runs", 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
+      alias list_check_runs_for_ref check_runs_for_ref
 
       # List check runs in a check suite
       #
@@ -86,11 +84,12 @@ module Octokit
       #   result.check_runs[0].check_suite.id # => 50440400
       #   result.check_runs[0].status # => "in_progress"
       def check_runs_for_check_suite(repo, id, options = {})
-        ensure_api_media_type(:checks, options)
-
-        get "#{Repository.path repo}/check-suites/#{id}/check-runs", 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
+      alias list_check_runs_for_check_suite check_runs_for_check_suite
 
       # Get a single check run
       #
@@ -99,8 +98,6 @@ module Octokit
       # @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 = {})
-        ensure_api_media_type(:checks, options)
-
         get "#{Repository.path repo}/check-runs/#{id}", options
       end
 
@@ -116,9 +113,7 @@ module Octokit
       #   annotations[0].path # => "README.md"
       #   annotations[0].message # => "Looks good!"
       def check_run_annotations(repo, id, options = {})
-        ensure_api_media_type(:checks, options)
-
-        get "#{Repository.path repo}/check-runs/#{id}/annotations", options
+        paginate "#{Repository.path repo}/check-runs/#{id}/annotations", options
       end
 
       # Methods for Check Suites
@@ -132,8 +127,6 @@ module Octokit
       # @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 = {})
-        ensure_api_media_type(:checks, options)
-
         get "#{Repository.path repo}/check-suites/#{id}", options
       end
 
@@ -153,11 +146,12 @@ module Octokit
       #   result.check_suites[0].id # => 50440400
       #   result.check_suites[0].app.id # => 76765
       def check_suites_for_ref(repo, ref, options = {})
-        ensure_api_media_type(:checks, options)
-
-        get "#{Repository.path repo}/commits/#{ref}/check-suites", 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
+      alias list_check_suites_for_ref check_suites_for_ref
 
       # Set preferences for check suites on a repository
       #
@@ -172,8 +166,6 @@ module Octokit
       #   result.preferences.auto_trigger_checks[0].setting # => false
       #   result.repository.full_name # => "octocat/Hello-World"
       def set_check_suite_preferences(repo, options = {})
-        ensure_api_media_type(:checks, options)
-
         patch "#{Repository.path repo}/check-suites/preferences", options
       end
 
@@ -188,7 +180,6 @@ module Octokit
       #   check_suite.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
       #   check_suite.status # => "queued"
       def create_check_suite(repo, head_sha, options = {})
-        ensure_api_media_type(:checks, options)
         options[:head_sha] = head_sha
 
         post "#{Repository.path repo}/check-suites", options
@@ -201,8 +192,6 @@ module Octokit
       # @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 = {})
-        ensure_api_media_type(:checks, options)
-
         post "#{Repository.path repo}/check-suites/#{id}/rerequest", options
         true
       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

@@ -1,11 +1,11 @@
+# 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

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
 

data/lib/octokit/client/community_profile.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 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
@@ -14,7 +14,6 @@ module Octokit
       # @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

data/lib/octokit/client/contents.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 module Octokit
   class Client
-
     # Methods for the Repo Contents API
     #
     # @see https://developer.github.com/v3/repos/contents/
     module Contents
-
       # Receive the default Readme for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -16,7 +16,9 @@ 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")
-      def readme(repo, options={})
+      # @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,13 +31,15 @@ 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')
-      def contents(repo, options={})
+      # @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
       end
-      alias :content :contents
+      alias content contents
 
       # Add content to a repository
       #
@@ -55,7 +59,7 @@ module Octokit
       #                    "File content",
       #                    :branch => "my-new-feature")
       def create_contents(*args)
-        args    = args.map { |item| item && item.dup }
+        args    = args.map { |item| item&.dup }
         options = args.last.is_a?(Hash) ? args.pop : {}
         repo    = args.shift
         path    = args.shift
@@ -65,7 +69,7 @@ module Octokit
           case file
           when String
             if File.exist?(file)
-              file = File.open(file, "r")
+              file = File.open(file, 'r')
               content = file.read
               file.close
             end
@@ -74,17 +78,16 @@ module Octokit
             file.close
           end
         end
-        raise ArgumentError.new("content or :file option required") if content.nil?
-        options[:content] = Base64.respond_to?(:strict_encode64) ?
-          Base64.strict_encode64(content) :
-          Base64.encode64(content).delete("\n") # Ruby 1.9.2
+        raise ArgumentError, 'content or :file option required' if content.nil?
+
+        options[:content] = Base64.strict_encode64(content)
         options[:message] = message
         url = "#{Repository.path repo}/contents/#{path}"
         put url, options
       end
-      alias :create_content :create_contents
-      alias :add_content :create_contents
-      alias :add_contents :create_contents
+      alias create_content create_contents
+      alias add_content create_contents
+      alias add_contents create_contents
 
       # Update content in a repository
       #
@@ -112,10 +115,10 @@ module Octokit
         message = args.shift
         sha     = args.shift
         content = args.shift
-        options.merge!(:sha => sha)
+        options.merge!(sha: sha)
         create_contents(repo, path, message, content, options)
       end
-      alias :update_content :update_contents
+      alias update_content update_contents
 
       # Delete content in a repository
       #
@@ -138,9 +141,9 @@ module Octokit
         url = "#{Repository.path repo}/contents/#{path}"
         delete url, options
       end
-      alias :delete_content :delete_contents
-      alias :remove_content :delete_contents
-      alias :remove_contents :delete_contents
+      alias delete_content delete_contents
+      alias remove_content delete_contents
+      alias remove_contents delete_contents
 
       # This method will provide a URL to download a tarball or zipball archive for a repository.
       #
@@ -151,8 +154,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/contents/#get-archive-link
       # @example Get archive link for octokit/octokit.rb
       #   Octokit.archive_link("octokit/octokit.rb")
-      def archive_link(repo, options={})
-        repo_ref = options.delete :ref
+      def archive_link(repo, options = {})
+        repo_ref = ERB::Util.url_encode(options.delete(:ref))
         format = (options.delete :format) || 'tarball'
         url = "#{Repository.path repo}/#{format}/#{repo_ref}"
 

data/lib/octokit/client/deployments.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Deployments API
     #
     # @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
@@ -24,7 +24,7 @@ module Octokit
       def deployments(repo, options = {})
         get("#{Repository.path repo}/deployments", options)
       end
-      alias :list_deployments :deployments
+      alias list_deployments deployments
 
       # Create a deployment for a ref
       #
@@ -43,16 +43,26 @@ 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
       # @return [Array<Sawyer::Resource>] A list of deployment statuses
       # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
-        deployment = get(deployment_url, :accept => options[:accept])
+        deployment = get(deployment_url, accept: options[:accept])
         get(deployment.rels[:statuses].href, options)
       end
-      alias :list_deployment_statuses :deployment_statuses
+      alias list_deployment_statuses deployment_statuses
 
       # Create a deployment status for a Deployment
       #
@@ -63,7 +73,7 @@ module Octokit
       # @return [Sawyer::Resource] A deployment status
       # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
       def create_deployment_status(deployment_url, state, options = {})
-        deployment = get(deployment_url, :accept => options[:accept])
+        deployment = get(deployment_url, accept: options[:accept])
         options[:state] = state.to_s.downcase
         post(deployment.rels[:statuses].href, options)
       end

data/lib/octokit/client/downloads.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repo Downloads API
     #
     # @see https://developer.github.com/v3/repos/downloads/
     module Downloads
-
       # List available downloads for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A Github Repository
@@ -14,10 +14,10 @@ module Octokit
       # @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository
       # @example List all downloads for Github/Hubot
       #   Octokit.downloads("github/hubot")
-      def downloads(repo, options={})
+      def downloads(repo, options = {})
         paginate "#{Repository.path repo}/downloads", options
       end
-      alias :list_downloads :downloads
+      alias list_downloads downloads
 
       # Get single download for a repository
       #
@@ -28,7 +28,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/downloads/#get-a-single-download
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.download("github/hubot")
-      def download(repo, id, options={})
+      def download(repo, id, options = {})
         get "#{Repository.path repo}/downloads/#{id}", options
       end
 
@@ -44,7 +44,6 @@ module Octokit
       def delete_download(repo, id, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/downloads/#{id}", options
       end
-
     end
   end
 end

data/lib/octokit/client/emojis.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Emojis API
     module Emojis
-
       # List all emojis used on GitHub
       #
       # @return [Sawyer::Resource] A list of all emojis on GitHub
@@ -11,7 +11,7 @@ module Octokit
       # @example List all emojis
       #   Octokit.emojis
       def emojis(options = {})
-        get "emojis", options
+        get 'emojis', options
       end
     end
   end

data/lib/octokit/client/events.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Method for the Events API
     #
     # @see https://developer.github.com/v3/activity/events/
     # @see https://developer.github.com/v3/issues/events/
     module Events
-
       # List all public events for GitHub
       #
       # @return [Array<Sawyer::Resource>] A list of all public events from GitHub
@@ -14,7 +14,7 @@ module Octokit
       # @example List all pubilc events
       #   Octokit.public_events
       def public_events(options = {})
-        paginate "events", options
+        paginate 'events', options
       end
 
       # List all user events
@@ -119,7 +119,7 @@ module Octokit
       def repository_issue_events(repo, options = {})
         paginate "#{Repository.path repo}/issues/events", options
       end
-      alias :repo_issue_events :repository_issue_events
+      alias repo_issue_events repository_issue_events
 
       # List events for an Issue
       #