restfulie 1.0.0 → 1.0.3

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+libs << " -r #{File.dirname(__FILE__) + '/../lib/restfulie.rb'}"
+puts "Loading Restfulie env"
+exec "#{irb} #{libs} --simple-prompt #{ARGV.join("")}"

data/site/README

@@ -0,0 +1 @@
+Restfulie's website at http://www.caelumobjects.com/restfulie

data/site/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/site/app/controllers/application_controller.rb

@@ -0,0 +1,11 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+  
+end

data/site/app/controllers/java_controller.rb

@@ -0,0 +1,53 @@
+class JavaController < ApplicationController
+  def index
+    render :action => 'basic'
+  end
+  
+  def basic
+  end
+  
+  def examples
+  end
+  
+  def conneg
+  end
+  
+  def features
+  end
+  
+  def hypermedia
+  end
+  
+  def server
+  end
+  
+  def rendering_resources
+  end
+
+  
+  #down here
+  #def installing
+  #end
+  #def features
+  #end
+  #def short_samples
+  #end
+  #def server
+  #end
+  #def rendering_resources
+  #end
+  #def server_state_machine
+  #end
+  #def client
+  #end
+  #def help_and_examples
+  #end
+  #def live_examples
+  #end
+  #def team
+  #end
+  #def roadmap
+  #end
+  #def what_is_new
+  #end
+end

data/site/app/controllers/javascript_controller.rb

@@ -0,0 +1,12 @@
+class JavascriptController < ApplicationController
+  
+  def index
+  end
+  
+  def basic
+  end
+  
+  def examples
+  end
+  
+end

data/site/app/controllers/restful_csharp_controller.rb

@@ -0,0 +1,12 @@
+class RestfulCsharpController < ApplicationController
+  def installing
+  end
+  def short_samples
+  end
+  def client
+  end
+  def license
+  end
+  def what_is_new
+  end
+end

data/site/app/controllers/ruby_controller.rb

@@ -0,0 +1,24 @@
+class RubyController < ApplicationController
+  
+  def index
+  end
+  
+  def basic
+  end
+  
+  def examples
+  end
+  
+  def conneg
+  end
+  
+  def features
+  end
+  
+  def tokamak
+  end
+
+  def opensearch
+  end
+  
+end

data/site/app/controllers/systems_controller.rb

@@ -0,0 +1,14 @@
+class SystemsController < ApplicationController
+  def index
+  end
+  def benefits
+  end
+  def support
+  end
+  def features
+  end
+  def quit_pretending
+  end
+  def hypermedia
+  end
+end

data/site/app/helpers/application_helper.rb

@@ -0,0 +1,10 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  def html(x)
+    x.gsub(/</,'&lt;').gsub(/>/,'&gt;')
+  end
+
+  def rails_path
+    url_for "/caelumobjects-restful-rails.pdf"
+  end
+end

data/site/app/helpers/documentation_helper.rb

@@ -0,0 +1,2 @@
+module DocumentationHelper
+end

data/site/app/views/java/features.html.erb

