RubyGems - restfulie - Versions diffs - 1.0.0 → 1.0.3 - Mend

restfulie 1.0.0 → 1.0.3

Files changed (452) hide show

data/site/app/views/layouts/java.html.erb ADDED Viewed

@@ -0,0 +1,72 @@
+<!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", :cache => true %>
+    <!--[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">
+        	<h1 id="logoRestfulie"><span>restfulie</span></h1><!-- vraptorlogo-->
+						<a id="caelumObjects" href="http://www.caelumobjects.com/" title="Caelum Objects Site"><span>Caelum Objects</span></a>
+        </div><!-- header content -->
+    </div><!-- header wrap-->
+    <%= render :partial => 'layouts/menu' %>
+    <div id="contentWrap">
+		  	<div id="contentDocumentacao">
+		      	<h2><span>documentation</span></h2>
+		          <h3>configuration and utilization</h3>
+			    <div id="subMenuDoc">
+											<%= image_tag"subMenuTop-trans.png", :id => "positionTop" %>
+			    	<ol type="1">
+												<li><%= link_to "1. One minute guide", :action => :index%></li>
+												<li><%= link_to "2. Basic Rest", :action => :basic %></li>
+												<li><%= link_to "3. Examples", :action => :examples%></li>
+												<li><%= link_to "4. Content negotiation", :action => :conneg %></li>
+												<li><%= link_to "5. Clients and hyperlinks", :action => :hypermedia%></li>
+												<li><%= link_to "6. Composable client features", :action => :features %></li>
+												<li><%= link_to "7. Server", :action => :server %></li>
+												<li><%= link_to "8. Help!", :controller => :systems, :action => :support %></li>
+			      </ol>
+											<%= image_tag"subMenuBottom-trans.png", :id => "positionBottom" %>
+			    </div><!-- submenu-->
+		          <%= yield %>
+		      </div><!-- content cnt -->
+		  </div><!-- content wrap-->
+	    <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>

data/site/app/views/layouts/javascript.html.erb ADDED Viewed

@@ -0,0 +1,62 @@
+<!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", :cache => true %>
+    <!--[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">
+        	<h1 id="logoRestfulie"><span>restfulie</span></h1><!-- vraptorlogo-->
+						<a id="caelumObjects" href="http://www.caelumobjects.com/" title="Caelum Objects Site"><span>Caelum Objects</span></a>
+        </div><!-- header content -->
+    </div><!-- header wrap-->
+    <%= render :partial => 'layouts/menu' %>
+    <div id="contentWrap">
+		  	<div id="contentDocumentacao">
+		      	<h2><span>documentation</span></h2>
+		          <h3>configuration and utilization</h3>
+    <div id="subMenuDoc">
+								<%= image_tag"subMenuTop-trans.png", :id => "positionTop" %>
+    	<ol type="1">
+									<li><%= link_to "1. One minute guide", :action => :index%></li>
+									<li><%= link_to "2. Basic Rest", :action => :basic %></li>
+      </ol>
+								<%= image_tag"subMenuBottom-trans.png", :id => "positionBottom" %>
+    </div><!-- submenu-->
+		          <%= yield %>
+		      </div>
+		  </div>
+	    <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>

data/site/app/views/layouts/restful_csharp.html.erb ADDED Viewed

@@ -0,0 +1,81 @@
+<!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</title>
+	<%= stylesheet_link_tag :all, :cache => true %>
+    <!--[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">
+        	<h1 id="logoRestfulie"><span>restfulie</span></h1><!-- vraptorlogo-->
+						<a id="caelumObjects" href="http://www.caelumobjects.com/" title="Caelum Objects Site"><span>Caelum Objects</span></a>
+        </div><!-- header content -->
+    </div><!-- header wrap-->
+    <%= render :partial => 'layouts/menu' %>
+    <div id="contentWrap">
+		  	<div id="contentDocumentacao">
+		      	<h2><span>documentation</span></h2>
+		          <h3>configuration and utilization</h3>
+		          <div id="subMenuDoc">
+								<%= image_tag"subMenuTop-trans.png", :id => "positionTop" %>
+		          	<ol type="1">
+									<li><%= link_to "1. Installing", :action => "installing"%></li>
+									<li><%= link_to "2. Short samples", :action => "short_samples"%></li>
+									<li><%= link_to "3. Client", :action => "client"%></li>
+									<li><%= link_to "4. What's new", :action => "what_is_new"%></li>
+									<li><%= link_to "5. License", :action => "license"%></li>
+		            </ol>
+								<%= image_tag"subMenuBottom-trans.png", :id => "positionBottom" %>
+		          </div><!-- submenu-->
+		          <%= yield %>
+		      </div><!-- content cnt -->
+		  </div><!-- content wrap-->
+    <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>
+					<ul>
+                    <li><a href="/">home</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :benefits%>">testimonials</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :rest%>">rest/hateoas</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :rails%>">rails</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :java%>">java</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :support%>">support</a></li>
+                </ul>
+                <p><a href="#.html">license</a> - Restfulie ©2009 Caelum Objects</p>
+            </div><!-- footnote-->
+        </div><!-- footer content -->
+        <a id="signature" href="mailto:lokidg@gmail.com">loki|design</a>
+    </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>

data/site/app/views/layouts/restful_java.html.erb ADDED Viewed

@@ -0,0 +1,87 @@
+<!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</title>
+	<%= stylesheet_link_tag :all, :cache => true %>
+    <!--[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">
+        	<h1 id="logoRestfulie"><span>restfulie</span></h1><!-- vraptorlogo-->
+						<a id="caelumObjects" href="http://www.caelumobjects.com/" title="Caelum Objects Site"><span>Caelum Objects</span></a>
+        </div><!-- header content -->
+    </div><!-- header wrap-->
+    <%= render :partial => 'layouts/menu' %>
+    <div id="contentWrap">
+		  	<div id="contentDocumentacao">
+		      	<h2><span>documentation</span></h2>
+		          <h3>configuration and utilization</h3>
+		          <div id="subMenuDoc">
+		          	<%= image_tag"subMenuTop-trans.png", :id => "positionTop" %>
+		          	<ol type="1">
+									<li><%= link_to "1. Installing", :action => "installing"%></li>
+									<li><%= link_to "2. Short samples", :action => "short_samples"%></li>
+									<li><%= link_to "3. Server", :action => "server"%></li>
+									<li><%= link_to "3.1. Rendering resources", :action => "rendering_resources"%></li>
+									<li><%= link_to "3.2. Server state machine", :action => "server_state_machine"%></li>
+									<li><%= link_to "4. Client", :action => "client"%></li>
+									<li><%= link_to "5. Help and examples", :action => "help_and_examples"%></li>
+									<li><%= link_to "5.1. Live examples", :action => "live_examples"%></li>
+									<li><%= link_to "6. License", :action => "license"%></li>
+									<li><%= link_to "7. Roadmap", :action => "roadmap"%></li>
+									<li><%= link_to "8. What's new", :action => "what_is_new"%></li>
+		            </ol>
+								<%= image_tag"subMenuBottom-trans.png", :id => "positionBottom" %>
+		          </div><!-- submenu-->
+		          <%= yield %>
+		      </div><!-- content cnt -->
+		  </div><!-- content wrap-->
+    <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>
+					<ul>
+                    <li><a href="/">home</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :benefits%>">testimonials</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :rest%>">rest/hateoas</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :rails%>">rails</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :java%>">java</a></li>
+                    <li>|</li>
+                    <li><a href="<%=url_for :support%>">support</a></li>
+                </ul>
+                <p><a href="#.html">license</a> - Restfulie ©2009 Caelum Objects</p>
+            </div><!-- footnote-->
+        </div><!-- footer content -->
+        <a id="signature" href="mailto:lokidg@gmail.com">loki|design</a>
+    </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>

data/site/app/views/shared/_examples.html.erb ADDED Viewed

@@ -0,0 +1,29 @@
+<div id="textoCapitulo">
+<h2>Examples</h2>
+	There are plenty of sample applications using Restfulie Ruby scattered around the web, and here you find a small listing of those systems:<br/>
+<ol>
+	<li><a href="https://github.com/caelum/restfulie-restbuy">Restbuy</a> - a service application that allows consumers to buy products and share payments. You can see all the power of hypermedia in place. The client code is contained in the spec folder. Ruby examples.</li>
+	<li><a href="https://github.com/caelum/restfulie-provisioning">Restfulie provisioning</a> - a provisioning example. Ruby code.</li>
+	<li><a href="http://restfulie.caelumobjects.com/caelumobjects-restful-rails.pdf">A guide on how to create a Restfulie project</a></li>
+	<li><a href="https://github.com/caelum/vraptor/tree/master/vraptor-mydvds">Mydvds</a> - controls a list of dvds, owners, security and so on. Java code</li>
+</ol>
+<h2>Java blank projects</h2>
+VRaptor, restfulie server side in Java (the oldest and more mature of all versions), <a href="https://github.com/caelum/vraptor/tree/master/">contains a few blank projects for default usage, scala usage or google app engine support</a>. One can also use <a href="http://vraptor.org/documentation">its vraptor-scaffold feature</a>.
+<h2>Source code - all versions</h2>
+All restfulie versions can be found in several different git repositories:
+<ul>
+	<li><a href="http://github.com/caelum/restfulie-all">All projects in one github project</li>
+	<li><a href="http://github.com/caelum/restfulie">Ruby client and server</li>
+	<li><a href="http://github.com/caelum/restfulie-java">Java client</li>
+	<li><a href="http://github.com/caelum/vraptor">Java server (vraptor)</li>
+	<li><a href="http://github.com/caelum/restfulie-javascript">Javascript client</li>
+	<li><a href="http://github.com/caelum/restfulie-py">Python client</li>
+	<li><a href="https://github.com/mauricioaniche/restfulie.net">C# server</li>
+</ul>
+</div>

data/site/app/views/shared/_negotiation.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<h3>What is content negotation?</h3>
+<p>REST clients know how to deal with several different media types, for instance application/xml and application/opensearchdescriptor+xml. Being so, when requesting something to your service, a client tells which media types it is capable of understand so the service provides the best fit between the ones both of them are capable of handling.</p>
+<%= image_tag "negotiation.png", :title => "Content negotiation" %><br/>
+Content negotiation is the key concept that allows services to change their links to other parts of other systems while not breaking compatibility with their consumers (clients).
+Because the new linked services supports a set of media types that so does your client, changes can be made and nothing breaks.

data/site/app/views/shared/_simple_representation.html.erb ADDED Viewed

@@ -0,0 +1,37 @@
+<h3>Hypermedia representations</h3>
+<p>A Restful application should support hypermedia content, and following this constraint, a typical resource representing an order in xml would add controls (links or forms) so clients can navigate through your service protocol (in this case, make a payment):</p>
+<pre>
+	<%= html '
+<order xmlns:atom="http://www.w3.org/2005/Atom">
+	<product>rails training</product>
+	<product>REST training</product>
+	<price>512.45</price>
+	<atom:link rel="self" href="http://www.caelum.com.br/orders/1" />
+	<atom:link rel="payment" href="http://www.caelum.com.br/orders/1/payment" />
+</order>
+'%>
+</pre>
+Here the order is represented through a typical application/xml file, but it has something extra: controls that allows clients to decide what to do next.
+Or an <b>example</b> of a valid json representation with hypermedia:
+<pre>
+{ "order" : {
+		"product" : "rails training",
+		"product" : "rest training",
+		"price" : "512.45"
+		"links" : {
+			"link" : { "rel" : "self", "href" : "http://www.caelum.com.br/orders/1"},
+			"link" : { "rel" : "payment", "href" : "http://www.caelum.com.br/orders/1/payment"}
+		}
+	}
+}
+</pre>
+Last of all, one could add the links on the Link header of the http response:
+<pre>
+<%= html 'Link: <http://www.caelum.com.br/orders/1>; rel="self", <http://www.caelum.com.br/orders/1/payment>; rel="payment"' %>
+</pre>

data/site/app/views/systems/features.html.erb ADDED Viewed

@@ -0,0 +1,106 @@
+<div id="contentWrap">
+	Client side
+	<table>
+		<thead>
+			<tr>
+				<th>Feature set</th>
+				<th>Java</th>
+				<th>C#</th>
+				<th>Ruby</th>
+				<th>Javascript</th>
+				<th>Python</th>
+			</tr>
+		</thead>
+		<tr>
+			<td>Http verbs + patch</td>
+			<td>yes</td>
+			<td>yes</td>
+			<td>yes</td>
+			<td>yes</td>
+			<td>?</td>
+		</tr>
+		<tr>
+			<td>Client content negotiation</td>
+			<td>yes</td>
+			<td>?</td>
+			<td>yes</td>
+			<td>?</td>
+			<td>?</td>
+		</tr>
+		<tr>
+			<td>Media types</td>
+			<td>json, xml</td>
+			<td>json, xml</td>
+			<td>json, xml, atom, opensearch, custom, formurlencoded</td>
+			<td>json, xml</td>
+			<td>json, xml</td>
+		</tr>
+		<tr>
+			<td>Media type profile through acceptors</td>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+		</tr>
+		<!--
+		<tr>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+		</tr>
+		-->
+	</table>
+	<br/><br/>
+	Server side
+	<table>
+		<thead>
+			<tr>
+				<th>Feature set</th>
+				<th>Java</th>
+				<th>C#</th>
+				<th>Ruby</th>
+			</tr>
+		</thead>
+		<tr>
+			<td>Http verbs + patch</td>
+			<td>yes</td>
+			<td>yes</td>
+			<td>yes</td>
+		</tr>
+		<tr>
+			<td>Server content negotiation</td>
+			<td>yes</td>
+			<td>?</td>
+			<td>yes</td>
+		</tr>
+		<tr>
+			<td>Media types</td>
+			<td>json, xml, formurlencoded</td>
+			<td>json, xml, formurlencoded</td>
+			<td>json, xml, atom, opensearch, custom, formurlencoded</td>
+		</tr>
+		<tr>
+			<td>Media type profile</td>
+			<td></td>
+			<td></td>
+			<td></td>
+		</tr>
+		<!--
+		<tr>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+			<td></td>
+		</tr>
+		-->
+	</table>
+</div>