rubyrest 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,4 +1,12 @@
-*0.0.1*
+== 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.
+* Better HTTP response codes for DELETE and POST
+* Atom formatting now more robust against nil values
+
+== Release 0.0.1
 
 * Initial release with very basic CRUD facilities
 * Hello sample application included

data/README

@@ -14,7 +14,7 @@ lets you create new REST services without too much effort.
 
 To check out the source code:
   
-  svn checkout http://rubyrest.rubyforge.org/svn/trunk
+  svn checkout svn://rubyforge.org/var/svn/rubyrest/trunk
   
 === Contact
 
@@ -36,6 +36,16 @@ Ruby-on-Rest provides a shell command. Open your console, and type the following
  
   rubyrest start|stop <my_service> [<my_service_module>]
 
+Ruby-on-Rest can also be embedded in ruby code. This is useful for testing purposes:
+
+  engine = RubyRest::Engine.new( <my_service>, <my_service_module> )
+  engine.start
+  # ...	
+  # do some http calls here
+  # ...
+  engine.stop
+
+
 === Configuring your service
 
 Ruby-on-Rest will try to load a file name <my_service>.rb which must provide access to

data/Rakefile

@@ -6,7 +6,7 @@ require 'fileutils'
 include FileUtils
 
 NAME = "rubyrest"
