Class: Ubiquity::Envoi::API::Client::Requests::BaseRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/ubiquity/envoi/api/client/requests/base_request.rb

Constant Summary collapse

HTTP_METHOD = 
:get
HTTP_BASE_PATH = 
''
HTTP_PATH = 
''
HTTP_SUCCESS_CODE = 
200
DEFAULT_PARAMETER_SEND_IN_VALUE = 
:query
PARAMETERS = 
[ ]

Attribute Readers collapse

Instance Attribute Summary collapse

Attribute Readers collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = { }, options = { }) ⇒ BaseRequest

Returns a new instance of BaseRequest.



74
75
76
77
78
79
80
81
82
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 74

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

Instance Attribute Details

#arguments ⇒ Object

Returns the value of attribute arguments.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def arguments
  @arguments
end

#body ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 155

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

#client ⇒ Object

Returns the value of attribute client.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def client
  @client
end

#default_parameter_send_in_value ⇒ Object

Returns the value of attribute default_parameter_send_in_value.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def default_parameter_send_in_value
  @default_parameter_send_in_value
end

#initial_arguments ⇒ Object

Returns the value of attribute initial_arguments.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def initial_arguments
  @initial_arguments
end

#initial_options ⇒ Object

Returns the value of attribute initial_options.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def initial_options
  @initial_options
end

#initialized ⇒ Object

Returns the value of attribute initialized.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def initialized
  @initialized
end

#missing_required_arguments ⇒ Object

Returns the value of attribute missing_required_arguments.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def missing_required_arguments
  @missing_required_arguments
end

#options ⇒ Object

Returns the value of attribute options.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def options
  @options
end

#parameters ⇒ Object 



183
184
185
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 183

def parameters
  @parameters ||= self.class::PARAMETERS.dup
end

#path ⇒ Object

The URI Path



192
193
194
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 192

def path
  @path ||= File.join(base_path, (eval_http_path? ? eval(%("#{http_path}"), binding, __FILE__, __LINE__) : http_path))
end

#processed_parameters ⇒ Object

Returns the value of attribute processed_parameters.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def processed_parameters
  @processed_parameters
end

#query ⇒ Object 



203
204
205
206
207
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 203

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

#response ⇒ Object

Returns the value of attribute response.



19
20
21
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 19

def response
  @response
end

Class Method Details

.normalize_argument_hash_keys(hash) ⇒ Object 



24
25
26
27
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 24

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

.normalize_parameter_name(name) ⇒ Object 



29
30
31
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 29

def self.normalize_parameter_name(name)
  (name || '').respond_to?(:to_s) ? name.to_s.gsub('_', '').gsub('-', '').downcase : name
end

.process_parameter(param, args = { }, args_out = { }, missing_required_arguments = [ ], processed_parameters = { }, default_parameter_send_in_value = DEFAULT_PARAMETER_SEND_IN_VALUE, options = { }) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 33

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 }
rescue => e
  raise e, "Error Processing Parameter: #{param.inspect} Args: #{args.inspect}. #{e.message}"
end

.process_parameters(params, args, options = { }) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 61

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

Instance Method Details

#after_initialize ⇒ Object 



84
85
86
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 84

def after_initialize
  process_parameters if initialized
end

#after_process_parameters ⇒ Object Also known as: post_process_arguments 



132
133
134
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 132

def after_process_parameters
  # TO BE IMPLEMENTED IN CHILD CLASS
end

#base_path ⇒ Object 



147
148
149
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 147

def base_path
  @base_path ||= self.class::HTTP_BASE_PATH
end

#before_process_parameters ⇒ Object Also known as: pre_process_arguments 



127
128
129
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 127

def before_process_parameters
  # TO BE IMPLEMENTED IN CHILD CLASS
end

#body_arguments ⇒ Object 



151
152
153
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 151

def body_arguments
  @body_arguments ||= arguments.dup.delete_if { |k,_| processed_parameters[k][:send_in] != :body }
end

#eval_http_path? ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 171

def eval_http_path?
  @eval_http_path
end

#execute ⇒ Object 



231
232
233
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 231

def execute
  @response = http_client.call_method(http_method, { :path => relative_path, :query => query, :body => body }, options) if client
end

#http_client ⇒ Object

def response

client.response if client

end



223
224
225
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 223

def http_client
  client.http_client
end

#http_method ⇒ Object 



179
180
181
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 179

def http_method
  @http_method ||= self.class::HTTP_METHOD
end

#http_path ⇒ Object 



175
176
177
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 175

def http_path
  @http_path ||= self.class::HTTP_PATH
end

#http_response ⇒ Object 



227
228
229
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 227

def http_response
  @http_response ||= http_client.response.dup rescue nil
end

#http_success_code ⇒ Object 



139
140
141
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 139

def http_success_code
  @http_success_code
end

#initialize_attributes ⇒ Object Also known as: reset_attributes 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 88

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
  @path_only = nil

  @query = options[:query]
  @query_arguments = nil

  @body = options[:body]
  @body_arguments = nil

  @response = nil


  @relative_path = nil

  @initialized = true
end

#path_arguments ⇒ Object 



196
197
198
199
200
201
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 196

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

#process_parameters(params = parameters, args = @initial_arguments, _options = @options) ⇒ Object 



121
122
123
124
125
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 121

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

#query_arguments ⇒ Object 



209
210
211
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 209

def query_arguments
  @query_arguments ||= arguments.dup.delete_if { |k,_| processed_parameters[k][:send_in] != :query }
end

#relative_path ⇒ Object 



187
188
189
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 187

def relative_path
  @relative_path ||= (path.start_with?('/') ? path[1..-1] : path)
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
238
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 235

def success?
  _response = http_response and ([*http_success_code].include?(http_response.code))
  _response
end

#uri_request_path ⇒ Object 



213
214
215
 
# File 'lib/ubiquity/envoi/api/client/requests/base_request.rb', line 213

def uri_request_path
  [ path ].concat( [*query].delete_if { |v| v.respond_to?(:empty?) and v.empty? } ).join('?')
end