octokit 4.13.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62cc9f95627d52ebe1950974e93a4ddf3a24709dd23d24f7124ef9f4befc7a94
-  data.tar.gz: b0390bb087b9cfda51e942ee3958c9ea600750697e4f6b825aa0dd40947574b1
+  metadata.gz: 9801b25dfdd07e517b87bdc1404ffa64fd12496b66af8bb8bc4af57f6f33483f
+  data.tar.gz: b082dcc32f514846b53da5aaafe7666020c9de8d590dafb6e93743767a70573b
 SHA512:
-  metadata.gz: efd51d1fb7f93e55da8d616c90ec6840688873f9070f63816a3782d3900587e41b3f4f50e49450bc2b721d088042038dec16d66dbc93b3356191404919932ca4
-  data.tar.gz: faa042b6c7afa1aa67eed9b0904e8319a178f0c79d4bc4be8467ce2fa5604a2c413d93ede232d739083085cdd94fcfa5d6b22854583b5807f0ed0978fc221d48
+  metadata.gz: 16595560313f6346448710adf2a0d641fe62521089ff017aff1c2f1dc6dd1d5dc06d8397e552a098cf1a6ada91edfa111863d9c4491df86d3d38d3143531a7b5
+  data.tar.gz: 7dc816349c9050b31e0c0d09a7e1e25b6d455d59f6ae817db2f46b16900104bcdff15d3f280352e7bcb0ca195060824094ebe09ea022c3e46b52c8f559c0cc5b

data/CONTRIBUTING.md

@@ -1,21 +1,22 @@
 ## Submitting a Pull Request
 
