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.

Methods

delete   get   new   post   put   requests   site=  

Attributes

format  [RW] 
site  [R] 

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.

[Source]

    # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 69
69:     def initialize(site, format = ActiveResource::Formats[:xml])
70:       raise ArgumentError, 'Missing site URI' unless site
71:       self.site = site
72:       self.format = format
73:     end
requests()

[Source]

    # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 62
62:       def requests
63:         @@requests ||= []
64:       end

Public Instance methods

delete(path, headers = {})

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

[Source]

    # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 88
88:     def delete(path, headers = {})
89:       request(:delete, path, build_request_headers(headers))
90:     end
get(path, headers = {})

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

[Source]

    # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 82
82:     def get(path, headers = {})
83:       format.decode(request(:get, path, build_request_headers(headers)).body)
84:     end
post(path, body = '', headers = {})

Execute a POST request. Used to create new resources.

[Source]

     # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 100
100:     def post(path, body = '', headers = {})
101:       request(:post, path, body.to_s, build_request_headers(headers))
102:     end
put(path, body = '', headers = {})

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

[Source]

    # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 94
94:     def put(path, body = '', headers = {})
95:       request(:put, path, body.to_s, build_request_headers(headers))
96:     end
site=(site)

Set URI for remote service.

[Source]

    # File vendor/rails/activeresource/lib/active_resource/connection.rb, line 76
76:     def site=(site)
77:       @site = site.is_a?(URI) ? site : URI.parse(site)
78:     end

[Validate]