restfulie 1.0.0.beta1 → 1.0.0.beta4

data/Gemfile

@@ -1,15 +1,10 @@
-# A sample Gemfile
 source :gemcutter
-#
-gem "rails", ">= 3.0.0"
-gem "libxml-ruby"
 
 gem "rack-conneg"
-gem "json_pure"
 gem "sqlite3-ruby"
-gem "yard"
-
-gem "respondie"
+gem 'tokamak', ">= 1.0.0.beta4"
+gem 'medie', ">= 1.0.0.beta4"
+gem 'respondie', "~> 0.9.0"
 
 if RUBY_VERSION < "1.9"
   gem "ruby-debug"
@@ -17,9 +12,12 @@ else
   gem "ruby-debug19", :require => "ruby-debug"
 end
 
+group :development do
+  gem "yard"
+end
+
 group :test do  
-  gem "nokogiri"
-  gem "rspec-rails", ">= 2.0.0.beta.19"
+  gem "rspec-rails", ">= 2.3.0"
   gem "rcov"
   gem "sinatra"
 	gem "state_machine"

data/Gemfile.lock

@@ -2,127 +2,101 @@ GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.0)
-      actionpack (= 3.0.0)
-      mail (~> 2.2.5)
-    actionpack (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
-      i18n (~> 0.4.1)
+      i18n (~> 0.4)
       rack (~> 1.2.1)
-      rack-mount (~> 0.6.12)
-      rack-test (~> 0.5.4)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.0)
-      activesupport (= 3.0.0)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
       builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-      arel (~> 1.0.0)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
     builder (2.1.2)
-    columnize (0.3.1)
+    columnize (0.3.2)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    fakeweb (1.2.8)
-    hoe (2.6.1)
+    fakeweb (1.3.0)
+    hoe (2.8.0)
       rake (>= 0.8.7)
-      rubyforge (>= 2.0.4)
-    i18n (0.4.1)
+    i18n (0.5.0)
     json_pure (1.4.6)
-    libxml-ruby (1.1.4)
     linecache (0.43)
-    mail (2.2.5)
-      activesupport (>= 2.3.6)
-      mime-types
-      treetop (>= 1.4.5)
-    mime-types (1.16)
-    nokogiri (1.4.3.1)
-    polyglot (0.3.1)
+    medie (1.0.0.beta4)
+      actionpack (>= 3.0.0)
+      activesupport
+      json_pure
+      methodize
+    methodize (0.1)
+    nokogiri (1.4.4)
     rack (1.2.1)
     rack-conneg (0.1.4)
       rack (>= 1.0)
-    rack-mount (0.6.12)
+    rack-mount (0.6.13)
       rack (>= 1.0.0)
-    rack-test (0.5.4)
+    rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.0)
-      actionmailer (= 3.0.0)
-      actionpack (= 3.0.0)
-      activerecord (= 3.0.0)
-      activeresource (= 3.0.0)
-      activesupport (= 3.0.0)
-      bundler (~> 1.0.0)
-      railties (= 3.0.0)
-    railties (3.0.0)
-      actionpack (= 3.0.0)
-      activesupport (= 3.0.0)
-      rake (>= 0.8.4)
-      thor (~> 0.14.0)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
     rake (0.8.7)
-    rcov (0.9.8)
+    rcov (0.9.9)
     respondie (0.9.0)
-    rspec (2.0.0.beta.19)
-      rspec-core (= 2.0.0.beta.19)
-      rspec-expectations (= 2.0.0.beta.19)
-      rspec-mocks (= 2.0.0.beta.19)
-    rspec-core (2.0.0.beta.19)
-    rspec-expectations (2.0.0.beta.19)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.19)
-    rspec-rails (2.0.0.beta.19)
-      rspec (= 2.0.0.beta.19)
-      webrat (>= 0.7.2.beta.1)
-    ruby-debug (0.10.3)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    ruby-debug (0.10.4)
       columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
       linecache (>= 0.3)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
