octokit 4.22.0 → 9.2.0

data/lib/octokit/client/projects.rb

@@ -1,23 +1,22 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for Projects API
     #
-    # @see https://developer.github.com/v3/repos/projects
+    # @see https://docs.github.com/en/rest/projects
     module Projects
-
       # List projects for a repository
       #
       # Requires authenticated client
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] Repository projects
-      # @see https://developer.github.com/v3/projects/#list-repository-projects 
+      # @see https://developer.github.com/v3/projects/#list-repository-projects
       # @example
       #   @client.projects('octokit/octokit.rb')
       def projects(repo, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        paginate "#{Repository.path repo}/projects", opts
+        paginate "#{Repository.path repo}/projects", options
       end
 
       # Create a project
@@ -28,16 +27,15 @@ module Octokit
       # @param name [String] Project name
       # @option options [String] :body Body of the project
       # @return [Sawyer::Resource] Fresh new project
-      # @see https://developer.github.com/v3/projects/#create-a-repository-project 
+      # @see https://developer.github.com/v3/projects/#create-a-repository-project
       # @example Create project with only a name
       #   @client.create_project('octokit/octokit.rb', 'implement new APIs')
       #
       # @example Create project with name and body
       #   @client.create_project('octokit/octokit.rb', 'bugs be gone', body: 'Fix all the bugs @joeyw creates')
       def create_project(repo, name, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        opts[:name] = name
-        post "#{Repository.path repo}/projects", opts
+        options[:name] = name
+        post "#{Repository.path repo}/projects", options
       end
 
       # List organization projects
@@ -50,10 +48,9 @@ module Octokit
       # @example
       #   @client.org_projects("octokit")
       def org_projects(org, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        paginate "orgs/#{org}/projects", opts
+        paginate "orgs/#{org}/projects", options
       end
-      alias :organization_projects :org_projects
+      alias organization_projects org_projects
 
       # Create organization project
       #
@@ -69,22 +66,20 @@ module Octokit
       # @example Create a project with name and body
       #   @client.create_org_project("octokit", "octocan", body: 'Improve clients')
       def create_org_project(org, name, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        opts[:name] = name
-        post "orgs/#{org}/projects", opts
+        options[:name] = name
+        post "orgs/#{org}/projects", options
       end
-      alias :create_organization_project :create_org_project
+      alias create_organization_project create_org_project
 
-      # Get a project by id 
+      # Get a project by id
       #
       # @param id [Integer] Project id
       # @return [Sawyer::Resource] Project
-      # @see https://developer.github.com/v3/projects/#get-a-project 
+      # @see https://developer.github.com/v3/projects/#get-a-project
       # @example
       #   Octokit.project(123942)
       def project(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        get "projects/#{id}", opts
+        get "projects/#{id}", options
       end
 
       # Update a project
@@ -95,12 +90,11 @@ module Octokit
       # @option options [String] :name Project name
       # @option options [String] :body Project body
       # @return [Sawyer::Resource] Project
-      # @see https://developer.github.com/v3/projects/#update-a-project 
+      # @see https://developer.github.com/v3/projects/#update-a-project
       # @example Update project name
       #   @client.update_project(123942, name: 'New name')
       def update_project(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        patch "projects/#{id}", opts
+        patch "projects/#{id}", options
       end
 
       # Delete a project
@@ -109,24 +103,22 @@ module Octokit
       #
       # @param id [Integer] Project id
       # @return [Boolean] Result of deletion
-      # @see https://developer.github.com/v3/projects/#delete-a-project 
+      # @see https://developer.github.com/v3/projects/#delete-a-project
       # @example
       #   @client.delete_project(123942)
       def delete_project(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        boolean_from_response :delete, "projects/#{id}", opts
+        boolean_from_response :delete, "projects/#{id}", options
       end
 
       # List project columns
       #
-      # @param id [Integer] Project id 
+      # @param id [Integer] Project id
       # @return [Array<Sawyer::Resource>] List of project columns
-      # @see https://developer.github.com/v3/projects/columns/#list-project-columns 
+      # @see https://developer.github.com/v3/projects/columns/#list-project-columns
       # @example
       #   @client.project_columns(123942)
       def project_columns(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        paginate "projects/#{id}/columns", opts
+        paginate "projects/#{id}/columns", options
       end
 
       # Create a project column
@@ -136,25 +128,23 @@ module Octokit
       # @param id [Integer] Project column id
       # @param name [String] New column name
       # @return [Sawyer::Resource] Newly created column
-      # @see https://developer.github.com/v3/projects/columns/#create-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#create-a-project-column
       # @example
       #   @client.create_project_column(123942, "To Dones")
       def create_project_column(id, name, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        opts[:name] = name
-        post "projects/#{id}/columns", opts
+        options[:name] = name
+        post "projects/#{id}/columns", options
       end
 
       # Get a project column by ID
       #
       # @param id [Integer] Project column id
       # @return [Sawyer::Resource] Project column
-      # @see https://developer.github.com/v3/projects/columns/#get-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#get-a-project-column
       # @example
       #   Octokit.project_column(30294)
       def project_column(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        get "projects/columns/#{id}", opts
+        get "projects/columns/#{id}", options
       end
 
       # Update a project column
@@ -164,13 +154,12 @@ module Octokit
       # @param id [Integer] Project column id
       # @param name [String] New column name
       # @return [Sawyer::Resource] Updated column
-      # @see https://developer.github.com/v3/projects/columns/#update-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#update-a-project-column
       # @example
       #   @client.update_project_column(30294, "new column name")
       def update_project_column(id, name, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        opts[:name] = name
-        patch "projects/columns/#{id}", opts
+        options[:name] = name
+        patch "projects/columns/#{id}", options
       end
 
       # Delete a project column
@@ -179,12 +168,11 @@ module Octokit
       #
       # @param id [Integer] Project column id
       # @return [Boolean] Result of deletion request, true when deleted
-      # @see https://developer.github.com/v3/projects/columns/#delete-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#delete-a-project-column
       # @example
       #   @client.delete_project_column(30294)
       def delete_project_column(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        boolean_from_response :delete, "projects/columns/#{id}", opts
+        boolean_from_response :delete, "projects/columns/#{id}", options
       end
 
       # Move a project column
@@ -192,7 +180,7 @@ module Octokit
       # Requires authenticated client
       #
       # @param id [Integer] Project column id
-      # @param position [String] New position for the column. Can be one of 
+      # @param position [String] New position for the column. Can be one of
       #   <tt>first</tt>, <tt>last</tt>, or <tt>after:<column-id></tt>, where
       #   <tt><column-id></tt> is the id value of a column in the same project.
       # @return [Sawyer::Resource] Result
@@ -200,9 +188,8 @@ module Octokit
       # @example
       #   @client.move_project_column(30294, "last")
       def move_project_column(id, position, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        opts[:position] = position
-        post "projects/columns/#{id}/moves", opts
+        options[:position] = position
+        post "projects/columns/#{id}/moves", options
       end
 
       # List columns cards
@@ -215,8 +202,7 @@ module Octokit
       # @example
       #   @client.column_cards(30294)
       def column_cards(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        paginate "projects/columns/#{id}/cards", opts
+        paginate "projects/columns/#{id}/cards", options
       end
 
       # Create project card
@@ -238,8 +224,7 @@ module Octokit
       # @example Create a project card for an repository issue
       #   @client.create_project_card(123495, content_id: 1, content_type: 'Issue')
       def create_project_card(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        post "projects/columns/#{id}/cards", opts
+        post "projects/columns/#{id}/cards", options
       end
 
       # Get a project card
@@ -252,8 +237,7 @@ module Octokit
       # @example
       #   @client.project_card(123495)
       def project_card(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        get "projects/columns/cards/#{id}", opts
+        get "projects/columns/cards/#{id}", options
       end
 
       # Update a project card
@@ -269,8 +253,7 @@ module Octokit
       # @example
       #   @client.update_project_card(12345, note: 'new note')
       def update_project_card(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        patch "projects/columns/cards/#{id}", opts
+        patch "projects/columns/cards/#{id}", options
       end
 
       # Move a project card
@@ -290,13 +273,12 @@ module Octokit
       # @example Move a card to the top of another column
       #   @client.move_project_card(123495, 'top', column_id: 59402)
       def move_project_card(id, position, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        opts[:position] = position
-        post "projects/columns/cards/#{id}/moves", opts
+        options[:position] = position
+        post "projects/columns/cards/#{id}/moves", options
       end
 
       # Delete a project card
-      # 
+      #
       # Requires authenticated client
       #
       # @param id [Integer] Project card id
@@ -305,10 +287,8 @@ module Octokit
       # @example
       #   @client.delete_project_card(123495)
       def delete_project_card(id, options = {})
-        opts = ensure_api_media_type(:projects, options)
-        boolean_from_response :delete, "projects/columns/cards/#{id}", opts
+        boolean_from_response :delete, "projects/columns/cards/#{id}", options
       end
-
     end # Projects
   end
 end

data/lib/octokit/client/pull_requests.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Pull Requests API
     #
     # @see https://developer.github.com/v3/pulls/
     module PullRequests
-
       # List pull requests for a repository
       #
       # @overload pull_requests(repo, options)
@@ -19,7 +19,7 @@ module Octokit
       def pull_requests(repo, options = {})
         paginate "#{Repository.path repo}/pulls", options
       end
-      alias :pulls :pull_requests
+      alias pulls pull_requests
 
       # Get a pull request
       #
@@ -28,11 +28,11 @@ module Octokit
       # @param number [Integer] Number of the pull request to fetch
       # @return [Sawyer::Resource] Pull request info
       # @example
-      #   Octokit.pull_request('rails/rails', 42, :state => 'closed')      
+      #   Octokit.pull_request('rails/rails', 42, :state => 'closed')
       def pull_request(repo, number, options = {})
         get "#{Repository.path repo}/pulls/#{number}", options
       end
-      alias :pull :pull_request
+      alias pull pull_request
 
       # Create a pull request
       #
@@ -51,9 +51,9 @@ module Octokit
       #     "Pull Request title", "Pull Request body")
       def create_pull_request(repo, base, head, title, body = nil, options = {})
         pull = {
-          :base  => base,
-          :head  => head,
-          :title => title,
+          base: base,
+          head: head,
+          title: title
         }
         pull[:body] = body unless body.nil?
         post "#{Repository.path repo}/pulls", options.merge(pull)
@@ -72,9 +72,9 @@ module Octokit
       # @return [Sawyer::Resource] The newly created pull request
       def create_pull_request_for_issue(repo, base, head, issue, options = {})
         pull = {
-          :base  => base,
-          :head  => head,
-          :issue => issue
+          base: base,
+          head: head,
+          issue: issue
         }
         post "#{Repository.path repo}/pulls", options.merge(pull)
       end
@@ -103,7 +103,7 @@ module Octokit
       #   @client.update_pull_request('octokit/octokit.rb', 67, nil, '')
       def update_pull_request(*args)
         arguments = Octokit::Arguments.new(args)
-        repo   = arguments.shift
+        repo = arguments.shift
         number = arguments.shift
         patch "#{Repository.path repo}/pulls/#{number}", arguments.options
       end
@@ -117,7 +117,7 @@ module Octokit
       # @example
       #   @client.close_pull_request('octokit/octokit.rb', 67)
       def close_pull_request(repo, number, options = {})
-        options.merge! :state => 'closed'
+        options.merge! state: 'closed'
         update_pull_request(repo, number, options)
       end
 
@@ -130,7 +130,7 @@ module Octokit
       def pull_request_commits(repo, number, options = {})
         paginate "#{Repository.path repo}/pulls/#{number}/commits", options
       end
-      alias :pull_commits :pull_request_commits
+      alias pull_commits pull_request_commits
 
       # List pull request comments for a repository
       #
@@ -160,8 +160,8 @@ module Octokit
       def pull_requests_comments(repo, options = {})
         paginate("#{Repository.path repo}/pulls/comments", options)
       end
-      alias :pulls_comments   :pull_requests_comments
-      alias :reviews_comments :pull_requests_comments
+      alias pulls_comments   pull_requests_comments
+      alias reviews_comments pull_requests_comments
 
       # List comments on a pull request
       #
@@ -173,8 +173,8 @@ module Octokit
         # return the comments for a pull request
         paginate("#{Repository.path repo}/pulls/#{number}/comments", options)
       end
-      alias :pull_comments   :pull_request_comments
-      alias :review_comments :pull_request_comments
+      alias pull_comments   pull_request_comments
+      alias review_comments pull_request_comments
 
       # Get a pull request comment
       #
@@ -187,8 +187,8 @@ module Octokit
       def pull_request_comment(repo, comment_id, options = {})
         get "#{Repository.path repo}/pulls/comments/#{comment_id}", options
       end
-      alias :pull_comment   :pull_request_comment
-      alias :review_comment :pull_request_comment
+      alias pull_comment   pull_request_comment
+      alias review_comment pull_request_comment
 
       # Create a pull request comment
       #
@@ -197,23 +197,34 @@ module Octokit
       # @param body [String] Comment content
       # @param commit_id [String] Sha of the commit to comment on.
       # @param path [String] Relative path of the file to comment on.
-      # @param position [Integer] Line index in the diff to comment on.
+      # @param line [Integer] Optional line index in the diff to comment on.
+      #                       For a multi-line comment, the last line of the range
+      #                       and specify 'start_line' in the 'options'.
+      #                       If not specified, the comment will be on the whole file.
       # @return [Sawyer::Resource] Hash representing the new comment
+      # @deprecated The position will be deprecated in the next major version. Please refer to the details below.
       # @see https://developer.github.com/v3/pulls/comments/#create-a-comment
       # @example
       #   @client.create_pull_request_comment("octokit/octokit.rb", 163, ":shipit:",
       #     "2d3201e4440903d8b04a5487842053ca4883e5f0", "lib/octokit/request.rb", 47)
-      def create_pull_request_comment(repo, pull_id, body, commit_id, path, position, options = {})
-        options.merge!({
-          :body => body,
-          :commit_id => commit_id,
-          :path => path,
-          :position => position
-        })
+      def create_pull_request_comment(repo, pull_id, body, commit_id, path, line = nil, options = {})
+        comment = {
+          body: body,
+          commit_id: commit_id,
+          path: path
+        }
+
+        if line.nil?
+          comment[:subject_type] = 'file'
+        else
+          comment[:line] = line
+        end
+
+        options.merge! comment
         post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end
-      alias :create_pull_comment :create_pull_request_comment
-      alias :create_view_comment :create_pull_request_comment
+      alias create_pull_comment create_pull_request_comment
+      alias create_view_comment create_pull_request_comment
 
       # Create reply to a pull request comment
       #
@@ -227,13 +238,13 @@ module Octokit
       #   @client.create_pull_request_comment_reply("octokit/octokit.rb", 163, "done.", 1903950)
       def create_pull_request_comment_reply(repo, pull_id, body, comment_id, options = {})
         options.merge!({
-          :body => body,
-          :in_reply_to => comment_id
-        })
+                         body: body,
+                         in_reply_to: comment_id
+                       })
         post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end
-      alias :create_pull_reply   :create_pull_request_comment_reply
-      alias :create_review_reply :create_pull_request_comment_reply
+      alias create_pull_reply   create_pull_request_comment_reply
+      alias create_review_reply create_pull_request_comment_reply
 
       # Update pull request comment
       #
@@ -245,11 +256,11 @@ module Octokit
       # @example
       #   @client.update_pull_request_comment("octokit/octokit.rb", 1903950, ":shipit:")
       def update_pull_request_comment(repo, comment_id, body, options = {})
-        options.merge! :body => body
+        options.merge! body: body
         patch("#{Repository.path repo}/pulls/comments/#{comment_id}", options)
       end
-      alias :update_pull_comment   :update_pull_request_comment
-      alias :update_review_comment :update_pull_request_comment
+      alias update_pull_comment   update_pull_request_comment
+      alias update_review_comment update_pull_request_comment
 
       # Delete pull request comment
       #
@@ -262,8 +273,8 @@ module Octokit
       def delete_pull_request_comment(repo, comment_id, options = {})
         boolean_from_response(:delete, "#{Repository.path repo}/pulls/comments/#{comment_id}", options)
       end
-      alias :delete_pull_comment   :delete_pull_request_comment
-      alias :delete_review_comment :delete_pull_request_comment
+      alias delete_pull_comment   delete_pull_request_comment
+      alias delete_review_comment delete_pull_request_comment
 
       # List files on a pull request
       #
@@ -274,7 +285,18 @@ module Octokit
       def pull_request_files(repo, number, options = {})
         paginate "#{Repository.path repo}/pulls/#{number}/files", options
       end
-      alias :pull_files :pull_request_files
+      alias pull_files pull_request_files
+
+      # Update a pull request branch
+      #
+      # @see https://developer.github.com/v3/pulls/#update-a-pull-request-branch
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of pull request
+      # @param options [Hash] Optional parameters (e.g. expected_head_sha)
+      # @return [Boolean] True if the pull request branch has been updated
+      def update_pull_request_branch(repo, number, options = {})
+        boolean_from_response(:put, "#{Repository.path repo}/pulls/#{number}/update-branch", options)
+      end
 
       # Merge a pull request
       #
@@ -283,8 +305,8 @@ module Octokit
       # @param number [Integer] Number of pull request
       # @param commit_message [String] Optional commit message for the merge commit
       # @return [Array<Sawyer::Resource>] Merge commit info if successful
-      def merge_pull_request(repo, number, commit_message='', options = {})
-        put "#{Repository.path repo}/pulls/#{number}/merge", options.merge({:commit_message => commit_message})
+      def merge_pull_request(repo, number, commit_message = '', options = {})
+        put "#{Repository.path repo}/pulls/#{number}/merge", options.merge({ commit_message: commit_message })
       end
 
       # Check pull request merge status
@@ -296,8 +318,7 @@ module Octokit
       def pull_merged?(repo, number, options = {})
         boolean_from_response :get, "#{Repository.path repo}/pulls/#{number}/merge", options
       end
-      alias :pull_request_merged? :pull_merged?
-
+      alias pull_request_merged? pull_merged?
     end
   end
 end

data/lib/octokit/client/rate_limit.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for API rate limiting info
     #
     # @see https://developer.github.com/v3/#rate-limiting
     module RateLimit
-
       # Get rate limit info from last response if available
       # or make a new request to fetch rate limit
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Octokit::RateLimit] Rate limit info
-      def rate_limit(options = {})
+      def rate_limit(_options = {})
         return rate_limit! if last_response.nil?
 
         Octokit::RateLimit.from_response(last_response)
@@ -22,8 +22,8 @@ module Octokit
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Integer] Number of requests remaining in this period
-      def rate_limit_remaining(options = {})
-        octokit_warn "Deprecated: Please use .rate_limit.remaining"
+      def rate_limit_remaining(_options = {})
+        octokit_warn 'Deprecated: Please use .rate_limit.remaining'
         rate_limit.remaining
       end
       alias ratelimit_remaining rate_limit_remaining
@@ -32,8 +32,8 @@ module Octokit
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Octokit::RateLimit] Rate limit info
-      def rate_limit!(options = {})
-        get "rate_limit"
+      def rate_limit!(_options = {})
+        get 'rate_limit'
         Octokit::RateLimit.from_response(last_response)
       end
       alias ratelimit! rate_limit!
@@ -42,13 +42,11 @@ module Octokit
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Integer] Number of requests remaining in this period
-      def rate_limit_remaining!(options = {})
-        octokit_warn "Deprecated: Please use .rate_limit!.remaining"
+      def rate_limit_remaining!(_options = {})
+        octokit_warn 'Deprecated: Please use .rate_limit!.remaining'
         rate_limit!.remaining
       end
       alias ratelimit_remaining! rate_limit_remaining!
-
     end
   end
 end
-