octokit 4.15.0 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acde45338bbfff0aac4a04d4e9867b5345f1b1123e58fdc80d0c69d01a1f0877
-  data.tar.gz: 65324c811d6edbfb510ef41a2ffbe54cc3197d64cfc018e1997858e8d59a5e20
+  metadata.gz: df9b83eea7a75984e7f2c153a5329d58d277d73ee07a900f59c1f6b37f251965
+  data.tar.gz: 6ae139d074857f6724487097e797c9fdf8e062f7950d48c56564fbd57127087e
 SHA512:
-  metadata.gz: dc30ba3288f921516c9aa78f27389c91840522aedb97e3a0c1fb21d672b69586d7096b12affc25a7cd859906da8fe6376a9b5244ca667a5977aad400ec65eff0
-  data.tar.gz: cdd80e10b58cfa64d2ed18d0376c762ce478b6efddb41e1581f529c3c1d265a0fb67c337398a7e9beee307045b6468732d7d11db2b5b54797734dac917e6029b
+  metadata.gz: 9cbc7cb5daa1424380e6c8b2580a296bfd31cb68ef1d89077938711c1adf90b6b79d7bbe1e759358b639214d86336b7162dca286cb022657d46a2da6afcddae5
+  data.tar.gz: 668ae004a851737a0e5116117311a2aec314f3742f1677b270f98c91de1025b5fe6614c7c052d56065917bf2e6e9e87b69db226ba1f84a66bc10305e508940b4

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

@@ -16,6 +16,7 @@ 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'
@@ -75,6 +76,7 @@ module Octokit
     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

data/lib/octokit/client/apps.rb

@@ -8,7 +8,7 @@ module Octokit
       #
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-installations
+      # @see https://developer.github.com/v3/apps/#list-installations
       #
       # @return [Array<Sawyer::Resource>] the total_count and an array of installations
       def find_app_installations(options = {})
@@ -31,7 +31,7 @@ module Octokit
       #
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#list-installations-for-user
+      # @see https://developer.github.com/v3/apps/installations/#list-installations-for-a-user
       #
       # @return [Sawyer::Resource] the total_count and an array of installations
       def find_user_installations(options = {})
@@ -45,7 +45,7 @@ module Octokit
       #
       # @param id [Integer] Installation id
       #
-      # @see https://developer.github.com/v3/apps/#get-a-single-installation
+      # @see https://developer.github.com/v3/apps/#get-an-installation
       #
       # @return [Sawyer::Resource] Installation information
       def installation(id, options = {})
@@ -58,7 +58,7 @@ module Octokit
       # @param installation [Integer] The id of a GitHub App Installation
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-installations
+      # @see https://developer.github.com/v3/apps/#create-a-new-installation-token
       #
       # @return [<Sawyer::Resource>] An installation token
       def create_app_installation_access_token(installation, options = {})
@@ -82,7 +82,7 @@ module Octokit
       # @param organization [String] Organization GitHub login
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-organization-installation
+      # @see https://developer.github.com/v3/apps/#get-an-organization-installation
       #
       # @return [Sawyer::Resource] Installation information
       def find_organization_installation(organization, options = {})
@@ -95,7 +95,7 @@ module Octokit
       # @param repo [String] A GitHub repository
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-repository-installation
+      # @see https://developer.github.com/v3/apps/#get-a-repository-installation
       #
       # @return [Sawyer::Resource] Installation information
       def find_repository_installation(repo, options = {})
@@ -108,7 +108,7 @@ module Octokit
       # @param user [String] GitHub user login
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/v3/apps/#find-user-installation
+      # @see https://developer.github.com/v3/apps/#get-a-user-installation
       #
       # @return [Sawyer::Resource] Installation information
       def find_user_installation(user, options = {})
@@ -119,6 +119,7 @@ module Octokit
       # List repositories that are accessible to the authenticated installation
       #
       # @param options [Hash] A customizable set of options
+      #
       # @see https://developer.github.com/v3/apps/installations/#list-repositories
       #
       # @return [Sawyer::Resource] the total_count and an array of repositories
