1
0
Fork 0
mirror of https://github.com/rest-client/rest-client.git synced 2022-11-09 13:49:40 -05:00
rest-client--rest-client/README
Adam Wiggins 15f58e67dd rdocs
2008-03-09 13:31:52 -07:00

32 lines
1,014 B
Text

= 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
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'
== 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)
Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
http://rest-client.rubyforge.org