class FaradayMiddleware::ResponseMiddleware

Internal: The base class for middleware that parses responses.

Constants

CONTENT_TYPE

Attributes

parser[RW]

Public Class Methods

define_parser(parser = nil, &block) click to toggle source

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

# File lib/faraday_middleware/response_middleware.rb, line 16
def self.define_parser(parser = nil, &block)
  @parser = parser ||
            block  ||
            raise(ArgumentError, 'Define parser with a block')
end
inherited(subclass) click to toggle source
Calls superclass method
# File lib/faraday_middleware/response_middleware.rb, line 22
def self.inherited(subclass)
  super
  subclass.load_error = load_error if subclass.respond_to? :load_error=
  subclass.parser = parser
end
new(app = nil, options = {}) click to toggle source
Calls superclass method
# File lib/faraday_middleware/response_middleware.rb, line 28
def initialize(app = nil, options = {})
  super(app)
  @options = options
  @parser_options = options[:parser_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 35
def call(environment)
  @app.call(environment).on_complete do |env|
    process_response(env) if process_response_type?(response_type(env)) && parse_response?(env)
  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 51
def parse(body)
  if self.class.parser
    begin
      self.class.parser.call(body, @parser_options)
    rescue StandardError, SyntaxError => e
      raise e if e.is_a?(SyntaxError) &&
                 e.class.name != 'Psych::SyntaxError'

      raise Faraday::ParsingError, e
    end
  else
    body
  end
end
parse_response?(env) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 78
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 82
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 41
def process_response(env)
  env[:raw_body] = env[:body] if preserve_raw?(env)
  env[:body] = parse(env[:body])
rescue Faraday::ParsingError => e
  raise Faraday::ParsingError.new(e.wrapped_exception, env[:response])
end
process_response_type?(type) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 72
def process_response_type?(type)
  @content_types.empty? || @content_types.any? do |pattern|
    pattern.is_a?(Regexp) ? type =~ pattern : type == pattern
  end
end
response_type(env) click to toggle source
# File lib/faraday_middleware/response_middleware.rb, line 66
def response_type(env)
  type = env[:response_headers][CONTENT_TYPE].to_s
  type = type.split(';', 2).first if type.index(';')
  type
end