README.rdoc
README.rdoc
Last Update: 2011-02-03 19:38:34 +0530

Wrest 1.2.0

© Copyright 2009-2011 Sidu Ponnappa. All Rights Reserved.

Wrest is a ruby REST/HTTP client library which

  • Allows you to quickly build object oriented wrappers around any web service
  • Designed to be used as a library, not just a command line REST client (fewer class/static methods, more object oriented)
  • Is spec driven, strongly favours immutable objects and avoids class methods and setters making it better suited for use as a library, especially in multi-threaded environments
  • Runs on Ruby 1.8, Ruby 1.9.2, JRuby and Rubinius with MacRuby and IronRuby support on the way (Continuous Integration server)
  • Provides convenient HTTP wrappers, redirect handling, serialisation, deserialisation and response caching
  • Supports using either Net::HTTP or libcurl as the underlying HTTP library

To receive notifications whenever new features are added to Wrest, please subscribe to my twitter feed.

Examples

For Facebook, Twitter, Delicious, GitHub and other API examples, see github.com/kaiwren/wrest/tree/master/examples

Basic Http Calls

GET

  • Basic API calls
    'http://twitter.com/statuses/public_timeline.json'.to_uri.get.deserialise  # works with json and xml out of the box
    
    'http://twitter.com/statuses/public_timeline.xml'.to_uri.get.deserialise   # see lib/wrest/components/translators to add other formats
  • Timeout support
    'http://twitter.com/statuses/public_timeline.json'.to_uri.get(:timeout => 5).body
  • Redirect support
    'http://google.com'.to_uri(:follow_redirects => false).get
    
    'http://google.com'.to_uri(:follow_redirects_limit => 1).get

    :follow_redirects_limit defaults to 5 if not specified.

  • Deserialise with XPath filtering
    ActiveSupport::XmlMini.backend = 'REXML'
    
    'http://twitter.com/statuses/public_timeline.xml'.to_uri.get.deserialise(
                                                  :xpath => '//user/name/text()'
                                                )
  • More complex request with parameters and a custom deserialiser
    'http://search.yahooapis.com/NewsSearchService/V1/newsSearch'.to_uri.get(
                  :appid  => 'YahooDemo',
                  :output => 'xml',
                  :query  => 'India',
                  :results=> '3',
                  :start  => '1'
                ).deserialise_using(
                  Wrest::Translators::Xml
                )
  • Basic HTTP auth and URI extensions using Wrest::Uri#[]
    base_uri = 'https://api.del.icio.us/v1'.to_uri(:username => 'kaiwren', :password => 'fupupp1es')
    bookmarks = base_uri['/posts/get'].get.deserialise

POST

  • Regular, vanilla Post with a body and headers
    'http://my.api.com'.to_uri.post('YAML encoded body', 'Content-Type' => 'text/x-yaml')
  • Form encoded post
    'https://api.del.icio.us/v1/posts/add'.to_uri(
             :username => 'kaiwren', :password => 'fupupp1es'
          ).post_form(
             :url => 'http://blog.sidu.in/search/label/ruby',
             :description => 'The Ruby related posts on my blog!',
             :extended => "All posts tagged with 'ruby'",
             :tags => 'ruby hacking'
          )
  • Multipart posts
    'http://imgur.com/api/upload.xml'.to_uri.post_multipart(
      :image => UploadIO.new(File.open(file_path), "image/png", file_path),
      :key => imgur_key
     ).deserialise

DELETE

To delete a resource:

'https://api.del.icio.us/v1/posts/delete'.to_uri(
                                             :username => 'kaiwren',
                                             :password => 'fupupp1es'
                                           ).delete(
                                             :url => 'http://c2.com'
                                           )

Caching

Wrest supports caching with pluggable back-ends.

Wrest.always_cache_using_hash!     # Hash should NEVER be used in a production environment. It is unbounded and will keep increasing in size.
c42 = "http://c42.in".to_uri.get

A Memcached based caching back-end is available in Wrest. You can get instructions on how to install Memcached on your system here. The Dalli gem is used by Wrest to interface with Memcached. Install dalli using ‘gem install dalli’.

