seam 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seam.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Darren Cauthon
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Seam
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seam'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seam
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/seam/effort.rb

@@ -0,0 +1,72 @@
+module Seam
+  class Effort
+    attr_accessor :completed_steps
+    attr_accessor :created_at
+    attr_accessor :complete
+    attr_accessor :id
+    attr_accessor :next_execute_at
+    attr_accessor :next_step
+    attr_accessor :flow
+    attr_accessor :data
+    attr_accessor :history
+
+    class << self
+
+      def find effort_id
+        Seam::Persistence.find_by_effort_id effort_id
+      end
+
+      def find_all_by_step step
+        Seam::Persistence.find_all_pending_executions_by_step step
+      end
+
+      def parse document
+        effort = Effort.new
+        effort.id              = document['id']
+        effort.created_at      = Time.parse(document['created_at'].to_s)
+        effort.next_execute_at = document['next_execute_at']
+        effort.next_step       = document['next_step']
+        effort.flow            = HashWithIndifferentAccess.new document['flow']
+        effort.data            = HashWithIndifferentAccess.new document['data']
+        effort.history         = document['history'].map { |x| HashWithIndifferentAccess.new x }
+        effort.completed_steps = document['completed_steps']
+        effort.complete        = document['complete']
+        effort
+      end
+
+    end
+    
+    def initialize
+      @completed_steps = []
+      @history         = []
+      @complete        = false
+    end
+
+    def save
+      existing_record = Seam::Effort.find self.id
+      if existing_record
+        Seam::Persistence.save self
+      else
+        Seam::Persistence.create self
+      end
+    end
+
+    def complete?
+      complete
+    end
+
+    def to_hash
+      {
+        id:              self.id,
+        created_at:      self.created_at,
+        completed_steps: self.completed_steps,
+        next_execute_at: self.next_execute_at,
+        next_step:       self.next_step,
+        flow:            self.flow,
+        data:            self.data,
+        history:         self.history,
+        complete:        self.complete,
+      }
+    end
+  end
+end

data/lib/seam/flow.rb

@@ -0,0 +1,44 @@
+module Seam
+  class Flow
+
+    def initialize
+      @steps = []
+    end
+
+    def method_missing(meth, *args, &blk)
+      @steps << [meth.to_s, args]
+    end
+
+    def start(data = {})
+      effort = Seam::Effort.new
+      effort.id              = SecureRandom.uuid.to_s
+      effort.created_at      = Time.parse(Time.now.to_s)
+      effort.next_execute_at = Time.parse(Time.now.to_s)
+      effort.next_step       = self.steps.first.name.to_s
+      effort.flow            = ActiveSupport::HashWithIndifferentAccess.new self.to_hash
+      effort.data            = ActiveSupport::HashWithIndifferentAccess.new data
+      effort.save
+      effort
+    end
+
+    def to_hash
+      {
+        steps: self.steps.map { |x| x.to_hash }
+      }
+    end
+
+    def steps
+      @steps.map do |x|
+        step = Seam::Step.new
+        step.name = x[0]
+        step.type = "do"
+        step.arguments = x[1]
+        if step.name.index('branch_on')
+          step.name += "_#{x[1][0]}"
+          step.type = "branch"
+        end
+        step
+      end
+    end
+  end
+end

data/lib/seam/mongo_db.rb

@@ -0,0 +1,12 @@
+module Seam
+  module MongoDb
+
+    def self.collection
+      @collection
+    end
+
+    def self.set_collection collection
+      @collection = collection
+    end
+  end
+end

data/lib/seam/persistence.rb

@@ -0,0 +1,24 @@
+module Seam
+  module Persistence
+    def self.find_by_effort_id effort_id
+      document = Seam::MongoDb.collection.find( { id: effort_id } ).first
+      return nil unless document
+      Seam::Effort.parse document
+    end
+
+    def self.find_all_pending_executions_by_step step
+      Seam::MongoDb.collection
+        .find( { next_step: step, next_execute_at: { '$lte' => Time.now } } )
+        .map { |x| Seam::Effort.parse x }
+    end
+
+    def self.save effort
+      Seam::MongoDb.collection.find( { id: effort.id } )
+          .update("$set" => effort.to_hash)
+    end
+
+    def self.create effort
+      Seam::MongoDb.collection.insert(effort.to_hash)
+    end
+  end
+end

