lingfennan-github_api 0.18.2

data/lib/github_api/response/atom_parser.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::AtomParser < Response
+    define_parser do |body|
+      require 'rss'
+      RSS::Parser.parse(body)
+    end
+
+    def initialize(app, options = {})
+      super(app, options.merge(content_type: /(\batom|\brss)/))
+    end
+
+    def on_complete(env)
+      if parse_body?(env)
+        process_body(env)
+      end
+    end
+  end
+end

data/lib/github_api/response/follow_redirects.rb

@@ -0,0 +1,140 @@
+require 'faraday'
+require 'set'
+
+# First saw on octokit, then copied from lostisland/faraday_middleware
+# and adapted for this library.
+#
+# faraday_middleware/lib/faraday_middleware/response/follow_redirects.rb
+
+module Github
+  # Public: Exception thrown when the maximum amount of requests is exceeded.
+  class RedirectLimitReached < Faraday::Error::ClientError
+    attr_reader :response
+
+    def initialize(response)
+      super "too many redirects; last one to: #{response['location']}"
+      @response = response
+    end
+  end
+
+  # Public: Follow HTTP 301, 302, 303, 307, and 308 redirects.
+  #
+  # For HTTP 301, 302, and 303, the original GET, POST, PUT, DELETE, or PATCH
+  # request gets converted into a GET. With `:standards_compliant => true`,
+  # however, the HTTP method after 301/302 remains unchanged. This allows you
+  # to opt into HTTP/1.1 compliance and act unlike the major web browsers.
+  #
+  # This middleware currently only works with synchronous requests; i.e. it
+  # doesn't support parallelism.
+  #
+  # If you wish to persist cookies across redirects, you could use
+  # the faraday-cookie_jar gem:
+  #
+  #   Faraday.new(:url => url) do |faraday|
+  #     faraday.use FaradayMiddleware::FollowRedirects
+  #     faraday.use :cookie_jar
+  #     faraday.adapter Faraday.default_adapter
+  #   end
+
+  class Response::FollowRedirects < Faraday::Middleware
+    # HTTP methods for which 30x redirects can be followed
+    ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
+    # HTTP redirect status codes that this middleware implements
+    REDIRECT_CODES  = Set.new [301, 302, 303, 307, 308]
+    # Keys in env hash which will get cleared between requests
+    ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+
+    # Default value for max redirects followed
+    FOLLOW_LIMIT = 3
+
+    # Regex that matches characters that need to be escaped in URLs, sans
+    # the "%" character which we assume already represents an escaped sequence.
+    URI_UNSAFE = /[^\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]%]/
+
+    # Public: Initialize the middleware.
+    #
+    # options - An options Hash (default: {}):
+    #           :limit               - A Numeric redirect limit (default: 3)
+    #           :standards_compliant - A Boolean indicating whether to respect
+    #                                  the HTTP spec when following 301/302
+    #                                  (default: false)
+    #           :callback            - A callable that will be called on redirects
+    #                                  with the old and new envs
+    def initialize(app, options = {})
+      super(app)
+      @options = options
+
+      @convert_to_get = Set.new [303]
+      @convert_to_get << 301 << 302 unless standards_compliant?
+    end
+
+    def call(env)
+      perform_with_redirection(env, follow_limit)
+    end
+
+    private
+
+    def convert_to_get?(response)
+      ![:head, :options].include?(response.env[:method]) &&
+        @convert_to_get.include?(response.status)
+    end
+
+    def perform_with_redirection(env, follows)
+      request_body = env[:body]
+      response = @app.call(env)
+
+      response.on_complete do |response_env|
+        if follow_redirect?(response_env, response)
+          raise RedirectLimitReached, response if follows.zero?
+          new_request_env = update_env(response_env.dup, request_body, response)
+          callback.call(response_env, new_request_env) if callback
+          response = perform_with_redirection(new_request_env, follows - 1)
+        end
+      end
+      response
+    end
+
+    def update_env(env, request_body, response)
+      env[:url] += safe_escape(response['location'])
+
+      if convert_to_get?(response)
+        env[:method] = :get
+        env[:body] = nil
+      else
+        env[:body] = request_body
+      end
+
+      ENV_TO_CLEAR.each {|key| env.delete key }
+
+      env
+    end
+
+    def follow_redirect?(env, response)
+      ALLOWED_METHODS.include? env[:method] and
+        REDIRECT_CODES.include? response.status
+    end
+
+    def follow_limit
+      @options.fetch(:limit, FOLLOW_LIMIT)
+    end
+
+    def standards_compliant?
+      @options.fetch(:standards_compliant, false)
+    end
+
+    def callback
+      @options[:callback]
+    end
+
+    # Internal: escapes unsafe characters from an URL which might be a path
+    # component only or a fully qualified URI so that it can be joined onto an
+    # URI:HTTP using the `+` operator. Doesn't escape "%" characters so to not
+    # risk double-escaping.
+    def safe_escape(uri)
+      uri = uri.split('#')[0] # we want to remove the fragment if present
+      uri.to_s.gsub(URI_UNSAFE) { |match|
+        '%' + match.unpack('H2' * match.bytesize).join('%').upcase
+      }
+    end
+  end
+end