@@ -0,0 +1,99 @@
+<div id="textoCapitulo">
+<h2>Features</h2>
+
+<p>Most of the client features can be composed during the request building phase. This means that when invoking Restfulie.at() one can specify which features are supposed to be used and which can be left out, allowing an infinite number of combinations without the need to write extra classes.</p>
+
+<h2>Request Features<h2>
+	
+<h3>Retrying requests</h3>
+
+<p>Another characteristic of REST over HTTP is that some requests can be easily retried by adding a new feature to the DSL. The RetryWhenUnavailable feature demonstrates how to use it
+	when the server returns 503. The following code will retry the operation once by using this feature:</p>
+	
+<pre>
+Response response = Restfulie.at("uri").retryWhenUnavailable().get();
+</pre>
+
+<h3>Custom request features</h3>
+
+<p>It is easy to create your own feature, even with configuration parameters, simply create
+	a class and implemente the interface RequestFeature</p>
+	
+<pre>
+	public class MyFatureRequest implement RequestFeature {
+		
+		public Response process(RequestChain chain, Request request, String verb,
+				URI uri, Object payload) {
+		
+			//do something before the request is dispatched
+			Response response = chain.next(request, verb, uri, payload);
+			//do someething after the request have been dispatched
+			return response;
+		}
+		
+	}
+</pre>
+
+<p>After implementing it you just have to pass it so restfulie add it at the stack of features.</p>
+<pre>
+	//the method features can receive more than one feature
+	Restfulie.at("resource_uri").withFeature(MyFeatureRequest.class).get();
+</pre>
+
+<h2>Response Features</h2>
+
+<h3>Throw error feature</h3>
+
+<p>A common asked feature is to throw na error in case some specific response codes are returned. There is a sample feature that can be tweaked as required, that raises an exception when 300+ codes are returned. It's name is "ThrowError" and therefore to load it one only has to invoke it in the DSL:
+
+<pre>
+Response response = Restfulie.at(uri).throwError().get();
+</pre>
+
+<h3>History</h3>
+
+<p>The history feature gives access to the history of executed requests, so one can re-execute
+	it or customize it prior to sending the request again. To add it, simply load it into your DSL:</p>
+
+<pre>
+	Response response = Restfulie.at(uri).history().get();
+	
+	# sends the request again
+	response.getRequestHistory().get(0);
+</pre>
+
+<h3>ConnegWhenUnaccepted</h3>
+
+<p>The ConnegWhenUnaccepted feature retry an request when the server response with the 406("unaccepted media type") code, the new request will be sent with another media type supported by the server(throug Accept) if the client is 
+able to generate it.</p>
+
+<pre>
+	Product product = Restfulie.at("http://localhost:3000/product/2").connegWhenUnaccepted().get();
+</pre>
+
+<h3>Custom request features</h3>
+
+<p>It is easy to create your own feature, even with configuration parameters, simply create
+	a class and implement the interface ResponseFeature</p>
+	
+<pre>
+	public class MyFature implement ResponseFeature {
+		
+		public Response process(ResponseChain responseChain, Response response) {
+			Response reponse = responseChain.next(response);
+			return response;
+		}
+		
+	}
+</pre>
+
+<p>And then pass it so restfulie add it at the stack of features.</p>
+<pre>
+	//the method features can receive more than one feature
+	Restfulie.at("resource_uri").withFeature(MyFeatureResponse.class,OtherFeatureResponse.class).get();
+</pre>
+
+
+<p>All Restfulie client features are implemented through a set of feature classes
+	such as this one. Feel free to contribute with extra features, configuration sets or
+	documentation to them or ask around in the mailing lists for other people contributions.</p>

data/site/app/views/java/hypermedia.html.erb

