ruote-kit 2.1.8.2 → 2.1.10

data/.gitignore

@@ -5,3 +5,4 @@ work*/
 doc/*
 pkg/*
 .bundle/*
+nbproject/*

data/Gemfile

@@ -6,14 +6,30 @@ gem 'bundler'
 gem 'sinatra'
 gem 'sinatra-respond_to'
 gem 'haml'
-gem 'json'
+
+# json support
+#
+# you should choose one of the following three or add another backend supported
+# by Rufus::Json (http://github.com/jmettraux/rufus-json/)
+#
+# gem 'json_pure' # safest all-around choice
+# gem 'yajl-ruby' # the fastest, but using c code
+# gem 'json'      # not bad, but using c code and sometimes broken
+#
+# needed, uses one of the above as backend
+gem 'rufus-json', '>= 0.2.3'
 
 # ruote
-#gem 'ruote', :git => "git://github.com/kennethkalmer/ruote", :branch => "ruote-kit"
-gem 'ruote', '>= 2.1.8'
+gem 'ruote', '>= 2.1.10'
 
 # Testing environment requirements
 group :test do
-  gem 'rspec'
+  gem 'rspec', :require => "spec"
+  gem 'rack-test'
+  gem 'webrat'
+  gem 'test-unit', '~> 1.2.3'
+end
+
+group :build do
   gem 'jeweler'
 end

data/README.rdoc

@@ -18,13 +18,13 @@ Follow development:
 ruote-kit is under heavy development and will likely change violently over the
 coming weeks (albeit for the better).
 
-Dependencies you currently need is:
+Dependencies you currently need are:
 
 * bundler 0.9.5 or later (gem install bundler)
 * sinatra
 * sinatra-respond_to
 * haml
-* json
+* rufus-json[http://github.com/jmettraux/rufus-json] and a compatible backend
 * rspec (only to run the specs)
 
 ruote-kit uses bundler to setup and maintain its environment. Before running
@@ -38,12 +38,64 @@ unpacked in .bundle
 
 == Getting started quickly
 
-Once you have the dependencies installed, get going by running 'rackup'
-from inside the ruote-kit project.
+=== Using the RubyGem
+
+* Install the gem and its dependencies
+    $ gem install ruote-kit
+* You'll need an empty directory
+    $ mkdir my-ruote-kit && cd my-ruote-kit
+* There are two files needed in that directory: Gemfile and config.ru
+  * Gemfile
+      source :gemcutter
+      gem 'ruote-kit'
+  * config.ru
+      begin
+        # Try to require the preresolved locked set of gems.
+        require ::File.expand_path('.bundle/environment', __FILE__)
+      rescue LoadError
+        # Fall back on doing an unlocked resolve at runtime.
+        require "rubygems"
+        require "bundler"
+        Bundler.setup(:default)
+      end
+
+      # load json backend
+      require 'yajl-ruby'    # best choice as fastest, but uses a c module
+      # require 'json_pure'  # should work everywhere
+
+      require 'ruote-kit'
+
+      RuoteKit.configure do |config|
+        config.register { catchall }
+      end
+
+      use Rack::CommonLogger
+      use Rack::Lint
+
+      run RuoteKit::Application
+* Just to make sure every dependency is resolved
+    $ bundle check
+* If there are missing dependencies (there shouldn't be any if the gem
+  installation succeeded)
+    $ bundle install
+* Get going
+    $ rackup
+
+=== Using the source
+
+* Get the source files using git
+    $ git clone http://github.com/kennethkalmer/ruote-kit.git && cd ruote-kit
+* Make sure every dependency is resolved
+    $ bundle install
+* Get going
+    $ rackup
+
+=== Accessing the web interface
 
 If ruote-kit starts up without any issues (ie missing dependencies), you can
-point your browser to 'http://localhost:9292/_ruote/' to get going. By default ruote-kit
-binds to all IP addresses, so this works out the box remotely too.
+point your browser to 'http://localhost:9292/_ruote/' to get going.
+By default ruote-kit binds to all IP addresses, so this works out the box
+remotely too.
 
 == Plugging ruote-kit into your rack-stack
 
@@ -105,11 +157,8 @@ You may also use the catchall participant provided by RuoteKit. It's named '.+',
 so it will catch all workitems for any participant mentioned in your workflow
 definitions which are not already caught by another (previously) registered
 participant. So make sure to register the catchall after your own participants.
-The catchall participant may be registered by calling
-
-  catchall
-
-within the block given to RuoteKit::Configuration#register (this will use
+The catchall participant may be registered by calling +catchall+ within the
+block given to RuoteKit::Configuration#register (this will use
 Ruote::StorageParticipant as participant implementation, you may use any options
 of Ruote::Engine#register_participant to overwrite that default -- see the
 example above).
@@ -117,11 +166,11 @@ example above).
 == Running workers
 
 If you're using ruote-kit as part of your rack stack you'll need to start at
-least one worker separately or the workflows will be executed. You won't need
+least one worker separately or the workflows won't be executed. You won't need
 more than one worker unless you are running hundreds of processes at the same
 time.
 
-To run a worker you need to setup a worker scripts similar to the rake example
+To run a worker you need to setup a worker script similar to the rake example
 below:
 
   require 'rake'

data/Rakefile

@@ -1,15 +1,9 @@
 
 require 'rake/tasklib'
 
-begin
-  # Try to require the preresolved locked set of gems.
-  require ::File.expand_path('.bundle/environment', __FILE__)
-rescue LoadError
-  # Fall back on doing an unlocked resolve at runtime.
-  require "rubygems"
-  require "bundler"
-  Bundler.setup
-end
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test, :build)
 
 require 'lib/ruote-kit/version'
 
@@ -22,7 +16,7 @@ begin
     gemspec.description = 'ruote-kit is a RESTful Rack app for the ruote workflow engine'
     gemspec.email = 'kenneth.kalmer@gmail.com'
     gemspec.homepage = 'http://github.com/kennethkalmer/ruote-kit'
-    gemspec.authors = ['kenneth.kalmer@gmail.com']
+    gemspec.authors = ['kenneth.kalmer@gmail.com', 'John Mettraux']
     gemspec.extra_rdoc_files.include '*.txt'
 
     gemspec.files.include 'lib/ruote-kit/public/**/*'
