Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
CRUD through HTTP is a good step forward to using resources and becoming RESTful. Another step further into it is to make use of hypermedia-based services and the Restfulie gem allows you to do it very quickly.
Ruby JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples/guide
lib
spec
.gitignore
LICENSE
README.textile
Rakefile
build.sh
init.rb

README.textile

Web site

Restfulie’s website can be found at http://restfulie.caelum.com.br
Mikyung’s, a REST agent framework built on top of Restfulie can be seen at http://github.com/caelum/mikyung.

Quit pretending

CRUD through HTTP is a good step forward to using resources and becoming RESTful, another step further into it is to make use of hypermedia and semantic meaningful media types: this gem allows you to do it really fast.

You can read the article on using the web for real which gives an introduction to hypermedia/resources/services.

Why would I use restfulie?

  1. Easy —> writing hypermedia and semantic meaningful media type aware clients
  2. Small → it’s not a bloated solution with a huge list of APIs
  3. HATEOAS —> clients you are unaware of will not bother if you change your URIs
  4. HATEOAS —> resources that you consume will not affect your software whenever they change part of their flow or URIs
  5. Adaptability —> clients are able to adapt to your changes

Installing

For client side usage, execute:

gem install activesupport
gem install restfulie

For server side usage, execute:

gem install restfulie

Simple server example

In the server side, all you need to do is notify inherited_resources which media types you are able to represent your resource:

	class OrdersController < ApplicationController
	  include Restfulie::Server::ActionController::Base

	  respond_to :atom, :html, :xml, :commerce, :opensearch

	  def index
	    respond_with @orders = Order.all
	  end

	  def show
	    respond_with @order = Order.find(params[:id])
	  end

	end

That’s it. Restfulie will take care of rendering a valid representation according to content negotiation. You can configure the rendering process through a custom tokamak view:

	describe_collection(@orders) do |collection|
	  collection.id = orders_url
	  collection.links << link( :rel => :create,  :href => orders_url )
	  collection.describe_members
	end

You can go through an entire application by watching this video or downloading an example application.

Simple client example

The following example is a partial REST client implementation that navigates through some relations:

order = Restfulie.at('http://localhost:3000/orders/1').get!
order.items.each { |item| puts items }
receipt = order.payment.post! { :amount => 500 }
puts receipt.id

In order to create a full REST client, watch this video.

Download source example

You can view an entire application running Restfulie under spec/integration/order/server and spec/integration/order/client in this git repository.

You can also download a full example of a REST based agent and server using Restfulie and Mikyung, according to the Rest Architecture Maturity Model.

Building the project

If you want to build the project and run its tests, remember to install all (client and server) required gems and:

gem install rack-conneg
gem install responders_backport
Something went wrong with that request. Please try again.