@@ -195,7 +196,7 @@ module Octokit
       # @param installation [Integer] The id of a GitHub App Installation
       # @param options [Hash] A customizable set of options
       #
-      # @see https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps/
+      # @see https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation
       #
       # @return [Sawyer::Resource] the total_count and an array of repositories
       def find_installation_repositories_for_user(installation, options = {})

data/lib/octokit/client/commit_branches.rb

@@ -0,0 +1,20 @@
+module Octokit
+  class Client
+
+    # Methods for the Branches for HEAD API
+    #
+    # @see https://developer.github.com/v3/repos/commits/
+    module CommitBranches
+
+      # List branches for a single HEAD commit
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit whose branches will be fetched
+      # @return [Array]  List of branches
+      # @see https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit
+      def commit_branches(repo, sha, options = {})
+        paginate "#{Repository.path repo}/commits/#{sha}/branches-where-head", options
+      end
+    end
+  end
+end

data/lib/octokit/client/organizations.rb

@@ -333,7 +333,7 @@ module Octokit
       # @return [Sawyer::Resource] Hash representing team.
       # @see https://developer.github.com/v3/teams/#get-team-by-name
       # @example
-      #   @client.team("github", "justice-league")
+      #   @client.team_by_name("github", "justice-league")
       def team_by_name(org, team_slug, options = {})
         get "#{Organization.path(org)}/teams/#{team_slug}", options
       end

data/lib/octokit/client/refs.rb

@@ -60,11 +60,13 @@ module Octokit
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt>
       # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
-      # @param force [Boolean] A flag indicating one wants to force the update to make sure the update is a fast-forward update.
+      # @param force [Boolean] A flag indicating whether to force the update or to make sure the update is a fast-forward update.
       # @return [Array<Sawyer::Resource>] The list of references updated
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
       #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      # @example Fast-forward update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
+      #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd", false)
       def update_ref(repo, ref, sha, force = true, options = {})
         parameters = {
           :sha  => sha,
@@ -79,11 +81,13 @@ module Octokit
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param branch [String] The ref, e.g. <tt>feature/new-shiny</tt>
       # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
-      # @param force [Boolean] A flag indicating one wants to force the update to make sure the update is a fast-forward update.
+      # @param force [Boolean] A flag indicating whether to force the update or to make sure the update is a fast-forward update.
       # @return [Array<Sawyer::Resource>] The list of references updated
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
-      #   Octokit.update_branch("octocat/Hello-World","sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      #   Octokit.update_branch("octocat/Hello-World", "sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      # @example Fast-forward update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
+      #   Octokit.update_branch("octocat/Hello-World", "sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd", false)
       def update_branch(repo, branch, sha, force = true, options = {})
         update_ref repo, "heads/#{branch}", sha, force, options
       end

data/lib/octokit/connection.rb

@@ -113,7 +113,7 @@ module Octokit
         elsif bearer_authenticated?
           http.authorization 'Bearer', @bearer_token
         elsif application_authenticated?
-          http.params = http.params.merge application_authentication
+          http.basic_auth(@client_id, @client_secret)
         end
       end
     end

data/lib/octokit/preview.rb

@@ -8,6 +8,7 @@ module Octokit
       :checks                 => 'application/vnd.github.antiope-preview+json'.freeze,
       :commit_search          => 'application/vnd.github.cloak-preview+json'.freeze,
       :commit_pulls           => 'application/vnd.github.groot-preview+json'.freeze,
+      :commit_branches        => 'application/vnd.github.groot-preview+json'.freeze,
       :migrations             => 'application/vnd.github.wyandotte-preview+json'.freeze,
       :licenses               => 'application/vnd.github.drax-preview+json'.freeze,
       :source_imports         => 'application/vnd.github.barred-rock-preview'.freeze,

data/lib/octokit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/octokit/client/apps.rb
 - lib/octokit/client/authorizations.rb
 - lib/octokit/client/checks.rb
+- lib/octokit/client/commit_branches.rb
 - lib/octokit/client/commit_comments.rb
 - lib/octokit/client/commit_pulls.rb
 - lib/octokit/client/commits.rb