octokit 7.2.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab72372e0317944ac3a6c8b4e166bad268bea9524ef8bde2f5cacb13ee471d28
-  data.tar.gz: 19be89924891fb2a771d17fb739fad7454bc8cb79c66950d7c64eb426ab2aef5
+  metadata.gz: dead7bdb61143c1a0b84afa0b02b567a29e117b0b15e0d0ee10271bb9dc62a17
+  data.tar.gz: 648cb60f5d7f8765f925ec2a673dd00331151d3222b392a9814e856e6d303a67
 SHA512:
-  metadata.gz: 38724e4929489a803f1aa9e3186633217bd8473585b35a90ee82fd2985abc361b03af97c96e089759e1c1d2388fcb6cc4fba2d496aae0abfcc214265e0a54770
-  data.tar.gz: b2b589fccec5e74cddc322b850ac9bd04a0dd7300476b6b3758059bcba62b7651a10d634683f0e427ea4c049e78ee52542319206571493ce84241a326af5d6d7
+  metadata.gz: 9b5d2d09d0665466a4bdca1d523758ad447db67c911284c2738a311c400267dbbabcf4c92079c83550339b1cd5361abe841a672a89bc77a7345940d3041cee65
+  data.tar.gz: ca2ced14c1bb869c41f94806427fbd16917eadd6486c35c58c69c59c44b384c323b282266ae95b84bd6109674051a963d6b2d1fea15609bbc61c033a55b6e90f

data/README.md

@@ -213,15 +213,7 @@ user.login
 # => "defunkt"
 ```
 
-You can [create access tokens through your GitHub Account Settings](https://help.github.com/articles/creating-an-access-token-for-command-line-use)
-or with a basic authenticated Octokit client:
-
-```ruby
-client = Octokit::Client.new(:login => 'defunkt', :password => 'c0d3b4ssssss!')
-
-client.create_authorization(:scopes => ["user"], :note => "Name of token")
-# => <your new oauth token>
-```
+You can [create access tokens through your GitHub Account Settings](https://help.github.com/articles/creating-an-access-token-for-command-line-use).
 
 ### Two-Factor Authentication
 
@@ -237,18 +229,6 @@ client = Octokit::Client.new \
 user = client.user("defunkt", :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
 ```
 
-As you can imagine, this gets annoying quickly since two-factor auth tokens are very short lived. So it is recommended to create an oauth token for the user to communicate with the API:
-
-```ruby
-client = Octokit::Client.new \
-  :login    => 'defunkt',
-  :password => 'c0d3b4ssssss!'
-
-client.create_authorization(:scopes => ["user"], :note => "Name of token",
-                            :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
-# => <your new oauth token>
-```
-
 ### Using a .netrc file
 
 Octokit supports reading credentials from a netrc file (defaulting to

data/lib/octokit/client/actions_secrets.rb

@@ -15,6 +15,15 @@ module Octokit
         get "#{Repository.path repo}/actions/secrets/public-key"
       end
 
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://developer.github.com/v3/actions/secrets/#get-your-public-key
+      def get_org_actions_public_key(org)
+        get "#{Organization.path org}/actions/secrets/public-key"
+      end
+
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -26,6 +35,17 @@ module Octokit
         end
       end
 
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://developer.github.com/v3/actions/secrets/#list-organization-secrets
+      def list_org_actions_secrets(org)
+        paginate "#{Organization.path org}/actions/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
       # Get a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -36,6 +56,16 @@ module Octokit
         get "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at and updated_at
+      # @see https://developer.github.com/v3/actions/secrets/#get-a-secret
+      def get_org_actions_secret(org, name)
+        get "#{Organization.path org}/actions/secrets/#{name}"
+      end
+
       # Create or update secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -46,6 +76,16 @@ module Octokit
         put "#{Repository.path repo}/actions/secrets/#{name}", options
       end
 
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret
+      def create_or_update_org_actions_secret(org, name, options)
+        put "#{Organization.path org}/actions/secrets/#{name}", options
+      end
+
       # Delete a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -55,6 +95,15 @@ module Octokit
         boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret
+      def delete_org_actions_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/actions/secrets/#{name}"
+      end
+
       # Get environment public key for secrets encryption
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/codespaces_secrets.rb

@@ -15,6 +15,15 @@ module Octokit
         get "#{Repository.path repo}/codespaces/secrets/public-key"
       end
 
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key
+      def get_org_codespaces_public_key(org)
+        get "#{Organization.path org}/codespaces/secrets/public-key"
+      end
+
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -26,6 +35,17 @@ module Octokit
         end
       end
 
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#list-organization-secrets
+      def list_org_codespaces_secrets(org)
+        paginate "#{Organization.path org}/codespaces/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
       # Get a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -36,6 +56,16 @@ module Octokit
         get "#{Repository.path repo}/codespaces/secrets/#{name}"
       end
 
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret
+      def get_org_codespaces_secret(org, name)
+        get "#{Organization.path org}/codespaces/secrets/#{name}"
+      end
+
       # Create or update secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -46,6 +76,16 @@ module Octokit
         put "#{Repository.path repo}/codespaces/secrets/#{name}", options
       end
 
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
+      def create_or_update_org_codespaces_secret(org, name, options)
+        put "#{Organization.path org}/codespaces/secrets/#{name}", options
+      end
+
       # Delete a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -54,6 +94,15 @@ module Octokit
       def delete_codespaces_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
       end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret
+      def delete_org_codespaces_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/codespaces/secrets/#{name}"
+      end
     end
   end
 end

data/lib/octokit/client/dependabot_secrets.rb

@@ -15,6 +15,15 @@ module Octokit
         get "#{Repository.path repo}/dependabot/secrets/public-key"
       end
 
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key
+      def get_org_dependabot_public_key(org)
+        get "#{Organization.path org}/dependabot/secrets/public-key"
+      end
+
       # List secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -26,6 +35,17 @@ module Octokit
         end
       end
 
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#list-organization-secrets
+      def list_org_dependabot_secrets(org)
+        paginate "#{Organization.path org}/dependabot/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
       # Get a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -36,6 +56,16 @@ module Octokit
         get "#{Repository.path repo}/dependabot/secrets/#{name}"
       end
 
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret
+      def get_org_dependabot_secret(org, name)
+        get "#{Organization.path org}/dependabot/secrets/#{name}"
+      end
+
       # Create or update secrets
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -46,6 +76,16 @@ module Octokit
         put "#{Repository.path repo}/dependabot/secrets/#{name}", options
       end
 
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
+      def create_or_update_org_dependabot_secret(org, name, options)
+        put "#{Organization.path org}/dependabot/secrets/#{name}", options
+      end
+
       # Delete a secret
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -54,6 +94,15 @@ module Octokit
       def delete_dependabot_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/dependabot/secrets/#{name}"
       end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret
+      def delete_org_dependabot_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/dependabot/secrets/#{name}"
+      end
     end
   end
 end

data/lib/octokit/client/deployments.rb

@@ -22,7 +22,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of deployments
       # @see https://developer.github.com/v3/repos/deployments/#list-deployments
       def deployments(repo, options = {})
-        get("#{Repository.path repo}/deployments", options)
+        paginate("#{Repository.path repo}/deployments", options)
       end
       alias list_deployments deployments
 
@@ -60,7 +60,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
         deployment = get(deployment_url, accept: options[:accept])
-        get(deployment.rels[:statuses].href, options)
+        paginate(deployment.rels[:statuses].href, options)
       end
       alias list_deployment_statuses deployment_statuses
 

data/lib/octokit/client/oauth_applications.rb

@@ -65,7 +65,7 @@ module Octokit
       #
       # @example
       #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
-      #  client.delete_token('deadbeef1234567890deadbeef987654321')
+      #  client.delete_app_token('deadbeef1234567890deadbeef987654321')
       def delete_app_token(access_token, options = {})
         options[:access_token] = access_token
 

data/lib/octokit/client/pull_requests.rb

@@ -197,20 +197,21 @@ 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] 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'.
       # @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 = {})
