octokit 3.8.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2dedaa6599d61d3a75894f9d9650fc19f795510
-  data.tar.gz: cb4a2597cfa0df06f1f82c002e81e1dec0fee990
+  metadata.gz: 4db1a3149648f98eb7e918999ef0ed6eaf62ce7a
+  data.tar.gz: 780d60412f1b2d069b6fbceb99c9b7a6f2b52e16
 SHA512:
-  metadata.gz: 6b7d47dd30eff757599a6ce3080c60f7fdbdb99089cc9c9cee724f8e7cd5255b10a714698725a3f00ed59aee32e620e6ae9e6ac86f8c88590bccb463dcd72fb7
-  data.tar.gz: 826384c7909a6dcfd31f8590a9a6eeadbdda2a9b4b281f0bcb06d601e2d9ba74b0533d1cd946820650c09be07639236e1dde5b1549043ee6c430061a3ce5ac0f
+  metadata.gz: 3ebe426f79dd955dce9a8aa7595f0707ded3ae62170e03512f5dd28b6f11a37aeee4132cc74abb4b4f5dc11fddb16c2c2c7afeca330dcc0faa78a956eb75f46a
+  data.tar.gz: 91787763f68ec589cdbb07afa258943ad3c79fb96d0a128d348bb58a654c9bd3a600d8a8d9b4f065eafea3fc71ffc583fc4c38554d0dc106ad83a518a2c0b333

data/README.md

@@ -257,6 +257,64 @@ custom pattern for traversing large lists.
 
 [paginated]: http://developer.github.com/v3/#pagination
 
+## Working with GitHub Enterprise
+
+With a bit of setup, you can also use Octokit with your Github Enterprise instance.
+
+### Interacting with the GitHub.com APIs in GitHub Enterprise
+
+To interact with the "regular" GitHub.com APIs in GitHub Enterprise, simply configure the `api_endpoint` to match your hostname. For example:
+
+``` ruby
+Octokit.configure do |c|
+  c.api_endpoint = "<hostname>/api/v3/"
+end
+client = Octokit::Client.new(:access_token => "<your 40 char token>")
+```
+
+### Interacting with the GitHub Enterprise Admin APIs
+
+The GitHub Enterprise Admin APIs are under a different client: `EnterpriseAdminClient`. You'll need to have an administrator account in order to use these APIs.
+
+``` ruby
+admin_client = Octokit::EnterpriseAdminClient.new \
+                          :access_token => "<your 40 char token>",
+                          :api_endpoint = "https://<hostname>/api/v3/"
+
+# or
+Octokit.configure do |c|
+  c.api_endpoint = "https://hostname/api/v3/"
+  c.access_token = "<your 40 char token>"
+end
+admin_client = Octokit.enterprise_admin_client
+```
+
+### Interacting with the GitHub Enterprise Management Console APIs
+
+The GitHub Enterprise Management Console APIs are also under a separate client: `EnterpriseManagementConsoleClient`. In order to use it, you'll need to provide both your management console password as well as the endpoint to your management console. This is different than the API endpoint provided above.
+
+``` ruby
+management_console_client = Octokit::EnterpriseManagementConsoleClient.new \
+                          :management_console_password => "secret",
+                          :management_console_endpoint = "https://hostname:8633"
+# or
+Octokit.configure do |c|
+  c.management_console_endpoint = "https://hostname:8633"
+  c.management_console_password = "secret"
+end
+management_console_client = Octokit.enterprise_management_console_client
+```
+
+### SSL Connection Errors
+
+You *may* need to disable SSL temporarily while first setting up your GitHub Enterprise install. You can do that with the following configuration:
+
+``` ruby
+client.connection_options[:ssl] = { :verify => false }
+```
+
+Do remember to turn `:verify` back to `true`, as it's important for secure communication.
+
 ## Configuration and defaults
 
 While `Octokit::Client` accepts a range of options when creating a new client
@@ -362,6 +420,18 @@ construction currently used throughout the client.
 
 ## Upgrading guide
 
