octokit 4.24.0 → 5.0.0

data/lib/octokit/client/projects.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for Projects API
     #
     # @see https://developer.github.com/v3/repos/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 = {})
@@ -28,7 +28,7 @@ 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')
       #
@@ -53,7 +53,7 @@ module Octokit
         opts = ensure_api_media_type(:projects, options)
         paginate "orgs/#{org}/projects", opts
       end
-      alias :organization_projects :org_projects
+      alias organization_projects org_projects
 
       # Create organization project
       #
@@ -73,13 +73,13 @@ module Octokit
         opts[:name] = name
         post "orgs/#{org}/projects", opts
       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 = {})
@@ -95,7 +95,7 @@ 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 = {})
@@ -109,7 +109,7 @@ 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 = {})
@@ -119,9 +119,9 @@ module Octokit
 
       # 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 = {})
@@ -136,7 +136,7 @@ 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 = {})
@@ -149,7 +149,7 @@ module Octokit
       #
       # @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 = {})
@@ -164,7 +164,7 @@ 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 = {})
@@ -179,7 +179,7 @@ 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 = {})
@@ -192,7 +192,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
@@ -296,7 +296,7 @@ module Octokit
       end
 
       # Delete a project card
-      # 
+      #
       # Requires authenticated client
       #
       # @param id [Integer] Project card id
@@ -308,7 +308,6 @@ module Octokit
         opts = ensure_api_media_type(:projects, options)
         boolean_from_response :delete, "projects/columns/cards/#{id}", opts
       end
-
     end # Projects
   end
 end

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the PubSubHubbub API
     #
     # @see https://developer.github.com/v3/repos/hooks/#pubsubhubbub
     module PubSubHubbub
-
       # Subscribe to a pubsub topic
       #
       # @param topic [String] A recoginized and supported pubsub topic
@@ -18,11 +18,11 @@ module Octokit
       #   client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
       def subscribe(topic, callback, secret = nil)
         options = {
-          :"hub.callback" => callback,
-          :"hub.mode" => "subscribe",
-          :"hub.topic" => topic
+          "hub.callback": callback,
+          "hub.mode": 'subscribe',
+          "hub.topic": topic
         }
-        options.merge!(:"hub.secret" => secret) unless secret.nil?
+        options.merge!("hub.secret": secret) unless secret.nil?
 
         response = pub_sub_hubbub_request(options)
 
@@ -40,9 +40,9 @@ module Octokit
       #   client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
       def unsubscribe(topic, callback)
         options = {
-          :"hub.callback" => callback,
-          :"hub.mode" => "unsubscribe",
-          :"hub.topic" => topic
+          "hub.callback": callback,
+          "hub.mode": 'unsubscribe',
+          "hub.topic": topic
         }
         response = pub_sub_hubbub_request(options)
 
@@ -64,7 +64,7 @@ module Octokit
       #    client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" })
       def subscribe_service_hook(repo, service_name, service_arguments = {}, secret = nil)
         topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
-        callback = "github://#{service_name}?#{service_arguments.collect{ |k,v| [ k,v ].map{ |p| URI.encode_www_form_component(p) }.join("=") }.join("&") }"
+        callback = "github://#{service_name}?#{service_arguments.collect { |k, v| [k, v].map { |p| URI.encode_www_form_component(p) }.join('=') }.join('&')}"
         subscribe(topic, callback, secret)
       end
 
@@ -88,20 +88,20 @@ module Octokit
       def pub_sub_hubbub_request(options = {})
         # This method is janky, bypass normal stack so we don't
         # serialize request as JSON
-        conn = Faraday.new(:url => @api_endpoint) do |http|
+        conn = Faraday.new(url: @api_endpoint) do |http|
           http.headers[:user_agent] = user_agent
           if basic_authenticated?
-            http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
+            http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
           elsif token_authenticated?
             http.request :authorization, 'token', @access_token
           end
-          http.request  :url_encoded
+          http.request :url_encoded
           http.use Octokit::Response::RaiseError
