rubyrest 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,5 +1,10 @@
-== Release 0.0.2
+== Release 0.0.3
+
+* Added module RubyRest::Client, providing a convenience client to REST APIs deployed with Ruby-on-Rest
+* Improved Atom representation of resources (feeds, entries and service documents)
+* Dashboard (service document) can now be customized by developpers by implementing a class with name Dashboard.
 
+== Release 0.0.2
 
 * The engine now starts a daemonized server by default
 * The engine is now embeddable in ruby code, thanks to RubyRest::Engine new implementation.

data/Rakefile

@@ -6,7 +6,7 @@ require 'fileutils'
 include FileUtils
 
 NAME = "rubyrest"
-VERS = "0.0.2"
+VERS = "0.0.3"
 CLEAN.include ['**/.*.sw?', 'pkg/*', '.config', 'doc/*', 'coverage/*']
 RDOC_OPTS = ['--quiet', '--title', "Ruby-on-Rest: A simple REST framework for Ruby",
   "--opname", "index.html",

data/lib/rubyrest/atom.rb

@@ -19,7 +19,10 @@ module RubyRest
       HTML_TYPE = "text/html".freeze
       WORKSPACE_METHOD = "dashboard".freeze
       MODULEID = "Ruby-on-Rest (http://rubyrest.rubyforge.org)".freeze
-       
+      
+      
+    
+      
       #
       # Formats the response as a Atom feed, Atom Entry or 
       # Atom Service Document
@@ -34,7 +37,8 @@ module RubyRest
         else 
           response[ "content-type" ] = ATOM_TYPE 
           if @result.respond_to? "each"
-            build_feed( @result, builder, request.request_uri, request.path, @method )
+            title = @property || @model
+            build_feed( @result, builder, request.request_uri, request.path, title )
           else build_entry( @result, builder, request.request_uri ) end
         end
       end
@@ -42,16 +46,18 @@ module RubyRest
   
       # Builds an Atom Service Document. This is a representation of the 
       # user's dashboard or initial workspace.
-      def build_service_document( workspace, builder, uri )
+      def build_service_document( collections, builder, uri )
         builder.service( NAMESPACES ){
           builder.workspace {
             builder.title "Dashboard"
-            workspace.each { |w| 
-              builder.collection( { "href" =>  "#{uri}#{w}" } ) {
-                builder.title "#{w}_all"
-                builder.accept "entry"
-              }
-            }
+            if collections != nil and collections.respond_to?( :each ) 
+                collections.each { |col| 
+                  builder.collection( { "href" =>  "/#{col}" } ) {
+                    builder.title col
+                    builder.accept "entry"
+                  }
+                }
+            end
           }
         }
       end
@@ -93,7 +99,7 @@ module RubyRest
           builder.link( "rel" => "alternate", "href" => entry_link )
 
           if object.respond_to?( :atom_related )
-            related_entities = object.atom_related
+            related_entities = object.atom_related( @principal )
             if related_entities.respond_to?( :each )
               related_entities.each{ |related| 
                 builder.link( "rel" => "related", "href" => "#{entry_link}/#{related}", "title" => "#{related}", "type" =>  ATOM_TYPE ) 
@@ -140,6 +146,28 @@ module RubyRest
         def atom_author
           self.createdby
         end
+        
+        # Adds some convenience methods to a standard REXML
+        # document. This class supposes that the document is an Atom
+        # entry
+        class Document < REXML::Document 
+
+          # Resolves the missing method into a content property
+          # and returns its text value
+          def method_missing( name, *args )
+            location = "/entry/moodisland:content/#{name}"
+            method_name = name.to_s.chomp
+            if method_name == name.to_s
+              text( location )
+            else get_text( location ).value = args[0] end
+          end
+          
+          # Shortcut for the id element contained
+          # within the content.
+          def id
+            text( "/entry/moodisland:content/id" )
+          end
+        end
 
       end
       

data/lib/rubyrest/client.rb

@@ -0,0 +1,72 @@
+module RubyRest
+  
+  # This module provides a convenient interface
+  # to REST services offered by Ruby-on-REST. 
+  module Client
+    
+    # Builds a headers hash, with the specified 
+    # authorization token if not nil
+    def prepare_headers( auth = nil )
+      headers = { "Content-Type" => "text/xml; charset=utf-8" }
+      headers[ "token" ] = auth if auth != nil 
+      return headers
+    end
+    
+    # Reusable method that builds an Atom entry out of the specified hash of data
+    def hash2entry( data )
+      doc = RubyRest::Atom::Entry::Document.new
+      entry = REXML::Element.new( "entry", doc  )
+      content = REXML::Element.new( "content", entry )
+      data.each { |name,value| 
+        body = REXML::Element.new( name.to_s, content )
+        body.text = value
+      }
+      return doc
+    end
+    
+    # Parses the response body string as a Ruby-on-Rest Entry document,
+    def str2entry( rsp )
+      begin
+        RubyRest::Atom::Entry::Document.new( rsp.body ) if response.body
+      rescue => e
+        return nil
+      end
+    end
+    
+    # Reusable method that creates a query string
+    # with the specified hash of data
+    def to_query_string( data )
+      qs = "?"
+      params.each{ |k,v| qs << "#{k}=#{v}&" }
+      qs.chop!
+    end
+    
+    # Performs a POST request and returns the raw response object
+    # The data (a hash of name,value pairs) is converted to an
+    # simplified Atom Entry
+    def post( server, port, path, data, token )
+      body = nil
+      body = hash2entry( data ).to_s if data != nil
+      headers = prepare_headers( token )
+      rsp = Net::HTTP.new( server, port ).post( path, body, headers )
+      [ rsp.code.to_i, str2entry( rsp ) ] 
+    end
+    
+    # Performs a GET request and returns the raw response object
+    # The data (a hash of name,value pairs) is converted to a query
+    # string, then concatenated to the path.
+    def get( server, port, path, data, token )
+      path << to_query_string( data ) if data
+      headers = prepare_headers( token )
+      rsp = Net::HTTP.new( server, port ).get( path, headers )
+      [ rsp.code.to_i, str2entry( rsp ) ] 
+    end
+    
+   
+    
+  end
+  
+ 
+  
+  
+end

data/lib/rubyrest/servlets.rb

@@ -24,11 +24,6 @@ module RubyRest
       if server.rubyrest.has( :authmodel )
         @authmodel = server.rubyrest[ :authmodel ]
       end
-      
-      if server.rubyrest.has( :dashboard )
-        @dashboard = server.rubyrest[ :dashboard ]
-      else @dashboard = server.rubyrest[ :servicemodel ][0] end
-        
     end
     
     # Inspects the request, and resolve the parameters
@@ -71,7 +66,7 @@ module RubyRest
         raise WEBrick::HTTPStatus::Unauthorized
       else
         response.status = @success_code
-        format_response( request, response ) if @result != nil
+        format_response( request, response )
       end
     end
     
@@ -162,9 +157,9 @@ module RubyRest
     
     # Returns the model defined by the configuration
     # option :dashboard
-    #
     def dashboard( request ) 
-      [ @dashboard ]
+      clazz = to_class( @servicemodule, "dashboard" )
+      clazz.rest_retrieve( @principal )
     end
   
   end

data/lib/rubyrest.rb

@@ -7,7 +7,7 @@ require "extensions/all"
 require "builder"
 require "rexml/document"
 require "webrick"
-require "atom"
+
 
 dir = File.join( File.dirname( __FILE__ ), 'rubyrest' )
 
@@ -16,6 +16,7 @@ require File.join( dir, "atom" )
 require File.join( dir, "servlets" )
 require File.join( dir, "config" )
 require File.join( dir, "engine" )
+require File.join( dir, "client" )
 
 module RubyRest #:nodoc:
   class << self

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: rubyrest
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-03-30 00:00:00 +02:00
+  version: 0.0.3
+date: 2007-04-08 00:00:00 +02:00
 summary: REST framework for Ruby.
 require_paths: 
 - lib
@@ -38,6 +38,7 @@ files:
 - lib/rubyrest
 - lib/rubyrest.rb
 - lib/rubyrest/atom.rb
+- lib/rubyrest/client.rb
 - lib/rubyrest/config.rb
 - lib/rubyrest/engine.rb
 - lib/rubyrest/servlets.rb