ruote-kit 2.1.4.1 → 2.1.7

data/.gitignore

@@ -1,8 +1,7 @@
 *.swp
 work*/
 .DS_Store
-bin/*
-vendor/gems
 .yardoc
 doc/*
 pkg/*
+.bundle/*

data/Gemfile

@@ -1,10 +1,19 @@
 # Dependencies for ruote-kit
+source :gemcutter
 
 # ruote-kit itself
+gem 'bundler'
 gem 'sinatra'
+gem 'sinatra-respond_to'
 gem 'haml'
 gem 'json'
 
 # ruote
 #gem 'ruote', :git => "git://github.com/kennethkalmer/ruote", :branch => "ruote-kit"
-gem 'ruote', '>= 2.1.4'
+gem 'ruote', '>= 2.1.6'
+
+# Testing environment requirements
+group :test do
+  gem 'rspec'
+  gem 'jeweler'
+end

data/README.rdoc

@@ -1,4 +1,4 @@
-= ruote-kit (RESTful BPM & middleware)
+= ruote-kit (RESTful ruote & middleware)
 
 * http://kit.rubyforge.org/ruote (soon)
 * http://kit.rubyforge.org/ruote/rdoc (soon)
@@ -20,8 +20,9 @@ coming weeks (albeit for the better).
 
 Dependencies you currently need is:
 
-* bundler (gem install bundler)
+* bundler 0.9.5 or later (gem install bundler)
 * sinatra
+* sinatra-respond_to
 * haml
 * json
 * rspec (only to run the specs)
@@ -29,10 +30,11 @@ Dependencies you currently need is:
 ruote-kit uses bundler to setup and maintain its environment. Before running
 ruote-kit for the first time you need to install bundler and then run:
 
-  $ gem bundle
+  $ bundle install
 
-Bundler will download all the required gems and unpack them in 'vendor/gems'
-for you.
+Bundler will download all the required gems and install them for you. To
+bundle the gems you can simply run 'bundle lock' and all the gems will be
+unpacked in .bundle
 
 == Getting started quickly
 
@@ -52,16 +54,25 @@ Example:
 
   RuoteKit.configure do |config|
     # make changes if needed
+    # Register participants if needed
+    config.register do
+      participant :toto do |wi|
+        # ...
+      end
+      # register the catchall participant if needed
+      require 'ruote/part/storage_participant'
+      catchall Ruote::StorageParticipant
+    end
   end
 
-  # Register participants if needed
-  RuoteKit.engine.register_participant :toto do |wi|
-    # 
-  end
 
   # Slot into the stack
   use RuoteKit::Application
 
+=== Notes for Rails
+
+See http://github.com/tosch/ruote-on-rails for an example Rails app.
+
 == Configuring ruote-kit & ruote
 
 ruote-kit can be configured using RuoteKit#configure, after which it will start
@@ -71,6 +82,38 @@ Without any configuration ruote-kit will use file system persistence, and save
 the work in a sub-folder of the current working directory named +work_<env>+,
 where +env+ is the RACK_ENV or RAILS_ENV.
 
+=== Registration of participants
+
+ruote participants may be registered within the block given to
+RuoteKit#configure by the RuoteKit::Configuration#register method. It expects a
+block containing of +participant+ and one or less +catchall+ calls (see example
+above).
+
+Note that all +participant+ calls after a +catchall+ one are pretty useless:
+The catchall will eat all their cookies.
+
+== The +workitems+ resource
+
+The +workitems+ resource relies on the Ruote::StorageParticipant. You'll have to
+register at least one Storage Participant if you ever want to see a workitem in
+the resource. Example:
+
+  require 'ruote/part/storage_participant'
+  RuoteKit.engine.register_participant :storage, Ruote::StorageParticipant
+
+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
+Ruote::StorageParticipant as participant implementation, you may use any options
+of Ruote::Engine#register_participant to overwrite that default -- see the
+example above).
+
 == Running workers
 
 If you're using ruote-kit as part of your rack stack you'll need to start at
@@ -110,7 +153,7 @@ Please do not hesitate to come back with *any* feedback.
 
 (The MIT License)
 
-Copyright (c) 2009 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
+Copyright (c) 2009-2010 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,9 +1,17 @@
-require 'rubygems'
-require 'rake'
 
-require 'vendor/gems/environment' if File.exist?('vendor/gems/environment.rb')
+require 'rake/tasklib'
 
-require 'lib/ruote-kit'
+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 'lib/ruote-kit/version'
 
 begin
   require 'jeweler'
@@ -20,11 +28,15 @@ begin
     gemspec.files.include 'lib/ruote-kit/public/**/*'
     gemspec.executables.clear
 
