octokit 4.2.0 → 9.2.0

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)
@@ -21,9 +21,9 @@ module Octokit
       # Get number of rate limted requests remaining
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
-      # @return [Fixnum] Number of requests remaining in this period
-      def rate_limit_remaining(options = {})
-        octokit_warn "Deprecated: Please use .rate_limit.remaining"
+      # @return [Integer] Number of requests remaining in this period
+      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!
@@ -41,14 +41,12 @@ module Octokit
       # Refresh rate limit info and get number of rate limted requests remaining
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
-      # @return [Fixnum] Number of requests remaining in this period
-      def rate_limit_remaining!(options = {})
-        octokit_warn "Deprecated: Please use .rate_limit!.remaining"
+      # @return [Integer] Number of requests remaining in this period
+      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

@@ -0,0 +1,204 @@
+# 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
+      # @param id [Integer] The id of the commit comment
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment
+      #
+      # @example
+      #   @client.commit_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def commit_comment_reactions(repo, id, options = {})
+        get "#{Repository.path repo}/comments/#{id}/reactions", options
+      end
+
+      # Create a reaction for a commit comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the commit comment
+      # @param reaction [String] The Reaction
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_commit_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction
+      def create_commit_comment_reaction(repo, id, reaction, options = {})
+        options = options.merge(content: reaction)
+        post "#{Repository.path repo}/comments/#{id}/reactions", options
+      end
+
+      # List reactions for an issue
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The Issue number
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue
+      #
+      # @example
+      #   @client.issue_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def issue_reactions(repo, number, options = {})
+        get "#{Repository.path repo}/issues/#{number}/reactions", options
+      end
+
+      # Create reaction for an issue
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The Issue number
+      # @param reaction [String] The Reaction
+      #
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_issue_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction.
+      def create_issue_reaction(repo, number, reaction, options = {})
+        options = options.merge(content: reaction)
+        post "#{Repository.path repo}/issues/#{number}/reactions", options
+      end
+
+      # List reactions for an issue comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      #
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment
+      #
+      # @example
+      #   @client.issue_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def issue_comment_reactions(repo, id, options = {})
+        get "#{Repository.path repo}/issues/comments/#{id}/reactions", options
+      end
+
+      # Create reaction for an issue comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      # @param reaction [String] The Reaction
+      #
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_issue_comment_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hashes representing the reaction.
+      def create_issue_comment_reaction(repo, id, reaction, options = {})
+        options = options.merge(content: reaction)
+        post "#{Repository.path repo}/issues/comments/#{id}/reactions", options
+      end
+
+      # List reactions for a pull request review comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      #
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment
+      #
+      # @example
+      #   @client.pull_request_review_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def pull_request_review_comment_reactions(repo, id, options = {})
+        get "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
+      end
+
+      # Create reaction for a pull request review comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      # @param reaction [String] The Reaction
+      #
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_pull_request_reiew_comment_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction.
+      def create_pull_request_review_comment_reaction(repo, id, reaction, options = {})
+        options = options.merge(content: reaction)
+        post "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
+      end
+
+      # Delete a reaction
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param issue_id [Integer] The Issue comment id
+      # @param reaction_id [Integer] The Reaction id
+      #
+      # @see https://docs.github.com/en/rest/reactions/reactions#delete-an-issue-reaction
+      #
+      # @example
+      #   @client.delete_issue_reaction("octokit/octokit.rb", 1, 2)
+      #
+      # @return [Boolean] Return true if reaction was deleted, false otherwise.
+      def delete_issue_reaction(repo, issue_id, reaction_id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/issues/#{issue_id}/reactions/#{reaction_id}", options
+      end
+
+      # List reactions for a release
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Release id
+      #
+      # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#list-reactions-for-a-release
+      #
+      # @example
+      #   @client.release_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def release_reactions(repo, release_id, options = {})
+        get "#{Repository.path repo}/releases/#{release_id}/reactions", options
+      end
+
+      # Create reaction for a release
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Release id
+      # @param reaction [String] The Reaction
+      #
+      # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#create-reaction-for-a-release
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_release_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction.
+      def create_release_reaction(repo, release_id, reaction, options = {})
+        options = options.merge(content: reaction)
+        post "#{Repository.path repo}/releases/#{release_id}/reactions", options
+      end
+
+      # Delete a reaction for a release
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param issue_id [Integer] The Release id
+      # @param reaction_id [Integer] The Reaction id
+      #
+      # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#delete-a-release-reaction
+      #
+      # @example
+      #   @client.delete_release_reaction("octokit/octokit.rb", 1, 2)
+      #
+      # @return [Boolean] Return true if reaction was deleted, false otherwise.
+      def delete_release_reaction(repo, release_id, reaction_id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/releases/#{release_id}/reactions/#{reaction_id}", options
+      end
+    end
+  end
+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,21 @@ 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
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt> or <tt>heads/rails-3</tt>
+      # @return [Array<Sawyer::Resource>] The reference matching the given repo and the ref id
+      # @see https://developer.github.com/v3/git/refs/#list-matching-references
+      # @example Fetch refs matching  tags/v2 for sferik/rails_admin
+      #   Octokit.ref("sferik/rails_admin","tags/v2")
+      def matching_refs(repo, ref, options = {})
+        paginate "#{Repository.path repo}/git/matching-refs/#{ref}", options
+      end
 
       # Fetch a given reference
       #
@@ -34,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
       #
@@ -44,45 +56,48 @@ module Octokit
       # @return [Array<Sawyer::Resource>] The list of references, already containing the new one
       # @see https://developer.github.com/v3/git/refs/#create-a-reference
       # @example Create refs/heads/master for octocat/Hello-World with sha 827efc6d56897b048c772eb4087f854f46256132
-      #   Octokit.create_ref("octocat/Hello-World","heads/master", "827efc6d56897b048c772eb4087f854f46256132")
+      #   Octokit.create_ref("octocat/Hello-World", "heads/master", "827efc6d56897b048c772eb4087f854f46256132")
       def create_ref(repo, ref, sha, options = {})
+        ref = "refs/#{ref}" unless ref =~ %r{\Arefs/}
         parameters = {
-          :ref  => "refs/#{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
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt>
       # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
-      # @param force [Boolean] A flag indicating one wants to force the update to make sure the update is a fast-forward update.
+      # @param force [Boolean] A flag indicating whether to force the update or to make sure the update is a fast-forward update.
       # @return [Array<Sawyer::Resource>] The list of references updated
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
-      #   Octokit.update_ref("octocat/Hello-World","heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
-      def update_ref(repo, ref, sha, force = true, options = {})
+      #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      def update_ref(repo, ref, sha, force = false, 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
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param branch [String] The ref, e.g. <tt>feature/new-shiny</tt>
       # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
-      # @param force [Boolean] A flag indicating one wants to force the update to make sure the update is a fast-forward update.
+      # @param force [Boolean] A flag indicating whether to force the update or to make sure the update is a fast-forward update.
       # @return [Array<Sawyer::Resource>] The list of references updated
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
-      #   Octokit.update_ref("octocat/Hello-World","sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      #   Octokit.update_branch("octocat/Hello-World", "sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      # @example Fast-forward update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
+      #   Octokit.update_branch("octocat/Hello-World", "sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd", false)
       def update_branch(repo, branch, sha, force = true, options = {})
         update_ref repo, "heads/#{branch}", sha, force, options
       end
@@ -110,8 +125,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

data/lib/octokit/client/releases.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Releases API
     #
     # @see https://developer.github.com/v3/repos/releases/
     module Releases
-
       # List releases for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -14,7 +14,7 @@ module Octokit
       def releases(repo, options = {})
         paginate "#{Repository.path repo}/releases", options
       end
-      alias :list_releases :releases
+      alias list_releases releases
 
       # Create a release
       #
@@ -28,7 +28,7 @@ module Octokit
       # @return [Sawyer::Resource] The release
       # @see https://developer.github.com/v3/repos/releases/#create-a-release
       def create_release(repo, tag_name, options = {})
-        opts = options.merge(:tag_name => tag_name)
+        opts = options.merge(tag_name: tag_name)
         post "#{Repository.path repo}/releases", opts
       end
 
@@ -44,6 +44,7 @@ module Octokit
       # Update a release
       #
       # @param url [String] URL for the release as returned from .releases
+      # @option options [String] :tag_name Git tag from which to create release
       # @option options [String] :target_commitish Specifies the commitish value that determines where the Git tag is created from.
       # @option options [String] :name Name for the release
       # @option options [String] :body Content for release notes
@@ -54,7 +55,7 @@ module Octokit
       def update_release(url, options = {})
         patch url, options
       end
-      alias :edit_release :update_release
+      alias edit_release update_release
 
       # Delete a release
       #
@@ -83,17 +84,18 @@ module Octokit
       # @return [Sawyer::Resource] The release asset
       # @see https://developer.github.com/v3/repos/releases/#upload-a-release-asset
       def upload_asset(release_url, path_or_file, options = {})
-        file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, "r+b")
+        file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, 'rb')
         options[:content_type] ||= content_type_from_file(file)
-        raise Octokit::MissingContentType.new if options[:content_type].nil?
+        raise Octokit::MissingContentType if options[:content_type].nil?
+
         unless name = options[:name]
           name = File.basename(file.path)
         end
-        upload_url = release(release_url).rels[:upload].href_template.expand(:name => name)
+        upload_url = release(release_url).rels[:upload].href_template.expand(name: name)
 
         request :post, upload_url, file.read, parse_query_and_convenience_headers(options)
       ensure
-        file.close if file
+        file&.close
       end
 
       # Get a single release asset
@@ -116,7 +118,7 @@ module Octokit
       def update_release_asset(asset_url, options = {})
         patch(asset_url, options)
       end
-      alias :edit_release_asset :update_release_asset
+      alias edit_release_asset update_release_asset
 
       # Delete a release asset
       #
@@ -132,6 +134,7 @@ module Octokit
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param tag_name [String] the name for a tag
       # @return [Sawyer::Resource] The release
+      # @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
       def release_for_tag(repo, tag_name, options = {})
         get "#{Repository.path repo}/releases/tags/#{tag_name}", options
       end
@@ -140,6 +143,7 @@ module Octokit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return [Sawyer::Resource] The release
+      # @see https://developer.github.com/v3/repos/releases/#get-the-latest-release
       def latest_release(repo, options = {})
         get "#{Repository.path repo}/releases/latest", options
       end
@@ -152,10 +156,9 @@ module Octokit
           mime_type.content_type
         end
       rescue LoadError
-        msg = "Please pass content_type or install mime-types gem to guess content type from file"
-        raise Octokit::MissingContentType.new(msg)
+        msg = 'Please pass content_type or install mime-types gem to guess content type from file'
+        raise Octokit::MissingContentType, msg
       end
-
     end
   end
 end