octokit 3.8.0 → 4.0.0

data/lib/octokit/client/contents.rb

@@ -153,9 +153,22 @@ module Octokit
         repo_ref = options.delete :ref
         format = (options.delete :format) || 'tarball'
         url = "#{Repository.path repo}/#{format}/#{repo_ref}"
-        request :head, url, options
 
-        last_response.headers['Location']
+        conn_opts = @connection_options
+        conn_opts[:url] = @api_endpoint
+        conn_opts[:builder] = @middleware.dup if @middleware
+        conn_opts[:proxy] = @proxy if @proxy
+        conn = Faraday.new(conn_opts) do |http|
+          if basic_authenticated?
+            http.basic_auth(@login, @password)
+          elsif token_authenticated?
+            http.authorization 'token', @access_token
+          end
+        end
+        conn.builder.delete(Octokit::Middleware::FollowRedirects)
+        response = conn.head(url, options)
+
+        response.headers['Location']
       end
     end
   end

data/lib/octokit/client/hooks.rb

@@ -4,8 +4,6 @@ module Octokit
     # Methods for the Hooks API
     module Hooks
 
-      ORG_HOOKS_PREVIEW_MEDIA_TYPE = "application/vnd.github.sersi-preview+json".freeze
-
       # List all Service Hooks supported by GitHub
       #
       # @return [Sawyer::Resource] A list of all hooks on GitHub
@@ -118,7 +116,7 @@ module Octokit
       #     }
       #   )
       def edit_hook(repo, id, name, config, options = {})
-        options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
+        options = {:name => name, :config => config}.merge(options)
         patch "#{Repository.path repo}/hooks/#{id}", options
       end
 
@@ -160,7 +158,6 @@ module Octokit
       # @example
       #   @client.org_hooks('octokit')
       def org_hooks(org, options = {})
-        options = ensure_org_hooks_api_media_type(options)
         paginate "orgs/#{org}/hooks", options
       end
       alias :list_org_hooks :org_hooks
@@ -176,7 +173,6 @@ module Octokit
       # @example
       #   @client.org_hook('octokit', 123)
       def org_hook(org, id, options = {})
-        options = ensure_org_hooks_api_media_type(options)
         get "orgs/#{org}/hooks/#{id}", options
       end
 
@@ -207,7 +203,6 @@ module Octokit
       #     }
       #   )
       def create_org_hook(org, config, options = {})
-        options = ensure_org_hooks_api_media_type(options)
         options = { :name => "web", :config => config }.merge(options)
         post "orgs/#{org}/hooks", options
       end
@@ -241,7 +236,6 @@ module Octokit
       #     }
       #   )
       def edit_org_hook(org, id, config, options = {})
-        options = ensure_org_hooks_api_media_type(options)
         options = { :config => config }.merge(options)
         patch "orgs/#{org}/hooks/#{id}", options
       end
@@ -258,7 +252,6 @@ module Octokit
       # @example
       #   @client.ping_org_hook('octokit', 1000000)
       def ping_org_hook(org, id, options = {})
-        options = ensure_org_hooks_api_media_type(options)
         boolean_from_response :post, "orgs/#{org}/hooks/#{id}/pings", options
       end
 
@@ -273,27 +266,17 @@ module Octokit
       # @example
       #   @client.remove_org_hook('octokit', 1000000)
       def remove_org_hook(org, id, options = {})
-        options = ensure_org_hooks_api_media_type(options)
         boolean_from_response :delete, "orgs/#{org}/hooks/#{id}", options
       end
 
-      private
-
-      def ensure_org_hooks_api_media_type(options = {})
-        if options[:accept].nil?
-          options[:accept] = ORG_HOOKS_PREVIEW_MEDIA_TYPE
-          warn_org_hooks_preview
-        end
-
-        options
-      end
-
-      def warn_org_hooks_preview
-        octokit_warn <<-EOS
-WARNING: The preview version of the Org Hooks API is not yet suitable for production use.
-You can avoid this message by supplying an appropriate media type in the 'Accept' request
-header. See the blog post for details: http://git.io/uucWqg
-EOS
+      # Parse payload string
+      #
+      # @param payload_string [String] The payload
+      # @return [Sawyer::Resource] The payload object
+      # @see https://developer.github.com/v3/activity/events/types/
+      def parse_payload(payload_string)
+        payload_hash = agent.class.decode payload_string
+        Sawyer::Resource.new agent, payload_hash
       end
     end
   end

data/lib/octokit/client/issues.rb

@@ -28,7 +28,8 @@ module Octokit
       #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
       #   @client.list_issues
       def list_issues(repository = nil, options = {})
