modern_times 0.1.0

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Clarity Services, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,143 @@
+= modern_times
+
+* http://github.com/ClarityServices/modern_times
+
+== Description:
+
+JRuby library for performing background tasks via the hornetq messaging library.
+
+== Features/Problems:
+
+* TBD
+
+== Install:
+
+  gem install modern_times
+
+== Rails Usage:
+
+Create config/hornetq.yml which might look as follows:
+
+    development:
+      :connection: hornetq://invm
+
+    production:
+      :connection:
+        :uri: hornetq://msg1,msg2
+        :failover_on_initial_connection: true
+        :failover_on_server_shutdown: true
+        # 5 Connection attempts takes about 16 seconds before it switches to the backup server
+        :reconnect_attempts: 5
+      :session:
+        :username: mycluster_username
+        :password: mycluster_password
+
+In config/environment.rb, add the following lines:
+
+    ModernTimes.init_rails
+    # Publishers can be defined wherever appropriate
+    $foo_publisher = ModernTimes::HornetQ::Publisher.new('Foo')
+
+In your code, queue foo objects:
+
+    $foo_publisher.publish(my_foo_object)
+
+In app/workers, create a FooWorker class:
+
+    class FooWorker < ModernTimes::HornetQ::Worker
+      def perform(my_foo_object)
+        # Operate on my_foo_object
+      end
+    end
+
+Based on the hornetq.yml file above, a development mode connection will be created such that
+the queueing is handled in-memory (since the uri is 'hornetq://invm').
+When this is used, a single thread (by default) will be created for each defined Worker so queued
+messages will be handled asynchronously within the same process.
+
+In test mode, there is no configuration defined.  In this case, published messages will cause
+synchronous calls to the Worker's perform method.
+
+In production mode, you will need to start up a hornetq server to distribute the messages.  For the
+configuration above, you might create a hornetq_server.yml file as follows:
+
+    # backup server runs on msg2
+    backup_server:
+      :uri:                 hornetq://0.0.0.0
+      :backup:              true
+      :data_directory:      /var/lib/hornetq/data
+      :persistence_enabled: true
+      :security_enabled:    true
+      :cluster_user:        mycluster_username
+      :cluster_password:    mycluster_password
+
+    # live server runs on msg1
+    live_server:
+      :uri:                 hornetq://0.0.0.0,msg2
+      :data_directory:      /var/lib/hornetq/data
+      :persistence_enabled: true
+      :security_enabled:    true
+      :cluster_user:        mycluster_username
+      :cluster_password:    mycluster_password
+
+Then on host msg2 and msg1, you could startup the servers with the following commands:
+
+    # On msg2
+    hornetq_server hornetq_server.yml backup_server
+    # On msg1
+    hornetq_server hornetq_server.yml live_server
+
+For the production environment, you will need to startup a Manager process to handle messages.  You
+might create script/worker_manager as follows (assumes Rails.root/script is in your PATH):
+
+    #!/usr/bin/env runner
+
+    manager = ModernTimes.create_rails_manager
+    manager.join
+
+TODO:  Refer to example jsvc daemon script
+
+Configure your workers by starting jconsole and connecting to
+the manager process.  Go to the MBeans tab and open the tree to
+ModernTimes => Manager => Operations => start_worker
+
+Start/stop/increase/decrease workers as needed.  The state is stored in the log directory (by default)
+so you can stop and start the manager and not have to reconfigure your workers.
+TODO:  This is flaky right now due to bugs in jruby-jmx.
+
+== Multiple Workers For a Single Address:
+
+By default, a worker operates on the address and queue with the same name as the class.  You can override
+this by explicitily stating the address and queue that the worker should operate on.  For instance, the
+Fooworker defined above is equivalent to the following:
+
+    class FooWorker < ModernTimes::HornetQ::Worker
+      address 'Foo'
+      queue   'Foo'
+      def perform(my_foo_object)
+        # Operate on my_foo_object
+      end
+    end
+
+You can setup multiple workers to operate on the same address.  For instance, the following worker would
+create a separate queue that would also receive all the messages published on address 'Foo':
+
+    class BarWorker < ModernTimes::HornetQ::Worker
+      address 'Foo'
+      def perform(my_foo_object)
+        # Operate on my_foo_object
+      end
+    end
+
+
+== What's with the name?
+
+I'm a Chaplin fan.
+
+== Author
+
+Brad Pardee, Reid Morrison
+
+== Copyright
+
+Copyright (c) 2011 Clarity Services. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'modern_times'
+    gemspec.summary = 'Asynchronous task library'
+    gemspec.description = 'Generic asynchronous task library'
+    gemspec.authors = ['Brad Pardee', 'Reid Morrison']
+    gemspec.email = ['bradpardee@gmail.com', 'rubywmq@gmail.com']
+    gemspec.homepage = 'http://github.com/ClarityServices/modern_times'
+    gemspec.add_dependency 'jruby-hornetq', ['>= 0.3.2']
+    gemspec.add_dependency 'jmx'
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: gem install jeweler'
+end
+
+desc "Run Test Suite"
+task :test do
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::Task['functional'].invoke
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/simple/.gitignore