@@ -32,11 +26,14 @@ begin
     gemspec.add_dependency 'sinatra', '>=0.9.4'
     gemspec.add_dependency 'sinatra-respond_to', '>=0.4.0'
     gemspec.add_dependency 'haml', '>= 2.2.5'
-    gemspec.add_dependency 'json'
-    gemspec.add_dependency 'ruote', '>= 2.1.8'
+    gemspec.add_dependency 'rufus-json', '>= 0.2.3'
+    gemspec.add_dependency 'ruote', '>= 2.1.10'
     gemspec.add_development_dependency 'rake'
     gemspec.add_development_dependency 'rspec'
     gemspec.add_development_dependency 'jeweler'
+    gemspec.add_development_dependency 'webrat'
+    gemspec.add_development_dependency 'test-unit', '~> 1.2.3'
+    gemspec.add_development_dependency 'rack-test'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/config.ru

@@ -1,20 +1,36 @@
+
 begin
   # Try to require the preresolved locked set of gems.
   require ::File.expand_path('.bundle/environment', __FILE__)
 rescue LoadError
   # Fall back on doing an unlocked resolve at runtime.
-  require "rubygems"
-  require "bundler"
-  Bundler.setup
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup(:default)
 end
 
+# load json support
+# try yajl-ruby first, and json after that
+begin
+  require 'yajl'
+rescue LoadError
+  begin
+    require 'json'
+  rescue LoadError
+    puts 'Please specify "gem {yajl-ruby|json_pure|json}" in the Gemfile'
+    exit
+  end
+end
+
+require 'rufus-json'
+
 $:.unshift 'lib'
 
-require 'lib/ruote-kit'
+require 'ruote-kit'
 
 # Chance to configure ruote-kit
 RuoteKit.configure do |config|
-  
+
   # storage mode
   #config.mode = :transient
 
@@ -33,3 +49,4 @@ use Rack::Lint
 use Rack::ShowExceptions
 
 run RuoteKit::Application
+

data/lib/ruote-kit.rb

@@ -1,11 +1,10 @@
-require 'json'
+require 'rufus-json'
 require 'ruote'
 require 'ruote/part/storage_participant'
+require 'ruote-kit/version'
 
 module RuoteKit
 
-  VERSION = '2.1.8.2'
-
   autoload :Configuration, "ruote-kit/configuration"
   autoload :Application,   "ruote-kit/application"
   autoload :Helpers,       "ruote-kit/helpers"