-        paginate "#{Repository.new(repository).path}/issues", options
+        path = repository ? "#{Repository.new(repository).path}/issues" : "issues"
+        paginate path, options
       end
       alias :issues :list_issues
 

data/lib/octokit/client/licenses.rb

@@ -0,0 +1,50 @@
+module Octokit
+  class Client
+
+    # Methods for licenses API
+    #
+    module Licenses
+
+      LICENSES_PREVIEW_MEDIA_TYPE = "application/vnd.github.drax-preview+json".freeze
+
+      # List all licenses
+      #
+      # @see https://developer.github.com/v3/licenses/#list-all-licenses
+      # @return [Array<Sawyer::Resource>] A list of licenses
+      # @example
+      #   Octokit.licenses
+      def licenses(options = {})
+        options = ensure_license_api_media_type(options)
+        paginate "licenses", options
+      end
+
+      # List an individual license
+      #
+      # @see https://developer.github.com/v3/licenses/#get-an-individual-license
+      # @param license_name [String] The license name
+      # @return <Sawyer::Resource> An individual license
+      # @example
+      #   Octokit.license 'mit'
+      def license(license_name, options = {})
+        options = ensure_license_api_media_type(options)
+        get "licenses/#{license_name}", options
+      end
+
+      def ensure_license_api_media_type(options = {})
+        if options[:accept].nil?
+          options[:accept] = LICENSES_PREVIEW_MEDIA_TYPE
+          warn_license_preview
+        end
+        options
+      end
+
+      def warn_license_preview
+        warn <<-EOS
+WARNING: The preview version of the License API is not yet suitable for production use.
+You can avoid this message by supplying an appropriate media type in the 'Accept' request
+header. 
+EOS
+      end  
+    end
+  end
+end

data/lib/octokit/client/organizations.rb

@@ -44,7 +44,7 @@ module Octokit
       # @example
       #   @client.update_org('github', {:company => 'Unicorns, Inc.'})
       def update_organization(org, values, options = {})
-        patch Organization.path(org), options.merge({:organization => values})
+        patch Organization.path(org), options.merge(values)
       end
       alias :update_org :update_organization
 
@@ -76,12 +76,29 @@ module Octokit
       # @example
       #   @client.organizations
       def organizations(user=nil, options = {})
-        get "#{User.path user}/orgs", options
+        paginate "#{User.path user}/orgs", options
       end
       alias :list_organizations :organizations
       alias :list_orgs :organizations
       alias :orgs :organizations
 
+      # List all GitHub organizations
+      #
+      # This provides a list of every organization, in the order that they
+      # were created.
+      #
+      # @param options [Hash] Optional options.
+      # @option options [Integer] :since The integer ID of the last
+      # Organization that you’ve seen.
+      #
+      # @see https://developer.github.com/v3/orgs/#list-all-organizations
+      #
+      # @return [Array<Sawyer::Resource>] List of GitHub organizations.
+      def all_organizations(options = {})
+        paginate "organizations"
+      end
+      alias :all_orgs :all_organizations
+
       # List organization repositories
       #
       # Public repositories are available without authentication. Private repos
@@ -535,26 +552,49 @@ module Octokit
       end
       alias :org_memberships :organization_memberships
 
-      # Get an organization membership for the authenticated user
+      # Get an organization membership
       #
       # @param org [String] Organization GitHub login.
+      # @option options [String] :user  The login of the user, otherwise authenticated user.
       # @return [Sawyer::Resource] Hash representing the organization membership.
       # @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 = {})
-        get "user/memberships/orgs/#{org}", options
+        if user = options.delete(:user)
+          get "orgs/#{org}/memberships/#{user}", options
+        else
+          get "user/memberships/orgs/#{org}", options
+        end
       end
       alias :org_membership :organization_membership
 
-      # Edit an organization membership for the authenticated user
+      # Edit an organization membership
       #
       # @param org [String] Organization GitHub login.
+      # @option options [String] :role  The role of the user in the organization.
       # @option options [String] :state The state that the membership should be in.
+      # @option options [String] :user  The login of the user, otherwise authenticated user.
       # @return [Sawyer::Resource] Hash representing the updated organization membership.
       # @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 = {})
-        patch "user/memberships/orgs/#{org}", options
+        if user = options.delete(:user)
+          put "orgs/#{org}/memberships/#{user}", options
+        else
+          patch "user/memberships/orgs/#{org}", options
+        end
       end
       alias :update_org_membership :update_organization_membership
