Class: ActiveResource::Connection

Inherits:
Object
  • Object
show all
Defined in:
activeresource/lib/active_resource/connection.rb,
activeresource/lib/active_resource/http_mock.rb

Overview

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

Constant Summary collapse

HTTP_FORMAT_HEADER_NAMES = 
{  :get => 'Accept',
  :put => 'Content-Type',
  :post => 'Content-Type',
  :delete => 'Accept',
  :head => 'Accept'
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(site, format = ActiveResource::Formats::JsonFormat) ⇒ Connection

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

Raises:

  • (ArgumentError) 


33
34
35
36
37
38
 
# 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

Instance Attribute Details

#auth_type ⇒ Object

Returns the value of attribute auth_type



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def auth_type
  @auth_type
end

#format ⇒ Object

Returns the value of attribute format



23
24
25
 
# File 'activeresource/lib/active_resource/connection.rb', line 23

def format
  @format
end

#password ⇒ Object

Returns the value of attribute password



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def password
  @password
end

#proxy ⇒ Object

Returns the value of attribute proxy



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def proxy
  @proxy
end

#site ⇒ Object

Returns the value of attribute site



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def site
  @site
end

#ssl_options ⇒ Object

Returns the value of attribute ssl_options



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def ssl_options
  @ssl_options
end

#timeout ⇒ Object

Returns the value of attribute timeout



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def timeout
  @timeout
end

#user ⇒ Object

Returns the value of attribute user



22
23
24
 
# File 'activeresource/lib/active_resource/connection.rb', line 22

def user
  @user
end

Class Method Details

.requests ⇒ Object 



26
27
28
 
# File 'activeresource/lib/active_resource/connection.rb', line 26

def requests
  @@requests ||= []
end

Instance Method Details

#delete(path, headers = {}) ⇒ Object

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



85
86
87
 
# 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

#get(path, headers = {}) ⇒ Object

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



79
80
81
 
# 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

#head(path, headers = {}) ⇒ Object

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



103
104
105
 
# 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

#post(path, body = '', headers = {}) ⇒ Object

Executes a POST request. Used to create new resources.



97
98
99
 
# 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

#put(path, body = '', headers = {}) ⇒ Object

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



91
92
93
 
# 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