Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 3.76 KB

README.markdown

File metadata and controls

73 lines (52 loc) · 3.76 KB
Raw

Ruote on Rails

A simple example Rails app which implements a workflow for a sample activity diagram, using Ruote in Rails via RuoteKit. This app is based on tosch's excellent ruote-on-rails sample app.

Installation

  • clone (or do whatever you like to get the code) this repo: $ git clone git://github.com/threetee/ruote-rails-example.git
    $ cd ruote-rails-example
  • install gem dependencies if you like (gems are vendored, so this step is optional) $ rake gems:install
  • install daemon-kit and generate AMQP remote participant daemons using the 'ruote' instance (you will need to install several other prerequisites for this, including Erlang and RabbitMQ)

Configuration

config/initializers/ruote_kit.rb has already been tweaked with participants for the sample workflow, but you can of course change it to meet your needs.

Run

In one terminal, start the Rails server itself: $ script/server In another terminal, start the RuoteKit worker process: $ rake ruote_kit:run_worker

Browse to http://localhost:3000/_ruote and you'll see there are no running processes. You could change that using the "Launch process" link ;-)

Using Ruote from within Rails

You can access Ruote's engine anywhere in your Rails code by calling RuoteKit.engine So launching a workflow process is as easy as RuoteKit.engine.launch your_process_definition The storage participant (used by the catchall participant) is available at RuoteKit.storage_participant

Usage

To kick off a sample Ruote workflow, do the following:

  1. Create a new email at http://localhost:3000/emails/new. Note the 'pending' state for the newly-created email account.
  2. Check http://localhost:3000/workitems. You should see two new workitems (one for account app form submission and one for NDA submission).
  3. Click the edit link for each of the above workitems and upload a sample image. This will complete the workitems required of the 'requestor' participant (see the requestor swimlane in the sample activity diagram). Hit http://localhost:3000/emails to see the state change for the email record.
  4. Check http://localhost:3000/workitems again. You should now see one workitem, this one for the 'reviewer' participant. Click the edit link for this workitem to approve or reject the submitted forms.
  5. Hit http://localhost:3000/workitems once more. If you rejected the submitted forms, the workflow will have been rewound to the requestor participant's tasks, so you will see the two workitems that were presented back in step 2. If you accepted the submitted forms, you will see the workitem for the 'approver' participant. http://localhost:3000/emails should also reflect another state change.
  6. Edit the 'approver' participant's workitem. The 'approver' participant has final say over whether or not the email address should be created. If you (as the approver) deny this workitem, the workflow will terminate and the email's state will be set accordingly. If you approve the workitem, workflow will continue to the AMQP remote participants.
  7. App will call AMQP remote participants with the default /sample/quote method as provided by the default daemon-kit ruote generator. Of course, make sure that you have remote participants running and listening on the appropriate queues.
  8. Workflow will terminate.

TODO

  • Implement AMQP (done 5/9/10)
  • Implement email notifications to participants (done 5/9/10)