octokit 1.25.0 → 2.0.0.pre

data/lib/octokit/configurable.rb

@@ -0,0 +1,117 @@
+module Octokit
+
+  # Configuration options for {Client}, defaulting to values
+  # in {Default}
+  module Configurable
+    # @!attribute [w] access_token
+    #   @see http://developer.github.com/v3/oauth/
+    #   @return [String] OAuth2 access token for authentication
+    # @!attribute api_endpoint
+    #   @return [String] Base URL for API requests. default: https://api.github.com/
+    # @!attribute auto_paginate
+    #   @return [Boolean] Auto fetch next page of results until rate limit reached
+    # @!attribute client_id
+    #   @see http://developer.github.com/v3/oauth/
+    #   @return [String] Configure OAuth app key
+    # @!attribute [w] client_secret
+    #   @see http://developer.github.com/v3/oauth/
+    #   @return [String] Configure OAuth app secret
+    # @!attribute default_media_type
+    #   @see http://developer.github.com/v3/media/
+    #   @return [String] Configure preferred media type (for API versioning, for example)
+    # @!attribute connection_options
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Hash] Configure connection options for Faraday
+    # @!attribute login
+    #   @return [String] GitHub username for Basic Authentication
+    # @!attribute middleware
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Faraday::RackBuilder] Configure middleware for Faraday
+    # @!attribute netrc
+    #   @return [Boolean] Instruct Octokit to get credentials from .netrc file
+    # @!attribute netrc_file
+    #   @return [String] Path to .netrc file. default: ~/.netrc
+    # @!attribute [w] password
+    #   @return [String] GitHub password for Basic Authentication
+    # @!attribute per_page
+    #   @return [String] Configure page size for paginated results. API default: 30
+    # @!attribute proxy
+    #   @see https://github.com/lostisland/faraday
+    #   @return [String] URI for proxy server
+    # @!attribute user_agent
+    #   @return [String] Configure User-Agent header for requests.
+    # @!attribute web_endpoint
+    #   @return [String] Base URL for web URLs. default: https://github.com/
+
+    attr_accessor :api_endpoint, :auto_paginate, :client_id, :default_media_type, :connection_options,
+                  :login, :middleware, :netrc, :netrc_file, :per_page, :proxy, :user_agent, :web_endpoint
+    attr_writer :access_token, :client_secret, :password
+
+    class << self
+
+      # List of configurable keys for {Octokit::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :access_token,
+          :api_endpoint,
+          :auto_paginate,
+          :client_id,
+          :client_secret,
+          :connection_options,
+          :default_media_type,
+          :login,
+          :middleware,
+          :netrc,
+          :netrc_file,
+          :per_page,
+          :password,
+          :proxy,
+          :user_agent,
+          :web_endpoint
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      Octokit::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Octokit::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    def api_endpoint
+      File.join(@api_endpoint, "")
+    end
+
+    # Base URL for generated web URLs
+    #
+    # @return [String] Default: https://github.com/
+    def web_endpoint
+      File.join(@web_endpoint, "")
+    end
+
+    def login
+      @login ||= begin
+        user.login if token_authenticated?
+      end
+    end
+
+    def netrc?
+      !!@netrc
+    end
+
+    private
+
+    def options
+      Hash[Octokit::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/lib/octokit/default.rb

@@ -0,0 +1,140 @@
+require 'octokit/response/raise_error'
+
+module Octokit
+
+  # Default configuration options for {Client}
+  module Default
+
+    # Default API endpoint
+    API_ENDPOINT = "https://api.github.com".freeze
+
+    # Default User Agent header string
+    USER_AGENT   = "Octokit Ruby Gem #{Octokit::VERSION}".freeze
+
+    # Default media type
+    MEDIA_TYPE   = "application/vnd.github.beta+json"
+
+    # Default WEB endpoint
+    WEB_ENDPOINT = "https://github.com".freeze
+
+    # Default Faraday middleware stack
+    MIDDLEWARE = Faraday::RackBuilder.new do |builder|
+      builder.use Octokit::Response::RaiseError
+      builder.adapter Faraday.default_adapter
+    end
+
+    class << self
+
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[Octokit::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # Default access token from ENV
+      # @return [String]
+      def access_token
+        ENV['OCTOKIT_ACCESS_TOKEN']
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        ENV['OCTOKIT_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      # Default pagination preference from ENV
+      # @return [String]
+      def auto_paginate
+        ENV['OCTOKIT_AUTO_PAGINATE']
+      end
+
+      # Default OAuth app key from ENV
+      # @return [String]
+      def client_id
+        ENV['OCTOKIT_CLIENT_ID']
+      end
+
+      # Default OAuth app secret from ENV
+      # @return [String]
+      def client_secret
+        ENV['OCTOKIT_SECRET']
+      end
+
+      # Default options for Faraday::Connection
+      # @return [Hash]
+      def connection_options
+        {
+          :headers => {
+            :accept => default_media_type,
+            :user_agent => user_agent
+          }
+        }
+      end
+
+      # Default media type from ENV or {MEDIA_TYPE}
+      # @return [String]
+      def default_media_type
+        ENV['OCTOKIT_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
+      end
+
+      # Default GitHub username for Basic Auth from ENV
+      # @return [String]
+      def login
+        ENV['OCTOKIT_LOGIN']
+      end
+
+      # Default middleware stack for Faraday::Connection
+      # from {MIDDLEWARE}
+      # @return [String]
+      def middleware
+        MIDDLEWARE
+      end
+
+      # Default GitHub password for Basic Auth from ENV
+      # @return [String]
+      def password
+        ENV['OCTOKIT_PASSWORD']
+      end
+
+      # Default pagination page size from ENV
+      # @return [Fixnum] Page size
+      def per_page
+        page_size = ENV['OCTOKIT_PER_PAGE']
+
+        page_size.to_i if page_size
+      end
+
+      # Default proxy server URI for Faraday connection from ENV
+      # @return [String]
+      def proxy
+        ENV['OCTOKIT_PROXY']
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['OCTOKIT_USER_AGENT'] || USER_AGENT
+      end
+
+      # Default web endpoint from ENV or {WEB_ENDPOINT}
+      # @return [String]
+      def web_endpoint
+        ENV['OCTOKIT_WEB_ENDPOINT'] || WEB_ENDPOINT
+      end
+
+      # Default behavior for reading .netrc file
+      # @return [Boolean]
+      def netrc
+        ENV['OCTOKIT_NETRC'] || false
+      end
+
+      # Default path for .netrc file
+      # @return [String]
+      def netrc_file
+        ENV['OCTOKIT_NETRC_FILE'] || File.join(ENV['HOME'], '.netrc')
+      end
+
+    end
+  end
+end

data/lib/octokit/error.rb

@@ -6,11 +6,13 @@ module Octokit
       super(build_error_message)
     end
 
+    # private
     def response_body
       @response_body ||=
         if (body = @response[:body]) && !body.empty?
           if body.is_a?(String)
-            MultiJson.load(body, :symbolize_keys => true)
+            serializer = Sawyer::Serializer.new(Sawyer::Serializer.any_json)
+            serializer.decode(body)
           else
             body
           end
@@ -19,18 +21,17 @@ module Octokit
         end
     end
 
-    private
-
+    # private
     def build_error_message
       return nil  if @response.nil?
 
       message = if response_body
-        ": #{response_body[:error] || response_body[:message] || ''}"
+        ": #{response_body['error'] || response_body['message'] || ''}"
       else
         ''
       end
       errors = unless message.empty?
-        response_body[:errors] ?  ": #{response_body[:errors].map{|e|e[:message]}.join(', ')}" : ''
+        response_body['errors'] ?  ": #{response_body['errors'].map{|e|e['message']}.join(', ')}" : ''
       end
       "#{@response[:method].to_s.upcase} #{@response[:url].to_s}: #{@response[:status]}#{message}#{errors}"
     end

data/lib/octokit/gist.rb

@@ -1,9 +1,16 @@
 require 'addressable/uri'
 
 module Octokit
+
+  # Class to parse and create Gist URLs
   class Gist
+
+    # !@attribute id
+    #   @return [String] Gist ID
     attr_accessor :id
 
+    # Instantiate {Gist} object from Gist URL
+    # @ return [Gist]
     def self.from_url(url)
       Gist.new(Addressable::URI.parse(url).path[1..-1])
     end
@@ -15,10 +22,14 @@ module Octokit
       end
     end
 
+    # Gist ID
+    # @return [String]
     def to_s
       @id
     end
 
+    # Gist URL
+    # @return [String]
     def url
       "https://gist.github.com/#{@id}"
     end

data/lib/octokit/rate_limit.rb

@@ -0,0 +1,22 @@
+module Octokit
+
+  # Class for API Rate Limit info
+  #
+  # @see http://developer.github.com/v3/#rate-limiting
+  class RateLimit < Struct.new :limit, :remaining
+
+    # Get rate limit info from HTTP response
+    #
+    # @param response [#headers] HTTP response
+    # @return [RateLimit]
+    def self.from_response(response)
+      info = new
+      if response && !response.headers.nil?
+        info.limit = response.headers['X-RateLimit-Limit'].to_i
+        info.remaining = response.headers['X-RateLimit-Remaining'].to_i
+      end
+
+      info
+    end
+  end
+end

data/lib/octokit/repo_arguments.rb

@@ -0,0 +1,19 @@
+module Octokit
+
+  # Class to extract options from Ruby arguments for
+  # Repository-related methods
+  class RepoArguments < Arguments
+
+    # !@attribute [r] repo
+    #   @return [Repository]
+    attr_reader :repo
+
+    def initialize(args)
+      arguments = super(args)
+      @repo = arguments.shift
+
+      arguments
+    end
+
+  end
+end

data/lib/octokit/repository.rb

@@ -1,9 +1,15 @@
 require 'addressable/uri'
 
 module Octokit
+  
+  # Class to parse GitHub repository owner and name from 
+  # URLs and to generate URLs
   class Repository
     attr_accessor :username, :name
 
+    # Instantiate from a GitHub repository URL
+    #
+    # @return [Repository]
     def self.from_url(url)
       Repository.new(Addressable::URI.parse(url).path[1..-1])
     end
@@ -21,14 +27,15 @@ module Octokit
       end
     end
 
+    # Repository owner/name
+    # @return [String]
     def slug
       "#{@username}/#{@name}"
     end
+    alias :to_s :slug
 
-    def to_s
-      self.slug
-    end
-
+    # Repository URL based on {Octokit::Client#web_endpoint}
+    # @return [String]
     def url
       "#{Octokit.web_endpoint}#{slug}"
     end

data/lib/octokit/response/raise_error.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'octokit/error'
+
+module Octokit
+  # Faraday response middleware
+  module Response
+
+    # This class raises an Octokit-flavored exception based 
+    # HTTP status codes returned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      # Status code to error mappings
+      # @private
+      ERROR_MAP = {
+        400 => Octokit::BadRequest,
+        401 => Octokit::Unauthorized,
+        403 => Octokit::Forbidden,
+        404 => Octokit::NotFound,
+        406 => Octokit::NotAcceptable,
+        422 => Octokit::UnprocessableEntity,
+        500 => Octokit::InternalServerError,
+        501 => Octokit::NotImplemented,
+        502 => Octokit::BadGateway,
+        503 => Octokit::ServiceUnavailable
+      }
+
+      private
+
+      def on_complete(response)
+        key = response[:status].to_i
+        raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+      end
+    end
+  end
+end

data/lib/octokit/version.rb

@@ -1,3 +1,7 @@
 module Octokit
-  VERSION = "1.25.0" unless defined?(Octokit::VERSION)
+
+  # Current version
+  # @return [String]
+  VERSION = "2.0.0.pre".freeze
+
 end