@@ -0,0 +1,97 @@
+<div id="textoCapitulo">
+<h2>Hypermedia clients</h2>
+
+<p>Hypermedia support information is scattered aroud the entire documentation as this is a hypermedia based library..</p>
+
+<h2>The response object</h2>
+
+The response object to a restfulie http request allows access to four different methods, the
+response <b>code</b>, its <b>body</b>, <b>headers</b> and an extra method called <b>resource</b>
+that will try to unmarshall the response body according to its content type.
+
+Restfulie uses <a href="http://github.com/caelum/medie">medie</a> to do the unmarshalling,
+giving back a hypermedia aware object. The following example shows a typical response to
+a xml request:
+
+<pre>
+Response response = Restfulie.at(uri).accepts("application/xml").get();
+System.out.println(response.getBody());
+<%=html("
+<order>
+	<link rel='payment' href='http://store.caelum.com.br/orders/2345/payment' />
+	<items>
+		<item>
+			<id>Rest from scratch book</id>
+		</item>
+	</items>
+	<price>1235.4</price>
+</order>
+")%>
+System.out.println(response.getCode()); // 200
+System.out.println(response.headers('Content-Type')); //'application/xml'
+Order oder = response.getResourse();
+System.out.println(order.getItems(0).getId()); // "Rest from scratch book"
+</pre>
+
+<h2>Supported media types</h2>
+
+Restfulie client comes with built in support to xml, json and opensearch and can be easily enhanced by providing your own driver through Medie. Check out medie's documentation on how to
+support your own media type or contribute with Restfulie by posting your media
+type handler at the mailing list.
+	
+<h2>Link support</h2>
+
+For representations that contain link elements in its body, such as this one in xml:
+
+<pre>
+<%=html("
+<order>
+	<link rel='payment' href='http://store.caelum.com.br/orders/2345/payment' />
+	<items>
+		<item>
+			<id>Rest from scratch book</id>
+		</item>
+	</items>
+	<price>1235.4</price>
+</order>
+")%>
+</pre>
+
+This link can be accessed by unmarshalling the resource and then accessing the link itself:
+
+<pre>
+Response response = Restfulie.at(uri).get();
+
+//follow the payment link within the order
+Order order = response.getResource();
+// the resource method is staticaly imported from ...
+resource(order).link("payment").follow().get();
+
+//will print the payment body
+System.out.println(order.response.getBody());
+</pre>
+
+Once you have invoked the <b>follow</b> method, the object returned is the same as a
+<b>Restfulie.at()</b> invocation, a request dsl, which allows you to configure the
+request as you wish, and execute it by invoking the proper http verb (i.e. get, post or put).
+
+You can see an example of a full client navigating through links in the examples section.
+
+<h2>Link header support</h2>
+
+If your service provides a link header such as:
+
+<pre>
+Link: <http://amundsen.com/examples/mazes/2d/ten-by-ten/0:north>; rel="start"; type="application/xml"
+</pre>
+
+This header can be accessed by using the headers.link and links method:
+
+<pre>
+Response response = Restfulie.at(uri).get();
+puts response.getHeaders().link("start").getHref();
+
+# following the link
+Resource resource = response.getResource();
+Response anotherResponse = resource.headers.link("start").follow().get();
+</pre>

data/site/app/views/layouts/_blackmenu.html.erb

@@ -0,0 +1,11 @@
+<div id="menuWrap">
+	<ul id="menuElements">
+    	<li><a href="<%=url_for :controller => :systems, :action =>:hypermedia%>"><span>why hypermedia?</span></a></li>
+    	<li><a href="<%=url_for :controller => :systems, :action =>:quit_pretending%>"><span>quit pretending</span></a></li>
+    	<li><a href="<%=url_for :controller => :systems, :action =>:features %>"><span>features</span></a></li>
+    	<li><a href="<%=url_for :controller => :systems, :action =>:documentation %>"><span>documentation</span></a></li>
+    	<li><a href="<%= url_for :support%>"><span>support</span></a></li>
+    	<li><a href="<%=rails_path%>" onclick="javascript:pageTracker._trackPageview('<%= rails_path%>')"><span>pdf</span></a></li>
+    	<li><a href="<%= url_for :benefits%>"><span>testimonials</span></a></li>
+    </ul>
+</div>

data/site/app/views/layouts/_uppermenu.html.erb

@@ -0,0 +1,24 @@
+<div class="navigation">
+    <ul id="nav">
+      <li>
+        <h4><a href="http://github.com/caelum/restfulie/wiki">WIKI</a></h4>
+        <p><a href="http://github.com/caelum/restfulie/wiki">Detailed Documentation</a></p>
+      </li>
+      <li>
+        <h4><a href="https://github.com/caelum/restfulie/wiki/Videos">VIDEO</a></h4>
+        <p><a href="https://github.com/caelum/restfulie/wiki/Videos">Tutorials</a></p>
+      </li>
+      <li>
+        <h4><a href="https://github.com/caelum/restfulie/wiki/Mailing-lists">SUPPORT</a></h4>
+        <p><a href="https://github.com/caelum/restfulie/wiki/Mailing-lists">Mailing list</a></p>
+      </li>
+      <li>
+        <h4><a href="https://github.com/caelum/restfulie/wiki/issues">ISSUES</a></h4>
+        <p><a href="https://github.com/caelum/restfulie/wiki/issues">Issue tracker</a></p>
+      </li>
+      <li>
+        <h4><a href="http://webchat.freenode.net/?channels=restfulie">IRC</a></h4>
+        <p><a href="http://webchat.freenode.net/?channels=restfulie">The human touch</a></p>
+      </li>
+    </ul>
+  </div>

data/site/app/views/layouts/application.html.erb

@@ -0,0 +1,50 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+	<title>restfulie - rest from scratch</title>
+	<%= stylesheet_link_tag "screen", "menu", "uppermenu" %>
+    <!--[if lt IE 7]>
+    <script src="http://ie7-js.googlecode.com/svn/version/2.0(beta3)/IE7.js" type="text/javascript"></script>
+    <![endif]-->
+</head>
+
+<body>
+	<div id="headerWrap">
+    	<div id="headerContent">
+    	
+    	    <%= render :partial => 'layouts/uppermenu' %>
+    	
+        	<h1 id="logoRestfulie"><span>restfulie</span></h1><!-- restfulielogo-->
+        	    <p class="moto">Restful made easy.</p>
+            
+						<a id="caelumObjects" href="http://www.caelumobjects.com/" title="Caelum Objects Site"><span>Caelum Objects</span></a>
+						
+        </div><!-- header content -->
+    </div><!-- header wrap-->
+
+
+    
+	<%= yield %>
+
+    <div id="footerWrap">
+    	<div id="footerContent">
+            <div class="footbar">
+            	<a href="http://caelumobjects.com" style="border:none"><%= image_tag"logoCaelumGray-trans.png", :alt => "caelum logo", :class => "logoFooter" %></a>
+                <p><a href="#.html">license</a> - Restfulie ©2009-2011 Caelum Objects</p>
+            </div><!-- footnote-->
+        </div><!-- footer content -->
+    </div><!-- footer wrap-->
+
+	<script type="text/javascript">
+	var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+	document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+	</script>
+	<script type="text/javascript">
+	try {
+	var pageTracker = _gat._getTracker("UA-11770776-2");
+	pageTracker._trackPageview();
+	} catch(err) {}</script>
+		    
+</body>
+</html>