octokit 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f3b264edbac32970be83bf7b14081732f130d12
-  data.tar.gz: 15af8a2c6a80cfe94fdd14bb56a68dfbc772cb45
+  metadata.gz: 6b938b8240c566e33d75ff8a0d65c797f652e0ec
+  data.tar.gz: 9b9dc7920741ba14a93c6dd9be7cf26b750453bf
 SHA512:
-  metadata.gz: 7a77fc4d18fbc0dac671774e2486ba93aee5a434490db33579afa768a0386fbf12fcc251ff19fa514fa4f0bf564c643538b6b6a33360311bd05d789bfa6914e0
-  data.tar.gz: 134a0f49e4ade9f5b0ffc377b9394d4597c6fe69a871d27b2c90912024b4cd52ab1efc7de6019fcf3140fb756a2a9023f1fa742443227f63888113217ede8a16
+  metadata.gz: 0b72eef6e4954f798f45dfb49f990805b06411ac8f9cff2affe66738d6803f98d2e666d18248bb5742bbf1625aafd2cfd3989991642dc5af697569e19566df32
+  data.tar.gz: d026883962480255da7515279a57423b5c43e38b2743553727ec132e10dc1156d53688a6634f99d820cebc858d221b07f8cf8940a4eacc6017c3d45b04d968c4

data/lib/octokit/client.rb

@@ -222,6 +222,7 @@ module Octokit
       conn_opts[:url] = @api_endpoint
       conn_opts[:builder] = @middleware.dup if @middleware
       conn_opts[:proxy] = @proxy if @proxy
+      conn_opts[:ssl] = { :verify_mode => @ssl_verify_mode } if @ssl_verify_mode
       conn = Faraday.new(conn_opts) do |http|
         if basic_authenticated?
           http.basic_auth(@login, @password)

data/lib/octokit/client/apps.rb

@@ -10,7 +10,7 @@ module Octokit
       #
       # @see https://developer.github.com/v3/apps/#find-installations
       #
-      # @return [Array<Sawyer::Resource>] A list of installations
+      # @return [Array<Sawyer::Resource>] the total_count and an array of installations
       def find_app_installations(options = {})
         opts = ensure_api_media_type(:integrations, options)
         paginate "app/installations", opts
@@ -33,10 +33,12 @@ module Octokit
       #
       # @see https://developer.github.com/v3/apps/#list-installations-for-user
       #
-      # @return [Array<Sawyer::Resource>] A list of installations
+      # @return [Sawyer::Resource] the total_count and an array of installations
       def find_user_installations(options = {})
         opts = ensure_api_media_type(:integrations, options)
-        paginate "user/installations", opts
+        paginate("user/installations", opts) do |data, last_response|
+          data.installations.concat last_response.data.installations
+        end
       end
 
       # Get a single installation
@@ -80,10 +82,12 @@ module Octokit
       # @param options [Hash] A customizable set of options
       # @see https://developer.github.com/v3/apps/installations/#list-repositories
       #
-      # @return [Array<Sawyer::Resource>] A list of repositories
+      # @return [Sawyer::Resource] the total_count and an array of repositories
       def list_app_installation_repositories(options = {})
         opts = ensure_api_media_type(:integrations, options)
-        paginate "installation/repositories", opts
+        paginate("installation/repositories", opts) do |data, last_response|
+          data.repositories.concat last_response.data.repositories
+        end
       end
       alias list_installation_repos list_app_installation_repositories
 
@@ -154,10 +158,12 @@ module Octokit
       #
       # @see https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps/
       #
-      # @return [Array<Sawyer::Resource>] A list of repositories
+      # @return [Sawyer::Resource] the total_count and an array of repositories
       def find_installation_repositories_for_user(installation, options = {})
         opts = ensure_api_media_type(:integrations, options)
-        paginate "user/installations/#{installation}/repositories", opts
+        paginate("user/installations/#{installation}/repositories", opts) do |data, last_response|
+          data.repositories.concat last_response.data.repositories
+        end
       end
     end
   end

data/lib/octokit/client/authorizations.rb

@@ -61,7 +61,7 @@ module Octokit
       def create_authorization(options = {})
         # Techincally we can omit scopes as GitHub has a default, however the
         # API will reject us if we send a POST request with an empty body.
-
+        options = options.dup
         if options.delete :idempotent
           client_id, client_secret = fetch_client_id_and_secret(options)
           raise ArgumentError.new("Client ID and Secret required for idempotent authorizations") unless client_id && client_secret
@@ -122,6 +122,7 @@ module Octokit
       # @return [Array<String>] OAuth scopes
       # @see https://developer.github.com/v3/oauth/#scopes
       def scopes(token = @access_token, options = {})
+        options= options.dup
         raise ArgumentError.new("Access token required") if token.nil?
 
         auth = { "Authorization" => "token #{token}" }
@@ -226,6 +227,7 @@ module Octokit
       # @example
       #   @client.authorize_url('xxxx')
       def authorize_url(app_id = client_id, options = {})