+    gemspec.add_dependency 'bundler', '>=0.9.5'
     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.4'
+    gemspec.add_dependency 'ruote', '>= 2.1.7'
+    gemspec.add_development_dependency 'rake'
     gemspec.add_development_dependency 'rspec'
+    gemspec.add_development_dependency 'jeweler'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/config.ru

@@ -1,4 +1,12 @@
-require 'vendor/gems/environment' if ::File.exist?( 'vendor/gems/environment.rb' )
+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
 
 $:.unshift 'lib'
 
@@ -12,8 +20,14 @@ RuoteKit.configure do |config|
 
   # run a worker
   config.run_worker = true
+
+  register do
+    # With this rackup I bundle as catchall, making it easy to experiment
+    catchall
+  end
 end
 
+
 use Rack::CommonLogger
 use Rack::Lint
 use Rack::ShowExceptions

data/lib/ruote-kit/application.rb

@@ -1,15 +1,17 @@
-require 'ruote-kit/vendor/sinatra-respond_to/lib/sinatra/respond_to'
+require 'sinatra/respond_to'
 require 'haml'
 
+Sinatra::Application.register Sinatra::RespondTo
+
 module RuoteKit
-  class Application < Sinatra::Base
+  class Application < Sinatra::Application
 
     # Delay these a bit
     configure do
       # We want to support Rails
       if defined?( Rails )
         set :environment, Rails.env
-        disable :raise_errors
+        disable :raise_errors unless Rails.env == 'development'
       end
 
       RuoteKit.ensure_engine!
@@ -33,8 +35,11 @@ module RuoteKit
       format :json if env["HTTP_ACCEPT"] && env["HTTP_ACCEPT"] == "application/json"
     end
 
-    not_found do
-      resource_not_found
+    unless defined?( Rails )
+      # Handle 404's ourselves when not in Rails
+      not_found do
+        resource_not_found
+      end
     end
 
     get '/_ruote' do

data/lib/ruote-kit/configuration.rb

@@ -2,6 +2,21 @@ module RuoteKit
   # RuoteKit configuration handling
   class Configuration
 
+    class ParticipantRegistrationProxy
+      def self.participant(*args, &block)
+        RuoteKit.engine.register_participant(*args, &block)
+      end
+      
+      def self.catchall(*args, &block)
+        if(args.empty? and not block_given?)
+          require 'ruote/part/storage_participant'
+          participant('.+', Ruote::StorageParticipant)
+        else
+          participant('.+', *args, &block)
+        end
+      end
+    end
+
     # Working directory for the engine (if using file system persistence)
     attr_accessor :work_directory
 
@@ -31,8 +46,20 @@ module RuoteKit
       @mode = mode
     end
 
+    # Sets a custom storage
+    def set_storage( klass, *args )
+      @storage = [ klass, args ]
+      @mode = :custom
+    end
+
     # Return the best suited storage class for the current mode
     def storage_instance
+
+      if @storage
+        klass, args = @storage
+        return klass.new( *args )
+      end
+
       case mode
       when :transient
         require 'ruote/storage/hash_storage'
@@ -43,10 +70,14 @@ module RuoteKit
       end
     end
 
-    def catchall_participant
-      require 'ruote/part/storage_participant'
-      Ruote::StorageParticipant
+    def register &block
+      @participant_registration_block = block
+      do_participant_registration
     end
 
+    def do_participant_registration
+      return nil unless @participant_registration_block && RuoteKit.engine
+      ParticipantRegistrationProxy.instance_eval(&@participant_registration_block)
+    end
   end
 end

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

@@ -6,12 +6,12 @@ module RuoteKit
         RuoteKit.engine
       end
 