data/lib/github_api/response/header.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+require_relative '../constants'
+
+module Github
+  class Response
+
+    # Represents http response header
+    class Header < Struct.new(:env)
+      include Github::Constants
+
+      SUCCESSFUL_STATUSES = 200..299
+
+      def loaded?
+        !!env
+      end
+
+      def [](property)
+        loaded? ? env[:response_headers][property] : nil
+      end
+
+      def oauth_scopes
+        loaded? ? env[:response_headers][OAUTH_SCOPES] : nil
+      end
+
+      def accepted_oauth_scopes
+        loaded? ? env[:response_headers][ACCEPTED_OAUTH_SCOPES] : nil
+      end
+
+      # Requests are limited to API v3 to 5000 per hour.
+      def ratelimit_limit
+        loaded? ? env[:response_headers][RATELIMIT_LIMIT] : nil
+      end
+
+      def ratelimit_remaining
+        loaded? ? env[:response_headers][RATELIMIT_REMAINING] : nil
+      end
+
+      # A unix timestamp describing when the ratelimit will
+      # be reset
+      def ratelimit_reset
+        loaded? ? env[:response_headers][RATELIMIT_RESET] : nil
+      end
+
+      def cache_control
+        loaded? ? env[:response_headers][CACHE_CONTROL] : nil
+      end
+
+      def content_type
+        loaded? ? env[:response_headers][CONTENT_TYPE] : nil
+      end
+
+      def content_length
+        loaded? ? env[:response_headers][CONTENT_LENGTH] : nil
+      end
+
+      def etag
+        loaded? ? env[:response_headers][ETAG] : nil
+      end
+
+      def date
+        loaded? ? env[:response_headers][DATE] : nil
+      end
+
+      def location
+        loaded? ? env[:response_headers][LOCATION] : nil
+      end
+
+      def server
+        loaded? ? env[:response_headers][SERVER] : nil
+      end
+
+      def status
+        loaded? ? env[:status] : nil
+      end
+
+      def success?
+        SUCCESSFUL_STATUSES.include? status
+      end
+
+      # Returns raw body
+      def body
+        loaded? ? env[:body] : nil
+      end
+    end # Header
+  end # Response
+end # Github

data/lib/github_api/response/jsonize.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'json'
+
+module Github
+  class Response::Jsonize < Response
+
+    dependency 'json'
+
+    define_parser do |body|
+      JSON.parse(body)
+    end
+
+    def parse(body)
+      case body
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        self.class.parser.call(body)
+      end
+    end
+  end # Response::Jsonize
+end # Github

data/lib/github_api/response/mashify.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'hashie'
+require 'github_api/mash'
+
+module Github
+  class Response::Mashify < Response
+    define_parser do |body|
+      ::Github::Mash.new body
+    end
+
+    def parse(body)
+      case body
+      when Hash
+        self.class.parser.call body
+      when Array
+        body.map { |item| item.is_a?(Hash) ? self.class.parser.call(item) : item }
+      else
+        body
+      end
+    end
+  end # Response::Mashify
+end # Github

