octokit 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afa7dae6ede3d3871a1ba78d8c0de33d3aa4692869eacdbb30e0867f555c21f2
-  data.tar.gz: 213439dcb01e0af935df22e902caa69d9c395b1ab9076a83918efebc374140bd
+  metadata.gz: 398b3f7b1ccfb89b207c3bb654fe34617a4fade1e86b1d9bd7909180b702bc38
+  data.tar.gz: c00f669f44e74b19861c4bd86042aa67e05f272a64021c406aa8a4d6884ad0fd
 SHA512:
-  metadata.gz: 117e024b6078555cdd6809d941a19a0e8b77e629939e112ffe5a5116674c16d6b441358e3ba56bc2d27770fea108fd4adc18d48aa6c186206628abc28dd525d9
-  data.tar.gz: 4caea9cb705c43d9c8022f0de6d74cc9ece8d1e1771ae7a43c0e53a748c226a8c231fe25c64b813bf025a80521dd5c201eb7d2693ebbd6074d47a776137dd7fb
+  metadata.gz: 7d9034260fe94ee7fd55e117457592c36d34777d49ab3efe2ad526c6551e3a2a18a4f4ac1c17df88af53436115f3d6435128bbde1701f48c6647acfb9a396fbd
+  data.tar.gz: 0151f0ec5966df0bb940fe979cf73c1c646aed1f1ff75b050a3e39890c706aa078ef64ae7e5c6efa56f010c78f050913390346d8a2511946bbe731c7dcadb1bb

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,7 +51,7 @@ 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
     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/environments.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Environments API
+    #
+    # @see https://docs.github.com/en/rest/deployments/environments
+    module Environments
+      # Fetch a single environment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return <Sawyer::Resource> A single environment
+      # @see https://docs.github.com/en/rest/deployments/environments#get-an-environment
+      def environment(repo, environment_name, options = {})
+        get("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Lists the environments for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [Integer] :per_page The number of results per page (max 100). Default: 30
+      # @option options [Integer] :page Page number of the results to fetch. Default: 1
+      # @return [Sawyer::Resource] Total count of environments and list of environments
+      # @see https://docs.github.com/en/rest/deployments/environments#list-environments
+      def environments(repo, options = {})
+        get("#{Repository.path repo}/environments", options)
+      end
+      alias list_environments environments
+
+      # Create or update an environment with protection rules, such as required reviewers
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @option options [Integer] :wait_timer The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
+      # @option options [Array] :reviewers The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers.
+      # @option options [Object] :deployment_branch_policy The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
+      # @return [Sawyer::Resource] An environment
+      # @see https://docs.github.com/en/rest/deployments/environments#create-or-update-an-environment
+      def create_or_update_environment(repo, environment_name, options = {})
+        put("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Delete an Environment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return [No Content]
+      # @see https://docs.github.com/en/rest/deployments/environments#delete-an-environment
+      def delete_environment(repo, environment_name, options = {})
+        delete("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+    end
+  end
+end

data/lib/octokit/client/organizations.rb

@@ -50,12 +50,28 @@ module Octokit
       end
       alias update_org update_organization
 
+      # Delete an organization.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @param org [String, Integer] Organization login or ID.
+      # @return [Boolean] True if deletion successful, otherwise false.
+      # @see https://docs.github.com/rest/orgs/orgs#delete-an-organization
+      # @example
+      #   @client.delete_organization("my-org")
+      # @example
+      #   @client.delete_org("my-org")
+      def delete_organization(org)
+        boolean_from_response :delete, Organization.path(org)
+      end
+      alias delete_org delete_organization
+
       # Get organizations for a user.
       #
       # 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/search.rb

@@ -44,6 +44,7 @@ module Octokit
       # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests
+      # @see https://docs.github.com/en/rest/search#limitations-on-query-length
       def search_issues(query, options = {})
         search 'search/issues', query, options
       end

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,7 +27,9 @@ 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'
 require 'octokit/client/events'
 require 'octokit/client/feeds'
@@ -78,14 +82,18 @@ 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
     include Octokit::Client::Emojis
     include Octokit::Client::Events
     include Octokit::Client::Feeds

data/lib/octokit/error.rb

@@ -213,7 +213,7 @@ module Octokit
     end
 
     def redact_url(url_string)
-      %w[client_secret access_token].each do |token|
+      %w[client_secret access_token api_key].each do |token|
         if url_string.include? token
           url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)")
         end

data/lib/octokit/version.rb

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

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.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,28 +10,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-07-28 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,15 +72,19 @@ 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
+- lib/octokit/client/environments.rb
 - lib/octokit/client/events.rb
 - lib/octokit/client/feeds.rb
 - lib/octokit/client/gists.rb
@@ -183,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