ruote-kit 2.1.4

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

@@ -0,0 +1,23 @@
+%h2 Workitems
+
+.flash
+  .message
+    - if @workitems.empty?
+      .warn
+        %p No workitems are currently available #{ @wfid ? "for #{@wfid}" : '' }
+    - else
+      .notice
+        %p #{ pluralize(@workitems.size, 'workitem') } available #{ @wfid ? "for #{@wfid}" : '' }
+
+    - if @participants
+      .notice
+        %p Filtered for participant(s): #{@participants.join(', ')}
+
+%ul.nested_list
+  - @workitems.each do |wi|
+    %li
+      = link_to wi
+      %ul.nested_details
+        %li fei: #{wi.fei.to_s}
+        %li participant: #{wi.participant_name}
+        %li dispath time: TODO

data/lib/ruote-kit.rb

@@ -0,0 +1,105 @@
+require 'json'
+require 'ruote'
+
+module RuoteKit
+
+  VERSION = "2.1.4"
+
+  autoload :Configuration, "ruote-kit/configuration"
+  autoload :Application,   "ruote-kit/application"
+  autoload :Helpers,       "ruote-kit/helpers"
+
+  class << self
+    # The instance of ruote
+    attr_accessor :engine
+
+    # The instance of our worker, if used
+    attr_accessor :worker
+
+    def env
+      @env ||= (
+        if defined?( Rails )
+          Rails.env
+        else
+          ENV['RACK_ENV'] || 'development'
+        end
+      )
+    end
+
+    # Yields a RuoteKit::Configuration instance and then immediately starts
+    # the engine (unless configuration prohibits it).
+    def configure( &block )
+      yield configuration
+
+      run_engine! if configuration.run_engine
+    end
+
+    # Configure and run the engine in a RESTful container
+    def run!(&block)
+      yield if block_given?
+
+      run_engine!
+    end
+
+    def shutdown!( purge_engine = false )
+      shutdown_engine( purge_engine )
+    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?
+    end
+
+    # Runs an engine, and starts a threaded workers if #configuration allows
+    # it
+    def run_engine!
+
+      storage = configuration.storage_instance
+      self.engine = Ruote::Engine.new( storage )
+
+      configure_participants
+
+      run_worker!( true ) unless configuration.run_worker
+    end
+
+    # Run a single worker. By default this method will block indefinitely,
+    # unless +run_in_thread+ is set to true
+    def run_worker!( run_in_thread = false )
+      self.worker = Ruote::Worker.new( configuration.storage_instance )
+      run_in_thread ? self.worker.run_in_thread : self.worker.run
+    end
+
+    def shutdown_engine( purge = false )
+
+      return if self.engine.nil?
+
+      self.engine.shutdown
+
+      if purge
+        self.engine.context.keys.each do |k|
+          s = self.engine.context[k]
+          s.purge if s.respond_to?(:purge)
+        end
+      end
+
+      self.engine = nil
+
+      shutdown_worker! if configuration.run_worker
+    end
+
+    def shutdown_worker!
+      self.worker.shutdown if self.worker
+      self.worker = nil
+    end
+
+  end
+end

data/ruote-kit.gemspec

