Object
Class to handle connections to remote web services. This class is used by ActiveResource::Base to interface with REST services.
The site parameter is required and will set the site attribute to the URI for the remote resource service.
# File lib/active_resource/connection.rb, line 96 def initialize(site, format = ActiveResource::Formats[:xml]) raise ArgumentError, 'Missing site URI' unless site @user = @password = nil self.site = site self.format = format end
Execute a DELETE request (see HTTP protocol documentation if unfamiliar). Used to delete resources.
# File lib/active_resource/connection.rb, line 143 def delete(path, headers = {}) request(:delete, path, build_request_headers(headers, :delete)) end
Execute a GET request. Used to get (find) resources.
# File lib/active_resource/connection.rb, line 137 def get(path, headers = {}) format.decode(request(:get, path, build_request_headers(headers, :get)).body) end
Execute a HEAD request. Used to obtain meta-information about resources, such as whether they exist and their size (via response headers).
# File lib/active_resource/connection.rb, line 161 def head(path, headers = {}) request(:head, path, build_request_headers(headers, :head)) end
Set password for remote service.
# File lib/active_resource/connection.rb, line 121 def password=(password) @password = password end
Execute a POST request. Used to create new resources.
# File lib/active_resource/connection.rb, line 155 def post(path, body = '', headers = {}) request(:post, path, body.to_s, build_request_headers(headers, :post)) end
Set the proxy for remote service.
# File lib/active_resource/connection.rb, line 111 def proxy=(proxy) @proxy = proxy.is_a?(URI) ? proxy : URI.parse(proxy) end
Execute a PUT request (see HTTP protocol documentation if unfamiliar). Used to update resources.
# File lib/active_resource/connection.rb, line 149 def put(path, body = '', headers = {}) request(:put, path, body.to_s, build_request_headers(headers, :put)) end
Set URI for remote service.
# File lib/active_resource/connection.rb, line 104 def site=(site) @site = site.is_a?(URI) ? site : URI.parse(site) @user = URI.decode(@site.user) if @site.user @password = URI.decode(@site.password) if @site.password end
Hash of options applied to Net::HTTP instance when site protocol is ‘https’.
# File lib/active_resource/connection.rb, line 131 def ssl_options=(opts={}) @ssl_options = opts end
Generated with the Darkfish Rdoc Generator 2.