bumbleworks 0.0.69 → 0.0.70

data/lib/bumbleworks.rb

@@ -13,6 +13,7 @@ require "bumbleworks/entity"
 require "bumbleworks/participant"
 require "bumbleworks/workitem"
 require "bumbleworks/tracker"
+require "bumbleworks/user"
 
 # default implementations
 require "bumbleworks/simple_logger"

data/lib/bumbleworks/configuration.rb

@@ -299,10 +299,10 @@ module Bumbleworks
 
     def framework_root
       case
-        when defined?(Rails) then Rails.root
-        when defined?(Rory) then Rory.root
-        when defined?(Padrino) then Padrino.root
-        when defined?(Sinatra::Application) then Sinatra::Application.root
+        when defined?(::Rails) then ::Rails.root
+        when defined?(::Rory) then ::Rory.root
+        when defined?(::Padrino) then ::Padrino.root
+        when defined?(::Sinatra::Application) then ::Sinatra::Application.root
       end
     end
 

data/lib/bumbleworks/ruote/exp/broadcast_event_expression.rb

@@ -1,12 +1,15 @@
 require 'ruote/exp/flow_expression'
+require 'bumbleworks/support/flow_expression'
 
 module Ruote::Exp
   class BroadcastEventExpression < FlowExpression
+    include Bumbleworks::Support::FlowExpression
+
     names :broadcast_event
 
     def consider_tag
       update_tree
-      h.updated_tree[1]['tag'] = attribute_text.to_s
+      h.updated_tree[1]['tag'] = tag_from_attribute
       super
     end
 

data/lib/bumbleworks/ruote/exp/wait_for_event_expression.rb

@@ -1,8 +1,11 @@
 require 'ruote/exp/flow_expression'
 require 'ruote/exp/fe_await'
+require 'bumbleworks/support/flow_expression'
 
 module Ruote::Exp
   class WaitForEventExpression < AwaitExpression
+    include Bumbleworks::Support::FlowExpression
+
     names :wait_for_event
 
     # This does the same as the base AwaitExpression#apply, except that this
@@ -13,7 +16,7 @@ module Ruote::Exp
     def apply
       update_tree
       h.updated_tree[1]['global'] = true
-      h.updated_tree[1]['left_tag'] = attribute_text.to_s
+      h.updated_tree[1]['left_tag'] = tag_from_attribute
       h.updated_tree[1]['merge'] = 'drop'
       super
     end

data/lib/bumbleworks/support/flow_expression.rb

@@ -0,0 +1,18 @@
+module Bumbleworks
+  module Support
+    module FlowExpression
+      def tag_from_attribute
+        tag = attribute_text.to_s
+        if h.updated_tree[1]['for_entity'].to_s == 'true'
+          workitem_fields = h.applied_workitem['fields']
+          entity_type, entity_id = workitem_fields.values_at('entity_type', 'entity_id')
+          if entity_type && entity_id
+            entity_tag = "#{Bumbleworks::Support.tokenize(entity_type)}_#{entity_id}"
+            tag += "__for_entity__#{entity_tag}"
+          end
+        end
+        tag
+      end
+    end
+  end
+end

data/lib/bumbleworks/user.rb

