octokit 4.13.0 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62cc9f95627d52ebe1950974e93a4ddf3a24709dd23d24f7124ef9f4befc7a94
-  data.tar.gz: b0390bb087b9cfda51e942ee3958c9ea600750697e4f6b825aa0dd40947574b1
+  metadata.gz: da3e4a3c93344024b60cb7d3c5e13bc90742576c6e43dc3e438f3e16819cdc9f
+  data.tar.gz: 9a47ad957027e32a4f74ca93250476ae46627d961b6bd349cf62a632da04477f
 SHA512:
-  metadata.gz: efd51d1fb7f93e55da8d616c90ec6840688873f9070f63816a3782d3900587e41b3f4f50e49450bc2b721d088042038dec16d66dbc93b3356191404919932ca4
-  data.tar.gz: faa042b6c7afa1aa67eed9b0904e8319a178f0c79d4bc4be8467ce2fa5604a2c413d93ede232d739083085cdd94fcfa5d6b22854583b5807f0ed0978fc221d48
+  metadata.gz: 22921fbc5478cbdcbe17f033b7a63666dc69ff63b1b2fda1f47f37eb2967cd055539c1935a5a767d46e24ed427c2d64457c6057141f77caa3bfdf2ebcd6bd179
+  data.tar.gz: 1bc0add3fdff8b42dc752c3886f95ba51e8ffd234ff3f0091b7dc7a22dbfd8286b0df2d043646a859cdc0bb2837663b6259339c82a0602296dc9cb305b68ab4a

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)
@@ -427,6 +428,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,
@@ -693,6 +715,7 @@ implementations:
 * Ruby 2.3
 * Ruby 2.4
 * Ruby 2.5
+* Ruby 2.6
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 

data/lib/octokit/client.rb

@@ -12,6 +12,7 @@ require 'octokit/organization'
 require 'octokit/preview'
 require 'octokit/client/apps'
 require 'octokit/client/authorizations'
+require 'octokit/client/checks'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
 require 'octokit/client/community_profile'
@@ -69,6 +70,7 @@ module Octokit
     include Octokit::Preview
     include Octokit::Warnable
     include Octokit::Client::Authorizations
+    include Octokit::Client::Checks
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
     include Octokit::Client::CommunityProfile
@@ -119,7 +121,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 +135,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/checks.rb