-        octokit_warn 'Deprecated: The position will be deprecated in the next major version.'
+      def create_pull_request_comment(repo, pull_id, body, commit_id, path, line, options = {})
         options.merge!({
                          body: body,
                          commit_id: commit_id,
                          path: path,
-                         position: position
+                         line: line
                        })
         post "#{Repository.path repo}/pulls/#{pull_id}/comments", options
       end

data/lib/octokit/client/reactions.rb

@@ -150,6 +150,55 @@ module Octokit
       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/users.rb

@@ -57,6 +57,33 @@ module Octokit
         post "#{web_endpoint}login/oauth/access_token", options
       end
 
+      # Refresh a user's access token with a refresh token.
+      #
+      # Applications can refresh an access token without requiring a user to re-authorize using refresh access token.
+      #
+      # @param code [String] 40 character GitHub OAuth refresh access token
+      #
+      # @return [Sawyer::Resource]
+      # @see https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.refresh_access_token('40-character-refresh-token')
+      def refresh_access_token(code, app_id = client_id, app_secret = client_secret, options = {})
+        options = options.merge({
+                                  refresh_token: code,
+                                  client_id: app_id,
+                                  client_secret: app_secret,
+                                  grant_type: 'refresh_token',
+                                  headers: {
+                                    content_type: 'application/json',
+                                    accept: 'application/json'
+                                  }
+                                })
+
+        post "#{web_endpoint}login/oauth/access_token", options
+      end
+
       # Validate user username and password
       #
       # @param options [Hash] User credentials

data/lib/octokit/middleware/follow_redirects.rb

@@ -15,7 +15,7 @@ module Octokit
       attr_reader :response
 
       def initialize(response)
-        super "too many redirects; last one to: #{response['location']}"
+        super("too many redirects; last one to: #{response['location']}")
         @response = response
       end
     end

data/lib/octokit/version.rb

@@ -3,11 +3,11 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 7
+  MAJOR = 8
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 2
+  MINOR = 1
 
   # Current patch level.
   # @return [Integer]

data/octokit.gemspec

@@ -5,6 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'octokit/version'
 
 Gem::Specification.new do |spec|
+  spec.add_dependency 'base64'
   spec.add_dependency 'faraday', '>= 1', '< 3'
   spec.add_dependency 'sawyer', '~> 0.9'
   spec.authors = ['Wynn Netherland', 'Erik Michaels-Ober', 'Clint Shryock']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,8 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement