Class to handle connections to remote web services. This class is used by ActiveResource::Base to interface with REST services.

Methods
Attributes
[RW] format
[R] password
[R] site
[R] timeout
[R] user
Public Class methods
new(site, format = ActiveResource::Formats[:xml])

The site parameter is required and will set the site attribute to the URI for the remote resource service.

[ show source ]

    # File 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
requests()

[ show source ]

    # File activeresource/lib/active_resource/connection.rb, line 70
70:       def requests
71:         @@requests ||= []
72:       end
Public Instance methods
delete(path, headers = {})

Execute a DELETE request (see HTTP protocol documentation if unfamiliar). Used to delete resources.

[ show source ]

     # File activeresource/lib/active_resource/connection.rb, line 114
114:     def delete(path, headers = {})
115:       request(:delete, path, build_request_headers(headers))
116:     end
get(path, headers = {})

Execute a GET request. Used to get (find) resources.

[ show source ]

     # File activeresource/lib/active_resource/connection.rb, line 108
108:     def get(path, headers = {})
109:       format.decode(request(:get, path, build_request_headers(headers)).body)
110:     end
head(path, headers = {})

Execute a HEAD request. Used to obtain meta-information about resources, such as whether they exist and their size (via response headers).

[ show source ]

     # File activeresource/lib/active_resource/connection.rb, line 132
132:     def head(path, headers = {})
133:       request(:head, path, build_request_headers(headers))
134:     end
password=(password)

Set password for remote service.

[ show source ]

    # File activeresource/lib/active_resource/connection.rb, line 97
97:     def password=(password)
98:       @password = password
99:     end
post(path, body = '', headers = {})

Execute a POST request. Used to create new resources.

[ show source ]

     # File activeresource/lib/active_resource/connection.rb, line 126
126:     def post(path, body = '', headers = {})
127:       request(:post, path, body.to_s, build_request_headers(headers))
128:     end
put(path, body = '', headers = {})

Execute a PUT request (see HTTP protocol documentation if unfamiliar). Used to update resources.

[ show source ]

     # File 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
site=(site)

Set URI for remote service.

[ show source ]

    # File 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
timeout=(timeout)

Set the number of seconds after which HTTP requests to the remote service should time out.

[ show source ]

     # File activeresource/lib/active_resource/connection.rb, line 102
102:     def timeout=(timeout)
103:       @timeout = timeout
104:     end
user=(user)

Set user for remote service.

[ show source ]

    # File activeresource/lib/active_resource/connection.rb, line 92
92:     def user=(user)
93:       @user = user
94:     end