data/lib/ruote-kit/application.rb

@@ -42,7 +42,7 @@ module RuoteKit
       end
     end
 
-    get '/_ruote' do
+    get '/_ruote/?' do
       respond_to do |format|
         format.html { haml :index }
         format.json { json :misc, "ruote-kit" => "welcome", "version" => RuoteKit::VERSION }

data/lib/ruote-kit/helpers/launch_item_parser.rb

@@ -7,7 +7,7 @@ module RuoteKit
         case env["CONTENT_TYPE"]
 
         when "application/json" then
-          data = JSON.parse( env["rack.input"].read )
+          data = Rufus::Json.decode( env["rack.input"].read )
           launch_item = {}
           launch_item['pdef'] = data["definition"]
           launch_item['fields'] = data["fields"] || {}
@@ -18,10 +18,10 @@ module RuoteKit
           launch_item = { 'pdef' => params[:process_definition] }
           fields = params[:process_fields] || ""
           fields = "{}" if fields.empty?
-          launch_item['fields'] = JSON.parse( fields )
+          launch_item['fields'] = Rufus::Json.decode( fields )
           vars = params[:process_variables] || ""
           vars = "{}" if vars.empty?
-          launch_item['variables'] = JSON.parse( vars )
+          launch_item['variables'] = Rufus::Json.decode( vars )
           return launch_item
 
         else
@@ -38,12 +38,12 @@ module RuoteKit
         case env['CONTENT_TYPE']
 
         when "application/json" then
-          data = JSON.parse( env['rack.input'].read )
+          data = Rufus::Json.decode( env['rack.input'].read )
           options[:fields] = data['fields'] unless data['fields'].nil? || data['fields'].empty?
           options[:proceed] = data['_proceed'] unless data['_proceed'].nil? || data['_proceed'].empty?
 
         when "application/x-www-form-urlencoded"
-          options[:fields] = JSON.parse( params[:fields] ) unless params['fields'].nil? || params['fields'].empty?
+          options[:fields] = Rufus::Json.decode( params[:fields] ) unless params['fields'].nil? || params['fields'].empty?
           options[:proceed] = params[:_proceed] unless params[:_proceed].nil? || params[:_proceed].empty?
 
         else

data/lib/ruote-kit/helpers/render_helpers.rb

@@ -8,10 +8,10 @@ module RuoteKit
           object = send( "json_#{resource}", object )
         end
 
-        {
+        Rufus::Json.encode( {
           "links" => links( resource ),
-          resource => object
-        }.to_json
+          resource.to_s => object
+        } )
       end
 
       def json_processes( processes )
@@ -20,9 +20,9 @@ module RuoteKit
 
       def json_process( process )
         links = [
-          link( "/_ruote/processes/#{process.wfid}", rel('#process') ),
-          link( "/_ruote/expressions/#{process.wfid}", rel('#expressions') ),
-          link( "/_ruote/workitems/#{process.wfid}", rel('#workitems') )
+          link( "/_ruote/processes/#{process.wfid}", '#process' ),
+          link( "/_ruote/expressions/#{process.wfid}", '#expressions' ),
+          link( "/_ruote/workitems/#{process.wfid}", '#workitems' )
         ]
 
         process.to_h.merge( 'links' => links )
@@ -30,8 +30,8 @@ module RuoteKit
 
       def json_expression( expression )
         links = [
-          link( "/_ruote/processes/#{expression.fei.wfid}", rel('#process') ),
-          link( "/_ruote/expressions/#{expression.fei.wfid}", rel('#expressions') )
+          link( "/_ruote/processes/#{expression.fei.wfid}", '#process' ),
+          link( "/_ruote/expressions/#{expression.fei.wfid}", '#expressions' )
         ]
 
         if expression.parent
@@ -50,40 +50,58 @@ module RuoteKit
       end
 
       def json_workitem( workitem )
+
         links = [
-          link( "/_ruote/processes/#{workitem.fei.wfid}", rel('#process') ),
-          link( "/_ruote/expressions/#{workitem.fei.wfid}", rel('#expressions') )
+          link( "/_ruote/processes/#{workitem.fei.wfid}", '#process' ),
+          link( "/_ruote/expressions/#{workitem.fei.wfid}", '#expressions' ),
+          link( "/_ruote/errors/#{workitem.fei.wfid}", '#errors' )
         ]
 
         workitem.to_h.merge( 'links' => links )
       end
 