data/lib/seam/step.rb

@@ -0,0 +1,15 @@
+module Seam
+  class Step
+    attr_accessor :name
+    attr_accessor :type
+    attr_accessor :arguments
+
+    def to_hash
+      {
+        name: name,
+        type: type,
+        arguments: HashWithIndifferentAccess.new(arguments || {})
+      }
+    end
+  end
+end

data/lib/seam/version.rb

@@ -0,0 +1,3 @@
+module Seam
+  VERSION = "0.0.1"
+end

data/lib/seam/worker.rb

@@ -0,0 +1,56 @@
+module Seam
+  class Worker
+    def for(step)
+      @step = step
+    end
+
+    def execute effort
+      @current_run = HashWithIndifferentAccess.new( { 
+                                                      started_at: Time.now,
+                                                      step: @step.to_s, 
+                                                      data_before: effort.data,
+                                                    } )
+      @current_effort = effort
+      process
+      @current_run[:data_after] = effort.data
+      @current_run[:stopped_at] = Time.now
+      @current_effort.history << @current_run
+      @current_effort.save
+    end
+
+    def execute_all
+      Seam::Effort.find_all_by_step(@step.to_s).each do |effort|
+        execute effort
+      end
+    end
+
+    def eject
+      @current_run[:result] = "eject"
+      @current_effort.complete = true
+      @current_effort.next_step = nil
+      @current_effort.save
+    end
+
+    def move_to_next_step
+      @current_run[:result] = "move_to_next_step"
+      @current_effort.completed_steps << @current_effort.next_step
+
+      steps = @current_effort.flow['steps'].map { |x| x['name'] }
+
+      next_step = steps[@current_effort.completed_steps.count]
+      @current_effort.next_step = next_step
+      @current_effort.complete  = next_step.nil?
+      @current_effort.save
+    end
+
+    def try_again_in seconds
+      try_again_on = Time.now + seconds
+
+      @current_run[:result] = "try_again_in"
+      @current_run[:try_again_on] = try_again_on
+
+      @current_effort.next_execute_at = try_again_on
+      @current_effort.save
+    end
+  end
+end

data/lib/seam.rb

@@ -0,0 +1,9 @@
+require 'active_support/all'
+require 'active_support/time'
+require 'securerandom'
+require 'moped'
+require 'json'
+Dir[File.dirname(__FILE__) + '/seam/*.rb'].each {|file| require file }
+
+module Seam
+end

data/seam.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seam/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seam"
+  spec.version       = Seam::VERSION
+  spec.authors       = ["Darren Cauthon"]
+  spec.email         = ["darren@cauthon.com"]
+  spec.description   = %q{Simple workflows}
+  spec.summary       = %q{Simple workflows}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "active_support"
+  spec.add_runtime_dependency "i18n"
+  spec.add_runtime_dependency "moped"
+  spec.add_runtime_dependency "json"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "subtle"
+  spec.add_development_dependency "contrast"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "contrast"
+  spec.add_development_dependency "timecop"
+end

data/spec/seam/effort_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Seam::Effort do
+  before do
+    test_moped_session['efforts'].drop
+  end
+
+  let(:flow) do
+    f = Seam::Flow.new
+    f.step1
+    f.step2
+    f
+  end
+
+  describe "updating an effort" do
+    it "should not create another document in the collection" do
+      first_effort = flow.start
+      test_moped_session['efforts'].find.count.must_equal 1
+      first_effort.save
+      test_moped_session['efforts'].find.count.must_equal 1
+
+      second_effort = flow.start
+      test_moped_session['efforts'].find.count.must_equal 2
+      second_effort.save
+      test_moped_session['efforts'].find.count.must_equal 2
+    end
+
+    it "should update the information" do
+      first_effort = flow.start
+      second_effort = flow.start
+
+      first_effort.next_step = 'i_changed_the_first_one'
+      first_effort.save
+      first_effort.to_hash.contrast_with! Seam::Effort.find(first_effort.id).to_hash, [:id, :created_at]
+      second_effort.to_hash.contrast_with! Seam::Effort.find(second_effort.id).to_hash, [:id, :created_at]
+
+      second_effort.next_step = 'i_changed_the_second_one'
+      second_effort.save
+      first_effort.to_hash.contrast_with! Seam::Effort.find(first_effort.id).to_hash, [:id, :created_at]
+      second_effort.to_hash.contrast_with! Seam::Effort.find(second_effort.id).to_hash, [:id, :created_at]
+    end
+  end
+end

