Class: ActiveRestClient::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/active_rest_client/request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method, object, params = {}) ⇒ Request

Returns a new instance of Request.



9
10
11
12
13
14
15
16
17
 
# File 'lib/active_rest_client/request.rb', line 9

def initialize(method, object, params = {})
  @method                  = method
  @method[:options]        ||= {}
  @method[:options][:lazy] ||= []
  @overriden_name          = @method[:options][:overriden_name]
  @object                  = object
  @params                  = params
  @headers                 = HeadersList.new
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def body
  @body
end

#forced_url ⇒ Object

Returns the value of attribute forced_url.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def forced_url
  @forced_url
end

#get_params ⇒ Object

Returns the value of attribute get_params.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def get_params
  @get_params
end

#headers ⇒ Object

Returns the value of attribute headers.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def headers
  @headers
end

#method ⇒ Object

Returns the value of attribute method.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def method
  @method
end

#object ⇒ Object

Returns the value of attribute object.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def object
  @object
end

#original_url ⇒ Object

Returns the value of attribute original_url.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def original_url
  @original_url
end

#path ⇒ Object

Returns the value of attribute path.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def path
  @path
end

#post_params ⇒ Object

Returns the value of attribute post_params.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def post_params
  @post_params
end

#url ⇒ Object

Returns the value of attribute url.



7
8
9
 
# File 'lib/active_rest_client/request.rb', line 7

def url
  @url
end

Instance Method Details

#append_get_parameters ⇒ Object 



155
156
157
158
159
160
 
# File 'lib/active_rest_client/request.rb', line 155

def append_get_parameters
  if @get_params.any?
    params = @get_params.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}
    @url += "?" + params.sort * "&"
  end
end

#base_url ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/active_rest_client/request.rb', line 31

def base_url
  if object_is_class?
    @object.base_url
  else
    @object.class.base_url
  end
end

#call(explicit_parameters = nil) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
 
# File 'lib/active_rest_client/request.rb', line 69

def call(explicit_parameters=nil)
  @instrumentation_name = "#{class_name}##{@method[:name]}"
  result = nil
  cached = nil
  ActiveSupport::Notifications.instrument("request_call.active_rest_client", :name => @instrumentation_name) do
    if @method[:options][:fake]
      ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Faked response found"
      return handle_response(OpenStruct.new(status:200, body:@method[:options][:fake], headers:{"X-ARC-Faked-Response" => "true"}))
    end
    @explicit_parameters = explicit_parameters
    @body = nil
    prepare_params
    prepare_url
    if object_is_class?
      @object.send(:_filter_request, @method[:name], self)
    else
      @object.class.send(:_filter_request, @method[:name], self)
    end
    append_get_parameters
    prepare_request_body
    self.original_url = self.url
    cached = ActiveRestClient::Base.read_cached_response(self)
    if cached
      if cached.expires && cached.expires > Time.now
        ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Absolutely cached copy found"
        return handle_cached_response(cached)
      elsif cached.etag.present?
        ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}"
        etag = cached.etag
      end
    end
    response = if proxy
      proxy.handle(self) do |request|
        request.do_request(etag)
      end
    else
      do_request(etag)
    end
    if object_is_class? && @object.record_response?
      @object.record_response(self.url, response)
    end
    result = handle_response(response)
    if result == :not_modified && cached
      result = cached.result
    end
    ActiveRestClient::Base.write_cached_response(self, response, result)
    result
  end
end

#class_name ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/active_rest_client/request.rb', line 23

def class_name
  if object_is_class?
    @object.name
  else
    @object.class.name
  end
end

#do_request(etag) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/active_rest_client/request.rb', line 166