@@ -0,0 +1,2 @@
+data
+*.state

data/examples/simple/README

@@ -0,0 +1,24 @@
+# Step 1
+# Start a hornetq server (gem install jruby-hornetq if necessary)
+hornetq_server hornetq.yml server
+
+# Step 2
+# Start up the manager
+jruby manager.rb
+
+# Step 3
+# Start up jconsole
+# Attach to the manager process
+# Go to the MBeans tab
+# Open up the tree to ModernTimes => Manager => Operations => start_worker
+# Enter BarWorker for worker and 2 for count and click the start_worker button
+# Enter BazWorker for worker and 3 for count and click the start_worker button
+
+# Step 4
+# Publish 10 messages to the BarWorker and 20 to the BazWorker
+jruby publish.rb 10 5
+
+# Step 5
+# cntl-c the manager.rb process and start it back up.  It should come back with
+# the workers that have been configured via jconsole
+

data/examples/simple/bar_worker.rb

@@ -0,0 +1,6 @@
+class BarWorker < ModernTimes::HornetQ::Worker
+  def perform(obj)
+    puts "#{self}: Received #{obj.inspect} at #{Time.now}"
+    sleep 5
+  end
+end

data/examples/simple/baz_worker.rb

@@ -0,0 +1,8 @@
+class BazWorker < ModernTimes::HornetQ::Worker
+  include ModernTimes::HornetQ::MarshalStrategy::String
+  
+  def perform(obj)
+    puts "#{self}: Received #{obj} at #{Time.now}"
+    sleep 10
+  end
+end

data/examples/simple/hornetq.yml

@@ -0,0 +1,14 @@
+server:
+  :uri:                 hornetq://localhost
+  :data_directory:      ./data
+  :persistence_enabled: true
+  :security_enabled:    true
+  :cluster_user:        myuser
+  :cluster_password:    mypassword
+
+client:
+  :connection:
+    :uri:      hornetq://localhost
+  :session:
+    :username: myuser
+    :password: mypassword

data/examples/simple/manager.rb

@@ -0,0 +1,17 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'rubygems'
+require 'modern_times'
+require 'yaml'
+require 'bar_worker'
+require 'baz_worker'
+
+config = YAML.load_file('hornetq.yml')
+ModernTimes::HornetQ::Client.init(config['client'])
+
+manager = ModernTimes::Manager.new(:persist_file => 'modern_times.state')
+manager.stop_on_signal
+manager.allowed_workers = [BarWorker,BazWorker]
+#manager.add(BarWorker, 2, {})
+manager.join

data/examples/simple/publish.rb

@@ -0,0 +1,35 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'rubygems'
+require 'modern_times'
+require 'yaml'
+require 'bar_worker'
+require 'baz_worker'
+
+if ARGV.size < 2
+  $stderr.puts "Usage: {$0} <bar-publish-count> <baz-publish-count> [sleep-time]"
+end
+
+bar_count = ARGV[0].to_i
+baz_count = ARGV[1].to_i
+sleep_time = (ARGV[2] || 0.2).to_f
+
+config = YAML.load_file('hornetq.yml')
+ModernTimes::HornetQ::Client.init(config['client'])
+bar_publisher = ModernTimes::HornetQ::Publisher.new(BarWorker.address_name)
+baz_publisher = ModernTimes::HornetQ::Publisher.new(BazWorker.address_name, :marshal => :string)
+
+(1..bar_count).each do |i|
+  obj = {:message => i}
+  puts "Publishing to Bar object: #{obj.inspect}"
+  bar_publisher.publish(obj)
+  sleep sleep_time
+end
+
+(1..baz_count).each do |i|
+  obj = "Message ##{i}"
+  puts "Publishing to Baz object: #{obj}"
+  baz_publisher.publish(obj)
+  sleep sleep_time
+end

data/lib/modern_times/base/supervisor.rb

