simianarmy-ruote-external-workitem-rails 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.textile
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kenneth Kalmer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,12 @@
+h1. Ruote External Workitem
+
+A thin wrapper class that facilitates the examination/altering of ruote workitem's outside of the running engine.
+
+Example uses:
+
+* route-rest clients
+* route-kit clients
+* XMPP bots (messaged through the JabberParticipant)
+* AMQP bots (messaged through the AMQPParticipant)
+* Nanite agents (messaged through the NaniteMasterParticipant)
+* Your own external consumers!

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruote-external-workitem-rails"
+    gem.summary = %Q{TODO}
+    gem.email = "simianarmy@gmail.com"
+    gem.homepage = "http://github.com/simianarmy/ruote-external-workitem"
+    gem.authors = ["Kenneth Kalmer", "Marc Mauger"]
+
+    # gem is a Gem::Specification... see
+    # http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency 'active_support'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruote-external-workitem #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/ruote_external_workitem.rb

@@ -0,0 +1,23 @@
+$:.unshift( File.dirname(__FILE__) ) unless $:.include?( File.dirname(__FILE__) )
+
+require 'rubygems'
+require 'active_support'
+
+# Provide a thin wrapper around the OpenWFE::InFlowWorkItem instances
+# that eases interacting with the workitems from outside of the
+# running engine.
+module RuoteExternalWorkitem
+  autoload :Base, "ruote_external_workitem/base"
+  autoload :REST, "ruote_external_workitem/rest"
+  autoload :AMQP, "ruote_external_workitem/amqp"
+  autoload :XMPP, "ruote_external_workitem/xmpp"
+
+  class << self
+    
+    # Parse the string representation of a OpenWFE::InFlowWorkItem
+    # instance from JSON
+    def parse( json_string )
+      Base.new( ActiveSupport::JSON.decode( json_string ) )
+    end
+  end
+end

data/lib/ruote_external_workitem/amqp.rb

@@ -0,0 +1,13 @@
+module RuoteExternalWorkitem
+  # Extension to #Base with AMQP specific information exposed
+  module AMQP
+
+    def source_queue
+      @workitem['source_queue']
+    end
+
+    def reply_queue
+      @workitem['reply_queue']
+    end
+  end
+end

data/lib/ruote_external_workitem/base.rb

@@ -0,0 +1,65 @@
+require 'time'
+
+module RuoteExternalWorkitem
+  # Shared functionality for all workitems, no matter what the source
+  # of the workitem is.
+  class Base
+    include REST
+    include AMQP
+    include XMPP
+
+    def initialize( workitem = {} )
+      @workitem = workitem
+    end
+
+    def fei
+      @workitem['flow_expression_id']
+    end
+    
+    def short_fei
+      @short_fei ||=
+        '(' + [
+               'fei', self.fei['owfe_version'], self.fei['engine_id'],
+               self.fei['workflow_definition_url'], self.fei['workflow_definition_name'],
+               self.fei['workflow_definition_revision'], self.fei['workflow_instance_id'],
+               self.fei['expression_name'], self.fei['expression_id']
+              ].join(' ') + ')'
+    end
+
+    def dispatch_time
+      @dispath_time ||= Time.parse( @workitem['dispatch_time'] )
+    end
+
+    def last_modified
+      @last_modified ||= Time.parse( @workitem['last_modified'] )
+    end
+
+    def participant_name
+      @workitem['participant_name']
+    end
+
+    def attributes
+      @workitem['attributes']
+    end
+
+    def []( key )
+      self.attributes[ key ]
+    end
+
+    def []=( key, value )
+      self.attributes[ key ] = value
+    end
+
+    def to_json
+      ActiveSupport::JSON.encode(@workitem)
+    end
+
+    def method_missing( method_name, *args )
+      if self.attributes.keys.include?( method_name.to_s )
+        return self.attributes[ method_name.to_s ]
+      end
+
+      super
+    end
+  end
+end

data/lib/ruote_external_workitem/rest.rb

@@ -0,0 +1,21 @@
+require 'uri'
+
+module RuoteExternalWorkitem
+  # Extension of #Base that allows for accessing additional
+  # information from the workitems when using a RESTful interface like
+  # ruote-rest.
+  module REST
+
+    def base_uri
+      self.parsed_uri ? self.parsed_uri.to_s.gsub( self.parsed_uri.path, '/' ) : nil
+    end
+
+    def uri
+      self.parsed_uri ? self.parsed_uri.to_s : nil
+    end
+
+    def parsed_uri
+      @parsed_uri ||= URI.parse( @workitem['links'].detect { |l| l['rel'] == 'self' }['href'] ) rescue false
+    end
+  end
+end