+Version 4.0
+
+- **removes support for a [long-deprecated overload][list-pulls] for
+passing state as a positional argument** when listing pull requests. Instead,
+pass `state` in the method options.
+- **drops support for Ruby < 2.0**.
+- adds support for new [Enterprise-only APIs](#working-with-github-enterprise).
+- adds support for [Repository redirects][redirects].
+
+[list-pulls]: https://github.com/octokit/octokit.rb/commit/e48e91f736d5fce51e3bf74d7c9022aaa52f5c5c 
+[redirects]: https://developer.github.com/changes/2015-05-26-repository-redirects-are-coming/
+
 Version 3.0 includes a couple breaking changes when upgrading from v2.x.x:
 
 The [default media type][default-media-type] is now `v3` instead of `beta`. If
@@ -510,6 +580,11 @@ ENV Variable | Description |
 `OCTOKIT_TEST_GITHUB_CLIENT_SECRET` | Test OAuth application client secret.
 `OCTOKIT_TEST_GITHUB_REPOSITORY` | Test repository to perform destructive actions against, this should not be set to any repository of importance. **Automatically created by the test suite if nonexistent** Default: `api-sandbox`
 `OCTOKIT_TEST_GITHUB_ORGANIZATION` | Test organization.
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_LOGIN` | GitHub Enterprise login name
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_TOKEN` | GitHub Enterprise token
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT` | GitHub Enterprise hostname
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint
 
 Since we periodically refresh our cassettes, please keep some points in mind
 when writing new specs.
@@ -532,10 +607,9 @@ when writing new specs.
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
-* Ruby 1.9.2
-* Ruby 1.9.3
-* Ruby 2.0.0
-* Ruby 2.1.0
+* Ruby 2.0
+* Ruby 2.1
+* Ruby 2.2
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 
@@ -590,4 +664,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/lib/octokit.rb

@@ -1,4 +1,6 @@
 require 'octokit/client'
+require 'octokit/enterprise_admin_client'
+require 'octokit/enterprise_management_console_client'
 require 'octokit/default'
 
 # Ruby toolkit for the GitHub API
@@ -11,20 +13,44 @@ module Octokit
     #
     # @return [Octokit::Client] API wrapper
     def client
-      @client = Octokit::Client.new(options) unless defined?(@client) && @client.same_options?(options)
-      @client
+      return @client if defined?(@client) && @client.same_options?(options)
+      @client = Octokit::Client.new(options)
     end
 
-    # @private
-    def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
-    # @private
-    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+    # EnterpriseAdminClient client based on configured options {Configurable}
+    #
+    # @return [Octokit::EnterpriseAdminClient] API wrapper
+    def enterprise_admin_client
+      return @enterprise_admin_client if defined?(@enterprise_admin_client) && @enterprise_admin_client.same_options?(options)
+      @enterprise_admin_client = Octokit::EnterpriseAdminClient.new(options)
+    end
 
-  private
+    # EnterpriseManagementConsoleClient client based on configured options {Configurable}
+    #
+    # @return [Octokit::EnterpriseManagementConsoleClient] API wrapper
+    def enterprise_management_console_client
+      return @enterprise_management_console_client if defined?(@enterprise_management_console_client) && @enterprise_management_console_client.same_options?(options)
+      @enterprise_management_console_client = Octokit::EnterpriseManagementConsoleClient.new(options)
+    end
+
+    private
+
+    def respond_to_missing?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private) ||
+      enterprise_admin_client.respond_to?(method_name, include_private) ||
+      enterprise_management_console_client.respond_to?(method_name, include_private)
+    end
 
     def method_missing(method_name, *args, &block)
-      return super unless client.respond_to?(method_name)
-      client.send(method_name, *args, &block)
+      if client.respond_to?(method_name)
+        return client.send(method_name, *args, &block)
+      elsif enterprise_admin_client.respond_to?(method_name)
+        return enterprise_admin_client.send(method_name, *args, &block)
+      elsif enterprise_management_console_client.respond_to?(method_name)
+        return enterprise_management_console_client.send(method_name, *args, &block)
+      end
+
+      super
     end
 
   end

data/lib/octokit/client.rb

@@ -1,4 +1,5 @@
-require 'sawyer'
+require 'octokit/connection'
+require 'octokit/warnable'
 require 'octokit/arguments'
 require 'octokit/repo_arguments'
 require 'octokit/configurable'
@@ -23,6 +24,7 @@ require 'octokit/client/hooks'
 require 'octokit/client/issues'
 require 'octokit/client/labels'
 require 'octokit/client/legacy_search'
+require 'octokit/client/licenses'
 require 'octokit/client/meta'
 require 'octokit/client/markdown'
 require 'octokit/client/milestones'
@@ -52,6 +54,8 @@ module Octokit
 
     include Octokit::Authentication
     include Octokit::Configurable
+    include Octokit::Connection
+    include Octokit::Warnable
     include Octokit::Client::Authorizations
     include Octokit::Client::Commits
     include Octokit::Client::CommitComments
@@ -67,6 +71,7 @@ module Octokit
     include Octokit::Client::Issues
     include Octokit::Client::Labels
     include Octokit::Client::LegacySearch
+    include Octokit::Client::Licenses
     include Octokit::Client::Meta
     include Octokit::Client::Markdown
     include Octokit::Client::Milestones
@@ -99,14 +104,6 @@ module Octokit
       login_from_netrc unless user_authenticated? || application_authenticated?
     end
 
-    # Compares client options to a Hash of requested options
-    #
-    # @param opts [Hash] Options to compare with current client options
-    # @return [Boolean]
-    def same_options?(opts)
-      opts.hash == options.hash
-    end
-
     # Text representation of the client, masking tokens and passwords
     #
     # @return [String]
@@ -115,6 +112,7 @@ module Octokit
 
       # mask password
       inspected = inspected.gsub! @password, "*******" if @password
+      inspected = inspected.gsub! @management_console_password, "*******" if @management_console_password
       # Only show last 4 of token, secret
       if @access_token
         inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
@@ -126,126 +124,6 @@ module Octokit
       inspected
     end
 
-    # Make a HTTP GET request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Query and header params for request
-    # @return [Sawyer::Resource]
-    def get(url, options = {})
-      request :get, url, parse_query_and_convenience_headers(options)
-    end
-
-    # Make a HTTP POST request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Body and header params for request
-    # @return [Sawyer::Resource]
-    def post(url, options = {})
-      request :post, url, options
-    end
-
-    # Make a HTTP PUT request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Body and header params for request
-    # @return [Sawyer::Resource]
-    def put(url, options = {})
-      request :put, url, options
-    end
-
-    # Make a HTTP PATCH request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Body and header params for request
-    # @return [Sawyer::Resource]
-    def patch(url, options = {})
-      request :patch, url, options
-    end
-
-    # Make a HTTP DELETE request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Query and header params for request
-    # @return [Sawyer::Resource]
-    def delete(url, options = {})
-      request :delete, url, options
-    end
-
-    # Make a HTTP HEAD request
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Query and header params for request
-    # @return [Sawyer::Resource]
-    def head(url, options = {})
-      request :head, url, parse_query_and_convenience_headers(options)
-    end
-
-    # Make one or more HTTP GET requests, optionally fetching
-    # the next page of results from URL in Link response header based
-    # on value in {#auto_paginate}.
-    #
-    # @param url [String] The path, relative to {#api_endpoint}
-    # @param options [Hash] Query and header params for request
-    # @param block [Block] Block to perform the data concatination of the
-    #   multiple requests. The block is called with two parameters, the first
-    #   contains the contents of the requests so far and the second parameter
-    #   contains the latest response.
-    # @return [Sawyer::Resource]
-    def paginate(url, options = {}, &block)
-      opts = parse_query_and_convenience_headers(options.dup)
-      if @auto_paginate || @per_page
-        opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
-      end
-
-      data = request(:get, url, opts)
-
-      if @auto_paginate
-        while @last_response.rels[:next] && rate_limit.remaining > 0
-          @last_response = @last_response.rels[:next].get
-          if block_given?
-            yield(data, @last_response)
-          else
-            data.concat(@last_response.data) if @last_response.data.is_a?(Array)
-          end
-        end
-
-      end
-
-      data
-    end
-
-    # Hypermedia agent for the GitHub API
-    #
-    # @return [Sawyer::Agent]
-    def agent
-      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
-        http.headers[:accept] = default_media_type
-        http.headers[:content_type] = "application/json"
-        http.headers[:user_agent] = user_agent
-        if basic_authenticated?
-          http.basic_auth(@login, @password)
-        elsif token_authenticated?
-          http.authorization 'token', @access_token
-        elsif application_authenticated?
-          http.params = http.params.merge application_authentication
-        end
-      end
-    end
-
-    # Fetch the root resource for the API
-    #
-    # @return [Sawyer::Resource]
-    def root
-      get "/"
-    end
-
-    # Response for last HTTP request
-    #
-    # @return [Sawyer::Response]
-    def last_response
-      @last_response if defined? @last_response
-    end
-
     # Duplicate client using client_id and client_secret as
     # Basic Authentication credentials.
     # @example
@@ -310,72 +188,5 @@ module Octokit
       reset_agent
       @client_secret = value
     end
-
-    # Wrapper around Kernel#warn to print warnings unless
-    # OCTOKIT_SILENT is set to true.
-    #
-    # @return [nil]
-    def octokit_warn(*message)
-      unless ENV['OCTOKIT_SILENT']
-        warn message
-      end
-    end
-
-    private
-
-    def reset_agent
-      @agent = nil
-    end
-
-    def request(method, path, data, options = {})
-      if data.is_a?(Hash)
-        options[:query]   = data.delete(:query) || {}
-        options[:headers] = data.delete(:headers) || {}
-        if accept = data.delete(:accept)
-          options[:headers][:accept] = accept
-        end
-      end
-
-      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
-      response.data
-    end
-
-    # Executes the request, checking if it was successful
-    #
-    # @return [Boolean] True on success, false otherwise
-    def boolean_from_response(method, path, options = {})
-      request(method, path, options)
-      @last_response.status == 204
-    rescue Octokit::NotFound
-      false
-    end
-
-
-    def sawyer_options
-      opts = {
-        :links_parser => Sawyer::LinkParsers::Simple.new
-      }
-      conn_opts = @connection_options
-      conn_opts[:builder] = @middleware if @middleware
-      conn_opts[:proxy] = @proxy if @proxy
-      opts[:faraday] = Faraday.new(conn_opts)
-
-      opts
-    end
-
-    def parse_query_and_convenience_headers(options)
-      headers = options.fetch(:headers, {})
-      CONVENIENCE_HEADERS.each do |h|
-        if header = options.delete(h)
-          headers[h] = header
-        end
-      end
-      query = options.delete(:query)
-      opts = {:query => options}
-      opts[:query].merge!(query) if query && query.is_a?(Hash)
-      opts[:headers] = headers unless headers.empty?
-
-      opts
-    end
   end
 end

data/lib/octokit/client/commit_comments.rb

@@ -12,7 +12,7 @@ module Octokit
       # @return [Array] List of commit comments
       # @see https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
       def list_commit_comments(repo, options = {})
-        get "#{Repository.path repo}/comments", options
+        paginate "#{Repository.path repo}/comments", options
       end
 
       # List comments for a single commit
@@ -22,7 +22,7 @@ module Octokit
       # @return [Array]  List of commit comments
       # @see https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
       def commit_comments(repo, sha, options = {})
-        get "#{Repository.path repo}/commits/#{sha}/comments", options
+        paginate "#{Repository.path repo}/commits/#{sha}/comments", options
       end
 
       # Get a single commit comment