Use the following method to enable caching for all requests, and set Memcached as the default back-end.

Wrest.always_cache_using_memcached!

For fine-grained control over the cache store (or to use multiple cache stores in the same codebase), you can use this API:

memcache_store = Wrest::Components::CacheStore::Memcached.new("localhost:11211")
hash_store = {}

r1 = "http://c42.in".to_uri(:cache_store => memcache_store).get
r2 = "http://c42.in".to_uri(:cache_store => hash_store).get

A detailed writeup regarding caching as defined by RFC 2616, and how Wrest implements caching is at Wrest Caching Doc

You can create your own back-ends for Wrest caching by implementing the interface implemented in github.com/kaiwren/wrest/blob/master/lib/wrest/components/cache_store/memcached.rb

To explicitly disable caching for specific requests:

"http://c42.in".to_uri(:disable_cache => true).get

Callbacks

Uri level callbacks

You can define a set of callbacks that are invoked based on the http codes of the responses to any requests on a given uri.

"http://google.com".to_uri(:callback => {
            200      => lambda {|response| Wrest.logger.info "Ok." },
            400..499 => lambda {|response| Wrest.logger.error "Invalid. #{response.body}"},
            300..302 => lambda {|response| Wrest.logger.debug "Redirected. #{response.message}" }
          }).get
Per request callbacks

You can also define callbacks that are invoked based on the http code of the response to a particular request.

"http://google.com".to_uri.get do |callback|
  callback.on_ok do |response|
    Wrest.logger.info "Ok."
  end

  callback.on(202) do |response|
    Wrest.logger.info "Accepted."
  end

  callback.on(200..206) do |response|
    Wrest.logger.info "Successful."
  end
end

Please note that Wrest is a synchronous library. All requests are blocking, and will not return till the request is completed and appropriate callbacks executed.

Other useful stuff

Allows any class to hold an attributes hash, somewhat like ActiveResource. It also supports several extensions to this base fuctionality such as support for typecasting attribute values. See examples/twitter.rb and examples/wow_realm_status.rb for more samples.

Example:

class Demon
  include Wrest::Components::Container

  always_has       :id
  typecast         :age          =>  as_integer,
                   :chi          =>  lambda{|chi| Chi.new(chi)}

  alias_accessors  :chi => :energy
end

kai_wren = Demon.new('id' => '1', 'age' => '1500', 'chi' => '1024', 'teacher' => 'Viss')
kai_wren.id       # => '1'
kai_wren.age      # => 1500
kai_wren.chi      # => #<Chi:0x113af8c @count="1024">
kai_wren.energy   # => #<Chi:0x113af8c @count="1024">
kai_wren.teacher  # => 'Viss'

Logging

The Wrest logger can be set and accessed through Wrest.logger and is configured by default to log to STDOUT. If you’re using Wrest in a Rails application, you can configure logging by adding a config/initializers/wrest.rb file with the following contents :

Wrest.logger = ActiveRecord::Base.logger

Build

Standard options are available and can be listed using rake -T. Use rake:rcov for coverage and rake:rdoc to generate documentation. The link to the continuous integration build is over at the C42 Engineering open source page.

Documentation

Wrest RDocs can be found at wrest.rubyforge.org

Roadmap

Features that are planned, in progress or already implemented are documented in the CHANGELOG starting from version 0.0.8.

Installation

The source is available at git://github.com/kaiwren/wrest.git

To install the Wrest gem, do (sudo) gem install wrest.

Wrest is currently available as a gem for for Ruby and JRuby.

Shell

You can launch the interactive Wrest shell by running bin/wrest if you have the source or invoking wrest from your prompt if you’ve installed the gem.

$ wrest
>> y 'http://twitter.com/statuses/public_timeline.json'.to_uri(:timeout => 5).get.deserialise

Testing

Start the Sinatra test server for functional test.

rake -f spec/sample_app/Rakefile

Run the tests in a different terminal:

# Run the normal test suite.
rake

# Runs the functional test suite.
rake rspec:functional

Contributors