octokit 6.0.1 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ac7553d8be06123cac2720aa58ad0025845326916a3203f90b8713a6dbb3752
-  data.tar.gz: 3b0e9e958e9d4014cf9f95609ab078af9466613dc808d63f2a0cd3a666c063d2
+  metadata.gz: 68c11fbd1bb2d452acf5bbebf33974285207aa99513b22b4ff8d208e01f76e11
+  data.tar.gz: 63c099454a0ffcdbc621990114adbec36d44535929dfbfacaf09bb3d1b34394f
 SHA512:
-  metadata.gz: 5e0ffef0af68dc1270dc8f1af6cb841532b295dce58aa46cf8e6969f02d4ec1ab117a1198e136350bb630fb6d6120b4231a5d635214b693c997e0b990397258a
-  data.tar.gz: 269e9d3a3fcdb270dfa274d4225a8fa7f2de23280eae137aca3b82a1355f305dcc0fa93c23333a48760004503d9c4336231c588ee8135f1f7ce1434c1a180166
+  metadata.gz: a7ed6fb3bdf0b189ed74e8d12705fd9c377407910a6f8f5a8bd6a16f47326b86126dbf973fbbd6045c3b7f31202fa8af9120fbf8acf99cab1f26765be8413bfc
+  data.tar.gz: 52da944c212373baa9a68476e719dd5b2156bccbd09f0d6028edcf34ca90e15961499cfc88acda86ac7fa6625576005cf79d1c2c7eb8cd9f6f2c453317bbe054

data/README.md

