Parent

FaradayMiddleware::ResponseMiddleware

Internal: The base class for middleware that parses responses.

Constants

CONTENT_TYPE

Attributes

parser[RW]

Public Class Methods

define_parser(parser = nil) click to toggle source

Store a Proc that receives the body and returns the parsed result.

# File lib/faraday_middleware/response_middleware.rb, line 13
def self.define_parser(parser = nil)
  @parser = parser || Proc.new
end
inherited(subclass) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 17
def self.inherited(subclass)
  super
  subclass.load_error = self.load_error if subclass.respond_to? :load_error=
  subclass.parser = self.parser
end
new(app = nil, options = {}) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 23
def initialize(app = nil, options = {})
  super(app)
  @options = options
  @content_types = Array(options[:content_type])
end

Public Instance Methods

call(environment) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 29
def call(environment)
  @app.call(environment).on_complete do |env|
    if process_response_type?(response_type(env)) and parse_response?(env)
      process_response(env)
    end
  end
end
parse(body) click to toggle source

Parse the response body.

Instead of overriding this method, consider using `define_parser`.

# File lib/faraday_middleware/response_middleware.rb, line 45
def parse(body)
  if self.class.parser
    begin
      self.class.parser.call(body)
    rescue StandardError, SyntaxError => err
      raise err if err.is_a? SyntaxError and err.class.name != 'Psych::SyntaxError'
      raise Faraday::Error::ParsingError, err
    end
  else
    body
  end
end
parse_response?(env) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 70
def parse_response?(env)
  env[:body].respond_to? :to_str
end
preserve_raw?(env) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 74
def preserve_raw?(env)
  env[:request].fetch(:preserve_raw, @options[:preserve_raw])
end
process_response(env) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 37
def process_response(env)
  env[:raw_body] = env[:body] if preserve_raw?(env)
  env[:body] = parse(env[:body])
end
process_response_type?(type) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 64
def process_response_type?(type)
  @content_types.empty? or @content_types.any? { |pattern|
    pattern.is_a?(Regexp) ? type =~ pattern : type == pattern
  }
end
response_type(env) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 58
def response_type(env)
  type = env[:response_headers][CONTENT_TYPE].to_s
  type = type.split(';', 2).first if type.index(';')
  type
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.