Module: RestClient

Defined in:
lib/rest_client.rb,
lib/resource.rb,
lib/request_errors.rb

Overview

This module’s static methods are the entry point for using the REST client.

# GET
xml = RestClient.get 'http://example.com/resource'
jpg = RestClient.get 'http://example.com/resource', :accept => 'image/jpg'

# authentication and SSL
RestClient.get 'https://user:[email protected]/private/resource'

# POST or PUT with a hash sends parameters as a urlencoded form body
RestClient.post 'http://example.com/resource', :param1 => 'one'

# nest hash parameters
RestClient.post 'http://example.com/resource', :nested => { :param1 => 'one' }

# POST and PUT with raw payloads
RestClient.post 'http://example.com/resource', 'the post body', :content_type => 'text/plain'
RestClient.post 'http://example.com/resource.xml', xml_doc
RestClient.put 'http://example.com/resource.pdf', File.read('my.pdf'), :content_type => 'application/pdf'

# DELETE
RestClient.delete 'http://example.com/resource'

For live tests of RestClient, try using rest-test.heroku.com, which echoes back information about the rest call:

>> RestClient.put 'http://rest-test.heroku.com/resource', :foo => 'baz'
=> "PUT http://rest-test.heroku.com/resource with a 7 byte payload, content type application/x-www-form-urlencoded {\"foo\"=>\"baz\"}"

Defined Under Namespace

Classes: Exception, Redirect, Request, RequestFailed, RequestTimeout, Resource, ResourceNotFound, ServerBrokeConnection, Unauthorized

Class Method Summary collapse

Class Method Details

.delete(url, headers = {}) ⇒ Object 



58
59
60
61
62
 
# File 'lib/rest_client.rb', line 58

def self.delete(url, headers={})
	Request.execute(:method => :delete,
		:url => url,
		:headers => headers)
end

.get(url, headers = {}) ⇒ Object 



38
39
40
41
42
 
# File 'lib/rest_client.rb', line 38

def self.get(url, headers={})
	Request.execute(:method => :get,
		:url => url,
		:headers => headers)
end

.log ⇒ Object

:nodoc:



70
71
72
73
74
 
# File 'lib/rest_client.rb', line 70

def self.log    # :nodoc:
	return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
	return @@log if defined? @@log
	nil
end

.log=(log) ⇒ Object

Print log of RestClient calls. Value can be stdout, stderr, or a filename. You can also configure logging by the environment variable RESTCLIENT_LOG.



66
67
68
 
# File 'lib/rest_client.rb', line 66

def self.log=(log)
	@@log = log
end

.post(url, payload, headers = {}) ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/rest_client.rb', line 44

def self.post(url, payload, headers={})
	Request.execute(:method => :post,
		:url => url,
		:payload => payload,
		:headers => headers)
end

.put(url, payload, headers = {}) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/rest_client.rb', line 51

def self.put(url, payload, headers={})
	Request.execute(:method => :put,
		:url => url,
		:payload => payload,
		:headers => headers)
end