@@ -0,0 +1,97 @@
+module ModernTimes
+  module Base
+    class Supervisor
+      attr_reader :manager, :worker_klass
+
+      def initialize(manager, worker_klass, options)
+        @stopped       = false
+        @manager       = manager
+        @worker_klass  = worker_klass
+        @workers       = []
+        @worker_mutex  = Mutex.new
+        @failure_mutex = Mutex.new
+      end
+
+      def worker_count
+        @workers.size
+      end
+
+      def worker_count=(count)
+        @worker_mutex.synchronize do
+          ModernTimes.logger.info "#{@worker_klass.name}: Changing number of workers from #{@workers.size} to #{count}"
+          raise "#{@worker_klass.name}: Can't change worker_count, this manager has been stopped" if stopped?
+          curr_count = @workers.size
+          if curr_count < count
+            (curr_count...count).each do |index|
+              worker = @worker_klass.new
+              worker.supervisor = self
+              worker.index = index
+              if index == 0
+                # HornetQ hack:  If I create the session in the jmx thread, it dies with no feedback
+                tmp_thread = Thread.new do
+                  worker.setup
+                end
+                tmp_thread.join
+              end
+              worker.thread = Thread.new do
+                #ModernTimes.logger.debug "#{worker}: Started thread with priority #{Thread.current.priority}"
+                worker.start
+              end
+              @workers << worker
+            end
+          elsif curr_count > count
+            (count...curr_count).each { |index| @workers[index].stop }
+            (count...curr_count).each { |index| @workers[index].thread.join }
+            @workers = @workers[0, count]
+          end
+          manager.save_persist_state
+        end
+      end
+
+      def worker_status(index)
+        @workers[index].status
+      end
+
+      def stop
+        @worker_mutex.synchronize do
+          @stopped = true
+          @workers.each { |worker| worker.stop }
+        end
+      end
+
+      def stopped?
+        @stopped
+      end
+
+      def join
+        @workers.each { |worker| worker.thread.join }
+      end
+
+      def failure(worker, message)
+        
+      end
+
+      def self.mbean(klass, options={})
+#        self.class.class_eval do
+#          define_method :create_mbean do |domain, supervisor, worker_klass|
+#            klass.new("#{domain}.Worker.#{worker_klass.name}", "Supervisor for #{worker_klass.name}", supervisor, options)
+#          end
+#        end
+        # TODO: This is nasty but I'm not sure how to create a dynamic class method within a scope
+        eval <<-EOS
+          def self.create_mbean(domain, supervisor, worker_klass)
+            #{klass.name}.new("\#{domain}.Worker.\#{worker_klass.name}", "Supervisor for \#{worker_klass.name}", supervisor, #{options.inspect})
+          end
+        EOS
+      end
+
+      def create_mbean(domain)
+        self.class.create_mbean(domain, self, @worker_klass)
+      end
+
+      #########
+      protected
+      #########
+    end
+  end
+end

data/lib/modern_times/base/supervisor_mbean.rb

@@ -0,0 +1,30 @@
+require 'jmx'
+
+module ModernTimes
+  module Base
+    class SupervisorMBean < RubyDynamicMBean
+      attr_reader :supervisor
+      rw_attribute :worker_count, :int, "Number of workers"
+
+      def initialize(name, description, supervisor, options)
+        super(name, description)
+        @supervisor = supervisor
+      end
+
+      def worker_count
+        supervisor.worker_count
+      end
+
+      def worker_count=(count)
+        supervisor.worker_count = count
+      end
+
+      operation 'Get the worker status'
+      parameter :int, "index", "Index of the worker"
+      returns :string
+      def worker_status(index)
+        supervisor.worker_status(index)
+      end
+    end
+  end
+end

data/lib/modern_times/base/worker.rb

@@ -0,0 +1,55 @@
+module ModernTimes
+  module Base
+    class Worker
+      attr_accessor :name, :index, :supervisor, :thread
+
+      def self.supervisor(klass, options={})
+        puts "calling supervisor with klass=#{klass.name} and class=#{self.name}"
+#        self.class_eval do
+#          define_method :create_supervisor do |manager|
+#            puts "calling create_supervisor for klass-#{klass.name} and self=#{self} and manager=#{manager}"
+#            klass.new(manager, self, options)
+#          end
+#        end
+        # TODO: This is nasty but I'm not sure how to create a dynamic class method within a scope
+        eval <<-EOS
+          def self.create_supervisor(manager)
+            #{klass.name}.new(manager, self, #{options.inspect})
+          end
+        EOS
+      end
+
+      # Default supervisor is Base::Supervisor
+      supervisor Supervisor
+
+      def initialize(opts={})
+        @name = opts[:name] || self.class.default_name
+      end
+
+      def name
+        @name
+      end
+
+      # One time initialization prior to first thread
+      def setup
+      end
+
+      def start
+        raise "Need to override start method in #{self.class.name}"
+      end
+
+      def stop
+        raise "Need to override stop method in #{self.class.name}"
+      end
+
+      def status
+        raise "Need to override status method in #{self.class.name}"
+      end
+
+      def self.default_name
+        name = self.name.sub(/Worker$/, '')
+        name.sub(/::/, '_')
+      end
+    end
+  end
+end

data/lib/modern_times/base.rb

@@ -0,0 +1,3 @@
+require 'modern_times/base/supervisor'
+require 'modern_times/base/supervisor_mbean'
+require 'modern_times/base/worker'