module FlexmlsApi module FaradayExt #=Flexmls API Faraday middleware # HTTP Response after filter to package api responses and bubble up basic api errors. class FlexmlsMiddleware < Faraday::Response::Middleware begin def self.register_on_complete(env) env[:response].on_complete do |finished_env| validate_and_build_response(finished_env) end end rescue LoadError, NameError => e self.load_error = e end # Handles pretty much all the api response parsing and error handling. All responses that # indicate a failure will raise a FlexmlsApi::ClientError exception def self.validate_and_build_response(finished_env) body = finished_env[:body] FlexmlsApi.logger.debug("Response Body: #{body.inspect}") unless body.is_a?(Hash) && body.key?("D") raise InvalidResponse, "The server response could not be understood" end response = ApiResponse.new body case finished_env[:status] when 400, 409 raise BadResourceRequest.new(response.code, finished_env[:status]), response.message when 401 # Handle the WWW-Authenticate Response Header Field if present. This can be returned by # OAuth2 implementations and wouldn't hurt to log. auth_header_error = finished_env[:request_headers]["WWW-Authenticate"] FlexmlsApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil? raise PermissionDenied.new(response.code, finished_env[:status]), response.message when 404 raise NotFound.new(response.code, finished_env[:status]), response.message when 405 raise NotAllowed.new(response.code, finished_env[:status]), response.message when 500 raise ClientError.new(response.code, finished_env[:status]), response.message when 200..299 FlexmlsApi.logger.debug("Success!") else raise ClientError.new(response.code, finished_env[:status]), response.message end finished_env[:body] = response end def initialize(app) super @parser = nil end end end end