-0. Check out Hacking on Octokit in the README guide for
-   bootstrapping the project for local development.
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `script/test`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `script/test`. If your specs fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
+0. Read our [Code of Conduct](CODE_OF_CONDUCT.md).
+1. Check out [Hacking on Octokit](README.md#hacking-on-octokitrb) in the
+   README for bootstrapping the project for local development.
+2. [Fork the repository.][fork]
+3. [Create a topic branch.][branch]
+4. Add specs for your unimplemented feature or bug fix.
+5. Run `script/test`. If your specs pass, return to step 3.
+6. Implement your feature or bug fix.
+7. Run `script/test`. If your specs fail, return to step 5.
+8. Run `open coverage/index.html`. If your changes are not completely covered
    by your tests, return to step 4.
-8. Add documentation for your feature or bug fix.
-9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
+9. Add documentation for your feature or bug fix.
+10. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
    back to step 8.
-10. Add, commit, and push your changes. For documentation-only fixes, please
+11. Add, commit, and push your changes. For documentation-only fixes, please
     add "[ci skip]" to your commit message to avoid needless CI builds.
-11. [Submit a pull request.][pr]
+12. [Submit a pull request.][pr]
 
 [fork]: https://help.github.com/articles/fork-a-repo
 [branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/

data/README.md

@@ -30,6 +30,7 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 10. [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)
     1. [Hypermedia in Octokit](#hypermedia-in-octokit)
     2. [URI templates](#uri-templates)
@@ -40,7 +41,8 @@ Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
     1. [Debugging](#debugging)
     2. [Caching](#caching)
 14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
-    1. [Running and writing new tests](#running-and-writing-new-tests)
+    1. [Code of Conduction](#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)
@@ -62,7 +64,7 @@ client.readme 'al3x/sovereign', :accept => 'application/vnd.github.html'
 ```
 
 [wrappers]: http://wynnnetherland.com/journal/what-makes-a-good-api-wrapper
-[github-api]: http://developer.github.com
+[github-api]: https://developer.github.com/v3/
 
 ## Quick start
 
@@ -288,7 +290,7 @@ link relations](#hypermedia-agent).
 
 ```ruby
 issues = client.issues 'rails/rails'
-issues.concat client.last_response.rels[:next].get.data
+issues.concat client.get(client.last_response.rels[:next].href)
 ```
 
 ### Auto pagination
@@ -427,6 +429,27 @@ Deprecation warnings and API endpoints in development preview warnings are
 printed to STDOUT by default, these can be disabled by setting the ENV
 `OCTOKIT_SILENT=true`.
 
+### Timeouts
+
+By default, Octokit does not timeout network requests. To set a timeout, pass in Faraday timeout settings to Octokit's `connection_options` setting.
+
+```ruby
+Octokit.configure do |c|
+  c.api_endpoint = ENV.fetch('GITHUB_API_ENDPOINT', 'https://api.github.com/')
+  c.connection_options = {
+    request: {
+      open_timeout: 5,
+      timeout: 5
+    }
+  }
+end
+```
+You should set a timeout in order to avoid Ruby’s Timeout module, which can hose your server. Here are some resources for more information on this:
+
+- [The Oldest Bug In Ruby - Why Rack::Timeout Might Hose your Server](https://www.schneems.com/2017/02/21/the-oldest-bug-in-ruby-why-racktimeout-might-hose-your-server/)
+- [Timeout: Ruby's Most Dangerous API](https://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/)
+- [The Ultimate Guide to Ruby Timeouts](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts)
+
 ## Hypermedia agent
 
 Starting in version 2.0, Octokit is [hypermedia][]-enabled. Under the hood,
@@ -628,9 +651,15 @@ to run a Ruby console to poke on Octokit, you can crank one up with:
 
     script/console
 
-Using the scripts in `./scripts` instead of `bundle exec rspec`, `bundle
+Using the scripts in `./script` instead of `bundle exec rspec`, `bundle
 console`, etc.  ensures your dependencies are up-to-date.
 
+### Code of Conduct
+
+We want both the Octokit.rb and larger Octokit communities to be an open
+and welcoming environments. Please read and follow both in spirit and
+letter [Code of Conduct](CODE_OF_CONDUCT.md).
+
 ### Running and writing new tests
 
 Octokit uses [VCR][] for recording and playing back API fixtures during test
@@ -684,15 +713,12 @@ when writing new specs.
 
 ## Supported Ruby Versions
 
-This library aims to support and is [tested against][travis] the following Ruby
+This library aims to support and is [tested against][actions] the following Ruby
 implementations:
 
-* Ruby 2.0
-* Ruby 2.1
-* Ruby 2.2
-* Ruby 2.3
-* Ruby 2.4
 * Ruby 2.5
+* Ruby 2.6
+* Ruby 2.7
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 
@@ -707,7 +733,7 @@ implementation, you will be responsible for providing patches in a timely
 fashion. If critical issues for a particular implementation exist at the time
 of a major release, support for that Ruby version may be dropped.
 
-[travis]: https://travis-ci.org/octokit/octokit.rb
+[actions]: https://github.com/octokit/octokit.rb/actions
 
 ## Versioning
 
@@ -729,7 +755,7 @@ The changes made between versions can be seen on the [project releases page][rel
 [releases]: https://github.com/octokit/octokit.rb/releases
 
 ## Making Repeating Requests
-In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests. 
+In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests.
 
 ```ruby
 Octopoller.poll(timeout: 15.seconds) do

data/lib/octokit/authentication.rb

@@ -43,22 +43,13 @@ module Octokit
     # requests at a higher rate limit
     #
     # @see https://developer.github.com/v3/#unauthenticated-rate-limited-requests
-    # @return Boolean
+    # @return [Boolean]
     def application_authenticated?
-      !!application_authentication
+      !!(@client_id && @client_secret)
     end
 
     private
 
-    def application_authentication
-      if @client_id && @client_secret
-        {
-          :client_id     => @client_id,
-          :client_secret => @client_secret
-        }
-      end
-    end
-
     def login_from_netrc
       return unless netrc?
 

data/lib/octokit/client.rb

@@ -10,10 +10,16 @@ require 'octokit/repository'
 require 'octokit/user'
 require 'octokit/organization'
 require 'octokit/preview'
+require 'octokit/client/actions_secrets'
+require 'octokit/client/actions_workflows'
+require 'octokit/client/actions_workflow_runs'
 require 'octokit/client/apps'
 require 'octokit/client/authorizations'
+require 'octokit/client/checks'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
+require 'octokit/client/commit_pulls'
+require 'octokit/client/commit_branches'
 require 'octokit/client/community_profile'
 require 'octokit/client/contents'
 require 'octokit/client/downloads'
@@ -33,6 +39,7 @@ require 'octokit/client/markdown'
 require 'octokit/client/marketplace'
 require 'octokit/client/milestones'
 require 'octokit/client/notifications'
+require 'octokit/client/oauth_applications'
 require 'octokit/client/objects'
 require 'octokit/client/organizations'
 require 'octokit/client/pages'
@@ -68,9 +75,13 @@ module Octokit
     include Octokit::Connection
     include Octokit::Preview
     include Octokit::Warnable
+    include Octokit::Client::ActionsSecrets
     include Octokit::Client::Authorizations
+    include Octokit::Client::Checks
     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::Deployments
@@ -81,6 +92,8 @@ module Octokit
     include Octokit::Client::Gists
     include Octokit::Client::Gitignore
     include Octokit::Client::Hooks
+    include Octokit::Client::ActionsWorkflows
+    include Octokit::Client::ActionsWorkflowRuns
     include Octokit::Client::Apps
     include Octokit::Client::Issues
     include Octokit::Client::Labels
@@ -91,6 +104,7 @@ module Octokit
     include Octokit::Client::Marketplace
     include Octokit::Client::Milestones
     include Octokit::Client::Notifications
+    include Octokit::Client::OauthApplications
     include Octokit::Client::Objects
     include Octokit::Client::Organizations
     include Octokit::Client::Pages
@@ -119,7 +133,8 @@ module Octokit
     def initialize(options = {})
       # Use options passed in, but fall back to module defaults
       Octokit::Configurable.keys.each do |key|
-        instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
+        value = options.key?(key) ? options[key] : Octokit.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
       end
 
       login_from_netrc unless user_authenticated? || application_authenticated?
@@ -132,16 +147,12 @@ module Octokit
       inspected = super
 
       # mask password
-      inspected = inspected.gsub! @password, "*******" if @password
-      inspected = inspected.gsub! @management_console_password, "*******" if @management_console_password
-      inspected = inspected.gsub! @bearer_token, '********' if @bearer_token
+      inspected.gsub! @password, '*******' if @password
+      inspected.gsub! @management_console_password, '*******' if @management_console_password
+      inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
-      if @access_token
-        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
-      end
-      if @client_secret
-        inspected = inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}"
-      end
+      inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" if @access_token
+      inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" if @client_secret
 
       inspected
     end

data/lib/octokit/client/actions_secrets.rb

@@ -0,0 +1,58 @@
+module Octokit
+  class Client
+
+    # Methods for the Actions Secrets API
+    #
+    # @see https://developer.github.com/v3/actions/secrets/
+    module ActionsSecrets
+
+      # Get public key for secrets encryption
+      #
+      # @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)
+        get "#{Repository.path repo}/actions/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://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository
+      def list_secrets(repo)
+        paginate "#{Repository.path repo}/actions/secrets"
+      end
+
+      # Get a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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)
+        get "#{Repository.path repo}/actions/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://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository
+      def create_or_update_secret(repo, name, options)
+        put "#{Repository.path repo}/actions/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @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)
+        boolean_from_response :delete, "#{Repository.path repo}/actions/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/actions_workflow_runs.rb

@@ -0,0 +1,94 @@
+module Octokit
+  class Client
+    module ActionsWorkflowRuns
+      # List all runs for a repository workflow
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param workflow [Integer, String] Id or file name of the workflow
+      # @option options [String] :actor Optional filtering by a user
+      # @option options [String] :branch Optional filtering by a branch
+      # @option options [String] :event Optional filtering by the event type
+      # @option options [String] :status Optional filtering by a status or conclusion
+      #
+      # @return [Sawyer::Resource] the total count and an array of workflows
+      # @see https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs
+      def workflow_runs(repo, workflow, options = {})
+        paginate "#{Repository.path repo}/actions/workflows/#{workflow}/runs", options
+      end
+      alias list_workflow_runs workflow_runs
+
+      # List all workflow runs for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [String] :actor Optional filtering by the login of a user
+      # @option options [String] :branch Optional filtering by a branch
+      # @option options [String] :event Optional filtering by the event type (e.g. push, pull_request, issue)
+      # @option options [String] :status Optional filtering by a status or conclusion (e.g. success, completed...)
+      #
+      # @return [Sawyer::Resource] the total count and an array of workflows
+      # @see https://developer.github.com/v3/actions/workflow-runs/#list-repository-workflow-runs
+      def repository_workflow_runs(repo, options = {})
+        paginate "#{Repository.path repo}/actions/runs", options
+      end
+      alias list_repository_workflow_runs repository_workflow_runs
+
+      # Get a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Sawyer::Resource] Run information
+      # @see https://developer.github.com/v3/actions/workflow-runs/#get-a-workflow-run
+      def workflow_run(repo, id, options = {})
+        get "#{Repository.path repo}/actions/runs/#{id}", options
+      end
+
+      # Re-runs a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Boolean] Returns true if the re-run request was accepted
+      # @see https://developer.github.com/v3/actions/workflow-runs/#re-run-a-workflow
+      def rerun_workflow_run(repo, id, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/actions/runs/#{id}/rerun", options
+      end
+
+      # Cancels a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Boolean] Returns true if the cancellation was accepted
+      # @see https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run
+      def cancel_workflow_run(repo, id, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/actions/runs/#{id}/cancel", options
+      end
+
+      # Get a download url for archived log files of a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [String] URL to the archived log files of the run
+      # @see https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs
+      def workflow_run_logs(repo, id, options = {})
+        url = "#{Repository.path repo}/actions/runs/#{id}/logs"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+
+      # Delets all log files of a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of a workflow run
+      #
+      # @return [Boolean] Returns true if the logs are deleted
+      # @see https://developer.github.com/v3/actions/workflow-runs/#delete-workflow-run-logs
+      def delete_workflow_run_logs(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/actions/runs/#{id}/logs", options
+      end
+    end
+  end
+end

data/lib/octokit/client/actions_workflows.rb

@@ -0,0 +1,43 @@
+module Octokit
+  class Client
+    # Methods for the Actions Workflows API
+    #
+    # @see https://developer.github.com/v3/actions/workflows
+    module ActionsWorkflows
+
+      # Get the workflows in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Sawyer::Resource] the total count and an array of workflows
+      # @see https://developer.github.com/v3/actions/workflows/#list-repository-workflows
+      def workflows(repo, options = {})
+        paginate "#{Repository.path repo}/actions/workflows", options
+      end
+      alias list_workflows workflows
+
+      # Get single workflow in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      #
+      # @return [Sawyer::Resource] A single workflow
+      # @see https://developer.github.com/v3/actions/workflows/#get-a-workflow
+      def workflow(repo, id, options = {})
+        get "#{Repository.path repo}/actions/workflows/#{id}", options
+      end
+
+      # Create a workflow dispatch event
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Id or file name of the workflow
+      # @param ref [String] A SHA, branch name, or tag name
+      #
+      # @return [Boolean] True if event was dispatched, false otherwise
+      # @see https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event
+      def workflow_dispatch(repo, id, ref, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/actions/workflows/#{id}/dispatches", options.merge({ ref: ref })
+      end
+    end
+  end
+end