data/lib/ruote_external_workitem/xmpp.rb

@@ -0,0 +1,13 @@
+module RuoteExternalWorkitem
+  # Extensions to #Base with XMPP specific information exposed
+  module XMPP
+
+    def source_jid
+      @workitem['source_jid']
+    end
+
+    def reply_jid
+      @workitem['reply_jid']
+    end
+  end
+end

data/spec/ruote_external_workitem_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper'
+
+describe RuoteExternalWorkitem, "parsing" do
+  it "should parse a workitem from JSON" do
+    json = <<-JSON
+      {"last_modified": "2009/04/23 12:49:07 +0200",
+       "type": "OpenWFE::InFlowWorkItem",
+       "participant_name": "toto",
+       "attributes": {"shallow": "true", "nes": {"ted": "yes" } },
+       "links": [{"href": "http://localhost:4567/workitems", "rel": "via"},
+         {"href": "http://localhost:4567/workitems/20090413-juduhojewo/0_0_0_0_1", "rel": "self"}],
+       "dispatch_time": "2009/04/23 12:49:07 +0200",
+       "flow_expression_id": {"workflow_definition_url": "field:__definition",
+       "expression_name": "toto",
+       "workflow_definition_name": "TestExternal",
+       "owfe_version": "0.9.21",
+       "workflow_definition_revision": "0",
+       "workflow_instance_id": "20090413-juduhojewo",
+       "engine_id": "ruote_rest",
+       "expression_id": "0.0.0.0.1"}}
+    JSON
+
+    wi = RuoteExternalWorkitem.parse( json )
+    wi.should be_an_instance_of( RuoteExternalWorkitem::Base )
+  end
+end
+
+describe RuoteExternalWorkitem::Base do
+  before(:each) do
+    json = <<-JSON
+      {"last_modified": "2009/04/23 12:49:07 +0200",
+       "type": "OpenWFE::InFlowWorkItem",
+       "participant_name": "toto",
+       "attributes": {"shallow": "true", "nes": {"ted": "yes" } },
+       "dispatch_time": "2009/04/23 12:49:07 +0200",
+       "flow_expression_id":
+          {"workflow_definition_url": "field:__definition",
+           "expression_name": "toto",
+           "workflow_definition_name": "TestExternal",
+           "owfe_version": "0.9.21",
+           "workflow_definition_revision": "0",
+           "workflow_instance_id": "20090413-juduhojewo",
+           "engine_id": "ruote_rest",
+           "expression_id": "0.0.0.0.1"}
+          }
+    JSON
+
+    @wi = RuoteExternalWorkitem.parse( json )
+  end
+  
+  it "should have a fei (FlowExpressionId) hash" do
+    fei = @wi.fei
+
+    fei['owfe_version'].should == '0.9.21'
+
+    fei.keys.should include('workflow_definition_url')
+    fei.keys.should include('expression_name')
+    fei.keys.should include('owfe_version')
+    fei.keys.should include('workflow_definition_name')
+    fei.keys.should include('workflow_instance_id')
+    fei.keys.should include('engine_id')
+    fei.keys.should include('expression_id')
+  end
+
+  it "should have 'short fei'" do
+    @wi.short_fei.should == '(fei 0.9.21 ruote_rest field:__definition TestExternal 0 20090413-juduhojewo toto 0.0.0.0.1)'
+  end
+  
+  it "should have a participant name" do
+    @wi.participant_name.should == 'toto'
+  end
+  
+  it "should have a dispatch time" do
+    @wi.dispatch_time.should_not be_nil
+    @wi.dispatch_time.should be_an_instance_of( Time )
+  end
+  
+  it "should have a last modified time" do
+    @wi.last_modified.should_not be_nil
+    @wi.last_modified.should be_an_instance_of( Time )
+  end
+  
+  it "should have attributes" do
+    @wi.attributes.should be_an_instance_of( Hash )
+    @wi.attributes['shallow'].should be_true
+  end
+  
+  it "should act like a hash for attributes" do
+    @wi['shallow'].should be_true
+  end
+  
+  it "should have convenient access to attribute keys through methods" do
+    lambda {
+      @wi.shallow.should be_true
+    }.should_not raise_error(NoMethodError)
+  end
+
+  it "should spill itself as json" do
+    lambda {
+      ActiveSupport::JSON.decode( @wi.to_json )
+    }.should_not raise_error
+  end
+end
+
+describe RuoteExternalWorkitem::REST do
+  before(:each) do
+    json = <<-JSON
+      {"last_modified": "2009/04/23 12:49:07 +0200",
+       "type": "OpenWFE::InFlowWorkItem",
+       "participant_name": "toto",
+       "attributes": {"shallow": "true", "nes": {"ted": "yes" } },
+       "links": [{"href": "http://localhost:4567/workitems", "rel": "via"},
+         {"href": "http://localhost:4567/workitems/20090413-juduhojewo/0_0_0_0_1", "rel": "self"}],
+       "dispatch_time": "2009/04/23 12:49:07 +0200",
+       "flow_expression_id":
+          {"workflow_definition_url": "field:__definition",
+           "expression_name": "toto",
+           "workflow_definition_name": "TestExternal",
+           "owfe_version": "0.9.21",
+           "workflow_definition_revision": "0",
+           "workflow_instance_id": "20090413-juduhojewo",
+           "engine_id": "ruote_rest",
+           "expression_id": "0.0.0.0.1"}
+          }
+    JSON
+
+    @wi = RuoteExternalWorkitem.parse( json )
+  end
+  
+  it "should have a base URI" do
+    @wi.base_uri.should == "http://localhost:4567/"
+  end
+  
+  it "should have a URI to self" do
+    @wi.uri.should == "http://localhost:4567/workitems/20090413-juduhojewo/0_0_0_0_1"
+  end
+end
+
+describe RuoteExternalWorkitem::XMPP do
+  before(:each) do
+    json = <<-JSON
+      {"last_modified": "2009/04/23 12:49:07 +0200",
+       "type": "OpenWFE::InFlowWorkItem",
+       "participant_name": "toto",
+       "attributes": {"shallow": "true", "nes": {"ted": "yes" } },
+       "source_jid": "jabber@example.com",
+       "reply_jid": "replies@example.com",
+       "dispatch_time": "2009/04/23 12:49:07 +0200",
+       "flow_expression_id":
+          {"workflow_definition_url": "field:__definition",
+           "expression_name": "toto",
+           "workflow_definition_name": "TestExternal",
+           "owfe_version": "0.9.21",
+           "workflow_definition_revision": "0",
+           "workflow_instance_id": "20090413-juduhojewo",
+           "engine_id": "ruote_rest",
+           "expression_id": "0.0.0.0.1"}
+          }
+    JSON
+
+    @wi = RuoteExternalWorkitem.parse( json )
+  end
+  
+  it "should have a source jabber id" do
+    @wi.source_jid.should == 'jabber@example.com'
+  end
+
+  it "should have a destination jabber id for replies" do
+    @wi.reply_jid.should == 'replies@example.com'
+  end
+end
+
+describe RuoteExternalWorkitem::AMQP do
+  before(:each) do
+    json = <<-JSON
+      {"last_modified": "2009/04/23 12:49:07 +0200",
+       "type": "OpenWFE::InFlowWorkItem",
+       "participant_name": "toto",
+       "attributes": {"shallow": "true", "nes": {"ted": "yes" } },
+       "source_queue": "ruote.participant",
+       "reply_queue": "ruote.listener",
+       "dispatch_time": "2009/04/23 12:49:07 +0200",
+       "flow_expression_id":
+          {"workflow_definition_url": "field:__definition",
+           "expression_name": "toto",
+           "workflow_definition_name": "TestExternal",
+           "owfe_version": "0.9.21",
+           "workflow_definition_revision": "0",
+           "workflow_instance_id": "20090413-juduhojewo",
+           "engine_id": "ruote_rest",
+           "expression_id": "0.0.0.0.1"}
+          }
+    JSON
+
+    @wi = RuoteExternalWorkitem.parse( json )
+  end
+  
+  it "should have a source queue" do
+    @wi.source_queue.should == 'ruote.participant'
+  end
+  
+  it "should have a queue name for replies" do
+    @wi.reply_queue.should == 'ruote.listener'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruote_external_workitem'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: simianarmy-ruote-external-workitem-rails
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kenneth Kalmer
+- Marc Mauger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: simianarmy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
+- lib/ruote_external_workitem.rb
+- lib/ruote_external_workitem/amqp.rb
+- lib/ruote_external_workitem/base.rb
+- lib/ruote_external_workitem/rest.rb
+- lib/ruote_external_workitem/xmpp.rb
+- spec/ruote_external_workitem_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/simianarmy/ruote-external-workitem
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/ruote_external_workitem_spec.rb
+- spec/spec_helper.rb