@@ -0,0 +1,91 @@
+module Bumbleworks
+  module User
+    class NoRoleIdentifiersMethodDefined < StandardError; end
+    class NoClaimTokenMethodDefined < StandardError; end
+    class MissingRoleQueryMethod < StandardError; end
+    class AmbiguousRoleQueryMethod < StandardError; end
+    class UnauthorizedClaimAttempt < StandardError; end
+    class UnauthorizedReleaseAttempt < StandardError; end
+
+    # The return value from this method is used as the "claimant" token on
+    # tasks, both for claiming a task and for checking if the user is the
+    # current claimant.
+    #
+    # By default, claim_token will first check for `username`, then `email`, and
+    # finally raise an exception if neither method exists.  Including classes
+    # should override this method if using something other than username or
+    # email (or if both respond, but email should be preferred).
+    def claim_token
+      [:username, :email].each do |token_method|
+        return send(token_method) if respond_to?(token_method)
+      end
+      raise NoClaimTokenMethodDefined,
+        "If your user class does not respond to :username or :email, define a `claim_token` method"
+    end
+
+    # The return value from this method is used when determining which tasks in
+    # the queue this user should be authorized for.  Must return an array of
+    # strings.
+    def role_identifiers
+      raise NoRoleIdentifiersMethodDefined,
+        "Define a `role_identifiers` method that returns an array of role names"
+    end
+
+    # Returns true if the array returned by #role_identifiers includes the given
+    # name.  Can be used to determine authority to perform actions on a task,
+    # for example.
+    def has_role?(role_name)
+      role_identifiers.include? role_name
+    end
+
+    # Attempts to set self as the claimant of the given task.  If not authorized
+    # to claim the task, raises exception.  Also bubbles exception from Task
+    # when task is already claimed by a different claimant.
+    def claim(task)
+      raise UnauthorizedClaimAttempt unless has_role?(task.role)
+      task.claim(claim_token)
+    end
+
+    # Same as #claim, but first releases (by force) the task, to avoid any
+    # possible UnauthorizedClaimAttempt or AlreadyClaimed exceptions.  Should
+    # only be made available to supervisory roles.
+    def claim!(task)
+      release!(task)
+      claim(task)
+    end
+
+    # If we are the current claimant of the given task, release the task. Does
+    # nothing if the task is not claimed, but raises exception if the task is
+    # currently claimed by someone else.
+    def release(task, force = false)
+      return unless task.claimed?
+      raise UnauthorizedReleaseAttempt unless force || task.claimant == claim_token
+      task.release
+    end
+
+    # Same as #release, but releases the task even if we're not the current
+    # claimant.  Allows an administrator, for example, to wrench a task away
+    # from an employee who is lagging.  Should only be made available to
+    # supervisory roles.
+    def release!(task)
+      release(task, true)
+    end
+
+    # Returns Task::Finder instance filtered by roles assigned to this user.
+    def authorized_tasks
+      Bumbleworks::Task.for_roles(role_identifiers)
+    end
+
+    # Returns Task::Finder instance filtered by user roles and availability
+    # (unclaimed and completable).
+    def available_tasks
+      authorized_tasks.available
+    end
+
+    # Returns Task::Finder instance filtered by claimant - only tasks this user
+    # has claimed (and not released or completed).
+    def claimed_tasks
+      Bumbleworks::Task.for_claimant(claim_token)
+    end
+  end
+end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.69"
+  VERSION = "0.0.70"
 end

data/spec/lib/bumbleworks/ruote/exp/broadcast_event_expression_spec.rb

@@ -21,4 +21,20 @@ describe Ruote::Exp::BroadcastEventExpression do
     Bumbleworks.dashboard.wait_for(waiter.wfid)
     @tracer.should == ['amazing']
   end
+
+  it 'appends entity info to tag when :for_entity is true' do
+    Bumbleworks.define_process 'waiter' do
+      await :left_tag => :the_event__for_entity__pig_widget_15, :global => true
+      echo 'amazing'
+    end
+
+    Bumbleworks.define_process 'sender' do
+      broadcast_event :the_event, :for_entity => true
+    end
+
+    waiter = Bumbleworks.launch!('waiter')
+    sender = Bumbleworks.launch!('sender', :entity_type => 'PigWidget', :entity_id => 15)
+    Bumbleworks.dashboard.wait_for(waiter.wfid)
+    @tracer.should == ['amazing']
+  end
 end

data/spec/lib/bumbleworks/ruote/exp/wait_for_event_expression_spec.rb

@@ -76,4 +76,21 @@ describe Ruote::Exp::WaitForEventExpression do
     Bumbleworks.dashboard.wait_for(waiter3.wfid)
     @tracer.should == ['entities! Rhubarb,spitpickle-4boof']
   end
