Class | ActiveResource::Connection |
In: |
vendor/rails/activeresource/lib/active_resource/connection.rb
vendor/rails/activeresource/lib/active_resource/http_mock.rb |
Parent: | Object |
Class to handle connections to remote web services. This class is used by ActiveResource::Base to interface with REST services.
HTTP_FORMAT_HEADER_NAMES | = | { :get => 'Accept', :put => 'Content-Type', :post => 'Content-Type', :delete => 'Accept' |
format | [RW] | |
password | [R] | |
site | [R] | |
timeout | [R] | |
user | [R] |
The site parameter is required and will set the site attribute to the URI for the remote resource service.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 84 84: def initialize(site, format = ActiveResource::Formats[:xml]) 85: raise ArgumentError, 'Missing site URI' unless site 86: @user = @password = nil 87: self.site = site 88: self.format = format 89: end
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 77 77: def requests 78: @@requests ||= [] 79: end
Execute a DELETE request (see HTTP protocol documentation if unfamiliar). Used to delete resources.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 121 121: def delete(path, headers = {}) 122: request(:delete, path, build_request_headers(headers, :delete)) 123: end
Execute a HEAD request. Used to obtain meta-information about resources, such as whether they exist and their size (via response headers).
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 139 139: def head(path, headers = {}) 140: request(:head, path, build_request_headers(headers)) 141: end
Set password for remote service.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 104 104: def password=(password) 105: @password = password 106: end
Execute a PUT request (see HTTP protocol documentation if unfamiliar). Used to update resources.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 127 127: def put(path, body = '', headers = {}) 128: request(:put, path, body.to_s, build_request_headers(headers, :put)) 129: end
Set URI for remote service.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 92 92: def site=(site) 93: @site = site.is_a?(URI) ? site : URI.parse(site) 94: @user = URI.decode(@site.user) if @site.user 95: @password = URI.decode(@site.password) if @site.password 96: end