@@ -0,0 +1,136 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruote-kit}
+  s.version = "2.1.4"
+
+  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-11}
+  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 = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "README.rdoc",
+     "Rakefile",
+     "config.ru",
+     "lib/ruote-kit.rb",
+     "lib/ruote-kit/application.rb",
+     "lib/ruote-kit/configuration.rb",
+     "lib/ruote-kit/helpers.rb",
+     "lib/ruote-kit/helpers/engine_helpers.rb",
+     "lib/ruote-kit/helpers/form_helpers.rb",
+     "lib/ruote-kit/helpers/launch_item_parser.rb",
+     "lib/ruote-kit/helpers/navigation_helpers.rb",
+     "lib/ruote-kit/helpers/render_helpers.rb",
+     "lib/ruote-kit/public/_ruote/images/bg.gif",
+     "lib/ruote-kit/public/_ruote/images/bg_button_left.gif",
+     "lib/ruote-kit/public/_ruote/images/bg_button_left_cancel.gif",
+     "lib/ruote-kit/public/_ruote/images/bg_button_left_submit.gif",
+     "lib/ruote-kit/public/_ruote/images/bg_button_right.gif",
+     "lib/ruote-kit/public/_ruote/javascripts/SimplyButtons.js",
+     "lib/ruote-kit/public/_ruote/javascripts/fluo-can.js",
+     "lib/ruote-kit/public/_ruote/javascripts/fluo-dial.js",
+     "lib/ruote-kit/public/_ruote/javascripts/fluo-json.js",
+     "lib/ruote-kit/public/_ruote/javascripts/fluo-tred.js",
+     "lib/ruote-kit/public/_ruote/stylesheets/SimplyButtons.css",
+     "lib/ruote-kit/public/_ruote/stylesheets/base.css",
+     "lib/ruote-kit/public/_ruote/stylesheets/rk.css",
+     "lib/ruote-kit/public/_ruote/stylesheets/style.css",
+     "lib/ruote-kit/resources/expressions.rb",
+     "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/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/processes.html.haml",
+     "lib/ruote-kit/views/resource_not_found.html.haml",
+     "lib/ruote-kit/views/workitem.html.haml",
+     "lib/ruote-kit/views/workitems.html.haml",
+     "ruote-kit.gemspec",
+     "spec/helpers/render_helpers_spec.rb",
+     "spec/resources/expressions_spec.rb",
+     "spec/resources/index_spec.rb",
+     "spec/resources/processes_spec.rb",
+     "spec/resources/workitems_spec.rb",
+     "spec/ruote-kit_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/views/launch_process.html.haml_spec.rb",
+     "spec/views/process.html.haml_spec.rb",
+     "spec/views/processes.html.haml_spec.rb",
+     "spec/views/workitems.html.haml_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/kennethkalmer/ruote-kit}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  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/index_spec.rb",
+     "spec/resources/processes_spec.rb",
+     "spec/resources/workitems_spec.rb",
+     "spec/ruote-kit_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/views/launch_process.html.haml_spec.rb",
+     "spec/views/process.html.haml_spec.rb",
+     "spec/views/processes.html.haml_spec.rb",
+     "spec/views/workitems.html.haml_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.9.4"])
+      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_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+      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<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+    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<rspec>, [">= 0"])
+  end
+end
+

data/spec/helpers/render_helpers_spec.rb