-      def store_participant
-        RuoteKit.engine.context.plist.lookup('.*')
+      def storage_participant
+        RuoteKit.storage_participant
       end
 
       def find_workitems( wfid )
-        store_participant.by_wfid( wfid )
+        storage_participant.by_wfid( wfid )
       end
 
       def find_workitem( wfid, expid )

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

@@ -83,7 +83,16 @@ module RuoteKit
         status 404
         respond_to do |format|
           format.html { haml :resource_not_found }
-          format.json { { "error" => { "code" => "404", "message" => "Resource not found" } }.to_json }
+          format.json { { "error" => { "code" => 404, "message" => "Resource not found" } }.to_json }
+        end
+      end
+
+      # Easy 503
+      def workitems_not_available
+        status 503
+        respond_to do |format|
+          format.html { haml :workitems_not_available }
+          format.json { { "error" => { "code" => 503, "messages" => "Workitems not available" } }.to_json }
         end
       end
 

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

@@ -29,11 +29,17 @@ class RuoteKit::Application
   post "/_ruote/processes" do
     launch_item = launch_item_from_post
 
-    @wfid = engine.launch( launch_item['pdef'], launch_item['fields'], launch_item['variables'] )
-
     respond_to do |format|
-      format.html { redirect "/_ruote/processes/#{@wfid}" }
-      format.json { json( :launched, @wfid ) }
+      begin
+        @wfid = engine.launch( launch_item['pdef'], launch_item['fields'], launch_item['variables'] )
+      rescue ArgumentError => @error
+        status 422
+        format.html { haml :process_failed_to_launch }
+        format.json { { "error" => { "code" => 422, "message" => @error.message } }.to_json }
+      else
+        format.html { haml :process_launched }
+        format.json { json( :launched, @wfid ) }
+      end
     end
   end
 

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

@@ -4,10 +4,10 @@ class RuoteKit::Application
     if params[:participant]
       @participants = params[:participant].split(',')
       @workitems = @participants.inject([]) do |memo, part|
-        memo.concat store_participant.by_participant( part )
+        memo.concat storage_participant.by_participant( part )
       end
     else
-      @workitems = store_participant.all
+      @workitems = storage_participant.all
     end
 
     respond_to do |format|
@@ -42,15 +42,17 @@ class RuoteKit::Application
   put "/_ruote/workitems/:wfid/:expid" do
     workitem = find_workitem( params[:wfid], params[:expid] )
 
+    (resource_not_found and return) if workitem.nil?
+
     options = field_updates_and_proceed_from_put
 
     unless options[:fields].empty?
       workitem.fields = options[:fields]
-      store_participant.update( workitem )
+      storage_participant.update( workitem )
     end
 
     if options[:proceed]
-      store_participant.reply( workitem )
+      storage_participant.reply( workitem )
     end
 
     respond_to do |format|

data/lib/ruote-kit/spec/ruote_helpers.rb

@@ -30,12 +30,12 @@ module RuoteKit
         RuoteKit.engine.context[:noisy] = on
       end
 
-      def store_participant
-        RuoteKit.engine.context.plist.lookup('.*')
+      def storage_participant
+        RuoteKit.storage_participant
       end
 
       def find_workitem( wfid, expid )
-        store_participant.by_wfid( wfid ).detect { |wi| wi.fei.expid == expid }
+        storage_participant.by_wfid( wfid ).detect { |wi| wi.fei.expid == expid }
       end
 
       def wait_for( wfid )

data/lib/ruote-kit/version.rb

@@ -0,0 +1,11 @@
+
+# lib/ruote-kit/version.rb
+#
+# so that the Rakefile doesn't have to load all the deps
+# when running "rake gemspec"
+
+module RuoteKit
+
+  VERSION = '2.1.7'
+end
+

data/lib/ruote-kit/views/expression.html.haml

@@ -17,7 +17,7 @@
         %span.description DELETE /_ruote/expressions/#{@expression.fei.wfid}/#{@expression.fei.expid}?_kill=1
 
 %ul.nolist
-  %li fei: #{@expression.fei.to_s}
+  %li id: #{@expression.fei.expid}
   %li class: #{@expression.class.name}
   %li name: #{@expression.respond_to?(:participant_name) ? @expression.participant_name : @expression.name}
   %li process: #{link_to @process}

