# frozen_string_literal: true require 'forwardable' module Faraday # Response represents an HTTP response from making an HTTP request. class Response # Used for simple response middleware. class Middleware < Faraday::Middleware # Override this to modify the environment after the response has finished. # Calls the `parse` method if defined # `parse` method can be defined as private, public and protected def on_complete(env) return unless respond_to?(:parse, true) && env.parse_body? env.body = parse(env.body) end end extend Forwardable extend MiddlewareRegistry register_middleware File.expand_path('response', __dir__), raise_error: [:RaiseError, 'raise_error'], logger: [:Logger, 'logger'] def initialize(env = nil) @env = Env.from(env) if env @on_complete_callbacks = [] end attr_reader :env def status finished? ? env.status : nil end def reason_phrase finished? ? env.reason_phrase : nil end def headers finished? ? env.response_headers : {} end def_delegator :headers, :[] def body finished? ? env.body : nil end def finished? !!env end def on_complete(&block) if !finished? @on_complete_callbacks << block else yield(env) end self end def finish(env) raise 'response already finished' if finished? @env = env.is_a?(Env) ? env : Env.from(env) @on_complete_callbacks.each { |callback| callback.call(@env) } self end def success? finished? && env.success? end def to_hash { status: env.status, body: env.body, response_headers: env.response_headers } end # because @on_complete_callbacks cannot be marshalled def marshal_dump finished? ? to_hash : nil end def marshal_load(env) @env = Env.from(env) end # Expand the env with more properties, without overriding existing ones. # Useful for applying request params after restoring a marshalled Response. def apply_request(request_env) raise "response didn't finish yet" unless finished? @env = Env.from(request_env).update(@env) self end end end