ruote-mon 2.3.0

data/CHANGELOG.txt

@@ -0,0 +1,8 @@
+
+= ruote-mon - CHANGELOG.txt
+
+
+== ruote-mon 2.3.0    released 2012/09/01
+
+- initial release
+

data/CREDITS.txt

@@ -0,0 +1,16 @@
+
+= ruote-mon CREDITS.txt
+
+
+== authors
+
+- John Mettraux - http://jmettraux.wordpress.com
+
+
+== contributors
+
+
+== many thanks to
+
+- Nathan Stults - https://github.com/PlasticLizard
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2011-2012, John Mettraux, jmettraux@gmail.com
+
+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.rdoc

@@ -0,0 +1,63 @@
+
+= ruote-mon
+
+A MongoDB storage for ruote.
+
+This is the 'official' storage. There is also: https://github.com/PlasticLizard/ruote-mongodb but it contains optimizations for Plastic Lizard's team.
+
+Works best with a 1.9.x Ruby.
+
+
+== usage
+
+  require 'ruote'
+  require 'ruote-mon'
+
+  ruote = Ruote::Dashboard.new(
+    Ruote::Worker.new(
+      Ruote::Mon::Storage.new(
+        Mongo::Connection.new()['ruote_mon_test'],
+        {})))
+
+  # ...
+
+
+== running tests
+
+assuming you have
+
+  ruote/
+  ruote-mon/
+
+start your MongoDB server and then
+
+
+* unit tests :
+
+get into ruote/ and do
+
+  ruby test/unit/storage.rb -- --mon
+
+* functional tests :
+
+get into ruote/ and do
+
+  ruby test/functional/test.rb -- --mon
+
+
+== license
+
+MIT
+
+
+== links
+
+* http://ruote.rubyforge.org/
+* http://github.com/jmettraux/ruote-mon
+
+
+== feedback
+
+mailing list : http://groups.google.com/group/openwferu-users
+irc : irc.freenode.net #ruote
+

data/Rakefile