data/lib/github_api/response/raise_error.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'faraday'
+
+require_relative '../error/service_error'
+
+module Github
+  class Response::RaiseError < Faraday::Response::Middleware
+    # Check if status code requires raising a ServiceError
+    #
+    # @api private
+    def on_complete(env)
+      status_code   = env[:status].to_i
+      service_error = Github::Error::ServiceError
+      error_class = service_error.error_mapping[status_code]
+      if !error_class and (400...600) === status_code
+        error_class = service_error
+      end
+      raise error_class.new(env) if error_class
+    end
+  end # Response::RaiseError
+end # Github

data/lib/github_api/response/xmlize.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::Xmlize < Response
+
+    dependency 'nokogiri'
+
+    define_parser do |body|
+      ::Nokogiri::XML body
+    end
+
+    def parse(body)
+      case body
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        self.class.parser.call(body)
+      end
+    end
+  end # Response::Xmlize
+end # Github

data/lib/github_api/response_wrapper.rb

@@ -0,0 +1,161 @@
+# encoding: utf-8
+
+require 'forwardable'
+
+require_relative 'pagination'
+
+module Github
+  # A class responsible for proxing to faraday response
+  class ResponseWrapper
+    extend Forwardable
+    include Pagination
+    include Enumerable
+
+    attr_reader :response
+
+    attr_reader :current_api
+
+    attr_reader :env
+
+    def_delegators :body, :empty?, :size, :include?, :length, :to_a, :first, :flatten, :include?, :keys, :[]
+
+    def initialize(response, current_api)
+      @response    = response
+      @current_api = current_api
+      @env         = response.env
+      @body        = nil
+    end
+
+    # Overwrite methods to hash keys
+    #
+    ['id', 'type', 'fork'].each do |method_name|
+      define_method(method_name) do
+        self.body.fetch(method_name.to_s)
+      end
+    end
+
+    # Request url
+    #
+    def url
+      response.env[:url].to_s
+    end
+
+    def body=(value)
+      @body = value
+      @env[:body] = value
+    end
+
+    # Response raw body
+    #
+    def body
+      @body ? @body : response.body
+    end
+
+    # Response status
+    #
+    def status
+      response.status
+    end
+
+    def success?
+      response.success?
+    end
+
+    def redirect?
+      status.to_i >= 300 && status.to_i < 400
+    end
+
+    def client_error?
+      status.to_i >= 400 && status.to_i < 500
+    end
+
+    def server_error?
+      status.to_i >= 500 && status.to_i < 600
+    end
+
+    # Return response headers
+    #
+    def headers
+      Github::Response::Header.new(env)
+    end
+
+    # Lookup an attribute from the body if hash, otherwise behave like array index.
+    # Convert any key to string before calling.
+    #
+    def [](key)
+      if self.body.is_a?(Array)
+        self.body[key]
+      else
+        self.body.send(:"#{key}")
+      end
+    end
+
+    # Return response body as string
+    #
+    def to_s
+      body.to_s
+    end
+
+    # Convert the ResponseWrapper into a Hash
+    #
+    def to_hash
+      body.to_hash
+    end
+
+    # Convert the ResponseWrapper into an Array
+    #
+    def to_ary
+      body.to_ary
+    end
+
+    # Iterate over each resource inside the body
+    #
+    def each
+      body_parts = self.body.respond_to?(:each) ? self.body : [self.body]
+      return body_parts.to_enum unless block_given?
+      body_parts.each { |part| yield(part) }
+    end
+
+    # Check if body has an attribute
+    #
+    def has_key?(key)
+      self.body.is_a?(Hash) && self.body.has_key?(key)
+    end
+
+    # Coerce any method calls for body attributes
+    #
+    def method_missing(method_name, *args, &block)
+      if self.has_key?(method_name.to_s)
+        self.[](method_name, &block)
+      else
+        super
+      end
+    end
+
+    # Check if method is defined on the body
+    #
+    def respond_to?(method_name, include_all = false)
+      if self.has_key?(method_name.to_s)
+        true
+      else
+        super
+      end
+    end
+
+    # Print only response body
+    #
+    def inspect
+      "#<#{self.class.name} @body=\"#{self.body}\">"
+    end
+
+    # Compare the wrapper with other wrapper for equality
+    #
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      return false unless (other.respond_to?(:env) && other.respond_to?(:body))
+      self.env == other.env && self.body == other.body
+    end
+    alias eql? ==
+
+  end # ResponseWrapper
+end # Github