octokit 6.1.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68c11fbd1bb2d452acf5bbebf33974285207aa99513b22b4ff8d208e01f76e11
-  data.tar.gz: 63c099454a0ffcdbc621990114adbec36d44535929dfbfacaf09bb3d1b34394f
+  metadata.gz: 27b858e49de1997cc637b78dd77f283f49164e16783d58b665e55da23a2fe957
+  data.tar.gz: f2447bb4e8e8a15e45eb43ebf771a4a04d2fbb9f1615ef9cd835347bb289f33f
 SHA512:
-  metadata.gz: a7ed6fb3bdf0b189ed74e8d12705fd9c377407910a6f8f5a8bd6a16f47326b86126dbf973fbbd6045c3b7f31202fa8af9120fbf8acf99cab1f26765be8413bfc
-  data.tar.gz: 52da944c212373baa9a68476e719dd5b2156bccbd09f0d6028edcf34ca90e15961499cfc88acda86ac7fa6625576005cf79d1c2c7eb8cd9f6f2c453317bbe054
+  metadata.gz: 6e616a14ccdeba68b690f0d3956a6e8eaf45963615231c9c2d95bbef41d3da5bba70401aff57676bdcefcd9d49095cf19932c1383cd8c5d8bb9f54d246f5a48d
+  data.tar.gz: afeaa8ff5a087af75af032b14ffb7428614bd76827fd987a35f36614601ed62d2592961ef09327357ec7b1378ca6b214ef251daa5be5afab5bee5e1c8656fd1f

data/Rakefile

@@ -3,12 +3,18 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
 task test: :spec
 task default: :spec
 
+desc 'Run RSpec'
+task :spec do
+  if Process.respond_to?(:fork)
+    sh('rspec-queue')
+  else
+    sh('rspec')
+  end
+end
+
 namespace :doc do
   require 'yard'
   YARD::Rake::YardocTask.new do |task|

data/lib/octokit/client/actions_secrets.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Hash] key_id and key
       # @see https://developer.github.com/v3/actions/secrets/#get-your-public-key
-      def get_public_key(repo)
+      def get_actions_public_key(repo)
         get "#{Repository.path repo}/actions/secrets/public-key"
       end
 
@@ -20,7 +20,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @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-secrets-for-a-repository
-      def list_secrets(repo)
+      def list_actions_secrets(repo)
         paginate "#{Repository.path repo}/actions/secrets" do |data, last_response|
           data.secrets.concat last_response.data.secrets
         end
@@ -32,7 +32,7 @@ module Octokit
       # @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_secret(repo, name)
+      def get_actions_secret(repo, name)
         get "#{Repository.path repo}/actions/secrets/#{name}"
       end
 
@@ -42,7 +42,7 @@ module Octokit
       # @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-for-a-repository
-      def create_or_update_secret(repo, name, options)
+      def create_or_update_actions_secret(repo, name, options)
         put "#{Repository.path repo}/actions/secrets/#{name}", options
       end
 
@@ -51,9 +51,62 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param name [String] Name of secret
       # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository
-      def delete_secret(repo, name)
+      def delete_actions_secret(repo, name)
         boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
       end
+
+      # Get environment public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-public-key
+      def get_actions_environment_public_key(repo, environment)
+        get "#{Repository.path repo}/environments/#{environment}/secrets/public-key"
+      end
+
+      # List environment secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @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-environment-secrets
+      def list_actions_environment_secrets(repo, environment)
+        paginate "#{Repository.path repo}/environments/#{environment}/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get an environment secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at and updated_at
+      # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-secret
+      def get_actions_environment_secret(repo, environment, name)
+        get "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
+      end
+
+      # Create or update an environment secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/actions/secrets#create-or-update-an-environment-secret
+      def create_or_update_actions_environment_secret(repo, environment, name, options)
+        put "#{Repository.path repo}/environments/#{environment}/secrets/#{name}", options
+      end
+
+      # Delete environment secret
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param environment [String] Name of environment
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/actions/secrets#delete-an-environment-secret
+      def delete_actions_environment_secret(repo, environment, name)
+        boolean_from_response :delete, "#{Repository.path repo}/environments/#{environment}/secrets/#{name}"
+      end
     end
   end
 end

