h1. restr
h3. Copyright (c) 2008 Urbacon Ltd.
h2. What is it?
Restr is a very simple client for "RESTful":en.wikipedia.org/wiki/Representational_State_Transfer web services. It was developed as a lightweight alternative to "ActiveResource":api.rubyonrails.com/files/vendor/rails/activeresource/README.html.
For project info and downloads please see the Restr's "RubyForge Page":rubyforge.org/projects/restr
h2. Installing
<pre syntax="ruby">sudo gem install restr</pre>
h2. Usage Example
Fetch Kitten with id 1 and print out its name and colour:
<pre syntax="ruby"> require 'restr' kitten = Restr.get('example.com/kittens/1.xml') puts kitten puts kitten </pre>
Change the Kitten's colour and store the modification:
<pre syntax="ruby"> kitten = 'black' kitten = Restr.put('example.com/kittens/1.xml', kitten) </pre>
h2. Further Resources
"Full API Documentation RDocs":restr.rubyforge.org/rdoc/
"Reststop":rubyforge.org/projects/reststop/ -- makes it easy to implement RESTful controllers in the Camping microframework
"Wikipedia Article on REST":en.wikipedia.org/wiki/Representational_State_Transfer
h2. How to submit patches
See below for author's contact info.
The trunk repository is
svn://rubyforge.org/var/svn/restr/trunk
for anonymous access.
h2. License
"Lesser GPL Version 3":www.gnu.org/licenses/lgpl.html
h2. Contact
"Author's Rubyforge Page":rubyforge.org/users/gunark/
"Restr RubyForge Forum":rubyforge.org/forum/?group_id=5848