-VERS = "0.0.1"
+VERS = "0.0.2"
 CLEAN.include ['**/.*.sw?', 'pkg/*', '.config', 'doc/*', 'coverage/*']
 RDOC_OPTS = ['--quiet', '--title', "Ruby-on-Rest: A simple REST framework for Ruby",
   "--opname", "index.html",
@@ -25,7 +25,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.options += RDOC_OPTS
   rdoc.main = "README"
   rdoc.title = "Ruby-on-Rest Documentation"
-  rdoc.rdoc_files.add ['README', 'COPYING', 'lib/rubyrest.rb', 'lib/rubyrest/**/*.rb', 'examples/**/*.rb' ]
+  rdoc.rdoc_files.add ['README', 'COPYING', "CHANGELOG", 'lib/rubyrest.rb', 'lib/rubyrest/**/*.rb', 'examples/**/*.rb' ]
 end
 
 spec = Gem::Specification.new do |s|
@@ -45,7 +45,7 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('metaid')
   s.required_ruby_version = '>= 1.8.2'
 
-  s.files = %w(COPYING README Rakefile) + Dir.glob("{bin,doc,lib}/**/*")
+  s.files = %w(COPYING README CHANGELOG Rakefile) + Dir.glob("{bin,doc,lib}/**/*")
       
   s.require_path = "lib"
   s.bindir = "bin"
@@ -75,9 +75,9 @@ end
 desc 'Make a release in Rubyforge'
 task :release => [:clean, :package, :doc_rforge ] do
   # create a svn tag
-  sh %{svn copy svn+ssh://rubyforge.org/var/svn/rubyrest/trunk svn+ssh://rubyforge.org/var/svn/rubyrest/tags/#{VERS}}
+  sh %{svn copy -m 'TAG: #{VERS}' svn+ssh://rubyforge.org/var/svn/rubyrest/trunk svn+ssh://rubyforge.org/var/svn/rubyrest/tags/#{VERS}}
   # upload the gem
-  sh %{scp pkg/#{NAME}-#{VERS}.gem sicozu@rubyforge.org:/var/www/gforge-projects/rubyrest/}
+  #sh %{scp pkg/#{NAME}-#{VERS}.gem sicozu@rubyforge.org:/var/www/gforge-projects/rubyrest/}
 end
 
 require 'spec/rake/spectask'

data/bin/rubyrest

@@ -6,62 +6,21 @@
 require 'rubygems'
 require 'rubyrest'
 
+service = ARGV[1]
+prefix = ARGV[2]
+action = ARGV[0]
 
-module RubyRest
-  
-  
-  class RubyRestBoot
-    include RubyRest::Tools
-    
-    def initialize( option, service, prefix = nil )
-      
-      if option == nil or service == nil or !self.respond_to?( option )  
-        help_and_exit
-        return
-      end
-      
-      @option = option
-      @service = service
-      @service_prefix = prefix
-      
-      #begin
-        self.method( @option ).call 
-      #rescue => e
-      #  puts "ERROR #{e.message}"
-      #end
-      
-    end
-    
-    def help_and_exit
-      puts "Usage: rubyrest start|stop <your_service> "
-      puts "Ruby-on-Rest: Simple REST for Ruby."
-      puts
-      puts "Examples:"
-      puts "  rubyrest start grape"
-      puts "  rubyrest stop grape"
-      puts
-      puts "For more information see http://rubyrest.rubyforge.org"
-    end
-    
-    def start
-      service_module = to_module_name( @service_prefix, @service )
-      require @service
-      puts "=> Starting service '#{@service}' in module '#{service_module}'"
-      config = to_class( service_module, "config" ).new
-      config[ :servicemodule ] = service_module
-      RubyRest::Engine.new( config ).start
-      puts "=> Service #{@service} running!"
-    end
-    
-    
-    def stop
-      puts "=> Stopping service #{@service}..."
-      
-      
-      puts "=> Service #{@service} stopped!"
-    end
-    
-  end
+if action == nil or ( action != "start" and  action != "stop" )  or service == nil
+  puts "Usage: rubyrest start|stop <your_service> "
+  puts "Ruby-on-Rest: Simple REST for Ruby."
+  puts
+  puts "Examples:"
+  puts "  rubyrest start grape"
+  puts "  rubyrest stop grape"
+  puts
+  puts "For more information see http://rubyrest.rubyforge.org"
+else
+  engine = RubyRest::Engine.new( service, prefix )
+  engine.method( action ).call
 end
 
-RubyRest::RubyRestBoot.new( ARGV[0], ARGV[1], ARGV[2] )

data/lib/rubyrest/atom.rb

@@ -92,10 +92,13 @@ module RubyRest
           builder.summary object.atom_summary
           builder.link( "rel" => "alternate", "href" => entry_link )
 
-          if object.respond_to? :atom_related
-            object.atom_related.each{ |related| 
+          if object.respond_to?( :atom_related )
+            related_entities = object.atom_related
+            if related_entities.respond_to?( :each )
+              related_entities.each{ |related| 
                 builder.link( "rel" => "related", "href" => "#{entry_link}/#{related}", "title" => "#{related}", "type" =>  ATOM_TYPE ) 
-            }
+              }
+            end
           end
       
           builder.moodisland :content do

data/lib/rubyrest/engine.rb

@@ -8,27 +8,43 @@ module RubyRest
   # Objects of this class take a configuration as argument
   # then launch a new server instance. 
   class Engine
+    include Tools
     
     # Enables external objects to read the 
     # engine configuration
     attr_reader :config
     
-    # Creates a new RubyRest engine, for the specified
-    # configuration
-    def initialize( config )
-      @config = config
+    # Creates a new RubyRest engine, for the service 
+    # and service prefix
+    def initialize( service, prefix = nil )
+      @service = service
+      @prefix = prefix
+      service_module = to_module_name( @prefix, @service )
+      require @service
+      @config = to_class( service_module, "config" ).new
+      @config[ :servicemodule ] = service_module
     end
     
-    # Starts the engine. 
-    # The following operations are accomplished:
+    # Starts the engine. The following operations are accomplished:
     # 
-    #   1. establish a connection to the database
-    #   2. initialize the database schema
-    #   3. load initial data into the database
-    #
+    #   1. configure the database
+    #   2. launch the webserver, in daemon mode unless false is 
+    # specified in the configuration
     def start
       configure_database if @config.has( :dbadapter )
-      start_server
+      @server = RubyRest::Server.new( @config )
+      @server.mount "/", CRUDServlet
+      if @config.has( :daemon ) and @config[ :daemon ] == false 
+        start_server 
+      else start_daemon end
+    end
+    
+    # Shutdowns the current server, if existing.
+    # This is only useful when working in daemon mode.
+    def stop
+      return if @pid == nil
+      Process.kill( 9, @pid )
+      puts "#{self.to_s}: killed process with pid=#{@pid}"
     end
     
     # Configures the database connectivity
@@ -41,16 +57,25 @@ module RubyRest
       end
     end
     
-    # Configures and returns a new web server
-    # instance. For the moment, only WEBrick instances
-    # are supported 
+    # Starts the server in another process
+    def start_daemon
+      @pid = fork do
+        start_server
+      end
+      puts "#{self.to_s}: started process with pid=#{@pid}"
+    end
+    
+    # Starts the server
     def start_server
-      server = RubyRest::Server.new( @config )
       [ "INT", "TERM" ].each { |signal|
-        trap( signal ) { server.shutdown }
+        trap( signal ) { @server.shutdown }
       }
-      server.mount "/", CRUDServlet
-      server.start
+      @server.start
+    end
+    
+    # Returns the service name
+    def to_s 
+      "rubyrest: #{@service}"
     end
     
   end

data/lib/rubyrest/servlets.rb

@@ -72,7 +72,6 @@ module RubyRest
       else
         response.status = @success_code
         format_response( request, response ) if @result != nil
-        raise WEBrick::HTTPStatus::OK
       end
     end
     
@@ -114,7 +113,7 @@ module RubyRest
       resolve_params( request )
       incompatible_path( request ) if @id == nil
       @generic_method = :delete
-      @success_code = 200
+      @success_code = 410
       dispatch( request, response )
     end
     

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: rubyrest
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-03-28 00:00:00 +02:00
+  version: 0.0.2
+date: 2007-03-30 00:00:00 +02:00
 summary: REST framework for Ruby.
 require_paths: 
 - lib
@@ -31,6 +31,7 @@ authors:
 files: 
 - COPYING
 - README
+- CHANGELOG
 - Rakefile
 - bin/rubyrest
 - doc/rdoc
@@ -41,7 +42,6 @@ files:
 - lib/rubyrest/engine.rb
 - lib/rubyrest/servlets.rb
 - lib/rubyrest/tools.rb
-- CHANGELOG
 - examples/hello.rb
 test_files: []