-          http.adapter  Faraday.default_adapter
+          http.adapter Faraday.default_adapter
         end
 
         conn.post do |req|
-          req.url "hub"
+          req.url 'hub'
           req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
           req.body = options
         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
       #
@@ -205,15 +205,15 @@ module Octokit
       #     "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
-        })
+                         body: body,
+                         commit_id: commit_id,
+                         path: path,
+                         position: position
+                       })
         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 +227,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 +245,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 +262,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 +274,7 @@ 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
 
       # Merge a pull request
       #
@@ -283,8 +283,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 +296,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
-

data/lib/octokit/client/reactions.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Reacions API
     #
     # @see https://developer.github.com/v3/reactions/
     module Reactions
-
       # List reactions for a commit comment
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -34,7 +34,7 @@ module Octokit
       #
       # @return [<Sawyer::Resource>] Hash representing the reaction
       def create_commit_comment_reaction(repo, id, reaction, options = {})
-        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        options = ensure_api_media_type(:reactions, options.merge(content: reaction))
         post "#{Repository.path repo}/comments/#{id}/reactions", options
       end
 
@@ -67,7 +67,7 @@ module Octokit
       #
       # @return [<Sawyer::Resource>] Hash representing the reaction.
       def create_issue_reaction(repo, number, reaction, options = {})
-        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        options = ensure_api_media_type(:reactions, options.merge(content: reaction))
         post "#{Repository.path repo}/issues/#{number}/reactions", options
       end
 
@@ -101,7 +101,7 @@ module Octokit
       #
       # @return [<Sawyer::Resource>] Hashes representing the reaction.
       def create_issue_comment_reaction(repo, id, reaction, options = {})
-        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        options = ensure_api_media_type(:reactions, options.merge(content: reaction))
         post "#{Repository.path repo}/issues/comments/#{id}/reactions", options
       end
 
@@ -135,7 +135,7 @@ module Octokit
       #
       # @return [<Sawyer::Resource>] Hash representing the reaction.
       def create_pull_request_review_comment_reaction(repo, id, reaction, options = {})
-        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        options = ensure_api_media_type(:reactions, options.merge(content: reaction))
         post "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
       end
 

data/lib/octokit/client/refs.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for References for Git Data API
     #
     # @see https://developer.github.com/v3/git/refs/
     module Refs
-
       # List all refs for a given user and repo
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -19,9 +19,9 @@ module Octokit
         path += "/#{namespace}" unless namespace.nil?
         paginate path, options
       end
-      alias :list_refs :refs
-      alias :references :refs
-      alias :list_references :refs
+      alias list_refs refs
+      alias references refs
+      alias list_references refs
 
       # Fetch matching refs
       #
@@ -46,7 +46,7 @@ module Octokit
       def ref(repo, ref, options = {})
         get "#{Repository.path repo}/git/refs/#{ref}", options
       end
-      alias :reference :ref
+      alias reference ref
 
       # Create a reference
       #
@@ -60,12 +60,12 @@ module Octokit
       def create_ref(repo, ref, sha, options = {})
         ref = "refs/#{ref}" unless ref =~ %r{\Arefs/}
         parameters = {
-          :ref  => ref,
-          :sha  => sha
+          ref: ref,
+          sha: sha
         }
         post "#{Repository.path repo}/git/refs", options.merge(parameters)
       end
-      alias :create_reference :create_ref
+      alias create_reference create_ref
 
       # Update a reference
       #
@@ -81,12 +81,12 @@ module Octokit
       #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd", false)
       def update_ref(repo, ref, sha, force = true, options = {})
         parameters = {
-          :sha  => sha,
-          :force => force
+          sha: sha,
+          force: force
         }
         patch "#{Repository.path repo}/git/refs/#{ref}", options.merge(parameters)
       end
-      alias :update_reference :update_ref
+      alias update_reference update_ref
 
       # Update a branch
       #
@@ -127,8 +127,7 @@ module Octokit
       def delete_ref(repo, ref, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/git/refs/#{ref}", options
       end
-      alias :delete_reference :delete_ref
-
+      alias delete_reference delete_ref
     end
   end
 end