Class to handle connections to remote web services. This class is used by ActiveResource::Base to interface with REST services.
- A
- D
- G
- H
- N
- P
- R
- S
- T
- U
HTTP_FORMAT_HEADER_NAMES | = | { :get => 'Accept', :put => 'Content-Type', :post => 'Content-Type', :delete => 'Accept', :head => 'Accept' } |
[R] | auth_type | |
[RW] | format | |
[R] | password | |
[R] | proxy | |
[R] | site | |
[R] | ssl_options | |
[R] | timeout | |
[R] | user |
The site
parameter is required and will set the
site
attribute to the URI for the
remote resource service.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 33 def initialize(site, format = ActiveResource::Formats::JsonFormat) raise ArgumentError, 'Missing site URI' unless site @user = @password = nil self.site = site self.format = format end
Source: show
# File activeresource/lib/active_resource/connection.rb, line 26 def requests @@requests ||= [] end
Sets the auth type for remote service.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 63 def auth_type=(auth_type) @auth_type = legitimize_auth_type(auth_type) end
Executes a DELETE request (see HTTP protocol documentation if unfamiliar). Used to delete resources.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 85 def delete(path, headers = {}) with_auth { request(:delete, path, build_request_headers(headers, :delete, self.site.merge(path))) } end
Executes a GET request. Used to get (find) resources.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 79 def get(path, headers = {}) with_auth { request(:get, path, build_request_headers(headers, :get, self.site.merge(path))) } end
Executes a HEAD request. Used to obtain meta-information about resources, such as whether they exist and their size (via response headers).
Source: show
# File activeresource/lib/active_resource/connection.rb, line 103 def head(path, headers = {}) with_auth { request(:head, path, build_request_headers(headers, :head, self.site.merge(path))) } end
Sets the password for remote service.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 58 def password=(password) @password = password end
Executes a POST request. Used to create new resources.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 97 def post(path, body = '', headers = {}) with_auth { request(:post, path, body.to_s, build_request_headers(headers, :post, self.site.merge(path))) } end
Set the proxy for remote service.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 48 def proxy=(proxy) @proxy = proxy.is_a?(URI) ? proxy : URI.parser.parse(proxy) end
Executes a PUT request (see HTTP protocol documentation if unfamiliar). Used to update resources.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 91 def put(path, body = '', headers = {}) with_auth { request(:put, path, body.to_s, build_request_headers(headers, :put, self.site.merge(path))) } end
Set URI for remote service.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 41 def site=(site) @site = site.is_a?(URI) ? site : URI.parser.parse(site) @user = URI.parser.unescape(@site.user) if @site.user @password = URI.parser.unescape(@site.password) if @site.password end
Hash of options applied to Net::HTTP instance
when site
protocol is ‘https’.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 73 def ssl_options=(opts={}) @ssl_options = opts end
Sets the number of seconds after which HTTP requests to the remote service should time out.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 68 def timeout=(timeout) @timeout = timeout end
Sets the user for remote service.
Source: show
# File activeresource/lib/active_resource/connection.rb, line 53 def user=(user) @user = user end