data/lib/ruote-kit/views/expressions.html.haml

@@ -16,7 +16,7 @@
       %li
         = link_to_expression expression
         %ul.nested_details
-          %li fei: #{expression.fei.to_s}
+          %li id: #{expression.fei.expid}
           %li class: #{expression.class.name}
           %li name: #{expression.respond_to?(:participant_name) ? expression.participant_name : expression.name}
 

data/lib/ruote-kit/views/process.html.haml

@@ -27,7 +27,7 @@
 %ul.nolist
   %li wfid: #{@process.wfid}
   %li launch: #{@process.launched_time}
-  %li paused:
+  /%li paused:
   %li: tags: #{@process.all_tags.keys.join(', ')}
   %li
     expressions:

data/lib/ruote-kit/views/process_failed_to_launch.html.haml

@@ -0,0 +1,7 @@
+%h2 Process failed to launch
+
+.flash
+  .message.error
+    %p
+      &= @error.message
+      %a{ :href => "javascript:history.go(-1)" } Go back to the previous page

data/lib/ruote-kit/views/process_launched.html.haml

@@ -0,0 +1,6 @@
+%h2 Process launched
+
+.flash
+  .message
+    .notice
+      %p Your process has been launched. #{ link_to "GET /_ruote/processes/#{@wfid}", "/_ruote/processes/#{@wfid}" }

data/lib/ruote-kit.rb

@@ -1,9 +1,10 @@
 require 'json'
 require 'ruote'
+require 'ruote/part/storage_participant'
 
 module RuoteKit
 
-  VERSION = "2.1.4.1"
+  VERSION = '2.1.7'
 
   autoload :Configuration, "ruote-kit/configuration"
   autoload :Application,   "ruote-kit/application"
@@ -31,11 +32,11 @@ module RuoteKit
     def configure( &block )
       yield configuration
 
-      run_engine! if configuration.run_engine
+      run_engine!
     end
 
     # Configure and run the engine in a RESTful container
-    def run!(&block)
+    def run!( &block )
       yield if block_given?
 
       run_engine!
@@ -46,14 +47,9 @@ module RuoteKit
     end
 
     def configuration
-
       @configuration ||= Configuration.new
     end
 
-    def configure_participants
-      self.engine.register_participant('.*', configuration.catchall_participant)
-    end
-
     # Ensure the engine is running
     def ensure_engine!
       run_engine! if self.engine.nil?
@@ -63,10 +59,14 @@ module RuoteKit
     # it
     def run_engine!
 
+      return unless configuration.run_engine
+
       storage = configuration.storage_instance
       self.engine = Ruote::Engine.new( storage )
 
-      configure_participants
+      configuration.do_participant_registration
+
+      @storage_participant = nil
 
       run_worker!( true ) if configuration.run_worker
     end
@@ -101,5 +101,17 @@ module RuoteKit
       self.worker = nil
     end
 
+    def storage_participant
+      return nil if self.engine.nil?
+      @storage_participant ||= Ruote::StorageParticipant.new(self.engine)
+    end
+
+    # resets the configuration
+    #
+    # mainly used in tests
+    def reset_configuration!
+      @configuration = nil
+    end
+
   end
 end