data/lib/octokit/client/code_scanning.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'tempfile'
+require 'zlib'
+
+module Octokit
+  class Client
+    # Methods for the code scanning alerts API
+    #
+    # @see https://docs.github.com/rest/code-scanning
+    module CodeScanning
+      # Uploads SARIF data containing the results of a code scanning analysis
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param file [String] Path to the SARIF file to upload
+      # @param sha [String] The SHA of the commit to which the analysis you are uploading relates
+      # @param ref [String] The full Git reference, formatted as `refs/heads/<branch name>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#upload-an-analysis-as-sarif-data
+      def upload_sarif_data(repo, file, sha, ref, options = {})
+        options[:sarif] = compress_sarif_data(file)
+        options[:commit_sha] = sha
+        options[:ref] = ref
+
+        post "#{Repository.path repo}/code-scanning/sarifs", options
+      end
+
+      # Gets information about a SARIF upload
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param sarif_id [String] The SARIF ID obtained after uploading
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#get-information-about-a-sarif-upload
+      def get_sarif_upload_information(repo, sarif_id, options = {})
+        get "#{Repository.path repo}/code-scanning/sarifs/#{sarif_id}", options
+      end
+
+      private
+
+      def compress_sarif_data(file)
+        Tempfile.create('sarif.gz') do |tempfile|
+          Zlib::GzipWriter.open(tempfile) do |gz_file|
+            gz_file.write File.binread(file)
+          end
+          Base64.strict_encode64(tempfile.read)
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/codespaces_secrets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Codespaces Secrets API
+    #
+    # @see https://docs.github.com/en/rest/codespaces/
+    module CodespacesSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets#get-a-repository-public-key
+      def get_codespaces_public_key(repo)
+        get "#{Repository.path repo}/codespaces/secrets/public-key"
+      end
+
+      # List secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_codespaces_secrets(repo)
+        paginate "#{Repository.path repo}/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
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_codespaces_secret(repo, name)
+        get "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+
+      # Create or update secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_codespaces_secret(repo, name, options)
+        put "#{Repository.path repo}/codespaces/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_codespaces_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/dependabot_secrets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the dependabot Secrets API
+    #
+    # @see https://docs.github.com/en/rest/dependabot/
+    module DependabotSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets#get-a-repository-public-key
+      def get_dependabot_public_key(repo)
+        get "#{Repository.path repo}/dependabot/secrets/public-key"
+      end
+
+      # List secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_dependabot_secrets(repo)
+        paginate "#{Repository.path repo}/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
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_dependabot_secret(repo, name)
+        get "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+
+      # Create or update secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_dependabot_secret(repo, name, options)
+        put "#{Repository.path repo}/dependabot/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_dependabot_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/organizations.rb

@@ -71,7 +71,7 @@ module Octokit
       # Nonauthenticated calls to this method will return organizations that
       # the user is a public member.
       #
-      # Use an authenicated client to get both public and private organizations
+      # Use an authenticated client to get both public and private organizations
       # for a user.
       #
       # Calling this method on a `@client` will return that users organizations.

data/lib/octokit/client/pull_requests.rb