data/spec/seam/flow_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "flow" do
+  before do
+    test_moped_session['efforts'].drop
+  end
+
+  after do
+    Timecop.return
+  end
+
+  describe "a useful example" do
+    let(:flow) do
+      f = Seam::Flow.new
+      f.wait_for_attempting_contact_stage limit: 2.weeks
+      f.determine_if_postcard_should_be_sent
+      f.send_postcard_if_necessary
+      f
+    end
+
+    describe "steps that must be taken" do
+      before do
+        flow
+      end
+
+      it "should not throw an error" do
+        flow.steps.count.must_equal 3
+      end
+
+      it "should set the name of the three steps" do
+        flow.steps[0].name.must_equal "wait_for_attempting_contact_stage"
+        flow.steps[1].name.must_equal "determine_if_postcard_should_be_sent"
+        flow.steps[2].name.must_equal "send_postcard_if_necessary"
+      end
+
+      it "should set the step types of the three steps" do
+        flow.steps[0].type.must_equal "do"
+        flow.steps[1].type.must_equal "do"
+        flow.steps[2].type.must_equal "do"
+      end
+      
+      it "should set the arguments as well" do
+        flow.steps[0].arguments.must_equal [{ limit: 14.days.to_i }]
+        flow.steps[1].arguments.must_equal []
+        flow.steps[2].arguments.must_equal []
+      end
+    end
+  end
+
+  describe "a more useful example" do
+
+    describe "starting an effort" do
+      let(:flow) do
+        flow = Seam::Flow.new
+        flow.do_something
+        flow.do_something_else
+        flow
+      end
+
+      let(:now) { Time.parse('1/1/2011') }
+
+      before do
+        Timecop.freeze now
+
+        @expected_uuid = SecureRandom.uuid.to_s
+        SecureRandom.expects(:uuid).returns @expected_uuid
+
+        @effort = flow.start( { first_name: 'John' } )
+      end
+
+      it "should mark no steps as completed" do
+        @effort.completed_steps.count.must_equal 0
+      end
+
+      it "should stamp the effort with a uuid" do
+        @effort.id.must_equal @expected_uuid
+      end
+
+      it "should stamp the create date" do
+        @effort.created_at.must_equal now
+      end
+
+      it "should stamp the next execute date" do
+        @effort.next_execute_at.must_equal now
+      end
+
+      it "should stamp the next step name" do
+        @effort.next_step.must_equal "do_something"
+      end
+
+      it "should save an effort in the db" do
+        effort = Seam::Effort.find @effort.id
+        effort.to_hash.contrast_with! @effort.to_hash, [:id, :created_at]
+      end
+    end
+  end
+end

data/spec/seam/worker_spec.rb