+
+  it 'appends entity info to expected tag when :for_entity is true' do
+    Bumbleworks.define_process 'waiter' do
+      wait_for_event :the_event, :for_entity => true
+      echo 'i found your tag, sucka'
+    end
+
+    Bumbleworks.define_process 'sender' do
+      noop :tag => 'the_event__for_entity__fun_face_yellow5'
+    end
+
+    waiter = Bumbleworks.launch!('waiter', 'entity_type' => 'FunFace', 'entity_id' => 'yellow5')
+    sender = Bumbleworks.launch!('sender')
+
+    Bumbleworks.dashboard.wait_for(waiter.wfid)
+    @tracer.should == ['i found your tag, sucka']
+  end
 end

data/spec/lib/bumbleworks/user_spec.rb

@@ -0,0 +1,152 @@
+describe Bumbleworks::User do
+  let(:user_class) { Class.new { include Bumbleworks::User } }
+  let(:subject) { user_class.new }
+
+  describe '#claim_token' do
+    it 'returns username by default' do
+      subject.stub(:username => 'nerfobot')
+      subject.claim_token.should == 'nerfobot'
+    end
+
+    it 'returns email if no username' do
+      subject.stub(:email => 'fromp@nougatcountry.com')
+      subject.claim_token.should == 'fromp@nougatcountry.com'
+    end
+
+    it 'prefers username to email when both respond' do
+      subject.stub(:username => 'dumb', :email => 'moar dumb')
+      subject.claim_token.should == 'dumb'
+    end
+
+    it 'returns nil if method defined' do
+      subject.stub(:username)
+      subject.claim_token.should be_nil
+    end
+
+    it 'raises exception if neither username nor email defined' do
+      expect {
+        subject.claim_token
+      }.to raise_error(Bumbleworks::User::NoClaimTokenMethodDefined)
+    end
+  end
+
+  describe '#claim' do
+    before(:each) do
+      subject.stub(:role_identifiers => ['snoogat'])
+      subject.stub(:claim_token => "the umpire of snorts")
+    end
+
+    it 'claims a task if authorized' do
+      task = double('task', :role => 'snoogat')
+      task.should_receive(:claim).with("the umpire of snorts")
+      subject.claim(task)
+    end
+
+    it 'raises exception if unauthorized' do
+      task = double('task', :role => 'fashbone')
+      task.should_receive(:claim).never
+      expect {
+        subject.claim(task)
+      }.to raise_error(Bumbleworks::User::UnauthorizedClaimAttempt)
+    end
+
+    it 'raises exception if already claimed by another' do
+      task = double('task', :role => 'snoogat')
+      task.should_receive(:claim).and_raise(Bumbleworks::Task::AlreadyClaimed)
+      expect {
+        subject.claim(task)
+      }.to raise_error(Bumbleworks::Task::AlreadyClaimed)
+    end
+
+    describe '!' do
+      it 'resets even if claimed by another' do
+        task = double('task', :role => 'snoogat', :claimed? => true, :claimant => 'fumbo the monfey')
+        task.should_receive(:release).ordered
+        task.should_receive(:claim).with("the umpire of snorts").ordered
+        subject.claim!(task)
+      end
+    end
+  end
+
+  describe '#release' do
+    before(:each) do
+      subject.stub(:claim_token => "the umpire of snorts")
+    end
+
+    it 'releases a claimed task if claimant' do
+      task = double('task', :claimed? => true, :claimant => "the umpire of snorts")
+      task.should_receive(:release)
+      subject.release(task)
+    end
+
+    it 'does nothing if task not claimed' do
+      task = double('task', :claimed? => false)
+      task.should_receive(:release).never
+      subject.release(task)
+    end
+
+    it 'raises exception if not claimant' do
+      task = double('task', :claimed? => true, :claimant => 'a castanet expert')
+      task.should_receive(:release).never
+      expect {
+        subject.release(task)
+      }.to raise_error(Bumbleworks::User::UnauthorizedReleaseAttempt)
+    end
+
+    describe '!' do
+      it 'releases even if not claimant' do
+        task = double('task', :claimed? => true, :claimant => 'a castanet expert')
+        task.should_receive(:release)
+        subject.release!(task)
+      end
+    end
+  end
+
+  describe '#role_identifiers' do
+    it 'raises exception by default' do
+      expect {
+        subject.role_identifiers
+      }.to raise_error(Bumbleworks::User::NoRoleIdentifiersMethodDefined)
+    end
+  end
+
+  describe '#has_role?' do
+    before(:each) do
+      subject.stub(:role_identifiers => ['role1', 'role2'])
+    end
+
+    it 'returns true if role_identifiers includes given role' do
+      subject.has_role?('role1').should be_true
+    end
+
+    it 'returns false if role_identifiers does not include given role' do
+      subject.has_role?('role3').should be_false
+    end
+  end
+
+  describe '#authorized_tasks' do
+    it 'returns task query for all tasks for user roles' do
+      subject.stub(:role_identifiers => ['goose', 'midget'])
+      Bumbleworks::Task.stub(:for_roles).with(['goose', 'midget']).and_return(:all_the_tasks)
+      subject.authorized_tasks.should == :all_the_tasks
+    end
+  end
+
+  describe '#claimed_tasks' do
+    it 'returns task query for all user claimed tasks' do
+      subject.stub(:claim_token => :yay_its_me)
+      Bumbleworks::Task.stub(:for_claimant).with(:yay_its_me).and_return(:my_tasks)
+      subject.claimed_tasks.should == :my_tasks
+    end
+  end
+
+  describe '#available_tasks' do
+    it 'returns authorized tasks filtered by available' do
+      subject.stub(:role_identifiers => ['goose', 'midget'])
+      task_finder = double('task_finder')
+      task_finder.stub(:available => :only_the_available_tasks)
+      Bumbleworks::Task.stub(:for_roles).with(['goose', 'midget']).and_return(task_finder)
+      subject.available_tasks.should == :only_the_available_tasks
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.69
+  version: 0.0.70
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -187,11 +187,13 @@ files:
 - lib/bumbleworks/simple_logger.rb
 - lib/bumbleworks/storage_adapter.rb
 - lib/bumbleworks/support.rb