@@ -0,0 +1,211 @@
+module Octokit
+  class Client
+
+    # Methods for the Checks API
+    #
+    # @see https://developer.github.com/v3/checks/
+    module Checks
+
+      # Methods for Check Runs
+      #
+      # @see https://developer.github.com/v3/checks/runs/
+
+      # Create a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] The name of the check
+      # @param head_sha [String] The SHA of the commit to check
+      # @return [Sawyer::Resource] A hash representing the new check run
+      # @see https://developer.github.com/v3/checks/runs/#create-a-check-run
+      # @example Create a check run
+      #   check_run = @client.create_check_run("octocat/Hello-World", "my-check", "7638417db6d59f3c431d3e1f261cc637155684cd")
+      #   check_run.name # => "my-check"
+      #   check_run.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   check_run.status # => "queued"
+      def create_check_run(repo, name, head_sha, options = {})
+        ensure_api_media_type(:checks, options)
+        options[:name] = name
+        options[:head_sha] = head_sha
+
+        post "#{Repository.path repo}/check-runs", options
+      end
+
+      # Update a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Sawyer::Resource] A hash representing the updated check run
+      # @see https://developer.github.com/v3/checks/runs/#update-a-check-run
+      # @example Update a check run
+      #   check_run = @client.update_check_run("octocat/Hello-World", 51295429, status: "in_progress")
+      #   check_run.id # => 51295429
+      #   check_run.status # => "in_progress"
+      def update_check_run(repo, id, options = {})
+        ensure_api_media_type(:checks, options)
+
+        patch "#{Repository.path repo}/check-runs/#{id}", options
+      end
+
+      # List check runs for a specific ref
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param ref [String] A SHA, branch name, or tag name
+      # @param options [Hash] A set of optional filters
+      # @option options [String] :check_name Returns check runs with the specified <tt>name</tt>
+      # @option options [String] :status Returns check runs with the specified <tt>status</tt>
+      # @option options [String] :filter Filters check runs by their <tt>completed_at</tt> timestamp
+      # @return [Sawyer::Resource] A hash representing a collection of check runs
+      # @see https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref
+      # @example List check runs for a specific ref
+      #   result = @client.check_runs_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", status: "in_progress")
+      #   result.total_count # => 1
+      #   result.check_runs.count # => 1
+      #   result.check_runs[0].id # => 51295429
+      #   result.check_runs[0].status # => "in_progress"
+      def check_runs_for_ref(repo, ref, options = {})
+        ensure_api_media_type(:checks, options)
+
+        get "#{Repository.path repo}/commits/#{ref}/check-runs", options
+      end
+      alias :list_check_runs_for_ref :check_runs_for_ref
+
+      # List check runs in a check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @param options [Hash] A set of optional filters
+      # @option options [String] :check_name Returns check runs with the specified <tt>name</tt>
+      # @option options [String] :status Returns check runs with the specified <tt>status</tt>
+      # @option options [String] :filter Filters check runs by their <tt>completed_at</tt> timestamp
+      # @return [Sawyer::Resource] A hash representing a collection of check runs
+      # @see https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite
+      # @example List check runs in a check suite
+      #   result = @client.check_runs_for_check_suite("octocat/Hello-World", 50440400, status: "in_progress")
+      #   result.total_count # => 1
+      #   result.check_runs.count # => 1
+      #   result.check_runs[0].check_suite.id # => 50440400
+      #   result.check_runs[0].status # => "in_progress"
+      def check_runs_for_check_suite(repo, id, options = {})
+        ensure_api_media_type(:checks, options)
+
+        get "#{Repository.path repo}/check-suites/#{id}/check-runs", options
+      end
+      alias :list_check_runs_for_check_suite :check_runs_for_check_suite
+
+      # Get a single check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Sawyer::Resource] A hash representing the check run
+      # @see https://developer.github.com/v3/checks/runs/#get-a-single-check-run
+      def check_run(repo, id, options = {})
+        ensure_api_media_type(:checks, options)
+
+        get "#{Repository.path repo}/check-runs/#{id}", options
+      end
+
+      # List annotations for a check run
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check run
+      # @return [Array<Sawyer::Resource>] An array of hashes representing check run annotations
+      # @see https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run
+      # @example List annotations for a check run
+      #   annotations = @client.check_run_annotations("octocat/Hello-World", 51295429)
+      #   annotations.count # => 1
+      #   annotations[0].path # => "README.md"
+      #   annotations[0].message # => "Looks good!"
+      def check_run_annotations(repo, id, options = {})
+        ensure_api_media_type(:checks, options)
+
+        get "#{Repository.path repo}/check-runs/#{id}/annotations", options
+      end
+
+      # Methods for Check Suites
+      #
+      # @see https://developer.github.com/v3/checks/suites/
+
+      # Get a single check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @return [Sawyer::Resource] A hash representing the check suite
+      # @see https://developer.github.com/v3/checks/suites/#get-a-single-check-suite
+      def check_suite(repo, id, options = {})
+        ensure_api_media_type(:checks, options)
+
+        get "#{Repository.path repo}/check-suites/#{id}", options
+      end
+
+      # List check suites for a specific ref
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param ref [String] A SHA, branch name, or tag name
+      # @param options [Hash] A set of optional filters
+      # @option options [Integer] :app_id Filters check suites by GitHub App <tt>id</tt>
+      # @option options [String] :check_name Filters checks suites by the <tt>name</tt> of the check run
+      # @return [Sawyer::Resource] A hash representing a collection of check suites
+      # @see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref
+      # @example List check suites for a specific ref
+      #   result = @client.check_suites_for_ref("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd", app_id: 76765)
+      #   result.total_count # => 1
+      #   result.check_suites.count # => 1
+      #   result.check_suites[0].id # => 50440400
+      #   result.check_suites[0].app.id # => 76765
+      def check_suites_for_ref(repo, ref, options = {})
+        ensure_api_media_type(:checks, options)
+
+        get "#{Repository.path repo}/commits/#{ref}/check-suites", options
+      end
+      alias :list_check_suites_for_ref :check_suites_for_ref
+
+      # Set preferences for check suites on a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Preferences to set
+      # @return [Sawyer::Resource] A hash representing the repository's check suite preferences
+      # @see https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository
+      # @example Set preferences for check suites on a repository
+      #   result = @client.set_check_suite_preferences("octocat/Hello-World", auto_trigger_checks: [{ app_id: 76765, setting: false }])
+      #   result.preferences.auto_trigger_checks.count # => 1
+      #   result.preferences.auto_trigger_checks[0].app_id # => 76765
+      #   result.preferences.auto_trigger_checks[0].setting # => false
+      #   result.repository.full_name # => "octocat/Hello-World"
+      def set_check_suite_preferences(repo, options = {})
+        ensure_api_media_type(:checks, options)
+
+        patch "#{Repository.path repo}/check-suites/preferences", options
+      end
+
+      # Create a check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param head_sha [String] The SHA of the commit to check
+      # @return [Sawyer::Resource] A hash representing the new check suite
+      # @see https://developer.github.com/v3/checks/suites/#create-a-check-suite
+      # @example Create a check suite
+      #   check_suite = @client.create_check_suite("octocat/Hello-World", "7638417db6d59f3c431d3e1f261cc637155684cd")
+      #   check_suite.head_sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   check_suite.status # => "queued"
+      def create_check_suite(repo, head_sha, options = {})
+        ensure_api_media_type(:checks, options)
+        options[:head_sha] = head_sha
+
+        post "#{Repository.path repo}/check-suites", options
+      end
+
+      # Rerequest check suite
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The ID of the check suite
+      # @return [Boolean] True if successful, raises an error otherwise
+      # @see https://developer.github.com/v3/checks/suites/#rerequest-check-suite
+      def rerequest_check_suite(repo, id, options = {})
+        ensure_api_media_type(:checks, options)
+
+        post "#{Repository.path repo}/check-suites/#{id}/rerequest", options
+        true
+      end
+    end
+  end
+end

