require 'faraday' require 'faraday_middleware' require 'saddle/middleware/request/encode_json' require 'saddle/middleware/request/path_prefix' require 'saddle/middleware/request/retry' require 'saddle/middleware/request/url_encoded' require 'saddle/middleware/request/user_agent' require 'saddle/middleware/response/default_response' require 'saddle/middleware/response/parse_json' require 'saddle/middleware/ruby_timeout' # The requester handles setting up the network connecting and brokering # requests. module Saddle class Requester VALID_BODY_STYLES = [:json, :urlencoded] # Available options ## host - host to connect to (default: localhost) ## port - port to connect on ## use_ssl - true if we should use https (default: false) ## request_style - :json or :urlencoded (default: :json) ## num_retries - number of times to retry each request (default: 3) ## timeout - timeout in seconds ## additional_middleware - an Array of more middlewares to apply to the top of the stack ## - each middleware consists of hash of klass, and optionally args (an array) ## stubs - test stubs for specs def initialize(parent_client, opt={}) # We may want properties about the parent client in middlewares @parent_client = parent_client # Store the options for later use @options = opt @host = opt[:host] || 'localhost' raise ':host must be a string' unless @host.is_a?(String) @port = opt[:port] raise ':port must be nil or an integer' unless (@port.nil? || @port.is_a?(Fixnum)) @use_ssl = opt[:use_ssl] || false raise ':use_ssl must be true or false' unless (@use_ssl.is_a?(TrueClass) || @use_ssl.is_a?(FalseClass)) @request_style = opt[:request_style] || :json raise ":request_style must be in: #{VALID_BODY_STYLES.join(',')}" unless VALID_BODY_STYLES.include?(@request_style) @num_retries = opt[:num_retries] || 3 raise ':num_retries must be an integer' unless @num_retries.is_a?(Fixnum) @timeout = opt[:timeout] raise ':timeout must be nil or an integer' unless (@timeout.nil? || @timeout.is_a?(Numeric)) @additional_middlewares = opt[:additional_middlewares] || [] raise ':additional_middleware must be an Array' unless @additional_middlewares.is_a?(Array) raise 'invalid middleware found' unless @additional_middlewares.all? { |m| m[:klass] < Faraday::Middleware } raise 'middleware arguments must be an array' unless @additional_middlewares.all? { |m| m[:args].nil? || m[:args].is_a?(Array) } @stubs = opt[:stubs] || nil unless @stubs.nil? raise ':stubs must be a Faraday::Adapter::Test::Stubs' unless @stubs.is_a?(Faraday::Adapter::Test::Stubs) end end # Make a GET request def get(url, params={}, options={}) response = connection.get do |req| req.options.merge!(options) req.url(url, params) end response.body end # Make a POST request def post(url, data={}, options={}) response = connection.post do |req| req.options.merge!(options) req.url(url) req.body = data end response.body end # Make a PUT request def put(url, data={}, options={}) response = connection.put do |req| req.options.merge!(options) req.url(url) req.body = data end response.body end # Make a DELETE request def delete(url, params={}, options={}) response = connection.delete do |req| req.options.merge!(options) req.url(url, params) end response.body end private # Construct a base url using this requester's settings def base_url "http#{'s' if @use_ssl}://#{@host}#{":#{@port}" if @port}" end # Build a connection instance, wrapped in the middleware that we want def connection @connection ||= Faraday.new(base_url) do |builder| # Include the requester level options builder.options[:client_options] = @options # Include a saddle hash builder.options[:saddle] = { :client => @parent_client, } # Config options unless @timeout.nil? builder.options[:timeout] = @timeout builder.options[:request_style] = @request_style builder.options[:num_retries] = @num_retries end # Hard timeout on the entire request builder.use(Saddle::Middleware::RubyTimeout) # Set up a user agent builder.use(Saddle::Middleware::Request::UserAgent) # Set up the path prefix if needed builder.use(Saddle::Middleware::Request::PathPrefix) # Support default return values upon exception builder.use(Saddle::Middleware::Response::DefaultResponse) # Apply additional implementation-specific middlewares @additional_middlewares.each do |m| builder.use(m[:klass], *m[:args]) end # Request encoding builder.use(Saddle::Middleware::Request::JsonEncoded) builder.use(Saddle::Middleware::Request::UrlEncoded) # Handle parsing out the response if it's JSON builder.use(Saddle::Middleware::Response::ParseJson) # Automatic retries builder.use(Saddle::Middleware::Request::Retry) # Raise exceptions on 4xx and 5xx errors builder.use(Faraday::Response::RaiseError) # Set up instrumentation around the adapter for extensibility builder.use(FaradayMiddleware::Instrumentation) # Set up our adapter if @stubs.nil? # Use the default adapter builder.adapter(:net_http) else # Use the test adapter builder.adapter(:test, @stubs) end end end end end