+        opts = options.dup
         if app_id.to_s.empty?
           raise Octokit::ApplicationCredentialsRequired.new "client_id required"
         end

data/lib/octokit/client/contents.rb

@@ -30,6 +30,7 @@ module Octokit
       # @example List the contents of lib/octokit.rb
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
       def contents(repo, options={})
+        options = options.dup
         repo_path = options.delete :path
         url = "#{Repository.path repo}/contents/#{repo_path}"
         get url, options
@@ -54,6 +55,7 @@ module Octokit
       #                    "File content",
       #                    :branch => "my-new-feature")
       def create_contents(*args)
+        args    = args.map { |item| item && item.dup }
         options = args.last.is_a?(Hash) ? args.pop : {}
         repo    = args.shift
         path    = args.shift

data/lib/octokit/client/deployments.rb

@@ -6,6 +6,16 @@ module Octokit
     # @see https://developer.github.com/v3/repos/commits/deployments/
     module Deployments
 
+      # Fetch a single deployment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param deployment_id [Integer, String, Repository, Hash] A GitHub repository
+      # @return <Sawyer::Resource> A single deployment
+      # @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment
+      def deployment(repo, deployment_id, options = {})
+        get("#{Repository.path repo}/deployments/#{deployment_id}", options)
+      end
+
       # List all deployments for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository

data/lib/octokit/client/gists.rb

@@ -50,6 +50,7 @@ module Octokit
       # @see https://developer.github.com/v3/gists/#get-a-single-gist
       # @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
       def gist(gist, options = {})
+        options = options.dup
         if sha = options.delete(:sha)
           get "gists/#{Gist.new(gist)}/#{sha}", options
         else

data/lib/octokit/client/issues.rb

@@ -261,7 +261,7 @@ module Octokit
       # @return [Sawyer::Resource] The specific comment in question
       # @see https://developer.github.com/v3/issues/comments/#get-a-single-comment
       # @example Get comment #1194549 from an issue on octokit/octokit.rb
-      #   Octokit.issue_comments("octokit/octokit.rb", 1194549)
+      #   Octokit.issue_comment("octokit/octokit.rb", 1194549)
       def issue_comment(repo, number, options = {})
         paginate "#{Repository.path repo}/issues/comments/#{number}", options
       end
@@ -329,6 +329,23 @@ module Octokit
       def add_assignees(repo, number, assignees, options = {})
         post "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
       end
+
+      # Remove assignees from an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Issue number
+      # @param assignees [Array] Assignees to be removed
+      # @return [Sawyer::Resource] Issue
+      # @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue
+      # @example Remove assignees "pengwynn" and "joeyw" from Issue #23 on octokit/octokit.rb
+      #   Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"])
+      #
+      # @example Remove assignees "pengwynn" from Issue #23 on octokit/octokit.rb
+      #   Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn"],
+      #     :accept => "application/vnd.github.v3+json")
+      def remove_assignees(repo, number, assignees, options = {})
+        delete "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+      end
     end
   end
 end

data/lib/octokit/client/labels.rb

@@ -26,7 +26,7 @@ module Octokit
       # @return [Sawyer::Resource] A single label from the repository
       # @see https://developer.github.com/v3/issues/labels/#get-a-single-label
       # @example Get the "V3 Addition" label from octokit/octokit.rb
-      #   Octokit.labels("octokit/octokit.rb", "V3 Addition")
+      #   Octokit.label("octokit/octokit.rb", "V3 Addition")
       def label(repo, name, options = {})
         get "#{Repository.path repo}/labels/#{name}", options
       end

data/lib/octokit/client/organizations.rb

@@ -142,6 +142,7 @@ module Octokit
       # @example
       #   Octokit.org_members('github')
       def organization_members(org, options = {})
+        options = options.dup
         path = "public_" if options.delete(:public)
         paginate "#{Organization.path org}/#{path}members", options
       end
@@ -664,6 +665,7 @@ module Octokit
       # @see https://developer.github.com/v3/orgs/members/#get-your-organization-membership
       # @see https://developer.github.com/v3/orgs/members/#get-organization-membership
       def organization_membership(org, options = {})
+        options = options.dup
         if user = options.delete(:user)
           get "#{Organization.path(org)}/memberships/#{user}", options
         else
@@ -682,6 +684,7 @@ module Octokit
       # @see https://developer.github.com/v3/orgs/members/#edit-your-organization-membership
       # @see https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership
       def update_organization_membership(org, options = {})
+        options = options.dup
         if user = options.delete(:user)
           put "orgs/#{org}/memberships/#{user}", options
         else
@@ -696,9 +699,11 @@ module Octokit
       # @return [Boolean] Success
       # @see https://developer.github.com/v3/orgs/members/#remove-organization-membership
       def remove_organization_membership(org, options = {})
+        options = options.dup
         user = options.delete(:user)
         user && boolean_from_response(:delete, "orgs/#{org}/memberships/#{user}", options)
       end