data/lib/octokit/client/projects.rb

@@ -51,7 +51,7 @@ module Octokit
       #   @client.org_projects("octokit")
       def org_projects(org, options = {})
         opts = ensure_api_media_type(:projects, options)
-        get "orgs/#{org}/projects", opts
+        paginate "orgs/#{org}/projects", opts
       end
       alias :organization_projects :org_projects
 

data/lib/octokit/client/repositories.rb

@@ -10,7 +10,7 @@ module Octokit
       #
       # @see https://developer.github.com/v3/repos/#get
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
-      # @return [Sawyer::Resource] if a repository exists, false otherwise
+      # @return [Boolean]
       def repository?(repo, options = {})
         !!repository(repo, options)
       rescue Octokit::InvalidRepository
@@ -293,7 +293,7 @@ module Octokit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @option options [String] :affiliation Filters the return array by affiliation.
-      #   Can be one of: <tt>outside</tt> or <tt>all</tt>.
+      #   Can be one of: <tt>outside</tt>, <tt>direct</tt>, or <tt>all</tt>.
       #   If not specified, defaults to <tt>all</tt>
       # @return [Array<Sawyer::Resource>] Array of hashes representing collaborating users.
       # @see https://developer.github.com/v3/repos/collaborators/#list-collaborators

data/lib/octokit/connection.rb

@@ -175,7 +175,15 @@ module Octokit
       conn_opts = @connection_options
       conn_opts[:builder] = @middleware if @middleware
       conn_opts[:proxy] = @proxy if @proxy
-      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      if conn_opts[:ssl].nil?
+        conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
+      else 
+        if @connection_options[:ssl][:verify] == false
+          conn_opts[:ssl] = { :verify_mode => 0}
+        else
+          conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode }
+        end
+      end
       opts[:faraday] = Faraday.new(conn_opts)
 
       opts

data/lib/octokit/preview.rb

@@ -5,6 +5,7 @@ module Octokit
 
     PREVIEW_TYPES = {
       :branch_protection      => 'application/vnd.github.loki-preview+json'.freeze,
+      :checks                 => 'application/vnd.github.antiope-preview+json'.freeze,
       :commit_search          => 'application/vnd.github.cloak-preview+json'.freeze,
       :migrations             => 'application/vnd.github.wyandotte-preview+json'.freeze,
       :licenses               => 'application/vnd.github.drax-preview+json'.freeze,

data/lib/octokit/repository.rb

@@ -88,7 +88,7 @@ module Octokit
 
       def raise_invalid_repository!(repo)
         msg = "#{repo.inspect} is invalid as a repository identifier. " +
-              "Use the repo/user (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys."
+              "Use the user/repo (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys."
         raise Octokit::InvalidRepository, msg
       end
   end

data/lib/octokit/version.rb

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

data/octokit.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'octokit/version'
 
 Gem::Specification.new do |spec|
-  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'bundler', '>= 1', '< 3'
   spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.8.0'
   spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
   spec.description = %q{Simple wrapper for the GitHub API}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 4.14.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,22 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2019-03-29 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: '1.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +73,7 @@ files:
 - lib/octokit/client.rb
 - lib/octokit/client/apps.rb
 - lib/octokit/client/authorizations.rb
+- lib/octokit/client/checks.rb
 - lib/octokit/client/commit_comments.rb
 - lib/octokit/client/commits.rb
 - lib/octokit/client/community_profile.rb
@@ -153,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API