couchrest_model/vendor/rest-client/README
2008-06-01 10:11:58 -07:00

50 lines
1.5 KiB
Plaintext

= REST Client -- simple DSL for accessing REST resources
A simple REST client for Ruby, inspired by the microframework (Camping,
Sinatra...) style of specifying actions: get, put, post, delete.
== Usage: Raw URL
require 'rest_client'
xml = RestClient.get 'http://some/resource'
jpg = RestClient.get 'http://some/resource', :accept => 'image/jpg'
RestClient.put 'http://some/resource', File.read('my.pdf'), :content_type => 'application/pdf'
RestClient.post 'http://some/resource', xml, :content_type => 'application/xml'
RestClient.delete 'http://some/resource'
See RestClient module docs for details.
== Usage: ActiveResource-Style
resource = RestClient::Resource.new 'http://some/resource'
resource.get
protected_resource = RestClient::Resource.new 'http://protected/resource', 'user', 'pass'
protected_resource.put File.read('pic.jpg'), :content_type => 'image/jpg'
See RestClient::Resource module docs for details.
== Shell
Require rest_client from within irb to access RestClient interactively, like
using curl at the command line. Better yet, require gem from within your
~/.rush/env.rb and have instant access to it from within your rush
(http://rush.heroku.com) sessions.
== Meta
Written by Adam Wiggins (adam at heroku dot com)
Patches contributed by: Chris Anderson, Greg Borenstein
Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
http://rest-client.heroku.com
http://github.com/adamwiggins/rest-client