+      alias :remove_org_membership :remove_organization_membership
 
       # Initiates the generation of a migration archive.
       #

data/lib/octokit/client/pull_requests.rb

@@ -151,8 +151,8 @@ module Octokit
       #
       # @example Get review comments, sort by updated asc since a time
       #   @client.pull_requests_comments("octokit/octokit.rb", {
-      #     :sort => 'asc',
-      #     :direction => 'down',
+      #     :sort => 'updated',
+      #     :direction => 'asc',
       #     :since => '2010-05-04T23:45:02Z'
       #   })
       def pull_requests_comments(repo, options = {})

data/lib/octokit/client/releases.rb

@@ -44,6 +44,7 @@ module Octokit
       # Update a release
       #
       # @param url [String] URL for the release as returned from .releases
+      # @option options [String] :tag_name Git tag from which to create release
       # @option options [String] :target_commitish Specifies the commitish value that determines where the Git tag is created from.
       # @option options [String] :name Name for the release
       # @option options [String] :body Content for release notes

data/lib/octokit/client/reviews.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Reviews API
     #
-    # @see https://developer.github.com/v3/reviews/
+    # @see https://developer.github.com/v3/pulls/reviews/
     module Reviews
 
       # List reviews on a pull request
@@ -123,7 +123,7 @@ module Octokit
       # @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review
       #
       # @example
-      #   @client.dismiss_pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #   @client.dismiss_pull_request_review('octokit/octokit.rb', 825, 6505518, 'The message.')
       #
       # @return [Sawyer::Resource] Hash representing the dismissed review
       def dismiss_pull_request_review(repo, number, review, message, options = {})

data/lib/octokit/client/search.rb

@@ -20,6 +20,21 @@ module Octokit
         search "search/code", query, options
       end
 
+      # Search commits
+      #
+      # @param query [String] Search terms and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-commits
+      def search_commits(query, options = {})
+        options = ensure_api_media_type(:commit_search, options)
+        search "search/commits", query, options
+      end
+
       # Search issues
       #
       # @param query [String] Search term and qualifiers

data/lib/octokit/client/stats.rb

@@ -88,6 +88,7 @@ module Octokit
       # @return [Array<Sawyer::Resource> or nil] Stats in metric-specific format, or nil if not yet calculated.
       # @see https://developer.github.com/v3/repos/statistics/
       def get_stats(repo, metric, options = {})
+        options = options.dup
         if retry_timeout = options.delete(:retry_timeout)
           retry_wait = options.delete(:retry_wait) || 0.5
           timeout = Time.now + retry_timeout

data/lib/octokit/configurable.rb

@@ -45,6 +45,9 @@ module Octokit
     # @!attribute proxy
     #   @see https://github.com/lostisland/faraday
     #   @return [String] URI for proxy server
+    # @!attribute ssl_verify_mode
+    #   @see https://github.com/lostisland/faraday
+    #   @return [String] SSL verify mode for ssl connections
     # @!attribute user_agent
     #   @return [String] Configure User-Agent header for requests.
     # @!attribute web_endpoint
@@ -53,7 +56,7 @@ module Octokit
     attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id,
                   :client_secret, :default_media_type, :connection_options,
                   :middleware, :netrc, :netrc_file,
-                  :per_page, :proxy, :user_agent
+                  :per_page, :proxy, :ssl_verify_mode, :user_agent
     attr_writer :password, :web_endpoint, :api_endpoint, :login,
                 :management_console_endpoint, :management_console_password
 
@@ -80,6 +83,7 @@ module Octokit
           :per_page,
           :password,
           :proxy,
+          :ssl_verify_mode,
           :user_agent,
           :web_endpoint
         ]

data/lib/octokit/connection.rb

@@ -153,7 +153,7 @@ module Octokit
         end
       end
 
-      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
       response.data
     end
 
@@ -175,6 +175,7 @@ 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
       opts[:faraday] = Faraday.new(conn_opts)
 
       opts

data/lib/octokit/default.rb

@@ -137,6 +137,15 @@ module Octokit
         ENV['OCTOKIT_PROXY']
       end
 
+      # Default SSL verify mode from ENV
+      # @return [Integer]
+      def ssl_verify_mode
+        # 0 is OpenSSL::SSL::VERIFY_NONE
+        # 1 is OpenSSL::SSL::SSL_VERIFY_PEER
+        # the standard default for SSL is SSL_VERIFY_PEER which requires a server certificate check on the client
+        ENV['OCTOKIT_SSL_VERIFY_MODE'] || 1 
+      end
+
       # Default User-Agent header string from ENV or {USER_AGENT}
       # @return [String]
       def user_agent

data/lib/octokit/preview.rb

@@ -5,6 +5,7 @@ module Octokit
 
     PREVIEW_TYPES = {
       :branch_protection      => 'application/vnd.github.loki-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,
       :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 = 8
+  MINOR = 9
 
   # Current patch level.
   # @return [Integer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API