+- lib/bumbleworks/support/flow_expression.rb
 - lib/bumbleworks/task.rb
 - lib/bumbleworks/task/base.rb
 - lib/bumbleworks/task/finder.rb
 - lib/bumbleworks/tracker.rb
 - lib/bumbleworks/tree_builder.rb
+- lib/bumbleworks/user.rb
 - lib/bumbleworks/version.rb
 - lib/bumbleworks/workitem.rb
 - lib/bumbleworks/workitem_entity_storage.rb
@@ -240,6 +242,7 @@ files:
 - spec/lib/bumbleworks/task_spec.rb
 - spec/lib/bumbleworks/tracker_spec.rb
 - spec/lib/bumbleworks/tree_builder_spec.rb
+- spec/lib/bumbleworks/user_spec.rb
 - spec/lib/bumbleworks/workitem_entity_storage_spec.rb
 - spec/lib/bumbleworks/workitem_spec.rb
 - spec/lib/bumbleworks_spec.rb
@@ -263,7 +266,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3077608415877383800
+      hash: -1442108325624690777
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -272,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3077608415877383800
+      hash: -1442108325624690777
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -324,6 +327,7 @@ test_files:
 - spec/lib/bumbleworks/task_spec.rb
 - spec/lib/bumbleworks/tracker_spec.rb
 - spec/lib/bumbleworks/tree_builder_spec.rb
+- spec/lib/bumbleworks/user_spec.rb
 - spec/lib/bumbleworks/workitem_entity_storage_spec.rb
 - spec/lib/bumbleworks/workitem_spec.rb
 - spec/lib/bumbleworks_spec.rb