@@ -199,11 +199,13 @@ module Octokit
       # @param path [String] Relative path of the file to comment on.
       # @param position [Integer] Line index in the diff to comment on.
       # @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.'
         options.merge!({
                          body: body,
                          commit_id: commit_id,

data/lib/octokit/client/reactions.rb

@@ -137,16 +137,18 @@ module Octokit
 
       # Delete a reaction
       #
-      # @param id [Integer] Reaction id
+      # @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://developer.github.com/v3/reactions/#delete-a-reaction
+      # @see https://docs.github.com/en/rest/reactions/reactions#delete-an-issue-reaction
       #
       # @example
-      #   @client.delete_reaction(1)
+      #   @client.delete_issue_reaction("octokit/octokit.rb", 1, 2)
       #
       # @return [Boolean] Return true if reaction was deleted, false otherwise.
-      def delete_reaction(id, options = {})
-        boolean_from_response :delete, "reactions/#{id}", options
+      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
     end
   end

data/lib/octokit/client/reviews.rb

@@ -151,7 +151,7 @@ module Octokit
       # @param number [Integer] Number ID of the pull request
       # @param reviewers [Hash] :reviewers [Array<String>] An array of user logins
       # @param options [Hash] :team_reviewers [Array<String>] An array of team slugs
-      # @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+      # @see https://developer.github.com/v3/pulls/review_requests/#request-reviewers-for-a-pull-request
       #
       # @example
       #   @client.request_pull_request_review('octokit/octokit.rb', 2, reviewers: ['soudy'])

data/lib/octokit/client.rb

@@ -18,6 +18,8 @@ require 'octokit/client/actions_workflow_jobs'
 require 'octokit/client/actions_workflow_runs'
 require 'octokit/client/apps'
 require 'octokit/client/checks'
+require 'octokit/client/code_scanning'
+require 'octokit/client/codespaces_secrets'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
 require 'octokit/client/commit_pulls'
@@ -25,6 +27,7 @@ require 'octokit/client/commit_branches'
 require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
+require 'octokit/client/dependabot_secrets'
 require 'octokit/client/deployments'
 require 'octokit/client/environments'
 require 'octokit/client/emojis'
@@ -79,12 +82,15 @@ module Octokit
     include Octokit::Client::ActionsArtifacts
     include Octokit::Client::ActionsSecrets
     include Octokit::Client::Checks
+    include Octokit::Client::CodeScanning
+    include Octokit::Client::CodespacesSecrets
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
     include Octokit::Client::CommitPulls
     include Octokit::Client::CommitBranches
     include Octokit::Client::CommunityProfile
     include Octokit::Client::Contents
+    include Octokit::Client::DependabotSecrets
     include Octokit::Client::Deployments
     include Octokit::Client::Downloads
     include Octokit::Client::Environments

data/lib/octokit/repository.rb

@@ -48,7 +48,8 @@ module Octokit
     # @return [String] Repository API path
     def path
       return named_api_path if @owner && @name
-      return id_api_path if @id
+
+      id_api_path if @id
     end
 
     # Get the api path for a repo

data/lib/octokit/version.rb

@@ -3,7 +3,7 @@
 module Octokit
   # Current major release.
   # @return [Integer]
-  MAJOR = 6
+  MAJOR = 7
 
   # Current minor release.
   # @return [Integer]
@@ -11,7 +11,7 @@ module Octokit
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 1
+  PATCH = 0
 
   # Full release version.
   # @return [String]

data/octokit.gemspec

@@ -5,7 +5,6 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'octokit/version'
 
 Gem::Specification.new do |spec|
-  spec.add_development_dependency 'bundler', '>= 1', '< 3'
   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: 6.1.1
+  version: 7.1.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,28 +10,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -92,12 +72,15 @@ files:
 - lib/octokit/client/actions_workflows.rb
 - lib/octokit/client/apps.rb
 - lib/octokit/client/checks.rb
+- lib/octokit/client/code_scanning.rb
+- lib/octokit/client/codespaces_secrets.rb
 - lib/octokit/client/commit_branches.rb
 - lib/octokit/client/commit_comments.rb
 - lib/octokit/client/commit_pulls.rb
 - lib/octokit/client/commits.rb
 - lib/octokit/client/community_profile.rb
 - lib/octokit/client/contents.rb
+- lib/octokit/client/dependabot_secrets.rb
 - lib/octokit/client/deployments.rb
 - lib/octokit/client/downloads.rb
 - lib/octokit/client/emojis.rb
@@ -184,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API