@@ -0,0 +1,92 @@
+
+$:.unshift('.') # 1.9.2
+
+require 'rubygems'
+
+require 'rake'
+require 'rake/clean'
+require 'rdoc/task'
+
+
+#
+# clean
+
+CLEAN.include('pkg', 'rdoc')
+
+
+#
+# test / spec
+
+task :test do
+
+  puts
+  puts "to test ruote-mon, head to your ruote/ dir and run"
+  puts
+  puts "  ruby test/test.rb -- --mon"
+  puts
+  puts "but first, make sure your ruote-dm/test/functional_connection.rb"
+  puts "is set correctly."
+  puts
+end
+
+task :default => [ :test ]
+
+
+#
+# gem
+
+GEMSPEC_FILE = Dir['*.gemspec'].first
+GEMSPEC = eval(File.read(GEMSPEC_FILE))
+GEMSPEC.validate
+
+
+desc %{
+  builds the gem and places it in pkg/
+}
+task :build do
+
+  sh "gem build #{GEMSPEC_FILE}"
+  sh "mkdir pkg" rescue nil
+  sh "mv #{GEMSPEC.name}-#{GEMSPEC.version}.gem pkg/"
+end
+
+desc %{
+  builds the gem and pushes it to rubygems.org
+}
+task :push => :build do
+
+  sh "gem push pkg/#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+
+#
+# rdoc
+#
+# make sure to have rdoc 2.5.x to run that
+
+Rake::RDocTask.new do |rd|
+
+  rd.main = 'README.rdoc'
+  rd.rdoc_dir = 'rdoc'
+
+  rd.rdoc_files.include(
+    'README.rdoc', 'CHANGELOG.txt', 'CREDITS.txt', 'lib/**/*.rb')
+
+  rd.title = "#{GEMSPEC.name} #{GEMSPEC.version}"
+end
+
+
+#
+# upload_rdoc
+
+desc %{
+  upload the rdoc to rubyforge
+}
+task :upload_rdoc => [ :clean, :rdoc ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/ruote'
+
+  sh "rsync -azv -e ssh rdoc/#{GEMSPEC.name}_rdoc #{account}:#{webdir}/"
+end
+

data/TODO.txt

@@ -0,0 +1,9 @@
+
+[ ] Storage#drop_indexes
+
+== for the StorageParticipant
+[ ] Storage#by_wfid
+[ ] Storage#by_field
+[ ] Storage#by_participant
+[ ] Storage#query_workitems
+

data/lib/ruote-mon.rb

@@ -0,0 +1,3 @@
+
+require 'ruote/mon/storage'
+

data/lib/ruote/mon.rb

@@ -0,0 +1,3 @@
+
+require 'ruote/mon/storage'
+

data/lib/ruote/mon/storage.rb

@@ -0,0 +1,333 @@
+# encoding: UTF-8
+
+#--
+# Copyright (c) 2011-2012, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+require 'mongo'
+
+require 'ruote/storage/base'
+require 'ruote/mon/version'
+
+
+module Ruote
+module Mon
+
+  class Storage
+
+    include Ruote::StorageBase
+
+    TYPES = %w[
+      msgs schedules expressions workitems errors
+      configurations variables trackers history
+    ]
+
+    attr_reader :db
+
+    def initialize(mongo_db, options={})
+
+      @db = mongo_db
+      @options = options
+
+      #collection('msgs').drop_index('_id_')
+        # can't do that...
+
+      (TYPES - %w[ msgs schedules ]).each do |t|
+        collection(t).ensure_index('_wfid')
+        collection(t).ensure_index([ [ '_id', 1 ], [ '_rev', 1 ] ])
+      end
+      collection('schedules').ensure_index('_wfid')
+      collection('schedules').ensure_index('at')
+
+      replace_engine_configuration(options)
+    end
+
+    def get_schedules(delta, now)
+
+      from_mongo(collection('schedules').find(
+        'at' => { '$lte' => Ruote.time_to_utc_s(now) }
+      ).to_a)
+    end
+
+    # Returns true if the doc was successfully deleted.
+    #
+    def reserve(doc)
+
+      r = collection(doc).remove(
+        { '_id' => doc['_id'] },
+        :safe => true)
+
+      r['n'] == 1
+    end
+
+    # Puts a msg. Doesn't use :safe => true, it's always an insert with a
+    # new id.
+    #
+    def put_msg(action, options)
+
+      msg = prepare_msg_doc(action, options)
+      msg['put_at'] = Ruote.now_to_utc_s
+
+      msg['_rev'] = 0
+        # in case of msg replay
+
+      collection(msg).insert(to_mongo(msg))
+    end
+
+    def put(doc, opts={})
+
+      original = doc
+      doc = doc.dup
+
+      doc['_rev'] = (doc['_rev'] || -1) + 1
+      doc['_wfid'] = doc['_id'].split('!').last
+      doc['put_at'] = Ruote.now_to_utc_s
+
+      if doc['type'] == 'schedules'
+        doc['_wfid'] = doc['_wfid'].split('-')[0..-2].join('-')
+      end
+
+      r = begin
+        collection(doc).update(
+          { '_id' => doc['_id'], '_rev' => original['_rev'] },
+          to_mongo(opts[:update_rev] ? Ruote.fulldup(doc) : doc),
+          :safe => true, :upsert => original['_rev'].nil?)
+      rescue Mongo::OperationFailure
+        false
+      end
+
+      if r && (r['updatedExisting'] || original['_rev'].nil?)
+        original.merge!(
+          '_rev' => doc['_rev'], 'put_at' => doc['put_at']
+        ) if opts[:update_rev]
+        nil
+      else
+        from_mongo(collection(doc).find_one('_id' => doc['_id']) || true)
+      end
+    end
+
+    def get(type, key)
+
+      from_mongo(collection(type).find_one('_id' => key))
+    end
+
+    def delete(doc)
+
+      rev = doc['_rev']
+
+      raise ArgumentError.new("can't delete doc without _rev") unless rev
+
+      r = collection(doc).remove(
+        { '_id' => doc['_id'], '_rev' => doc['_rev'] },
+        :safe => true)
+
+      if r['n'] == 1
+        nil
+      else
+        from_mongo(collection(doc).find_one('_id' => doc['_id']) || true)
+      end
+    end
+
+    def get_many(type, key=nil, opts={})
+
+      opts = Ruote.keys_to_s(opts)
+      keys = key ? Array(key) : nil
+
+      cursor = if keys.nil?
+        collection(type).find
+      elsif keys.first.is_a?(Regexp)
+        collection(type).find('_id' => { '$in' => keys })
+      else # a String
+        collection(type).find('_wfid' => { '$in' => keys })
+      end
+
+      paginate(cursor, opts)
+    end
+
+    def ids(type)
+
+      collection(type).find(
+        {},
+        :fields => [], :sort => [ '_id', Mongo::ASCENDING ]
+      ).collect { |d|
+        d['_id']
+      }
+    end
+
+    def purge!
+
+      TYPES.each { |t| collection(t).remove }
+    end
+
+    # Shuts this storage down.
+    #
+    def close
+
+      @db.connection.close
+    end
+
+    # Shuts this storage down.
+    #
+    def shutdown
+
+      @db.connection.close
+    end
+
+    # Mainly used by ruote's test/unit/ut_17_storage.rb
+    #
+    def add_type(type)
+
+      # nothing to be done
+    end
+
+    # Nukes a db type and reputs it(losing all the documents that were in it).
+    #
+    def purge_type!(type)
+
+      collection(type).remove
+    end
+
+    #--
+    # workitem methods
+    #++
+
+    # Note: no check on value, MongoDB specific queries can be used...
+    #
+    # http://www.mongodb.org/display/DOCS/Advanced+Queries
+    #
+    def by_field(type, key, value, opts={})
+
+      value = { '$exists' => true } if value.nil?
+
+      paginate_workitems(
+        collection(type).find("fields.#{key}" => value),
+        opts)
+    end
+
+    def by_participant(type, participant_name, opts={})
+
+      paginate_workitems(
+        collection(type).find('participant_name' => participant_name),
+        opts)
+    end
+
+    def query_workitems(query)
+
+      query = Ruote.keys_to_s(query)
+
+      opts = {}
+      opts['count'] = query.delete('count')
+      opts['skip'] = query.delete('skip') || query.delete('offset')
+      opts['limit'] = query.delete('limit')
+      opts['descending'] = query.delete('descending')
+
+      wfid = query.delete('wfid')
+      pname = query.delete('participant') || query.delete('participant_name')
+
+      query = query.each_with_object({}) { |(k, v), h| h["fields.#{k}"] = v }
+
+      query['wfid'] = wfid if wfid
+      query['participant_name'] = pname if pname
+
+      paginate_workitems(
+        collection('workitems').find(query),
+        opts)
+    end
+
+    protected
+
+    # Given a doc, returns the MongoDB collection it should go to.
+    #
+    def collection(doc_or_type)
+
+      @db.collection(
+        doc_or_type.is_a?(String) ? doc_or_type : doc_or_type['type'])
+    end
+
+    # Given a cursor, applies the count/skip/limit/descending options
+    # if requested.
+    #
+    def paginate(cursor, opts)
+
+      opts = Ruote.keys_to_s(opts)
+
+      return cursor.count if opts['count']
+
+      cursor.sort(
+        '_id', opts['descending'] ? Mongo::DESCENDING : Mongo::ASCENDING)
+
+      cursor.skip(opts['skip'])
+      cursor.limit(opts['limit'])
+
+      from_mongo(cursor.to_a)
+    end
+
+    # Wrapping around #paginate for workitems.
+    #
+    def paginate_workitems(cursor, opts)
+
+      docs = paginate(cursor, opts)
+
+      docs.is_a?(Array) ? docs.collect { |h| Ruote::Workitem.new(h) } : docs
+    end
+
+    # Prepares the doc for insertion in MongoDB (takes care of keys beginning
+    # with '$' and/or containing '.')
+    #
+    def to_mongo(doc)
+
+      # vertical tilde and ogonek to the rescue
+
+      Ruote.deep_mutate(doc, [ /^\$/, /\./ ]) { |h, k, v|
+        h.delete(k)
+        h[k.gsub(/^\$/, 'ⸯ$').gsub(/\./, '˛')] = v
+      }
+    end
+
+    # The real work being #from_mongo is done here.
+    #
+    def _from_mongo(doc)
+
+      # vertical tilde and ogonek to the rescue
+
+      Ruote.deep_mutate(doc, [ /^ⸯ\$/, /˛/ ]) { |h, k, v|
+        h.delete(k)
+        h[k.gsub(/^ⸯ\$/, '$').gsub(/˛/, '.')] = v
+      }
+    end
+
+    # Prepare the doc for consumption out of MongoDB (takes care of keys
+    # beginning with '$' and/or containing '.')
+    #
+    def from_mongo(docs)
+
+      case docs
+        when true, nil then docs
+        when Array then docs.collect { |doc| _from_mongo(doc) }
+        else _from_mongo(docs)
+      end
+    end
+  end
+end
+end
+

data/lib/ruote/mon/version.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2011-2012, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+
+module Ruote
+module Mon
+
+  VERSION = '2.3.0'
+end
+end
+

data/ruote-mon.gemspec

@@ -0,0 +1,35 @@
+
+Gem::Specification.new do |s|
+
+  s.name = 'ruote-mon'
+
+  s.version = File.read(
+    File.expand_path('../lib/ruote/mon/version.rb', __FILE__)
+  ).match(/ VERSION *= *['"]([^'"]+)/)[1]
+
+  s.platform = Gem::Platform::RUBY
+  s.authors = [ 'John Mettraux' ]
+  s.email = [ 'jmettraux@gmail.com' ]
+  s.homepage = 'http://ruote.rubyforge.org'
+  s.rubyforge_project = 'ruote'
+  s.summary = 'MongoDB storage for ruote (a Ruby workflow engine)'
+  s.description = %q{
+MongoDB storage for ruote (a Ruby workflow engine)
+}
+
+  #s.files = `git ls-files`.split("\n")
+  s.files = Dir[
+    'Rakefile',
+    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    '*.gemspec', '*.txt', '*.rdoc', '*.md'
+  ]
+
+  s.add_runtime_dependency 'bson_ext'#, '>= 1.4.0'
+  s.add_runtime_dependency 'mongo'#, '>= 1.4.0'
+  s.add_runtime_dependency 'ruote', ">= #{s.version}"
+
+  s.add_development_dependency 'rake'
+
+  s.require_path = 'lib'
+end
+

data/test/connection.rb

@@ -0,0 +1,28 @@
+
+#
+# testing ruote-mon
+#
+# Tue Nov 22 16:54:57 JST 2011
+#
+
+require 'ruote-mon'
+
+
+def new_storage(opts)
+
+  #con = Mongo::Connection.new
+    #
+    # not thread-safe
+
+  #con = Mongo::Connection.new(nil, nil, :refresh_mode => :sync)
+    #
+    # http://groups.google.com/group/mongodb-user/browse_thread/thread/7d09df9fa765891e
+    #
+    # but it doesn't work.
+
+  con = Mongo::Connection.new(
+    '127.0.0.1', 27017, :pool_size => 14, :pool_timeout => 3)
+
+  Ruote::Mon::Storage.new(con['ruote_mon_test'], opts)
+end
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: ruote-mon
+version: !ruby/object:Gem::Version
+  version: 2.3.0
+  prerelease: 
+platform: ruby
+authors:
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  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: mongo
+  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: ruote
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !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'
+description: ! '
+
+  MongoDB storage for ruote (a Ruby workflow engine)
+
+'
+email:
+- jmettraux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/ruote/mon/storage.rb
+- lib/ruote/mon/version.rb
+- lib/ruote/mon.rb
+- lib/ruote-mon.rb
+- test/connection.rb
+- ruote-mon.gemspec
+- CHANGELOG.txt
+- CREDITS.txt
+- LICENSE.txt
+- TODO.txt
+- README.rdoc
+homepage: http://ruote.rubyforge.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ruote
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: MongoDB storage for ruote (a Ruby workflow engine)
+test_files: []