Class: Flexirest::Request
- Inherits:
-
Object
- Object
- Flexirest::Request
- Includes:
- ActiveSupport::Inflector, AttributeParsing, JsonAPIProxy
- Defined in:
- lib/flexirest/request.rb
Instance Attribute Summary collapse
-
#body ⇒ Object
Returns the value of attribute body.
-
#forced_url ⇒ Object
Returns the value of attribute forced_url.
-
#get_params ⇒ Object
Returns the value of attribute get_params.
-
#headers ⇒ Object
Returns the value of attribute headers.
-
#method ⇒ Object
Returns the value of attribute method.
-
#object ⇒ Object
Returns the value of attribute object.
-
#original_url ⇒ Object
Returns the value of attribute original_url.
-
#path ⇒ Object
Returns the value of attribute path.
-
#post_params ⇒ Object
Returns the value of attribute post_params.
-
#retrying ⇒ Object
Returns the value of attribute retrying.
-
#url ⇒ Object
Returns the value of attribute url.
Instance Method Summary collapse
- #api_auth_access_id ⇒ Object
- #api_auth_options ⇒ Object
- #api_auth_secret_key ⇒ Object
- #append_get_parameters ⇒ Object
- #base_url ⇒ Object
- #basic_auth_digest ⇒ Object
- #call(explicit_parameters = nil) ⇒ Object
- #class_name ⇒ Object
- #delete? ⇒ Boolean
- #do_request(etag) ⇒ Object
- #get? ⇒ Boolean
- #hal_response? ⇒ Boolean
- #handle_cached_response(cached) ⇒ Object
- #handle_hal_links_embedded(object, attributes) ⇒ Object
- #handle_response(response, cached = nil) ⇒ Object
- #http_method ⇒ Object
- #ignore_root ⇒ Object
-
#initialize(method, object, params = {}) ⇒ Request
constructor
A new instance of Request.
- #inject_basic_auth_in_url(url) ⇒ Object
- #model_class ⇒ Object
- #new_object(attributes, name = nil, parent = nil, parent_attribute_name = nil) ⇒ Object
- #object_is_class? ⇒ Boolean
- #original_object_class ⇒ Object
- #password ⇒ Object
- #post? ⇒ Boolean
- #prepare_params ⇒ Object
- #prepare_request_body(params = nil) ⇒ Object
- #prepare_url ⇒ Object
- #proxy ⇒ Object
- #put? ⇒ Boolean
- #request_body_type ⇒ Object
- #set_corresponding_value(value, key = nil, object = nil, overridden_name = nil) ⇒ Object
- #translator ⇒ Object
- #username ⇒ Object
- #using_api_auth? ⇒ Boolean
- #using_basic_auth? ⇒ Boolean
- #verbose? ⇒ Boolean
- #wrap_root ⇒ Object
Constructor Details
#initialize(method, object, params = {}) ⇒ Request
Returns a new instance of Request.
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/flexirest/request.rb', line 14 def initialize(method, object, params = {}) @method = method @method[:options] ||= {} @method[:options][:lazy] ||= [] @method[:options][:array] ||= [] @method[:options][:has_one] ||= {} @overridden_name = @method[:options][:overridden_name] @object = object @response_delegate = Flexirest::RequestDelegator.new(nil) @params = params @headers = HeadersList.new (@method[:options][:headers] || {}).each do |k,v| @headers[k] = v end @forced_url = nil end |
Instance Attribute Details
#body ⇒ Object
Returns the value of attribute body.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def body @body end |
#forced_url ⇒ Object
Returns the value of attribute forced_url.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def forced_url @forced_url end |
#get_params ⇒ Object
Returns the value of attribute get_params.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def get_params @get_params end |
#headers ⇒ Object
Returns the value of attribute headers.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def headers @headers end |
#method ⇒ Object
Returns the value of attribute method.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def method @method end |
#object ⇒ Object
Returns the value of attribute object.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def object @object end |
#original_url ⇒ Object
Returns the value of attribute original_url.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def original_url @original_url end |
#path ⇒ Object
Returns the value of attribute path.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def path @path end |
#post_params ⇒ Object
Returns the value of attribute post_params.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def post_params @post_params end |
#retrying ⇒ Object
Returns the value of attribute retrying.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def @retrying end |
#url ⇒ Object
Returns the value of attribute url.
12 13 14 |
# File 'lib/flexirest/request.rb', line 12 def url @url end |
Instance Method Details
#api_auth_access_id ⇒ Object
75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/flexirest/request.rb', line 75 def api_auth_access_id ret = nil if object_is_class? ret = @object.api_auth_access_id ret = ret.call if ret.respond_to?(:call) else ret = @object.class.api_auth_access_id ret = ret.call(@object) if ret.respond_to?(:call) end ret end |
#api_auth_options ⇒ Object
99 100 101 102 103 104 105 |
# File 'lib/flexirest/request.rb', line 99 def if object_is_class? @object. else @object.class. end end |
#api_auth_secret_key ⇒ Object
87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/flexirest/request.rb', line 87 def api_auth_secret_key ret = nil if object_is_class? ret = @object.api_auth_secret_key ret = ret.call if ret.respond_to?(:call) else ret = @object.class.api_auth_secret_key ret = ret.call(@object) if ret.respond_to?(:call) end ret end |
#append_get_parameters ⇒ Object
441 442 443 444 445 446 447 448 449 |
# File 'lib/flexirest/request.rb', line 441 def append_get_parameters if @get_params.any? if @method[:options][:params_encoder] == :flat @url += "?" + URI.encode_www_form(@get_params) else @url += "?" + @get_params.to_query end end end |
#base_url ⇒ Object
55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/flexirest/request.rb', line 55 def base_url if object_is_class? url = @object.base_url else url = @object.class.base_url end if url.is_a?(Array) url = url.sample end url end |
#basic_auth_digest ⇒ Object
139 140 141 |
# File 'lib/flexirest/request.rb', line 139 def basic_auth_digest Base64.strict_encode64("#{username}:#{password}") end |
#call(explicit_parameters = nil) ⇒ Object
225 226 227 228 229 230 231 232 233 234 235 236 237 238 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 292 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 |
# File 'lib/flexirest/request.rb', line 225 def call(explicit_parameters=nil) @instrumentation_name = "#{class_name}##{@method[:name]}" result = nil cached = nil ActiveSupport::Notifications.instrument("request_call.flexirest", :name => @instrumentation_name) do @explicit_parameters = explicit_parameters @body = nil prepare_params prepare_url fake = @method[:options][:fake] if fake.present? if fake.respond_to?(:call) fake = fake.call(self) elsif @object.respond_to?(fake) fake = @object.send(fake) elsif @object.class.respond_to?(fake) fake = @object.class.send(fake) elsif @object.new.respond_to?(fake) fake = @object.new.send(fake) elsif @object.class.new.respond_to?(fake) fake = @object.class.new.send(fake) end Flexirest::Logger.debug " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Faked response found" content_type = @method[:options][:fake_content_type] || "application/json" return handle_response(OpenStruct.new(status:200, body:fake, response_headers:{"X-ARC-Faked-Response" => "true", "Content-Type" => content_type})) end if object_is_class? callback_result = @object.send(:_callback_request, :before, @method[:name], self) else callback_result = @object.class.send(:_callback_request, :before, @method[:name], self) end if callback_result == false return false end append_get_parameters prepare_request_body self.original_url = self.url cached = original_object_class.read_cached_response(self) if cached && !cached.is_a?(String) if cached.expires && cached.expires > Time.now Flexirest::Logger.debug " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Absolutely cached copy found" return handle_cached_response(cached) elsif cached.etag.to_s != "" #present? isn't working for some reason Flexirest::Logger.debug " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}" etag = cached.etag end end response = ( if proxy && proxy.is_a?(Class) proxy.handle(self) do |request| request.do_request(etag) end else do_request(etag) end ) # This block is called immediately when this request is not inside a parallel request block. # Otherwise this callback is called after the parallel request block ends. response.on_complete do |response_env| if verbose? Flexirest::Logger.debug " Response" Flexirest::Logger.debug " << Status : #{response_env.status}" response_env.response_headers.each do |k,v| Flexirest::Logger.debug " << #{k} : #{v}" end Flexirest::Logger.debug " << Body:\n#{response_env.body}" end if object_is_class? && @object.record_response? @object.record_response(self.url, response_env) end begin if object_is_class? callback_result = @object.send(:_callback_request, :after, @method[:name], response_env) else callback_result = @object.class.send(:_callback_request, :after, @method[:name], response_env) end rescue Flexirest::CallbackRetryRequestException if self. != true self. = true return call() end end result = handle_response(response_env, cached) @response_delegate.__setobj__(result) original_object_class.write_cached_response(self, response_env, result) unless @method[:options][:skip_caching] end # If this was not a parallel request just return the original result return result if response.finished? # Otherwise return the delegate which will get set later once the call back is completed return @response_delegate end end |
#class_name ⇒ Object
39 40 41 42 43 44 45 |
# File 'lib/flexirest/request.rb', line 39 def class_name if object_is_class? @object.name else @object.class.name end end |
#delete? ⇒ Boolean
221 222 223 |
# File 'lib/flexirest/request.rb', line 221 def delete? http_method == :delete end |
#do_request(etag) ⇒ Object
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
# File 'lib/flexirest/request.rb', line 524 def do_request(etag) http_headers = {} http_headers["If-None-Match"] = etag if etag && !@method[:options][:skip_caching] 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] || @method[:url] @url = @forced_url if @forced_url if connection = Flexirest::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}" @url = "#{base_url}#{@url}".gsub(@base_url, "") else _, @base_url, @url = parts end if using_basic_auth? && model_class.basic_auth_method == :url inject_basic_auth_in_url(base_url) end connection = Flexirest::ConnectionManager.get_connection(base_url) end 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}" @url = "#{base_url}#{@url}".gsub(@base_url, "") base_url = @base_url else base_url = parts[0] end if using_basic_auth? && model_class.basic_auth_method == :url inject_basic_auth_in_url(base_url) end connection = Flexirest::ConnectionManager.get_connection(base_url) end if @method[:options][:direct] Flexirest::Logger.info " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{@url}" else Flexirest::Logger.info " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}" end if verbose? Flexirest::Logger.debug "Flexirest Verbose Log:" Flexirest::Logger.debug " Request" Flexirest::Logger.debug " >> #{http_method.upcase} #{@url} HTTP/1.1" http_headers.each do |k,v| Flexirest::Logger.debug " >> #{k} : #{v}" end Flexirest::Logger.debug " >> Body:\n#{@body}" end = {:headers => http_headers} if using_api_auth? [:api_auth] = { :api_auth_access_id => api_auth_access_id, :api_auth_secret_key => api_auth_secret_key, :api_auth_options => } elsif using_basic_auth? && model_class.basic_auth_method == :header http_headers["Authorization"] = "Basic #{basic_auth_digest}" end if @method[:options][:timeout] [:timeout] = @method[:options][:timeout] end case http_method when :get response = connection.get(@url, ) when :put response = connection.put(@url, @body, ) when :post response = connection.post(@url, @body, ) when :patch response = connection.patch(@url, @body, ) when :delete response = connection.delete(@url, @body, ) else raise InvalidRequestException.new("Invalid method #{http_method}") end response end |
#get? ⇒ Boolean
209 210 211 |
# File 'lib/flexirest/request.rb', line 209 def get? http_method == :get end |
#hal_response? ⇒ Boolean
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 |
# File 'lib/flexirest/request.rb', line 779 def hal_response? _, content_type = @response.response_headers.detect{|k,v| k.downcase == "content-type"} faked_response = @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
614 615 616 617 618 619 620 621 622 623 624 625 |
# File 'lib/flexirest/request.rb', line 614 def handle_cached_response(cached) if cached.result.is_a? Flexirest::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
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 |
# File 'lib/flexirest/request.rb', line 795 def (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] ||= Flexirest::ResultIterator.new value.each do |element| begin = attributes["_embedded"][key].detect{|| ["_links"]["self"]["href"] == element["href"]} object._attributes[key.to_sym] << new_object(, key) rescue NoMethodError object._attributes[key.to_sym] << Flexirest::LazyAssociationLoader.new(key, element, self) end end else begin = attributes["_embedded"][key] object._attributes[key.to_sym] = new_object(, key) rescue NoMethodError object._attributes[key.to_sym] = Flexirest::LazyAssociationLoader.new(key, value, self) end end end attributes.delete("_links") attributes.delete("_embedded") end attributes end |
#handle_response(response, cached = nil) ⇒ Object
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 |
# File 'lib/flexirest/request.rb', line 627 def handle_response(response, cached = nil) @response = response status = @response.status || 200 if @response.body.blank? && !@method[:options][:ignore_empty_response] @response.response_headers['Content-Type'] = "application/json" @response.body = "{}" end if cached && response.status == 304 Flexirest::Logger.debug " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name}" + ' - Etag copy is the same as the server' return handle_cached_response(cached) end if (200..399).include?(status) if status == 204 || (@response.body.blank? && @method[:options][:ignore_empty_response]) return true end if @method[:options][:plain] return @response = Flexirest::PlainResponse.from_response(@response) elsif is_json_response? || is_xml_response? if @response.respond_to?(:proxied) && @response.proxied Flexirest::Logger.debug " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size" else Flexirest::Logger.debug " \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes" end result = generate_new_object(ignore_root: ignore_root, ignore_xml_root: @method[:options][:ignore_xml_root]) # TODO: Cleanup when ignore_xml_root is removed else raise ResponseParseException.new(status:status, body:@response.body, headers: @response.headers) end else if is_json_response? || is_xml_response? error_response = generate_new_object(mutable: false, ignore_xml_root: @method[:options][:ignore_xml_root]) else error_response = @response.body end if status == 400 raise HTTPBadRequestClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 401 raise HTTPUnauthorisedClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 403 raise HTTPForbiddenClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 404 raise HTTPNotFoundClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 405 raise HTTPMethodNotAllowedClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 406 raise HTTPNotAcceptableClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 408 raise HTTPTimeoutClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 409 raise HTTPConflictClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 429 raise HTTPTooManyRequestsClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 500 raise HTTPInternalServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 501 raise HTTPNotImplementedServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 502 raise HTTPBadGatewayServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 503 raise HTTPServiceUnavailableServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 504 raise HTTPGatewayTimeoutServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif (400..499).include? status raise HTTPClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif (500..599).include? status raise HTTPServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method) elsif status == 0 raise TimeoutException.new("Timed out getting #{response.url}") end end result end |
#http_method ⇒ Object
205 206 207 |
# File 'lib/flexirest/request.rb', line 205 def http_method @method[:method] end |
#ignore_root ⇒ Object
155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/flexirest/request.rb', line 155 def ignore_root if @method[:options][:ignore_root] @method[:options][:ignore_root] elsif @object.nil? nil elsif object_is_class? @object.ignore_root else @object.class.ignore_root end end |
#inject_basic_auth_in_url(url) ⇒ Object
131 132 133 |
# File 'lib/flexirest/request.rb', line 131 def inject_basic_auth_in_url(url) url.gsub!(%r{//(.)}, "//#{username}:#{password}@\\1") if !url[%r{//[^/]*:[^/]*@}] end |
#model_class ⇒ Object
35 36 37 |
# File 'lib/flexirest/request.rb', line 35 def model_class object_is_class? ? @object : @object.class end |
#new_object(attributes, name = nil, parent = nil, parent_attribute_name = nil) ⇒ Object
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 |
# File 'lib/flexirest/request.rb', line 704 def new_object(attributes, name = nil, parent = nil, parent_attribute_name = nil) @method[:options][:has_many] ||= {} name = name.to_sym rescue nil if @method[:options][:has_many][name] overridden_name = name object = @method[:options][:has_many][name].new elsif @method[:options][:has_one][name] overridden_name = name object = @method[:options][:has_one][name].new else object = create_object_instance end object._parent = parent object._parent_attribute_name = parent_attribute_name if hal_response? && name.nil? attributes = (object, attributes) end attributes.each do |k,v| if @method[:options][:rubify_names] k = rubify_name(k) else k = k.to_sym end overridden_name = select_name(k, overridden_name) set_corresponding_value(v, k, object, overridden_name) end object.clean! unless object_is_class? object end |
#object_is_class? ⇒ Boolean
31 32 33 |
# File 'lib/flexirest/request.rb', line 31 def object_is_class? !@object.respond_to?(:dirty?) end |
#original_object_class ⇒ Object
47 48 49 50 51 52 53 |
# File 'lib/flexirest/request.rb', line 47 def original_object_class if object_is_class? @object else @object.class end end |
#password ⇒ Object
119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/flexirest/request.rb', line 119 def password ret = nil if object_is_class? ret = @object.password ret = ret.call if ret.respond_to?(:call) else ret = @object.class.password ret = ret.call(@object) if ret.respond_to?(:call) end ret end |
#post? ⇒ Boolean
213 214 215 |
# File 'lib/flexirest/request.rb', line 213 def post? http_method == :post end |
#prepare_params ⇒ Object
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 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 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 |
# File 'lib/flexirest/request.rb', line 325 def prepare_params if http_method == :post || http_method == :put || http_method == :patch params = (@object._attributes rescue {}).merge(@params || {}) rescue {} else params = @params || @object._attributes rescue {} end if params.is_a?(String) || params.is_a?(Integer) params = {id:params} end # Format includes parameter for jsonapi if proxy == :json_api JsonAPIProxy::Request::Params.translate(params, @object._include_associations) @object._reset_include_associations! end if @method[:options][:defaults].respond_to?(:call) default_params = @method[:options][:defaults].call(params) else default_params = @method[:options][:defaults] || {} end if @explicit_parameters params = @explicit_parameters end if http_method == :get || (http_method == :delete && !@method[:options][:send_delete_body] && proxy != :json_api) @get_params = default_params.merge(params || {}) @post_params = nil elsif http_method == :delete && @method[:options][:send_delete_body] @post_params = default_params.merge(params || {}) @get_params = {} elsif params.is_a? String @post_params = params @get_params = {} else @post_params = (default_params || {}).merge(params || {}) @get_params = {} end # Evaluate :only_changed if @method[:options][:only_changed] if http_method == :post or http_method == :put or http_method == :patch # we only ever mess with @post_params in here, because @get_params will/should never match our method criteria if @method[:options][:only_changed].is_a? Hash # only include the listed attributes marked 'true' when they are changed; attributed marked false are always included newPostHash = {} @method[:options][:only_changed].each_pair do |changed_attr_k,changed_attr_v| if changed_attr_v == false or @object.changes.has_key? changed_attr_k.to_sym newPostHash[changed_attr_k.to_sym] = @object[changed_attr_k.to_sym] end end @post_params = newPostHash elsif @method[:options][:only_changed].is_a? Array # only send these listed attributes, and only if they are changed newPostHash = {} @method[:options][:only_changed].each do |changed_attr| if @object.changes.has_key? changed_attr.to_sym newPostHash[changed_attr.to_sym] = @object[changed_attr.to_sym] end end @post_params = newPostHash else # only send attributes if they are changed, drop the rest newPostHash = {} @object.changed.each do |k| newPostHash[k] = @object[k] end @post_params = newPostHash end end end if @method[:options][:requires] requires = @method[:options][:requires].dup merged_params = @get_params.merge(@post_params || {}) missing = [] requires.each do |key| if merged_params[key.to_sym].blank? && ![true, false].include?(merged_params[key.to_sym]) missing << key end end if missing.any? raise Flexirest::MissingParametersException.new("The following parameters weren't specifed: #{missing.join(", ")}") end end end |
#prepare_request_body(params = nil) ⇒ Object
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 |
# File 'lib/flexirest/request.rb', line 451 def prepare_request_body(params = nil) if proxy == :json_api if http_method == :get || (http_method == :delete && !@method[:options][:send_delete_body]) @body = "" else headers["Content-Type"] ||= "application/vnd.api+json" @body = JsonAPIProxy::Request::Params.create( params || @post_params || {}, object_is_class? ? @object.new : @object ).to_json end headers["Accept"] ||= "application/vnd.api+json" JsonAPIProxy::Headers.save(headers) elsif http_method == :get || (http_method == :delete && !@method[:options][:send_delete_body]) if request_body_type == :form_encoded headers["Content-Type"] ||= "application/x-www-form-urlencoded; charset=utf-8" elsif request_body_type == :form_multipart headers["Content-Type"] ||= "multipart/form-data; charset=utf-8" elsif request_body_type == :json headers["Content-Type"] ||= "application/json; charset=utf-8" end @body = "" elsif request_body_type == :form_encoded @body ||= if params.is_a?(String) params elsif @post_params.is_a?(String) @post_params else p = (params || @post_params || {}) if wrap_root.present? p = {wrap_root => p} end p.to_query end headers["Content-Type"] ||= "application/x-www-form-urlencoded" elsif request_body_type == :form_multipart headers["Content-Type"] ||= "multipart/form-data; charset=utf-8" @body ||= if params.is_a?(String) params elsif @post_params.is_a?(String) @post_params else p = (params || @post_params || {}) if wrap_root.present? p = {wrap_root => p} end data, mp_headers = Flexirest::Multipart::Post.prepare_query(p) mp_headers.each do |k,v| headers[k] = v end data end elsif request_body_type == :json @body ||= if params.is_a?(String) params elsif @post_params.is_a?(String) @post_params else if wrap_root.present? {wrap_root => (params || @post_params || {})}.to_json else (params || @post_params || {}).to_json end end headers["Content-Type"] ||= "application/json; charset=utf-8" elsif request_body_type == :plain && @post_params[:body].present? @body = @post_params[:body] headers["Content-Type"] ||= "text/plain" headers["Content-Type"] = @post_params[:content_type] if @post_params[:content_type].present? end end |
#prepare_url ⇒ Object
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/flexirest/request.rb', line 412 def prepare_url missing = [] 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] # pull URL path variables out of @get_params/@post_params 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) || "" unless object_is_class? # it's possible the URL path variable may not be part of the request, in that case, try to resolve it from the object attributes target = @object._attributes[token.to_sym] || "" if target == "" end if target.to_s.blank? missing << token end @url.gsub!(":#{token}", URI.encode_www_form_component(target.to_s)) end end if missing.present? raise Flexirest::MissingParametersException.new("The following parameters weren't specifed: #{missing.join(", ")}") end end |
#proxy ⇒ Object
195 196 197 198 199 200 201 202 203 |
# File 'lib/flexirest/request.rb', line 195 def proxy if object_is_class? @object.proxy else @object.class.proxy end rescue nil end |
#put? ⇒ Boolean
217 218 219 |
# File 'lib/flexirest/request.rb', line 217 def put? http_method == :put end |
#request_body_type ⇒ Object
143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/flexirest/request.rb', line 143 def request_body_type if @method[:options][:request_body_type] @method[:options][:request_body_type] elsif @object.nil? nil elsif object_is_class? @object.request_body_type else @object.class.request_body_type end end |
#set_corresponding_value(value, key = nil, object = nil, overridden_name = nil) ⇒ Object
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/flexirest/request.rb', line 738 def set_corresponding_value(value, key = nil, object = nil, overridden_name = nil) optional_args = [key, object, overridden_name] value_from_object = optional_args.all? # trying to parse a JSON Hash value value_from_other_type = optional_args.none? # trying to parse anything else raise Flexirest::InvalidArgumentsException.new("Optional args need all to be filled or none") unless value_from_object || value_from_other_type k = key || :key v = value assignable_hash = value_from_object ? object._attributes : {} if value_from_object && @method[:options][:lazy].include?(k) assignable_hash[k] = Flexirest::LazyAssociationLoader.new(overridden_name, v, self, overridden_name:(overridden_name), parent: object, parent_attribute_name: k) elsif v.is_a? Hash assignable_hash[k] = new_object(v, overridden_name, object, k) elsif v.is_a? Array if @method[:options][:array].include?(k) assignable_hash[k] = Array.new else assignable_hash[k] = Flexirest::ResultIterator.new end v.each do |item| if item.is_a? Hash assignable_hash[k] << new_object(item, overridden_name) else assignable_hash[k] << set_corresponding_value(item) end end else parse_fields = [ @method[:options][:parse_fields], @object._date_fields ].compact.reduce([], :|) parse_fields = nil if parse_fields.empty? if (parse_fields && parse_fields.include?(k)) assignable_hash[k] = parse_attribute_value(v) elsif parse_fields assignable_hash[k] = v elsif Flexirest::Base.disable_automatic_date_parsing assignable_hash[k] = v else assignable_hash[k] = parse_attribute_value(v) end end value_from_object ? object : assignable_hash[k] end |
#translator ⇒ Object
187 188 189 190 191 192 193 |
# File 'lib/flexirest/request.rb', line 187 def translator if object_is_class? @object.translator else @object.class.translator end end |
#username ⇒ Object
107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/flexirest/request.rb', line 107 def username ret = nil if object_is_class? ret = @object.username ret = ret.call if ret.respond_to?(:call) else ret = @object.class.username ret = ret.call(@object) if ret.respond_to?(:call) end ret end |
#using_api_auth? ⇒ Boolean
67 68 69 70 71 72 73 |
# File 'lib/flexirest/request.rb', line 67 def using_api_auth? if object_is_class? @object.using_api_auth? else @object.class.using_api_auth? end end |
#using_basic_auth? ⇒ Boolean
135 136 137 |
# File 'lib/flexirest/request.rb', line 135 def using_basic_auth? !!username end |
#verbose? ⇒ Boolean
179 180 181 182 183 184 185 |
# File 'lib/flexirest/request.rb', line 179 def verbose? if object_is_class? @object.verbose else @object.class.verbose end end |
#wrap_root ⇒ Object
167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/flexirest/request.rb', line 167 def wrap_root if @method[:options][:wrap_root] @method[:options][:wrap_root] elsif @object.nil? nil elsif object_is_class? @object.wrap_root else @object.class.wrap_root end end |