@@ -0,0 +1,583 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "worker" do
+
+  before do
+    test_moped_session['efforts'].drop
+  end
+
+  after do
+    Timecop.return
+  end
+
+  describe "move_to_next_step" do
+    it "should work" do
+      flow = Seam::Flow.new
+      flow.apple
+      flow.orange
+
+      effort = flow.start( { first_name: 'John' } )
+      effort = Seam::Effort.find(effort.id)
+
+      effort.next_step.must_equal "apple"
+
+      apple_worker = Seam::Worker.new
+      apple_worker.for(:apple)
+      def apple_worker.process
+        move_to_next_step
+      end
+
+      apple_worker.execute effort
+
+      effort = Seam::Effort.find(effort.id)
+      effort.next_step.must_equal "orange"
+    end
+  end
+
+  describe "try_again_in" do
+
+    let(:effort) do
+      flow = Seam::Flow.new
+      flow.apple
+      flow.orange
+
+      e = flow.start( { first_name: 'John' } )
+      Seam::Effort.find(e.id)
+    end
+
+    before do
+      Timecop.freeze Time.parse('3/4/2013')
+      effort.next_step.must_equal "apple"
+
+      apple_worker = Seam::Worker.new
+      apple_worker.for(:apple)
+      def apple_worker.process
+        try_again_in 1.day
+      end
+
+      apple_worker.execute effort
+    end
+
+    it "should not update the next step" do
+      fresh_effort = Seam::Effort.find(effort.id)
+      fresh_effort.next_step.must_equal "apple"
+    end
+
+    it "should not update the next execute date" do
+      fresh_effort = Seam::Effort.find(effort.id)
+      fresh_effort.next_execute_at.must_equal Time.parse('4/4/2013')
+    end
+  end
+
+  describe "more copmlex example" do
+
+    let(:effort1) do
+      flow = Seam::Flow.new
+      flow.grape
+      flow.mango
+
+      e = flow.start( { status: 'Good' } )
+      Seam::Effort.find(e.id)
+    end
+    
+    let(:effort2) do
+      flow = Seam::Flow.new
+      flow.grape
+      flow.mango
+
+      e = flow.start( { status: 'Bad' } )
+      Seam::Effort.find(e.id)
+    end
+
+    before do
+      Timecop.freeze Time.parse('1/6/2013')
+
+      apple_worker = Seam::Worker.new
+      apple_worker.for(:apple)
+      def apple_worker.process
+        if @current_effort.data[:status] == 'Good'
+          move_to_next_step
+        else
+          try_again_in 1.day
+        end
+      end
+
+      apple_worker.execute effort1
+      apple_worker.execute effort2
+    end
+
+    it "should move the first effort forward" do
+      fresh_effort = Seam::Effort.find(effort1.id)
+      fresh_effort.next_step.must_equal "mango"
+    end
+
+    it "should keep the second effort at the same step" do
+      fresh_effort = Seam::Effort.find(effort2.id)
+      fresh_effort.next_step.must_equal "grape"
+      fresh_effort.next_execute_at.must_equal Time.parse('2/6/2013')
+    end
+  end
+
+  describe "processing all pending steps for one effort" do
+    let(:effort1_creator) do
+      ->() do
+        flow = Seam::Flow.new
+        flow.banana
+        flow.mango
+
+        e = flow.start
+        Seam::Effort.find(e.id)
+      end
+    end
+    
+    let(:effort2_creator) do
+      ->() do
+        flow = Seam::Flow.new
+        flow.apple
+        flow.orange
+
+        e = flow.start
+        Seam::Effort.find(e.id)
+      end
+    end
+
+    let(:apple_worker) do
+      apple_worker = Seam::Worker.new
+      apple_worker.for(:apple)
+
+      apple_worker.class_eval do
+        attr_accessor :count
+      end
+
+      def apple_worker.process
+        self.count += 1
+      end
+
+      apple_worker.count = 0
+      apple_worker
+    end
+
+    before do
+      Timecop.freeze Time.parse('1/6/2013')
+
+      effort1_creator.call
+      effort1_creator.call
+      effort1_creator.call
+      effort2_creator.call
+      effort2_creator.call
+
+      apple_worker.execute_all
+    end
+
+    it "should call the apple worker for the record in question" do
+      apple_worker.count.must_equal 2
+    end
+  end
+
+  describe "a more realistic example" do
+
+    let(:flow) do
+      flow = Seam::Flow.new
+      flow.wait_for_attempting_contact_stage
+      flow.determine_if_postcard_should_be_sent
+      flow.send_postcard_if_necessary
+      flow
+    end
+
+    let(:effort_creator) do
+      ->() do
+        e = flow.start
+        Seam::Effort.find(e.id)
+      end
+    end
+    
+    let(:wait_for_attempting_contact_stage_worker) do
+      worker = Seam::Worker.new
+      worker.for(:wait_for_attempting_contact_stage)
+
+      def worker.process
+        @current_effort.data['hit 1'] ||= 0
+        @current_effort.data['hit 1'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    let(:determine_if_postcard_should_be_sent_worker) do
+      worker = Seam::Worker.new
+      worker.for(:determine_if_postcard_should_be_sent)
+
+      def worker.process
+        @current_effort.data['hit 2'] ||= 0
+        @current_effort.data['hit 2'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    let(:send_postcard_if_necessary_worker) do
+      worker = Seam::Worker.new
+      worker.for(:send_postcard_if_necessary)
+
+      def worker.process
+        @current_effort.data['hit 3'] ||= 0
+        @current_effort.data['hit 3'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    before do
+      Timecop.freeze Time.parse('1/6/2013')
+    end
+
+    it "should progress through the story" do
+
+      # SETUP
+      effort = effort_creator.call
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      # FIRST WAVE
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "determine_if_postcard_should_be_sent"
+
+      effort.complete?.must_equal false
+
+      # SECOND WAVE
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "send_postcard_if_necessary"
+
+      # THIRD WAVE
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal nil
+
+      effort.data['hit 1'].must_equal 1
+      effort.data['hit 2'].must_equal 1
+      effort.data['hit 3'].must_equal 1
+
+      effort.complete?.must_equal true
+      
+      # FUTURE WAVES
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal nil
+
+      effort.data['hit 1'].must_equal 1
+      effort.data['hit 2'].must_equal 1
+      effort.data['hit 3'].must_equal 1
+
+    end
+  end
+
+  describe "a more realistic example with waiting" do
+
+    let(:flow) do
+      flow = Seam::Flow.new
+      flow.wait_for_attempting_contact_stage
+      flow.determine_if_postcard_should_be_sent
+      flow.send_postcard_if_necessary
+      flow
+    end
+
+    let(:effort_creator) do
+      ->() do
+        e = flow.start
+        Seam::Effort.find(e.id)
+      end
+    end
+    
+    let(:wait_for_attempting_contact_stage_worker) do
+      worker = Seam::Worker.new
+      worker.for(:wait_for_attempting_contact_stage)
+
+      def worker.process
+        @current_effort.data['hit 1'] ||= 0
+        @current_effort.data['hit 1'] += 1
+        if Time.now >= Time.parse('28/12/2013')
+          move_to_next_step
+        else
+          try_again_in 1.day
+        end
+      end
+
+      worker
+    end
+
+    let(:determine_if_postcard_should_be_sent_worker) do
+      worker = Seam::Worker.new
+      worker.for(:determine_if_postcard_should_be_sent)
+
+      def worker.process
+        @current_effort.data['hit 2'] ||= 0
+        @current_effort.data['hit 2'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    let(:send_postcard_if_necessary_worker) do
+      worker = Seam::Worker.new
+      worker.for(:send_postcard_if_necessary)
+
+      def worker.process
+        @current_effort.data['hit 3'] ||= 0
+        @current_effort.data['hit 3'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    before do
+      Timecop.freeze Time.parse('25/12/2013')
+    end
+
+    it "should progress through the story" do
+
+      # SETUP
+      effort = effort_creator.call
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      # FIRST DAY
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      Timecop.freeze Time.parse('29/12/2013')
+
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "determine_if_postcard_should_be_sent"
+      effort.data['hit 1'].must_equal 2
+    end
+  end
+
+  describe "tracking history" do
+
+    let(:flow) do
+      flow = Seam::Flow.new
+      flow.wait_for_attempting_contact_stage
+      flow.determine_if_postcard_should_be_sent
+      flow.send_postcard_if_necessary
+      flow
+    end
+
+    let(:effort_creator) do
+      ->(values = {}) do
+        e = flow.start values
+        Seam::Effort.find(e.id)
+      end
+    end
+    
+    let(:wait_for_attempting_contact_stage_worker) do
+      worker = Seam::Worker.new
+      worker.for(:wait_for_attempting_contact_stage)
+
+      def worker.process
+        @current_effort.data['hit 1'] ||= 0
+        @current_effort.data['hit 1'] += 1
+        if Time.now >= Time.parse('28/12/2013')
+          move_to_next_step
+        else
+          try_again_in 1.day
+        end
+      end
+
+      worker
+    end
+
+    let(:determine_if_postcard_should_be_sent_worker) do
+      worker = Seam::Worker.new
+      worker.for(:determine_if_postcard_should_be_sent)
+
+      def worker.process
+        @current_effort.data['hit 2'] ||= 0
+        @current_effort.data['hit 2'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    let(:send_postcard_if_necessary_worker) do
+      worker = Seam::Worker.new
+      worker.for(:send_postcard_if_necessary)
+
+      def worker.process
+        @current_effort.data['hit 3'] ||= 0
+        @current_effort.data['hit 3'] += 1
+        move_to_next_step
+      end
+
+      worker
+    end
+
+    before do
+      Timecop.freeze Time.parse('26/12/2013')
+    end
+
+    it "should progress through the story" do
+
+      # SETUP
+      effort = effort_creator.call({ first_name: 'DARREN' })
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      # FIRST DAY
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      effort.history.count.must_equal 1
+      effort.history[0].contrast_with!( {
+                                          "started_at"=> Time.now, 
+                                          "step"=>"wait_for_attempting_contact_stage",
+                                          "stopped_at" => Time.now, 
+                                          "data_before" => { "first_name" => "DARREN" } ,
+                                          "data_after"  => { "first_name" => "DARREN", "hit 1" => 1 } 
+                                        } )
+
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      effort.history.count.must_equal 1
+      effort.history[0].contrast_with!({"started_at"=> Time.now, "step"=>"wait_for_attempting_contact_stage", "stopped_at" => Time.now, "result" => "try_again_in", "try_again_on" => Time.now + 1.day } )
+
+      # THE NEXT DAY
+      Timecop.freeze Time.parse('27/12/2013')
+
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "wait_for_attempting_contact_stage"
+
+      effort.history.count.must_equal 2
+      effort.history[1].contrast_with!({"started_at"=> Time.now, "step"=>"wait_for_attempting_contact_stage", "stopped_at" => Time.now, "result" => "try_again_in" } )
+
+      # THE NEXT DAY
+      Timecop.freeze Time.parse('28/12/2013')
+
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "determine_if_postcard_should_be_sent"
+
+      effort.history.count.must_equal 3
+      effort.history[2].contrast_with!({"started_at"=> Time.now, "step"=>"wait_for_attempting_contact_stage", "stopped_at" => Time.now, "result" => "move_to_next_step" } )
+
+      # KEEP GOING
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal "send_postcard_if_necessary"
+
+      effort.history.count.must_equal 4
+      effort.history[3].contrast_with!({"started_at"=> Time.now, "step"=>"determine_if_postcard_should_be_sent", "stopped_at" => Time.now, "result" => "move_to_next_step" } )
+      
+      # KEEP GOING
+      send_postcard_if_necessary_worker.execute_all
+      determine_if_postcard_should_be_sent_worker.execute_all
+      wait_for_attempting_contact_stage_worker.execute_all
+      effort = Seam::Effort.find effort.id
+      effort.next_step.must_equal nil
+
+      effort.history.count.must_equal 5
+      effort.history[4].contrast_with!({"started_at"=> Time.now, "step"=>"send_postcard_if_necessary", "stopped_at" => Time.now, "result" => "move_to_next_step" } )
+    end
+  end
+
+  describe "eject" do
+
+    let(:effort) do
+      flow = Seam::Flow.new
+      flow.apple
+      flow.orange
+
+      e = flow.start( { first_name: 'John' } )
+      Seam::Effort.find(e.id)
+    end
+
+    before do
+      Timecop.freeze Time.parse('5/11/2013')
+      effort.next_step.must_equal "apple"
+
+      apple_worker = Seam::Worker.new
+      apple_worker.for(:apple)
+      def apple_worker.process
+        eject
+      end
+
+      apple_worker.execute effort
+    end
+
+    it "should mark the step as completed" do
+      fresh_effort = Seam::Effort.find(effort.id)
+      fresh_effort.complete?.must_equal true
+    end
+
+    it "should mark the next step to nil" do
+      fresh_effort = Seam::Effort.find(effort.id)
+      fresh_effort.next_step.nil?.must_equal true
+    end
+    
+    it "should mark the history" do
+      effort.history[0].contrast_with!({"step"=>"apple", "result" => "eject" } )
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/seam')
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'subtle'
+require 'timecop'
+require 'contrast'
+require 'mocha/setup'
+
+def test_moped_session
+  session = Moped::Session.new([ "127.0.0.1:27017" ])
+  session.use "seam_test"
+end
+
+Seam::MongoDb.set_collection test_moped_session['efforts']

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: seam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Darren Cauthon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moped
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: subtle
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: contrast
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: contrast
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple workflows
+email:
+- darren@cauthon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/seam.rb
+- lib/seam/effort.rb
+- lib/seam/flow.rb
+- lib/seam/mongo_db.rb
+- lib/seam/persistence.rb
+- lib/seam/step.rb
+- lib/seam/version.rb
+- lib/seam/worker.rb
+- seam.gemspec
+- spec/seam/effort_spec.rb
+- spec/seam/flow_spec.rb
+- spec/seam/worker_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1454651581186774459
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1454651581186774459
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple workflows
+test_files:
+- spec/seam/effort_spec.rb
+- spec/seam/flow_spec.rb
+- spec/seam/worker_spec.rb
+- spec/spec_helper.rb