@@ -13,7 +13,7 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 ## Table of Contents
 
 1. [Philosophy](#philosophy)
-2. [Installation](#quick-start)
+2. [Installation](#installation)
 3. [Making requests](#making-requests)
    1. [Additional Query Parameters](#additional-query-parameters)
 4. [Consuming resources](#consuming-resources)
@@ -25,33 +25,35 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
    3. [Two-Factor Authentication](#two-factor-authentication)
    4. [Using a .netrc file](#using-a-netrc-file)
    5. [Application authentication](#application-authentication)
-8. [Pagination](#pagination)
+   6. [GitHub App](#github-app)
+8. [Default results per_page](#default-results-per_page)
+9. [Pagination](#pagination)
    1. [Auto pagination](#auto-pagination)
-9. [Working with GitHub Enterprise](#working-with-github-enterprise)
+10. [Working with GitHub Enterprise](#working-with-github-enterprise)
    1. [Interacting with the GitHub.com APIs in GitHub Enterprise](#interacting-with-the-githubcom-apis-in-github-enterprise)
    2. [Interacting with the GitHub Enterprise Admin APIs](#interacting-with-the-github-enterprise-admin-apis)
    3. [Interacting with the GitHub Enterprise Management Console APIs](#interacting-with-the-github-enterprise-management-console-apis)
    4. [SSL Connection Errors](#ssl-connection-errors)
-10. [Configuration and defaults](#configuration-and-defaults)
+11. [Configuration and defaults](#configuration-and-defaults)
     1. [Configuring module defaults](#configuring-module-defaults)
     2. [Using ENV variables](#using-env-variables)
     3. [Timeouts](#timeouts)
-11. [Hypermedia agent](#hypermedia-agent)
+12. [Hypermedia agent](#hypermedia-agent)
     1. [Hypermedia in Octokit](#hypermedia-in-octokit)
     2. [URI templates](#uri-templates)
     3. [The Full Hypermedia Experience™](#the-full-hypermedia-experience)
-12. [Upgrading guide](#upgrading-guide)
+13. [Upgrading guide](#upgrading-guide)
     1. [Upgrading from 1.x.x](#upgrading-from-1xx)
-13. [Advanced usage](#advanced-usage)
+14. [Advanced usage](#advanced-usage)
     1. [Debugging](#debugging)
     2. [Caching](#caching)
-14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
+15. [Hacking on Octokit.rb](#hacking-on-octokitrb)
     1. [Code of Conduct](#code-of-conduct)
     2. [Running and writing new tests](#running-and-writing-new-tests)
-15. [Supported Ruby Versions](#supported-ruby-versions)
-16. [Versioning](#versioning)
-17. [Making Repeating Requests](#making-repeating-requests)
-18. [License](#license)
+16. [Supported Ruby Versions](#supported-ruby-versions)
+17. [Versioning](#versioning)
+18. [Making Repeating Requests](#making-repeating-requests)
+19. [License](#license)
 
 ## Philosophy
 
@@ -298,6 +300,15 @@ user = client.user 'defunkt'
 [access scopes]: http://developer.github.com/v3/oauth/#scopes
 [app-creds]: http://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications
 
+### GitHub App
+Octokit.rb also supports authentication [using a GitHub App](https://docs.github.com/en/developers/apps/managing-github-apps/installing-github-apps), which [requires a generated JWT token](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app).
+
+```ruby
+client = Octokit::Client.new(:bearer_token => "<your jwt token>")
+client.app
+# => about GitHub App info
+```
+
 ## Default results per_page
 
 Default results from the GitHub API are 30, if you wish to add more you must do so during Octokit configuration.
@@ -606,7 +617,7 @@ traffic:
 
 ```ruby
 stack = Faraday::RackBuilder.new do |builder|
-  builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError] # or Faraday::Request::Retry for Faraday < 2.0
+  builder.use Faraday::Retry::Middleware, exceptions: Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Octokit::ServerError] # or Faraday::Request::Retry for Faraday < 2.0
   builder.use Octokit::Middleware::FollowRedirects
   builder.use Octokit::Response::RaiseError
   builder.use Octokit::Response::FeedParser
@@ -746,6 +757,7 @@ implementations:
 * Ruby 2.7
 * Ruby 3.0
 * Ruby 3.1
+* Ruby 3.2
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 

data/Rakefile

@@ -10,15 +10,13 @@ task test: :spec
 task default: :spec
 
 namespace :doc do
-  begin
-    require 'yard'
-    YARD::Rake::YardocTask.new do |task|
-      task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
-      task.options = [
-        '--output-dir', 'doc/yard',
-        '--markup', 'markdown'
-      ]
-    end
-  rescue LoadError
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown'
+    ]
   end
+rescue LoadError
 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,6 +50,22 @@ 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

data/lib/octokit/client/repositories.rb

@@ -564,7 +564,7 @@ module Octokit
       # @example Get branch 'master` from octokit/octokit.rb
       #   Octokit.branch("octokit/octokit.rb", "master")
       def branch(repo, branch, options = {})
-        get "#{Repository.path repo}/branches/#{branch}", options
+        get "#{Repository.path repo}/branches/#{CGI.escape(branch)}", options
       end
       alias get_branch branch
 

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

@@ -26,6 +26,7 @@ require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
 require 'octokit/client/deployments'
+require 'octokit/client/environments'
 require 'octokit/client/emojis'
 require 'octokit/client/events'
 require 'octokit/client/feeds'
@@ -86,6 +87,7 @@ module Octokit
     include Octokit::Client::Contents
     include Octokit::Client::Deployments
     include Octokit::Client::Downloads
+    include Octokit::Client::Environments
     include Octokit::Client::Emojis
     include Octokit::Client::Events
     include Octokit::Client::Feeds
@@ -163,10 +165,10 @@ module Octokit
       inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
       if @access_token
-        inspected.gsub! @access_token, "#{'*' * 36}#{@access_token[36..-1]}"
+        inspected.gsub! @access_token, "#{'*' * 36}#{@access_token[36..]}"
       end
       if @client_secret
-        inspected.gsub! @client_secret, "#{'*' * 36}#{@client_secret[36..-1]}"
+        inspected.gsub! @client_secret, "#{'*' * 36}#{@client_secret[36..]}"
       end
 
       inspected

data/lib/octokit/configurable.rb

@@ -144,7 +144,7 @@ module Octokit
     private
 
     def options
-      Octokit::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }.to_h
+      Octokit::Configurable.keys.to_h { |key| [key, instance_variable_get(:"@#{key}")] }
     end
 
     def fetch_client_id_and_secret(overrides = {})

data/lib/octokit/default.rb

@@ -34,9 +34,11 @@ module Octokit
       # In Faraday 2.x, Faraday::Request::Retry was moved to a separate gem
       # so we use it only when it's available.
       if defined?(Faraday::Request::Retry)
-        builder.use Faraday::Request::Retry, exceptions: [Octokit::ServerError]
+        retry_exceptions = Faraday::Request::Retry::DEFAULT_EXCEPTIONS + [Octokit::ServerError]
+        builder.use Faraday::Request::Retry, exceptions: retry_exceptions
       elsif defined?(Faraday::Retry::Middleware)
-        builder.use Faraday::Retry::Middleware, exceptions: [Octokit::ServerError]
+        retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Octokit::ServerError]
+        builder.use Faraday::Retry::Middleware, exceptions: retry_exceptions
       end
 
       builder.use Octokit::Middleware::FollowRedirects
@@ -49,7 +51,7 @@ module Octokit
       # Configuration options
       # @return [Hash]
       def options
-        Octokit::Configurable.keys.map { |key| [key, send(key)] }.to_h
+        Octokit::Configurable.keys.to_h { |key| [key, send(key)] }
       end
 
       # Default access token from ENV

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/gist.rb

@@ -10,7 +10,7 @@ module Octokit
     # Instantiate {Gist} object from Gist URL
     # @ return [Gist]
     def self.from_url(url)
-      Gist.new(URI.parse(url).path[1..-1])
+      Gist.new(URI.parse(url).path[1..])
     end
 
     def initialize(gist)

data/lib/octokit/rate_limit.rb

@@ -20,10 +20,12 @@ module Octokit
     # @return [RateLimit]
     def self.from_response(response)
       info = new
-      if response.respond_to?(:headers) && !response.headers.nil?
-        info.limit = (response.headers['X-RateLimit-Limit'] || 1).to_i
-        info.remaining = (response.headers['X-RateLimit-Remaining'] || 1).to_i
-        info.resets_at = Time.at((response.headers['X-RateLimit-Reset'] || Time.now).to_i)
+      headers = response.headers if response.respond_to?(:headers) && !response.headers.nil?
+      headers ||= response.response_headers if response.respond_to?(:response_headers) && !response.response_headers.nil?
+      if headers
+        info.limit = (headers['X-RateLimit-Limit'] || 1).to_i
+        info.remaining = (headers['X-RateLimit-Remaining'] || 1).to_i
+        info.resets_at = Time.at((headers['X-RateLimit-Reset'] || Time.now).to_i)
         info.resets_in = [(info.resets_at - Time.now).to_i, 0].max
       end
 

data/lib/octokit/repository.rb

@@ -12,7 +12,7 @@ module Octokit
     #
     # @return [Repository]
     def self.from_url(url)
-      new URI.parse(url).path[1..-1]
+      new URI.parse(url).path[1..]
              .gsub(%r{^repos/}, '')
              .split('/', 3)[0..1]
              .join('/')

data/lib/octokit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.1
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,7 @@ files:
 - 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