Module: RestClient

Defined in:
lib/restclient.rb,
lib/restclient/payload.rb,
lib/restclient/request.rb,
lib/restclient/resource.rb,
lib/restclient/response.rb,
lib/restclient/exceptions.rb,
lib/restclient/raw_response.rb,
lib/restclient/mixin/response.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'

# retreive the response http code and headers
res = RestClient.get 'http://example.com/some.jpg'
res.code                    # => 200
res.headers[:content_type]  # => 'image/jpg'

# HEAD
RestClient.head('http://example.com').headers

To use with a proxy, just set RestClient.proxy to the proper http proxy:

RestClient.proxy = "http://proxy.example.com/"

Or inherit the proxy from the environment:

RestClient.proxy = ENV['http_proxy']

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

Modules: Mixin, Payload Classes: Exception, ExceptionWithResponse, NotModified, RawResponse, Redirect, Request, RequestFailed, RequestTimeout, Resource, ResourceNotFound, Response, ServerBrokeConnection, Unauthorized

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.proxyObject

Returns the value of attribute proxy


87
88
89
# File 'lib/restclient.rb', line 87

def proxy
  @proxy
end

Class Method Details

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


78
79
80
# File 'lib/restclient.rb', line 78

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

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


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

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

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


82
83
84
# File 'lib/restclient.rb', line 82

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

.logObject

:nodoc:


96
97
98
99
100
# File 'lib/restclient.rb', line 96

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.


92
93
94
# File 'lib/restclient.rb', line 92

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

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


70
71
72
# File 'lib/restclient.rb', line 70

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

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


74
75
76
# File 'lib/restclient.rb', line 74

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

.versionObject


102
103
104
105
106
# File 'lib/restclient.rb', line 102

def self.version
  version_path = File.dirname(__FILE__) + "/../VERSION"
  return File.read(version_path).chomp if File.file?(version_path)
  "0.0.0"
end