In Files

  • lib/restclient.rb
  • lib/restclient/exceptions.rb
  • lib/restclient/mixin/response.rb
  • lib/restclient/raw_response.rb
  • lib/restclient/request.rb
  • lib/restclient/resource.rb
  • lib/restclient/response.rb
  • spec/exceptions_spec.rb
  • spec/mixin/response_spec.rb
  • spec/raw_response_spec.rb
  • spec/request_spec.rb
  • spec/resource_spec.rb
  • spec/response_spec.rb
  • spec/restclient_spec.rb

RestClient

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:password@example.com/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 ::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\"}"

Attributes

proxy[RW]

Public Class Methods

delete(url, headers={}) click to toggle source
 
               # File lib/restclient.rb, line 76
def self.delete(url, headers={})
        Request.execute(:method => :delete, :url => url, :headers => headers)
end
            
get(url, headers={}) click to toggle source
 
               # File lib/restclient.rb, line 64
def self.get(url, headers={})
        Request.execute(:method => :get, :url => url, :headers => headers)
end
            
head(url, headers={}) click to toggle source
 
               # File lib/restclient.rb, line 80
def self.head(url, headers={})
        Request.execute(:method => :head, :url => url, :headers => headers)
end
            
log=(log) click to toggle source

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

 
               # File lib/restclient.rb, line 90
def self.log=(log)
        @@log = log
end
            
post(url, payload, headers={}) click to toggle source
 
               # File lib/restclient.rb, line 68
def self.post(url, payload, headers={})
        Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
end
            
put(url, payload, headers={}) click to toggle source
 
               # File lib/restclient.rb, line 72
def self.put(url, payload, headers={})
        Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
end