@@ -0,0 +1,211 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "json helper" do
+  describe "rendering defaults" do
+    before(:each) do
+      stub_chain( :request, :fullpath ).and_return('/_ruote')
+
+      @hash = Rufus::Json.decode( json( :status, :ok ) )
+    end
+
+    it "should have the key & value" do
+      @hash.should have_key('status')
+      @hash['status'].should == 'ok'
+    end
+
+    it "should have a collection of links" do
+      @hash.should have_key('links')
+      @hash['links'].should_not be_empty
+    end
+
+    it "should link to 'self'" do
+      @hash['links'].detect { |l| l['rel'] == 'self' && l['href'] == '/_ruote' }.should_not be_nil
+    end
+
+    it "should link to the root" do
+      @hash['links'].detect { |l| l['rel'] =~ /#root$/ && l['href'] == '/_ruote' }.should_not be_nil
+    end
+
+    it "should link to the processes" do
+      @hash['links'].detect { |l| l['rel'] =~ /#processes$/ && l['href'] == '/_ruote/processes' }.should_not be_nil
+    end
+
+    it "should not link to the expressions by default" do
+      @hash['links'].detect { |l| l['rel'] =~ /#expressions$/ && l['href'] == '/_ruote/expressions' }.should be_nil
+    end
+
+    it "should link to the workitems" do
+      @hash['links'].detect { |l| l['rel'] =~ /#workitems$/ && l['href'] == '/_ruote/workitems' }.should_not be_nil
+    end
+  end
+
+  describe "rendering processes" do
+    before(:each) do
+      stub_chain( :request, :fullpath ).and_return('/_ruote/processes')
+
+      @wfid = launch_test_process
+      process = engine.process( @wfid )
+
+      @hash = Rufus::Json.decode( json( :processes, [process] ) )
+    end
+
+    it "should have a collection of processes" do
+      @hash.should have_key('processes')
+      @hash['processes'].should_not be_empty
+    end
+
+    describe "in detail, and" do
+      before(:each) do
+        @process = @hash['processes'].first
+
+        @process.should have_key('links')
+      end
+
+      it "should link to the process details" do
+
+        @process['links'].detect { |l| l['rel'] =~ /#process/ && l['href'] == "/_ruote/processes/#{@wfid}" }.should_not be_nil
+      end
+
+      it "should link to the process expressions" do
+
+        @process['links'].detect { |l| l['rel'] =~ /#expressions/ && l['href'] == "/_ruote/expressions/#{@wfid}" }.should_not be_nil
+      end
+
+      it "should link to the process workitems" do
+
+        @process['links'].detect { |l| l['rel'] =~ /#workitems/ && l['href'] == "/_ruote/workitems/#{@wfid}" }.should_not be_nil
+      end
+    end
+
+  end
+
+  describe "rendering a single process" do
+    before(:each) do
+      @wfid = launch_test_process
+
+      stub_chain( :request, :fullpath ).and_return("/_ruote/processes/#{@wfid}")
+
+      process = engine.process( @wfid )
+
+      @hash = Rufus::Json.decode( json( :process, process ) )
+    end
+
+    it "should have the process details" do
+      @hash.should have_key('process')
+    end
+
+    it "should link to the process details" do
+
+      @hash['process']['links'].detect { |l| l['rel'] =~ /#process/ && l['href'] == "/_ruote/processes/#{@wfid}" }.should_not be_nil
+    end
+
+    it "should link to the process expressions" do
+
+      @hash['process']['links'].detect { |l| l['rel'] =~ /#expressions/ && l['href'] == "/_ruote/expressions/#{@wfid}" }.should_not be_nil
+    end
+
+    it "should link to the process workitems" do
+
+      @hash['process']['links'].detect { |l| l['rel'] =~ /#workitems/ && l['href'] == "/_ruote/workitems/#{@wfid}" }.should_not be_nil
+    end
+  end
+
+  describe "render a single expression" do
+    before(:each) do
+      @wfid = launch_test_process do
+        Ruote.process_definition :name => 'foo' do
+          sequence do
+            nada :activity => 'work your magic'
+          end
+        end
+      end
+
+      @expid = '0_0_0'
+
+      stub_chain( :request, :fullpath ).and_return("/_ruote/expressions/#{@wfid}/#{@expid}")
+
+      process = engine.process( @wfid )
+      expression = process.expressions.detect { |exp| exp.fei.expid == @expid }
+
+      @hash = Rufus::Json.decode( json( :expression, expression ) )
+    end
+
+    it "should contain the expression" do
+      @hash.should have_key('expression')
+    end
+
+    it "should link to the process" do
+      @hash['expression']['links'].detect { |l| l['rel'] =~ /#process/ && l['href'] == "/_ruote/processes/#{@wfid}" }.should_not be_nil
+    end
+
+    it "should link to the parent expression" do
+      @hash['expression']['links'].detect { |l| l['rel'] == 'parent' && l['href'] == "/_ruote/expressions/#{@wfid}/0_0" }.should_not be_nil
+    end
+  end
+
+  describe "render an expression tree" do
+    before(:each) do
+      @wfid = launch_test_process do
+        Ruote.process_definition :name => 'foo' do
+          sequence do
+            nada :activity => 'work your magic'
+          end
+        end
+      end
+
+      stub_chain( :request, :fullpath ).and_return("/_ruote/expressions/#{@wfid}")
+
+      process = engine.process( @wfid )
+
+      @hash = Rufus::Json.decode( json( :expressions, process.expressions ) )
+    end
+
+    it "should have the list of expressions" do
+      @hash.should have_key('expressions')
+    end
+  end
+
+  describe "rendering a workitem" do
+    before(:each) do
+      @wfid = launch_test_process do
+        Ruote.process_definition :name => 'foo' do
+          sequence do
+            nada :activity => 'work your magic'
+          end
+        end
+      end
+
+      stub_chain( :request, :fullpath ).and_return("/_ruote/workitems/#{@wfid}/0_0_0")
+
+      workitem = find_workitem( @wfid, '0_0_0' )
+
+      @hash = Rufus::Json.decode( json( :workitem, workitem ) )
+    end
+
+    it "should have the workitem" do
+      @hash.should have_key('workitem')
+    end
+
+  end
+
+  describe "rendering workitems" do
+    before(:each) do
+      @wfid = launch_test_process do
+        Ruote.process_definition :name => 'foo' do
+          sequence do
+            nada :activity => 'work your magic'
+          end
+        end
+      end
+
+      stub_chain( :request, :fullpath ).and_return("/_ruote/workitems")
+
+      @hash = Rufus::Json.decode( json( :workitems, store_participant.all ) )
+    end
+
+    it "should have the workitems" do
+      @hash.should have_key('workitems')
+    end
+
+  end
+end

data/spec/resources/expressions_spec.rb

@@ -0,0 +1,179 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "GET /_ruote/expressions" do
+  it "should report a friendly message to the user (HTML)" do
+    get "/_ruote/expressions"
+
+    last_response.should be_ok
+  end
+
+  it "should report a friendly message to the client (JSON)" do
+    get "/_ruote/expressions.json"
+
+    last_response.should be_ok
+
+    last_response.json_body['status'].should == 'ok'
+  end
+end
+
+describe "GET /_ruote/expressions/wfid" do
+  describe "with running processes" do
+    before(:each) do
+      @wfid = launch_test_process
+    end
+
+    it "should render the expression tree (HTML)" do
+      get "/_ruote/expressions/#{@wfid}"
+
+      last_response.should be_ok
+    end
+
+    it "should render the expression tree (JSON)" do
+      get "/_ruote/expressions/#{@wfid}.json"
+
+      last_response.should be_ok
+    end
+  end
+
+  describe "without running processes" do
+    it "should 404 correctly (HTML)" do
+      get "/_ruote/expressions/foo"
+
+      last_response.should_not be_ok
+      last_response.status.should be(404)
+    end
+
+    it "should 404 correctly (JSON)" do
+      get "/_ruote/expressions/foo.json"
+
+      last_response.should_not be_ok
+      last_response.status.should be(404)
+    end
+  end
+end
+
+describe "GET /_ruote/expressions/wfid/expid" do
+  describe "with running processes" do
+    before(:each) do
+      @wfid = launch_test_process
+      process = engine.process( @wfid )
+      @nada_exp_id = process.expressions.last.fei.expid
+    end
+
+    it "should render the expression details (HTML)" do
+      get "/_ruote/expressions/#{@wfid}/#{@nada_exp_id}"
+
+      last_response.should be_ok
+    end
+
+    it "should render the expression details (JSON)" do
+      get "/_ruote/expressions/#{@wfid}/#{@nada_exp_id}.json"
+
+      last_response.should be_ok
+    end
+  end
+
+  describe "without running processes" do
+    it "should 404 correctly (HTML)" do
+      get "/workitems/foo/bar"
+
+      last_response.should_not be_ok
+      last_response.status.should be(404)
+    end
+
+    it "should 404 correctly (JSON)" do
+      get "/workitems/foo/bar.json"
+
+      last_response.should_not be_ok
+      last_response.status.should be(404)
+    end
+  end
+end
+
+describe "DELETE /_ruote/expressions/wfid/expid" do
+  describe "with running processes" do
+    before(:each) do
+      @wfid = launch_test_process do
+        Ruote.process_definition :name => 'delete' do
+          sequence do
+            wait '1d', :on_cancel => 'bail_out'
+            echo 'done'
+          end
+
+          define 'bail_out' do
+            sequence do
+              echo 'bailed'
+            end
+          end
+        end
+      end
+
+      wait_exp = engine.process( @wfid ).expressions.last
+      @expid = "0_1_0" #wait_exp.fei.expid
+    end
+
+    it "should cancel the expressions (HTML)" do
+      delete "/_ruote/expressions/#{@wfid}/#{@expid}"
+
+      last_response.should be_redirect
+      last_response['Location'].should == "/_ruote/expressions/#{@wfid}"
+
+      #sleep 0.4
+      wait_for( @wfid )
+
+      @tracer.to_s.should == "bailed\ndone"
+    end
+
+    it "should cancel the expressions (JSON)" do
+      delete "/_ruote/expressions/#{@wfid}/#{@expid}.json"
+
+      last_response.should be_ok
+      last_response.json_body['status'].should == 'ok'
+
+      #sleep 0.4
+      wait_for( @wfid )
+
+      @tracer.to_s.should == "bailed\ndone"
+    end
+
+    it "should kill the expression (HTML)" do
+      delete "/_ruote/expressions/#{@wfid}/#{@expid}?_kill=1"
+
+      last_response.should be_redirect
+      last_response['Location'].should == "/_ruote/expressions/#{@wfid}"
+
+      #sleep 0.4
+      wait_for( @wfid )
+
+      @tracer.to_s.should == "done"
+    end
+
+    it "should kill the expression (JSON)" do
+      delete "/_ruote/expressions/#{@wfid}/#{@expid}.json?_kill=1"
+
+      last_response.should be_ok
+      last_response.json_body['status'].should == 'ok'
+
+      #sleep 0.4
+      wait_for( @wfid )
+
+      @tracer.to_s.should == "done"
+    end
+  end
+
+  describe "without running processes" do
+    it "should 404 correctly (HTML)" do
+      delete "/_ruote/expressions/foo/bar"
+
+      last_response.should_not be_ok
+      last_response.status.should be(404)
+    end
+
+    it "should 404 correctly (JSON)" do
+      delete "/_ruote/expressions/foo/bar.json"
+
+      last_response.should_not be_ok
+      last_response.status.should be(404)
+    end
+  end
+end