+
+      # Remove an organization membership
+      #
+      # @param org [String] Organization GitHub login.
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/orgs/members/#remove-organization-membership
+      def remove_organization_membership(org, options = {})
+        user = options.delete(:user)
+        user && boolean_from_response(:delete, "orgs/#{org}/memberships/#{user}", options)
+      end
     end
   end
 end

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -1,10 +1,3 @@
-major, minor, patch = RUBY_VERSION.split('.').map(&:to_i)
-
-if (major == 1 && minor < 9) || (major == 1 && minor == 9 && patch < 2)
-  # pull in backports
-  require 'octokit/backports/uri'
-end
-
 module Octokit
   class Client
 
@@ -93,7 +86,7 @@ module Octokit
       private
 
       def pub_sub_hubbub_request(options = {})
-        # This method is janky, bypass normal stack so we don'tl
+        # This method is janky, bypass normal stack so we don't
         # serialize request as JSON
         conn = Faraday.new(:url => @api_endpoint) do |http|
           http.headers[:user_agent] = user_agent

data/lib/octokit/client/pull_requests.rb

@@ -12,24 +12,12 @@ module Octokit
       #   @param repo [Integer, String, Hash, Repository] A GitHub repository
       #   @param options [Hash] Method options
       #   @option options [String] :state `open` or `closed`.
-      # @overload pull_requests(repo, state, options)
-      #   @deprecated
-      #   @param repo [Integer, String, Hash, Repository] A GitHub repository
-      #   @param state [String] `open` or `closed`.
-      #   @param options [Hash] Method options
       # @return [Array<Sawyer::Resource>] Array of pulls
       # @see https://developer.github.com/v3/pulls/#list-pull-requests
       # @example
       #   Octokit.pull_requests('rails/rails', :state => 'closed')
-      def pull_requests(*args)
-        arguments = Arguments.new(args)
-        opts = arguments.options
-        repo = arguments.shift
-        if state = arguments.shift
-          octokit_warn "DEPRECATED: Client#pull_requests: Passing state as positional argument is deprecated. Please use :state => '#{state}'"
-          opts[:state] = state if state
-        end
-        paginate "#{Repository.path repo}/pulls", opts
+      def pull_requests(repo, options = {})
+        paginate "#{Repository.path repo}/pulls", options
       end
       alias :pulls :pull_requests
 

data/lib/octokit/client/users.rb

@@ -8,7 +8,7 @@ module Octokit
 
       # List all GitHub users
       #
-      # This provides a dump of every user, in the order that they signed up
+      # This provides a list of every user, in the order that they signed up
       # for GitHub.
       #
       # @param options [Hash] Optional options.

data/lib/octokit/configurable.rb

@@ -24,6 +24,10 @@ module Octokit
     #   @return [Hash] Configure connection options for Faraday
     # @!attribute login
     #   @return [String] GitHub username for Basic Authentication
+    # @!attribute management_console_password
+    #   @return [String] An admin password set up for your GitHub Enterprise management console
+    # @!attribute management_console_endpoint
+    #   @return [String] Base URL for API requests to the GitHub Enterprise management console
     # @!attribute middleware
     #   @see https://github.com/lostisland/faraday
     #   @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@@ -45,6 +49,7 @@ module Octokit
 
     attr_accessor :access_token, :auto_paginate, :client_id,
                   :client_secret, :default_media_type, :connection_options,
+                  :management_console_endpoint, :management_console_password,
                   :middleware, :netrc, :netrc_file,
                   :per_page, :proxy, :user_agent
     attr_writer :password, :web_endpoint, :api_endpoint, :login
@@ -63,6 +68,8 @@ module Octokit
           :connection_options,
           :default_media_type,
           :login,
+          :management_console_endpoint,
+          :management_console_password,
           :middleware,
           :netrc,
           :netrc_file,
@@ -89,10 +96,22 @@ module Octokit
     end
     alias setup reset!
 
+    # 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
+
     def api_endpoint
       File.join(@api_endpoint, "")
     end
 
+    def management_console_endpoint
+      File.join(@management_console_endpoint, "")
+    end
+
     # Base URL for generated web URLs
     #
     # @return [String] Default: https://github.com/

data/lib/octokit/connection.rb

@@ -0,0 +1,196 @@
+require 'sawyer'
+require 'octokit/authentication'
+module Octokit
+
+  # Network layer for API clients.
+  module Connection
+
+    include Octokit::Authentication
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    # 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.dup)
+
+      if @auto_paginate
+        while @last_response.rels[:next] && rate_limit.remaining > 0
+          @last_response = @last_response.rels[:next].get(:headers => opts[:headers])
+          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(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
+
+    protected
+
+    def endpoint
+      api_endpoint
+    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.delete(:headers) { Hash.new }
+      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