def do_request(etag)
  http_headers = {}
  http_headers["If-None-Match"] = etag if etag
  http_headers["Accept"] = "application/hal+json, application/json;q=0.5"
  headers.each do |key,value|
    value = value.join(",") if value.is_a?(Array)
    http_headers[key] = value
  end
  if @method[:options][:url] || @forced_url
    @url = @method[:options][:url]
    @url = @forced_url if @forced_url
    if connection = ActiveRestClient::ConnectionManager.find_connection_for_url(@url)
      @url = @url.slice(connection.base_url.length, 255)
    else
      parts = @url.match(%r{^(https?://[a-z\d\.:-]+?)(/.*)}).to_a
      if (parts.empty?) # Not a full URL, so use hostname/protocol from existing base_url
        uri = URI.parse(base_url)
        @base_url = "#{uri.scheme}://#{uri.host}#{":#{uri.port}" if uri.port != 80 && uri.port != 443}"
      else
        _, @base_url, @url = parts
      end
      connection = ActiveRestClient::ConnectionManager.get_connection(@base_url)
    end
  else
    connection = ActiveRestClient::ConnectionManager.get_connection(base_url)
  end
  ActiveRestClient::Logger.info "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}"

  if verbose?
    ActiveRestClient::Logger.debug "ActiveRestClient Verbose Log:"
    ActiveRestClient::Logger.debug "  > GET #{@url} HTTP/1.1"
    http_headers.each do |k,v|
      ActiveRestClient::Logger.debug "  > #{k} : #{v}"
    end
    ActiveRestClient::Logger.debug "  > #{@body}"
  end

  case http_method
  when :get
    response = connection.get(@url, http_headers)
  when :put
    response = connection.put(@url, @body, http_headers)
  when :post
    response = connection.post(@url, @body, http_headers)
  when :delete
    response = connection.delete(@url, http_headers)
  else
    raise InvalidRequestException.new("Invalid method #{http_method}")
  end

  if verbose?
    response.headers.each do |k,v|
      ActiveRestClient::Logger.debug "  < #{k} : #{v}"
    end
    ActiveRestClient::Logger.debug "  < #{response.body}"
  end

  response
end

#hal_response? ⇒ Boolean

Returns:

  • (Boolean) 


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/active_rest_client/request.rb', line 339

def hal_response?
  _, content_type = @response.headers.detect{|k,v| k.downcase == "content-type"}
  faked_response = @response.headers.detect{|k,v| k.downcase == "x-arc-faked-response"}
  if content_type && content_type.respond_to?(:each)
    content_type.each do |ct|
      return true if ct[%r{application\/hal\+json}i]
      return true if ct[%r{application\/json}i]
    end
    faked_response
  elsif content_type && (content_type[%r{application\/hal\+json}i] || content_type[%r{application\/json}i]) || faked_response
    true
  else
    false
  end
end

#handle_cached_response(cached) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/active_rest_client/request.rb', line 226

def handle_cached_response(cached)
  if cached.result.is_a? ActiveRestClient::ResultIterator
    cached.result
  else
    if object_is_class?
      cached.result
    else
      @object._copy_from(cached.result)
      @object
    end
  end
end

#handle_hal_links_embedded(object, attributes) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/active_rest_client/request.rb', line 355

def handle_hal_links_embedded(object, attributes)
  attributes["_links"] = attributes[:_links] if attributes[:_links]
  attributes["_embedded"] = attributes[:_embedded] if attributes[:_embedded]
  if attributes["_links"]
    attributes["_links"].each do |key, value|
      if value.is_a?(Array)
        object._attributes[key.to_sym] ||= ActiveRestClient::ResultIterator.new
        value.each do |element|
          begin
            embedded_version = attributes["_embedded"][key].detect{|embed| embed["_links"]["self"]["href"] == element["href"]}
            object._attributes[key.to_sym] << new_object(embedded_version, key)
          rescue NoMethodError
            object._attributes[key.to_sym] << ActiveRestClient::LazyAssociationLoader.new(key, element, self)
          end
        end
      else
        begin
          embedded_version = attributes["_embedded"][key]
          object._attributes[key.to_sym] = new_object(embedded_version, key)
        rescue NoMethodError
          object._attributes[key.to_sym] = ActiveRestClient::LazyAssociationLoader.new(key, value, self)
        end
      end
    end
    attributes.delete("_links")
    attributes.delete("_embedded")
  end

  attributes
end

#handle_response(response) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/active_rest_client/request.rb', line 239

def handle_response(response)
  if response.status == 304
    ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Etag copy is the same as the server"
    return :not_modified
  end
  if response.respond_to?(:proxied) && response.proxied
    ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"
  else
    ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response received #{response.body.size} bytes"
  end
  @response = response

  if response.body.is_a?(Array) || response.body.is_a?(Hash)
    body = response.body
  else
    body = Oj.load(response.body) || {}
  end
  body = begin
    @method[:name].nil? ? body : translator.send(@method[:name], body)
  rescue NoMethodError
    body
  end
  if body.is_a? Array
    result = ActiveRestClient::ResultIterator.new(response.status)
    body.each do |json_object|
      result << new_object(json_object, @overriden_name)
    end
  else
    result = new_object(body, @overriden_name)
    result._status = response.status
    unless object_is_class?
      @object._copy_from(result)
      result = @object
    end
  end

  response.status ||= 200
  if response.status == 401
    raise HTTPUnauthorisedClientException.new(status:response.status, result:result, url:@url)
  elsif response.status == 403
    raise HTTPForbiddenClientException.new(status:response.status, result:result, url:@url)
  elsif response.status == 404
    raise HTTPNotFoundClientException.new(status:response.status, result:result, url:@url)
  elsif (400..499).include? response.status
    raise HTTPClientException.new(status:response.status, result:result, url:@url)
  elsif (500..599).include? response.status
    raise HTTPServerException.new(status:response.status, result:result, url:@url)
  end

  result
rescue Oj::ParseError
  raise ResponseParseException.new(status:response.status, body:response.body)
end

#http_method ⇒ Object 



65
66
67
 
# File 'lib/active_rest_client/request.rb', line 65

def http_method
  @method[:method]
end

#new_object(attributes, name = nil) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/active_rest_client/request.rb', line 293

def new_object(attributes, name = nil)
  @method[:options][:has_many] ||= {}
  name = name.to_sym rescue nil
  if @method[:options][:has_many][name]
    overriden_name = name
    object = @method[:options][:has_many][name].new
  else
    if object_is_class?
      object = @object.new
    else
      object = @object.class.new
    end
  end

  if hal_response? && name.nil?
    attributes = handle_hal_links_embedded(object, attributes)
  end

  attributes.each do |k,v|
    k = k.to_sym
    if @method[:options][:lazy].include?(k)
      object._attributes[k] = ActiveRestClient::LazyAssociationLoader.new(overriden_name || k, v, self, overriden_name:(overriden_name||k))
    elsif v.is_a? Hash
      object._attributes[k] = new_object(v, overriden_name || k)
    elsif v.is_a? Array
      object._attributes[k] = ActiveRestClient::ResultIterator.new
      v.each do |item|
        if item.is_a? Hash
          object._attributes[k] << new_object(item, overriden_name || k)
        else
          object._attributes[k] << item
        end
      end
    else
      if v.to_s[/\d{4}\-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})/]
        object._attributes[k] = DateTime.parse(v)
      else
        object._attributes[k] = v
      end
    end
  end
  object.clean! unless object_is_class?

  object
end

#object_is_class? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/active_rest_client/request.rb', line 19

def object_is_class?
  !@object.respond_to?(:dirty?)
end

#prepare_params ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/active_rest_client/request.rb', line 119

def prepare_params
  params = @params || @object._attributes rescue {}
  if params.is_a?(String) || params.is_a?(Fixnum)
    params = {id:params}
  end

  default_params = @method[:options][:defaults] || {}

  if @explicit_parameters
    params = @explicit_parameters
  end
  if http_method == :get
    @get_params = default_params.merge(params || {})
    @post_params = nil
  else
    @post_params = default_params.merge(params || {})
    @get_params = {}
  end
end

#prepare_request_body(params = nil) ⇒ Object 



162
163
164
 
# File 'lib/active_rest_client/request.rb', line 162

def prepare_request_body(params = nil)
  @body ||= (params || @post_params || {}).map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.sort * "&"
end

#prepare_url ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/active_rest_client/request.rb', line 139

def prepare_url
  if @forced_url && @forced_url.present?
    @url = @forced_url
  else
    @url = @method[:url].dup
    matches = @url.scan(/(:[a-z_-]+)/)
    @get_params ||= {}
    @post_params ||= {}
    matches.each do |token|
      token = token.first[1,999]
      target = @get_params.delete(token.to_sym) || @post_params.delete(token.to_sym) || @get_params.delete(token.to_s) || @post_params.delete(token.to_s) || ""
      @url.gsub!(":#{token}", target.to_s)
    end
  end
end

#proxy ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/active_rest_client/request.rb', line 55

def proxy
  if object_is_class?
    @object.proxy
  else
    @object.class.proxy
  end
rescue
  nil
end

#translator ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/active_rest_client/request.rb', line 47

def translator
  if object_is_class?
    @object.translator
  else
    @object.class.translator
  end
end

#verbose? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
42
43
44
45
 
# File 'lib/active_rest_client/request.rb', line 39

def verbose?
  if object_is_class?
    @object.verbose
  else
    @object.class.verbose
  end
end