-      def rel( fragment )
-        "http://ruote.rubyforge.org/rels.html#{ fragment }"
+      def json_errors( errors )
+        errors.collect { |e| json_error( e, false ) }
+      end
+
+      def json_error( error )
+        error.to_h.merge( 'links' => links )
       end
 
       def links( resource )
-        links = [
-          link( '/_ruote', rel('#root') ),
-          link( '/_ruote/processes', rel('#processes') ),
-          link( '/_ruote/workitems', rel('#workitems') ),
-          link( '/_ruote/history', rel("#history") ),
+        [
+          link( '/_ruote', '#root' ),
+          link( '/_ruote/processes', '#processes' ),
+          link( '/_ruote/workitems', '#workitems' ),
+          link( '/_ruote/errors', '#errors' ),
+          link( '/_ruote/history', '#history' ),
           link( request.fullpath, 'self' )
         ]
-
-        links
       end
 
       def link( href, rel )
-        { 'href' => href, 'rel' => rel }
+        {
+          'href' => href,
+          'rel' => rel.match(/^#/) ? "http://ruote.rubyforge.org/rels.html#{rel}" : rel
+        }
       end
 
       # Easy 404
+      #
       def resource_not_found
+
         status 404
+
+        @format = if m = @format.to_s.match(/^[^\/]+\/([^;]+)/)
+          m[1].to_sym
+        else
+          @format
+        end
+          # freaking sinata-respond_to 0.4.0... (or is that it ?)
+
         respond_to do |format|
           format.html { haml :resource_not_found }
-          format.json { { "error" => { "code" => 404, "message" => "Resource not found" } }.to_json }
+          format.json { Rufus::Json.encode( { "error" => { "code" => 404, "message" => "Resource not found" } } ) }
         end
       end
 
@@ -92,7 +110,7 @@ module RuoteKit
         status 503
         respond_to do |format|
           format.html { haml :workitems_not_available }
-          format.json { { "error" => { "code" => 503, "messages" => "Workitems not available" } }.to_json }
+          format.json { Rufus::Json.encode( { "error" => { "code" => 503, "messages" => "Workitems not available" } } ) }
         end
       end
 
@@ -101,12 +119,11 @@ module RuoteKit
         case object
         when Ruote::Workitem
           process = engine.process( object.fei.wfid )
-          process.current_tree.to_json
+          Rufus::Json.encode( process.current_tree )
         when Ruote::ProcessStatus
-          object.current_tree.to_json
+          Rufus::Json.encode( object.current_tree )
         end
       end
-
     end
   end
 end

data/lib/ruote-kit/resources/errors.rb

@@ -0,0 +1,65 @@
+
+class RuoteKit::Application
+
+  get '/_ruote/errors/?' do
+
+    @errors = engine.errors
+
+    respond_to do |format|
+      format.html { haml :errors }
+      format.json { json( :errors, @errors ) }
+    end
+  end
+
+  get '/_ruote/errors/:wfid' do
+
+    process = engine.process( wfid )
+    @errors = process ? process.errors : nil
+
+    if @errors
+      respond_to do |format|
+        format.html { haml :errors }
+        format.json { json( :errors, @errors ) }
+      end
+    else
+      resource_not_found
+    end
+  end
+
+  get '/_ruote/errors/:wfid/:expid' do
+
+    process = engine.process( wfid )
+    errors = process ? process.errors : nil
+    @error = errors ? errors.find { |e| e.fei.expid == expid } : nil
+
+    if @error
+      respond_to do |format|
+        format.html { haml :error }
+        format.json { json( :error, @error ) }
+      end
+    else
+      resource_not_found
+    end
+  end
+
+  # replay_at_error(e)
+  #
+  delete '/_ruote/errors/:wfid/:expid' do
+
+    #process = engine.process( params[:wfid] )
+    #if process && expression = process.expressions.detect { |exp| exp.fei.expid == params[:expid] }
+    #  if params[:_kill]
+    #    engine.kill_expression( expression.fei )
+    #  else
+    #    engine.cancel_expression( expression.fei )
+    #  end
+    #  respond_to do |format|
+    #    format.html { redirect "/_ruote/expressions/#{params[:wfid]}" }
+    #    format.json { json( :status, :ok ) }
+    #  end
+    #else
+    #  resource_not_found
+    #end
+  end
+end
+