-    sinatra (1.0)
-      rack (>= 1.0)
-    sqlite3-ruby (1.3.1)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    sqlite3-ruby (1.3.2)
     state_machine (0.9.4)
     test-unit (1.2.3)
       hoe (>= 1.5.1)
-    thor (0.14.0)
-    treetop (1.4.8)
-      polyglot (>= 0.3.1)
+    thor (0.14.6)
+    tilt (1.2.1)
+    tokamak (1.1.1)
+      json_pure
+      nokogiri
     tzinfo (0.3.23)
-    webrat (0.7.2.beta.1)
-      nokogiri (>= 1.2.0)
-      rack (>= 1.0)
-      rack-test (>= 0.5.3)
-    yard (0.5.8)
+    yard (0.6.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   fakeweb
-  json_pure
-  libxml-ruby
-  nokogiri
+  medie (>= 1.0.0.beta4)
   rack-conneg
-  rails (>= 3.0.0)
   rcov
-  respondie
-  rspec-rails (>= 2.0.0.beta.19)
+  respondie (~> 0.9.0)
+  rspec-rails (>= 2.3.0)
   ruby-debug
   sinatra
   sqlite3-ruby
   state_machine
   test-unit (= 1.2.3)
+  tokamak (>= 1.0.0.beta4)
   yard

data/README.textile

@@ -1,85 +1,50 @@
 h1. Web site
 
-Restfulie's website can be found at "http://restfulie.caelumobjects.com":http://restfulie.caelumobjects.com
-From there you can see some videos and read the "Restfulie from Scratch guide":http://restfulie.caelumobjects.com/caelumobjects-restful-rails.pdf.
+"http://restfulie.caelumobjects.com":"Restfulie's site" has a lot of information on Restfulie itself
 
 h1. 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.
+CRUD through HTTP and web services (aka Rest) in Rails 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. Go go go!
 
-You can read the "article on using the web for real":http://guilhermesilveira.wordpress.com/2009/11/03/quit-pretending-use-the-web-for-real-restfulie/ which gives an introduction to hypermedia/resources/services.
+h2. Bite me!
 
-h2. Why would I use restfulie?
-
-#  Easy --> writing hypermedia and semantic meaningful media type aware clients
-#  Small -> it's not a bloated solution with a huge list of APIs
-#  HATEOAS --> clients you are unaware of will not bother if you change
-#  HATEOAS --> consumed resources will not affect your software whenever they change their flow
-#  Adaptability --> clients are able to adapt to your changes
- 
-h2. 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:
+One liners for your pleasure. First, how to let restfulie know which media types you can handle:
 
 <pre>
-	class OrdersController < ApplicationController
-	  include Restfulie::Server::ActionController::Base
-
+class ItemsController < ...
 	  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
+end
 </pre>
 
-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:
+Now let's handle them all:
 
 <pre>
-	collection(@orders) do |collection|
-	  collection.values do |value|
-		value.id = orders_url
+	  def index
+	    respond_with @orders = Order.all
 	  end
-	  
-	  collection.link("create", orders_url)
-	  collection.members
-	end
 </pre>
 
-You can go through an entire application by "watching this video":http://guilhermesilveira.wordpress.com or "downloading an example application contained within the restfulie ":http://github.com/caelum/restfulie/tree/master/full-examples/rest_from_scratch/
-
-h2. Simple client example
-
-The following example is a partial REST client implementation that navigates through some relations:
+And what is the *first* difference between simple web services with Rails and a REST architecture? Let's add hypermedia to the game:
 
 <pre>
-order = Restfulie.at('http://localhost:3000/orders/1').get!
-order.items.each { |item| puts items }
-receipt = order.payment.post! { :amount => 500 }
-puts receipt.id
+memeber(@order) do |order|
+  order.link "payment", payment_url(order)
+end
 </pre>
 
-In order to create a full REST client, "watch this video":http://guilhermesilveira.wordpress.com.
+There you go, hypermedia, on the fly. You can also throw in link headers and much more fun for your life when maintaining your services. Lets grab it and navigate!
 
-h2. Full examples
-
-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":http://github.com/caelum/restfulie/tree/master/full-examples/rest_from_scratch/ using Restfulie, according to the Rest Architecture Maturity Model.
+<pre>
+response = Restfulie.at('http://localhost:3030/orders').get
+puts response.code
 
-h2. Documentation
+orders = response.resource
+response = orders.link(payment).follow.post {creditcard => 4444}
+</pre>
 
-Appart from the simple server and client examples provided here, you can find the following links useful:
+That was it for your first hypermedia introduction with Restfulie. Now its time for the real deal.
 
-* "RDocs":http://rdoc.info/projects/caelum/restfulie
-* "Official website":http://restfulie.caelumobjects.com
-* "How-tos":http://restfulie.caelumobjects.com/caelumobjects-restful-rails.pdf
-* "Buying through Rest: Rest to the enterprise (video)":http://guilhermesilveira.wordpress.com/2010/04/13/buying-through-rest-applying-rest-to-the-enterprise/
+Download it, install it, use it, ask questions in the mailing list and read the documentation on Restfulie's website!
 
 h2. Installing
 

data/Rakefile

@@ -11,7 +11,7 @@ require File.expand_path('lib/restfulie')
 GEM = "restfulie"
 GEM_VERSION = Restfulie::VERSION
 SUMMARY  = "Hypermedia aware resource based library in ruby (client side) and ruby on rails (server side)."
-AUTHOR   = "Guilherme Silveira, Caue Guerra, Luis Cipriani, Everton Ribeiro, George Guimaraes, Paulo Ahagon, Several contributors"
+AUTHOR   = "Guilherme Silveira, Caue Guerra, Luis Cipriani, Everton Ribeiro, George Guimaraes, Paulo Ahagon, and many more!"
 EMAIL    = "guilherme.silveira@caelum.com.br"
 HOMEPAGE = "http://restfulie.caelumobjects.com"
 
@@ -23,8 +23,6 @@ spec = Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.files = FileList['lib/**/*.rb', '[A-Z]*', 'lib/**/*.rng'].to_a
   s.add_dependency("nokogiri", [">= 1.4.2"])
-  s.add_dependency("actionpack", [">= 2.3.2"])
-  s.add_dependency("activesupport", [">= 2.3.2"])
   s.add_dependency("json_pure", [">= 1.2.4"])
 
   s.author = AUTHOR

data/lib/restfulie/client/cache/basic.rb

@@ -16,7 +16,6 @@ module Restfulie::Client::Cache
 
     def get(key, request)
 
-      # debugger
       response = cache_get(key, request)
       return nil if response.nil?
 
@@ -34,6 +33,13 @@ module Restfulie::Client::Cache
       cache.clear
     end
 
+  protected
+  
+    # allows you to redefine the cache store
+    def cache
+      Restfulie::Client.cache_store
+    end
+
   private
 
     # allows response enhancement when the cache was hit with it
@@ -68,9 +74,5 @@ module Restfulie::Client::Cache
       nil
     end
 
-    def cache
-      Restfulie::Client.cache_store
-    end
-
   end
 end

data/lib/restfulie/client/cache/restrictions.rb

@@ -1,4 +1,6 @@
 module Restfulie::Client::Cache
+  
+  # Cache restrictions that allow you to cache this response or not
   module Restrictions
     class << self
 

data/lib/restfulie/client/dsl.rb

@@ -13,9 +13,9 @@ module Restfulie::Client
       request :follow_request
     end
     
-    def request(what)
+    def request(what, *args)
       req = "Restfulie::Client::Feature::#{what.to_s.classify}".constantize
-      @requests << req
+      @requests << {:type => req, :args => args}
       self
     end
 
@@ -32,7 +32,7 @@ module Restfulie::Client
       end
       if Restfulie::Client::Feature.const_defined? "#{sym.to_s.classify}Request"
         loaded = true
-        request "#{sym.to_s}Request"
+        request "#{sym.to_s}Request", *args
       end
       if loaded
         self
@@ -42,25 +42,10 @@ module Restfulie::Client
     end
     
     def request_flow(env = {})
-      Parser.new(@requests).continue(self, nil, env)
+      Restfulie::Common::Logger.logger.debug "ready to execute request using stack #{@requests}"
+      StackNavigator.new(@requests).continue(self, env)
     end
 
-  end
-  
-  class Parser
-    
-    def initialize(stack)
-      @stack = stack.dup
-    end
-    
-    def continue(request, response, env)
-      current = @stack.pop
-      if current.nil?
-        return response
-      end
-      filter = current.new
-      filter.execute(self, request, response, env)
-    end
-    
-  end
+  end  
+
 end

data/lib/restfulie/client/entry_point.rb

@@ -5,7 +5,7 @@ module Restfulie
     module HTTP::RecipeModule
       def recipe(converter_sym, options={}, &block)
         raise 'Undefined block' unless block_given?
-        converter = "Restfulie::Common::Converter::#{converter_sym.to_s.camelize}".constantize
+        converter = "Tokamak::#{converter_sym.to_s.camelize}".constantize
         converter.describe_recipe(options[:name], &block) 
       end
 

data/lib/restfulie/client/ext/link_ext.rb

@@ -0,0 +1,11 @@
+module Medie
+  class Link
+    
+    # allows you to follow links by using restfulie
+    def follow
+      r = Restfulie.at(href)
+      r = r.as(content_type) if content_type
+      r
+    end
+  end
+end

data/lib/restfulie/client/ext/open_search_ext.rb

@@ -0,0 +1,26 @@
+module Medie
+  module OpenSearch
+    class Descriptor
+      
+      def use(content_type)
+        uri = urls.find do |url|
+          url["type"]==content_type
+        end
+        return nil if uri.nil?
+    
+        base_uri, params_pattern = extract_uri(uri)
+        Restfulie.at(base_uri).accepts(content_type).open_search.with_pattern(params_pattern)
+      end
+  
+      private
+      def extract_uri(uri)
+        uri = uri["template"]
+        interrogation = uri.index("?")
+        params = uri[interrogation+1..uri.size]
+        base_uri = uri[0..interrogation-1]
+        [base_uri, params]
+      end
+
+    end
+  end
+end

data/lib/restfulie/client/ext.rb

@@ -0,0 +1,3 @@
+require 'restfulie/client/ext/link_ext'
+require 'restfulie/client/ext/http_ext'
+require 'restfulie/client/ext/open_search_ext'

data/lib/restfulie/client/feature/base_request.rb

@@ -1,6 +1,6 @@
 class Restfulie::Client::Feature::BaseRequest
   
-  def execute(flow, request, response, env)
+  def execute(flow, request, env)
     request!(request.verb, request.host, request.path, request, flow, env)
   end
   
@@ -24,7 +24,7 @@ class Restfulie::Client::Feature::BaseRequest
       response = e
     end
     
-    flow.continue(request, response, env)
+    response
     
   end
 

data/lib/restfulie/client/feature/cache.rb

@@ -1,10 +1,10 @@
 class Restfulie::Client::Feature::Cache
   
-  def execute(flow, request, response, env)
+  def execute(flow, request, env)
     found = Restfulie::Client.cache_provider.get([request.host, request.path], request)
     return found if found
     
-    resp = flow.continue(request, response, env)
+    resp = flow.continue(request, env)
     if resp.kind_of?(Exception)
       resp
     else

data/lib/restfulie/client/feature/conneg_when_unaccepted.rb

@@ -0,0 +1,25 @@
+# Retries marshalling to an acceptable media type if
+# the server returns with 406: content negotiation. This means looking for
+# another media type that both server and client
+# understands, picking its converter and using it
+# to marshal the original payload again.
+#
+# To use it, load it in your dsl:
+# Restfulie.at("http://localhost:3000/product/2").conneg_when_unaccepted.get
+module Restfulie::Client::Feature
+  class ConnegWhenUnaccepted
+    
+  	def execute(chain, request, env)
+			resp = chain.continue(request, env)
+			return resp if resp.code.to_i!=406
+		  
+			accept = Medie.registry.for(resp.headers["Accept"])
+		  return resp if accept.nil?
+		  
+    	request.with("Content-type", accept)
+    	env = env.dup.merge(:body => env[:payload])
+    	Restfulie::Client::Feature::SerializeBody.new.execute(chain, request, env)
+  	end
+
+  end
+end

data/lib/restfulie/client/feature/enhance_response.rb

@@ -1,7 +1,7 @@
 module Restfulie::Client::Feature
   class EnhanceResponse
-    def execute(flow, request, response, env)
-      resp = flow.continue(request, response, env)
+    def execute(flow, request, env)
+      resp = flow.continue(request, env)
       unless resp.kind_of? ::Restfulie::Client::HTTP::ResponseHolder
         resp.extend(::Restfulie::Client::HTTP::ResponseHolder)
         resp.results_from request, resp

data/lib/restfulie/client/feature/follow_request.rb

@@ -12,8 +12,8 @@ class Restfulie::Client::Feature::FollowRequest
     self
   end
 
-  def execute(flow, request, response, env)
-    resp = flow.continue(request, response, env)
+  def execute(flow, request, env)
+    resp = flow.continue(request, env)
     if !resp.respond_to?(:code)
       return resp
     end

data/lib/restfulie/client/feature/history_request.rb

@@ -10,8 +10,8 @@
 #
 class Restfulie::Client::Feature::HistoryRequest
 
-  def execute(flow, request, response, env)
-    resp = flow.continue(request, response, env)
+  def execute(flow, request, env)
+    resp = flow.continue(request, env)
     request.make_snapshot(request)
     resp
   end

data/lib/restfulie/client/feature/retry_when_unavailable.rb

@@ -0,0 +1,25 @@
+# Adds support to retrying a request if the result is 503.
+#
+# To use it, load it in your dsl:
+# Restfulie.at("http://localhost:3000/product/2").retry_when_unavailable.get
+module Restfulie::Client::Feature
+  class RetryWhenUnavailable
+
+  	def execute(chain, request, env)
+  		resp = chain.continue(request, env)
+  		if should_retry?(resp, env)
+  			resp = chain.continue(request, env)
+  		end
+  		resp
+  	end
+  	
+  	protected 
+    # extension point that allows you to redefine
+    # when a request should be retried
+    def should_retry?(response, env)
+      response.code.to_i == 503
+    end
+  	
+  end
+end
+

data/lib/restfulie/client/feature/serialize_body.rb

@@ -1,15 +1,18 @@
+# Feature responsible for marshalling the entity into the request body.
+# It will use the request content type header to select the proper marshaller using Medie.
 class Restfulie::Client::Feature::SerializeBody
   
-  def execute(flow, request, response, env)
+  def execute(flow, request, env = {})
     
     if should_have_payload?(request.verb)
       
-      payload = env[:body]
+      env = env.dup
+      payload = env[:payload] = env[:body]
       if payload && !(payload.kind_of?(String) && payload.empty?)
         type = request.headers['Content-Type']
         raise Restfulie::Common::Error::RestfulieError, "Missing content type related to the data to be submitted" unless type
       
-        marshaller = Restfulie::Common::Converter.content_type_for(type)
+        marshaller = Medie.registry.for(type)
         raise Restfulie::Common::Error::RestfulieError, "Missing content type for #{type} related to the data to be submitted" unless marshaller
 
         rel = request.respond_to?(:rel) ? request.rel : ""
@@ -18,7 +21,7 @@ class Restfulie::Client::Feature::SerializeBody
       
     end
 
-    flow.continue(request, response, env)
+    flow.continue(request, env)
   end
   
   protected

data/lib/restfulie/client/feature/setup_header.rb

@@ -2,7 +2,7 @@ module Restfulie::Client::Feature
 
   class SetupHeader
     
-    def execute(flow, request, response, env)
+    def execute(flow, request, env)
       headers = request.default_headers.dup.merge(request.headers)
       host = request.host
       if host.user || host.password
@@ -14,7 +14,7 @@ module Restfulie::Client::Feature
       # gs: this should not be overriden, do it in some other way
       request.headers = headers
       
-      flow.continue(request, response, env)
+      flow.continue(request, env)
     end
     
   end