data/ruote-kit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote-kit}
-  s.version = "2.1.4.1"
+  s.version = "2.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kenneth.kalmer@gmail.com"]
-  s.date = %q{2010-01-12}
+  s.date = %q{2010-03-10}
   s.description = %q{ruote-kit is a RESTful Rack app for the ruote workflow engine}
   s.email = %q{kenneth.kalmer@gmail.com}
   s.extra_rdoc_files = [
@@ -49,28 +49,15 @@ Gem::Specification.new do |s|
      "lib/ruote-kit/resources/processes.rb",
      "lib/ruote-kit/resources/workitems.rb",
      "lib/ruote-kit/spec/ruote_helpers.rb",
-     "lib/ruote-kit/vendor/sinatra-respond_to/LICENSE",
-     "lib/ruote-kit/vendor/sinatra-respond_to/README.markdown",
-     "lib/ruote-kit/vendor/sinatra-respond_to/Rakefile",
-     "lib/ruote-kit/vendor/sinatra-respond_to/VERSION.yml",
-     "lib/ruote-kit/vendor/sinatra-respond_to/lib/sinatra/respond_to.rb",
-     "lib/ruote-kit/vendor/sinatra-respond_to/sinatra-respond_to.gemspec",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/public/static folder/.keep",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/public/static.txt",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/test_app.rb",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/unreachable_static.txt",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/views/layout.html.haml",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/views/resource.html.haml",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/views/resource.js.erb",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/app/views/resource.xml.builder",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/extension_spec.rb",
-     "lib/ruote-kit/vendor/sinatra-respond_to/spec/spec_helper.rb",
+     "lib/ruote-kit/version.rb",
      "lib/ruote-kit/views/expression.html.haml",
      "lib/ruote-kit/views/expressions.html.haml",
      "lib/ruote-kit/views/index.html.haml",
      "lib/ruote-kit/views/launch_process.html.haml",
      "lib/ruote-kit/views/layout.html.haml",
      "lib/ruote-kit/views/process.html.haml",
+     "lib/ruote-kit/views/process_failed_to_launch.html.haml",
+     "lib/ruote-kit/views/process_launched.html.haml",
      "lib/ruote-kit/views/processes.html.haml",
      "lib/ruote-kit/views/resource_not_found.html.haml",
      "lib/ruote-kit/views/workitem.html.haml",
@@ -81,11 +68,14 @@ Gem::Specification.new do |s|
      "spec/resources/index_spec.rb",
      "spec/resources/processes_spec.rb",
      "spec/resources/workitems_spec.rb",
+     "spec/ruote-kit_configure_spec.rb",
      "spec/ruote-kit_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
+     "spec/views/expressions.html.haml_spec.rb",
      "spec/views/launch_process.html.haml_spec.rb",
      "spec/views/process.html.haml_spec.rb",
+     "spec/views/process_launched.html.haml_spec.rb",
      "spec/views/processes.html.haml_spec.rb",
      "spec/views/workitems.html.haml_spec.rb"
   ]
@@ -95,17 +85,20 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{ruote workflow engine, wrapped in a loving rack embrace}
   s.test_files = [
-    "spec/helpers/render_helpers_spec.rb",
-     "spec/resources/expressions_spec.rb",
+    "spec/resources/expressions_spec.rb",
+     "spec/resources/workitems_spec.rb",
      "spec/resources/index_spec.rb",
      "spec/resources/processes_spec.rb",
-     "spec/resources/workitems_spec.rb",
+     "spec/ruote-kit_configure_spec.rb",
      "spec/ruote-kit_spec.rb",
-     "spec/spec_helper.rb",
+     "spec/helpers/render_helpers_spec.rb",
+     "spec/views/workitems.html.haml_spec.rb",
+     "spec/views/process_launched.html.haml_spec.rb",
      "spec/views/launch_process.html.haml_spec.rb",
-     "spec/views/process.html.haml_spec.rb",
+     "spec/views/expressions.html.haml_spec.rb",
      "spec/views/processes.html.haml_spec.rb",
-     "spec/views/workitems.html.haml_spec.rb"
+     "spec/views/process.html.haml_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -113,24 +106,36 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bundler>, [">= 0.9.5"])
       s.add_runtime_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_runtime_dependency(%q<sinatra-respond_to>, [">= 0.4.0"])
       s.add_runtime_dependency(%q<haml>, [">= 2.2.5"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<ruote>, ["= 2.1.4"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.7"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
+      s.add_dependency(%q<bundler>, [">= 0.9.5"])
       s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_dependency(%q<sinatra-respond_to>, [">= 0.4.0"])
       s.add_dependency(%q<haml>, [">= 2.2.5"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<ruote>, ["= 2.1.4"])
+      s.add_dependency(%q<ruote>, [">= 2.1.7"])
+      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
+    s.add_dependency(%q<bundler>, [">= 0.9.5"])
     s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+    s.add_dependency(%q<sinatra-respond_to>, [">= 0.4.0"])
     s.add_dependency(%q<haml>, [">= 2.2.5"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<ruote>, ["= 2.1.4"])
+    s.add_dependency(%q<ruote>, [">= 2.1.7"])
+    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
   end
 end