class Ubiquity::Iconik::API::Client::Requests::BaseRequest
Constants
- DEFAULT_PARAMETER_SEND_IN_VALUE
- HTTP_BASE_PATH
- HTTP_METHOD
- HTTP_PATH
- HTTP_SUCCESS_CODE
- PARAMETERS
Attributes
Public Class Methods
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 86 def initialize(args = { }, options = { }) @initial_arguments = args.dup @initial_options = options.dup @options = options.dup initialize_attributes if options.fetch(:initialize_attributes, true) after_initialize end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 26 def self.normalize_argument_hash_keys(hash) return hash unless hash.is_a?(Hash) Hash[ hash.dup.map { |k,v| [ normalize_parameter_name(k), v ] } ] end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 31 def self.normalize_parameter_name(name) (name || '').respond_to?(:to_s) ? name.to_s.gsub('_', '').gsub('-', '').downcase : name end
A method to expose parameter processing
@param [Hash|Symbol] param The parameter to process @param [Hash] args ({ }) Arguments to possibly match to the parameter @param [Hash] args_out ({ }) The processed value of the parameter (if any) @param [Array] missing_required_arguments
([ ]) If the parameter was required and no argument found then it will be placed into this array @param [Hash] processed_parameters
({ }) The parameter will be placed into this array once processed @param [Symbol] default_parameter_send_in_value
(DEFAULT_PARAMETER_SEND_IN_VALUE
) The :send_in value that will be set if the :send_in key is not found @param [Hash] options @option options [True|False] :normalize_argument_hash_keys (false)
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 60 def self.process_parameter(param, args = { }, args_out = { }, missing_required_arguments = [ ], processed_parameters = { }, default_parameter_send_in_value = DEFAULT_PARAMETER_SEND_IN_VALUE, options = { }) args = normalize_argument_hash_keys(args) || { } if options.fetch(:normalize_argument_hash_keys, false) _k = param.is_a?(Hash) ? param : { :name => param, :required => false, :send_in => default_parameter_send_in_value } _k[:send_in] ||= default_parameter_send_in_value proper_parameter_name = _k[:name] param_name = normalize_parameter_name(proper_parameter_name) arg_key = (has_key = args.has_key?(param_name)) ? param_name : ( (_k[:aliases] || [ ]).map { |a| normalize_parameter_name(a) }.find { |a| has_key = args.has_key?(a) } || param_name ) value = has_key ? args[arg_key] : _k[:default_value] is_set = has_key || _k.has_key?(:default_value) processed_parameters[proper_parameter_name] = _k.merge(:value => value, :is_set => is_set) unless is_set missing_required_arguments << proper_parameter_name if _k[:required] else args_out[proper_parameter_name] = value end { :arguments_out => args_out, :processed_parameters => processed_parameters, :missing_required_arguments => missing_required_arguments } end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 35 def self.process_parameters(params, args, options = { }) args = normalize_argument_hash_keys(args) || { } args_out = options[:arguments_out] || { } default_parameter_send_in_value = options[:default_parameter_send_in_value] || DEFAULT_PARAMETER_SEND_IN_VALUE processed_parameters = options[:processed_parameters] || { } missing_required_arguments = options[:missing_required_arguments] || [ ] params.each do |param| process_parameter(param, args, args_out, missing_required_arguments, processed_parameters, default_parameter_send_in_value) end { :arguments_out => args_out, :processed_parameters => processed_parameters, :missing_required_arguments => missing_required_arguments } end
Public Instance Methods
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 96 def after_initialize process_parameters if initialized end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 142 def after_process_parameters # TO BE IMPLEMENTED IN CHILD CLASS end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 156 def base_path @base_path ||= self.class::HTTP_BASE_PATH end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 138 def before_process_parameters # TO BE IMPLEMENTED IN CHILD CLASS end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 164 def body # body_arguments.empty? ? @body : body_arguments _body = @body _body_arguments = body_arguments return _body unless _body_arguments if _body.is_a?(Hash) && _body_arguments.is_a?(Hash) return _body.merge(_body_arguments) end _body_arguments end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 160 def body_arguments @body_arguments ||= arguments.dup.delete_if { |k,_| processed_parameters[k][:send_in] != :body } end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 184 def eval_http_path? @eval_http_path end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 242 def execute @response = http_client.call_method(http_method, { :path => path, :query => query, :body => body }, options) if client end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 234 def http_client client.http_client end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 192 def http_method @http_method ||= self.class::HTTP_METHOD end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 188 def http_path @http_path ||= self.class::HTTP_PATH.dup end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 238 def http_response @http_response ||= http_client.response.dup rescue nil end
@!group Attribute Readers
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 148 def http_success_code @http_success_code end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 100 def initialize_attributes @client = options[:client] @missing_required_arguments = [ ] @default_parameter_send_in_value = options[:default_parameter_send_in_value] || self.class::DEFAULT_PARAMETER_SEND_IN_VALUE @processed_parameters = { } @arguments = { } @eval_http_path = options.fetch(:eval_http_path, true) @base_path = options[:base_path] @parameters = options[:parameters] @http_method = options[:http_method] @http_path = options[:http_path] ||= options[:path_raw] @http_success_code = options[:http_success_code] ||= HTTP_SUCCESS_CODE @path = options[:path] @path_arguments = nil @query = options[:query] @query_arguments = nil @body = options[:body] @body_arguments = nil @relative_path = nil @response = nil @initialized = true end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 180 def logger @logger ||= client.logger end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 196 def parameters @parameters ||= self.class::PARAMETERS.dup end
The URI Path
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 205 def path @path ||= begin _path = File.join(base_path, (eval_http_path? ? eval(%("#{http_path}"), binding, __FILE__, __LINE__) : http_path)) _path.concat('/') if !_path.end_with?('/') && http_path.end_with?('/') _path end end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 213 def path_arguments @path_arguments ||= Hash[ arguments.dup.delete_if { |k, _| processed_parameters[k][:send_in] != :path }. map { |k,v| [ k, CGI.escape(v.respond_to?(:to_s) ? v.to_s : '').gsub('+', '%20') ] } ] end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 130 def process_parameters(params = parameters, args = @initial_arguments, options = @options) before_process_parameters unless options.fetch(:skip_before_process_parameters, false) self.class.process_parameters(params, args, options.merge(:processed_parameters => processed_parameters, :missing_required_arguments => missing_required_arguments, :default_parameter_send_in_value => default_parameter_send_in_value, :arguments_out => arguments)) after_process_parameters unless options.fetch(:skip_after_process_parameters, false) end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 220 def query @query ||= begin query_arguments.is_a?(Hash) ? query_arguments.map { |k,v| "#{CGI.escape(k.to_s).gsub('+', '%20')}=#{CGI.escape(v.respond_to?(:to_s) ? v.to_s : v).gsub('+', '%20')}" }.join('&') : query_arguments end end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 226 def query_arguments @query_arguments ||= arguments.dup.delete_if { |k,_| processed_parameters[k][:send_in] != :query } end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 200 def relative_path @relative_path ||= (path.start_with?('/') ? path[1..-1] : path) end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 246 def success? _response = client.http_client.response _response && ( http_success_code.is_a?(Array) ? http_success_code.include?(_response.code) : http_success_code == _response.code ) end
# File lib/ubiquity/iconik/api/client/requests/base_request.rb, line 230 def uri_request_path [ path ].concat( [*query].delete_if { |v| v.respond_to?(:empty?) and v.empty? } ).join('?') end