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.
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 77 77: def initialize(site, format = ActiveResource::Formats[:xml]) 78: raise ArgumentError, 'Missing site URI' unless site 79: @user = @password = nil 80: self.site = site 81: self.format = format 82: end
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 70 70: def requests 71: @@requests ||= [] 72: 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 132 132: def head(path, headers = {}) 133: request(:head, path, build_request_headers(headers)) 134: end
Set password for remote service.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 97 97: def password=(password) 98: @password = password 99: 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 120 120: def put(path, body = '', headers = {}) 121: request(:put, path, body.to_s, build_request_headers(headers)) 122: end
Set URI for remote service.
# File vendor/rails/activeresource/lib/active_resource/connection.rb, line 85 85: def site=(site) 86: @site = site.is_a?(URI) ? site : URI.parse(site) 87: @user = URI.decode(@site.user) if @site.user 88: @password = URI.decode(@site.password) if @site.password 89: end