gz_activemessaging 0.13.1

data/lib/activemessaging/trace_filter.rb

@@ -0,0 +1,34 @@
+class TraceFilter< ActiveMessaging::Filter
+  include ActiveMessaging::MessageSender
+  
+  def initialize(options)
+    @queue = options[:queue]
+    TraceFilter.publishes_to @queue
+  end
+  
+  def process message, routing
+    
+    unless ( routing[:destination].name == @queue ) then
+      ActiveMessaging.logger.debug "Trace: direction = #{routing[:direction]} publisher=#{routing[:publisher]} queue=#{routing[:destination].name} @queue=#{@queue}"
+      if routing[:direction].to_sym==:outgoing then
+        "trace from outgoing"
+        publish @queue, "<sent>"+
+                        "<from>#{routing[:publisher]}</from>" +        
+                        "<queue>#{routing[:destination].name}</queue>" +
+                        "<message>#{message.body}</message>" + 
+                        "</sent>"
+      end
+      if routing[:direction].to_sym==:incoming then
+        "trace from incoming"
+        publish @queue, "<received>"+
+                        "<by>#{routing[:receiver]}</by>" +        
+                        "<queue>#{routing[:destination].name}</queue>" +
+                        "<message>#{message.body}</message>" + 
+                        "</received>"
+      end
+    end
+
+  end
+  
+end
+

data/lib/generators/active_messaging/install/USAGE

@@ -0,0 +1,21 @@
+Description:
+    Configures your application to use active messaging. The following files are installed:
+    1. config/broker.yml - Configures the broker that you will be using. 
+    2. script/poller - This script will start/stop/run the process that will be polling your broker. The name of this file/process is configurable. See Usage below. 
+    3. lib/poller.rb - The poller script will use this file to start up ActiveMesssaging
+  
+    The generator will also create a app/processors directory and modify your application.rb so that app/processors is in the autoload path
+
+Usage:
+    If you do not pass in an argument then the poller filename/process will be called poller. You can override this default by passing in the name that you want the file and process to be. 
+  
+Examples:
+    rails g activemessaging:install
+  
+      Installs activemessaging with the poller process named poller
+
+    rails g activemessaging:install POLLER_NAME
+  
+      Installs activemessaging but allows you to customize the name of the poller
+      
+      

data/lib/generators/active_messaging/install/install_generator.rb

@@ -0,0 +1,39 @@
+module ActiveMessaging
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    
+    argument :poller_name, :type => :string, :default => 'poller', :banner => 'poller_name'
+     
+    def copy_application
+      copy_file "application_processor.rb", "app/processors/application_processor.rb"
+    end
+
+    def copy_poller
+      template "poller", "script/#{poller_name}"
+      chmod("script/#{poller_name}", 0755)
+    end
+
+    def copy_threaded_poller
+      template "threaded_poller", "script/threaded_#{poller_name}"
+      chmod("script/threaded_#{poller_name}", 0755)
+    end
+
+    def copy_poller_rb
+      copy_file "poller.rb", "lib/#{poller_name}.rb"
+    end
+    
+    def copy_broker_rb
+      copy_file "broker.yml", "config/broker.yml"
+    end
+
+    def add_gems
+      gem("daemons")
+    end
+  
+ 
+    def change_application
+      application '  config.autoload_paths += %W(#{config.root}/app/processors)'
+    end
+    
+  end
+end

data/lib/generators/active_messaging/install/templates/application_processor.rb

@@ -0,0 +1,18 @@
+class ApplicationProcessor < ActiveMessaging::Processor
+  
+  # Default on_error implementation - logs standard errors but keeps processing. Other exceptions are raised.
+  # Have on_error throw ActiveMessaging::AbortMessageException when you want a message to be aborted/rolled back,
+  # meaning that it can and should be retried (idempotency matters here).
+  # Retry logic varies by broker - see individual adapter code and docs for how it will be treated
+  def on_error(err)
+    if (err.kind_of?(StandardError))
+      logger.error "ApplicationProcessor::on_error: #{err.class.name} rescued:\n" + \
+      err.message + "\n" + \
+      "\t" + err.backtrace.join("\n\t")
+    else
+      logger.error "ApplicationProcessor::on_error: #{err.class.name} raised: " + err.message
+      raise err
+    end
+  end
+
+end

data/lib/generators/active_messaging/install/templates/broker.yml

@@ -0,0 +1,139 @@
+#
+# broker.yml
+#
+# Simple yaml file for the env specific configuration of the broker connections.
+# See the wiki for more information: http://code.google.com/p/activemessaging/wiki/Configuration
+#
+development:
+    ############################
+    # Stomp Adapter Properties #
+    ############################
+    adapter: stomp
+
+    # properties below are all defaults for this adapter
+    # login: ""
+    # passcode: ""
+    # host: localhost
+    # port: 61613
+    # reliable: true
+    # reconnectDelay: 5
+
+    # NEW! enable stomp retry logic
+    #  will resend errored out messages to be retried when on_error throws ActiveMessaging::AbortMessageException
+    #
+    # Max number of times to retry an aborted message, for 0, will not retry (default)
+    # retryMax: 0
+    #
+    # If error still occurs after retryMax, send message to specified dead letter queue
+    # deadLetterQueue: '/queue/activemessaging/deadletter'
+
+    
+    ###########################
+    # AMQP Adapter Properties #    
+    ###########################
+    # adapter: amqp
+ 
+    # properties below are defaults for this adapter
+    # host: localhost
+    # port: 5672
+    # user: guest
+    # pass: guest
+    # vhost: /
+    # ssl: false
+    # ssl_verify: 1  
+    # debug: 0
+    # queue_name: <autogenerated>
+    # queue_durable: false if queue_name is autogenerated, defaults to true otherwise
+    # queue_auto_delete: true if queue_name is autogenerated, defaults to false otherwise
+    # queue_exclusive: true if queue_name is autogenerated, defaults to true otherwise
+
+    # SSL:
+
+    # in order to use SSL you will need to use the following fork of the carrot project:
+    #
+    #   http://github.com/rabbitt/carrot
+    #
+    # If your certificate is self signed, you will want to set ssl_verify to 0 which corresponds to 
+    # OpenSSL::SSL::VERIFY_NONE. Otherwise, it defaults to 1 (OpenSSL::SSL::VERIFY_PEER).
+   
+    # QUEUE_*:
+
+    # queue_name is the name of the "inbox" queue that will be bound to all subscription keys (called queues
+    # or destinations here). In other words, you only have one queue where all messages end up using this 
+    # adapter, and it is bound to the relevant exchanges using routing keys and exchange information 
+    # you provide in your messages.rb and subscribes_to calls. For example,
+    #
+    # in messages.rb:
+    #   s.queue :hello_world, 'hello.world', :exchange_type => :direct, :exchange_name => 'amq.direct'
+    #
+    # in a processor:
+    #   subscribes_to :hello_world, :routing_key => 'hello.#'
+    # 
+    # in a model:
+    #   publish :hello_world, 'Hello world!', :routing_key => 'hello.world'
+
+   
+    # Note: in the event that you don't specify a routing_key on publish, the queue_name of the specified
+    # destination (as listed in messages.rb) will be used as the routing_key when publishing.
+
+    ################################
+    # Beanstalk Adapter Properties #
+    ################################
+    # adapter: beanstalk
+    # host: localhost
+
+    ## properties below are all defaults for this adapter
+    # port: 11300
+
+
+    #################################
+    # Amazon SQS Adapter Properties #
+    #################################
+    # adapter: asqs
+    # access_key_id: XXXXXXXXXXXXXXXXXXXX
+    # secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
+    ## properties below are all defaults for this adapter
+    # host: queue.amazonaws.com
+    # port: 80
+    # reliable: true
+    # reconnectDelay: 5
+    # aws_version: 2006-04-01 
+    # content_type: text/plain
+    # poll_interval: 1
+    # cache_queue_list: true
+
+
+    ########################################
+    # ReliableMessaging Adapter Properties #
+    ########################################
+    # adapter: reliable_msg
+
+    ## properties below are all defaults for this adapter
+    # poll_interval: 1
+    # reliable: true
+
+
+    ###################################
+    # Websphere MQ Adapter Properties #
+    ###################################
+    # adapter: wmq
+    # q_mgr_name: ""
+    # poll_interval: .1
+
+
+    
+test:
+    adapter: test
+    reliable: false
+
+production:
+    adapter: stomp
+    reliable: true
+    # properties below are all defaults for this adapter
+    # login: ""
+    # passcode: ""
+    # host: localhost
+    # port: 61613
+    # reliable: true
+    # reconnectDelay: 5

data/lib/generators/active_messaging/install/templates/poller

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+ENV['APP_ROOT'] ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
+APP_ROOT = ENV['APP_ROOT']
+script_file = File.join(APP_ROOT, 'lib', '<%=poller_name%>.rb')
+tmp_dir = File.join(APP_ROOT, 'tmp')
+
+require 'rubygems'
+require 'daemons'
+
+
+options = {
+  :app_name   => "<%=poller_name%>",
+  :dir_mode   => :normal,
+  :dir        => tmp_dir,
+  :multiple   => true,
+  :ontop      => false,
+  :mode       => :load,
+  :backtrace  => true,
+  :monitor    => true,
+  :log_output => true
+}
+
+Daemons.run(script_file,options)

data/lib/generators/active_messaging/install/templates/poller.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# Make sure stdout and stderr write out without delay for using with daemon like scripts
+STDOUT.sync = true; STDOUT.flush
+STDERR.sync = true; STDERR.flush
+
+app_root = ENV['APP_ROOT'] || File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+application_file = File.join(app_root, 'config', 'environment.rb')
+
+if File.exist?(application_file)
+  load application_file
+else
+  raise "#{application_file} does not exist!"
+end
+
+Rails.logger = Logger.new(STDOUT)
+ActiveMessaging.logger = Rails.logger
+
+# Load ActiveMessaging
+ActiveMessaging::load_processors
+
+# Start it up!
+ActiveMessaging::start

data/lib/generators/active_messaging/install/templates/threaded_poller

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+# The threaded poller will use celluloid to generate many threads for a single poller process to handle messages
+# Yes, I absolutely looked at the sidekiq manager code, and this code is very very similar
+# This script also shows how to use the poller without loading Rails, though it loads the app lib directory
+# this is tested on 1.9.3, and rails 3+
+
+# Make sure stdout and stderr write out without delay for using with daemon like scripts
+STDOUT.sync = true; STDOUT.flush
+STDERR.sync = true; STDERR.flush
+
+# we're not going to load rails, but activemessaging does expect there to be an app root
+# this goes back to when it was used in both rails or merb, but work with just not loading a framework
+app_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ENV['APP_ROOT'] ||= app_root
+
+# minimal requirements, other requires are in the lib
+require 'rubygems'
+require 'bundler/setup'
+
+# load the app lib directory
+lib_path = File.dirname("#{app_root}/lib")
+$:.unshift(lib_path)
+Dir["#{lib_path}/**/*.rb"].each {|file| require file unless file.match(/poller\.rb/) }
+
+# require and load activemessaging
+require 'activemessaging'
+ActiveMessaging.load_activemessaging
+require 'activemessaging/threaded_poller'
+
+# configure the connection (there can be multiple defined in broker.yml) and number of threads
+connection_name = 'default'
+configuration   = [{:pool_size => 3}]
+
+# start it up!
+begin
+  trap("TERM", "EXIT")
+  @poller = ActiveMessaging::ThreadedPoller.new(connection_name, configuration)
+  @poller.start!
+  sleep
+rescue Interrupt
+  puts "-- Interrupt --"
+  @poller.stop!
+  @poller.wait(:shutdown)
+  exit(0)
+end

data/lib/generators/active_messaging/processor/USAGE

@@ -0,0 +1,2 @@
+Generates a stub ActiveMessaging Processor and associated test. 
+

data/lib/generators/active_messaging/processor/processor_generator.rb

@@ -0,0 +1,39 @@
+module ActiveMessaging
+  class ProcessorGenerator < Rails::Generators::NamedBase
+    # namespace "activemessaging"
+    source_root File.expand_path("../templates", __FILE__)
+
+    # check_class_collision :suffix=>"Processor"
+ 
+    def copy_processor
+      template "processor.rb", "app/processors/#{file_name}_processor.rb"
+    end
+    
+    def copy_messaging
+      template "messaging.rb", "config/messaging.rb"
+    end
+    
+    hook_for :test_framework, :as => :active_messaging_processor
+    
+  end
+end
+
+module TestUnit
+  class ActiveMessagingProcessor < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def copy_processor
+      template "processor_test.rb", "test/functional/#{file_name}_processor_test.rb"
+    end
+  end
+end
+
+module Rspec
+  class ActiveMessagingProcessor < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def copy_processor
+      template "processor_spec.rb", "spec/functional/#{file_name}_processor_spec.rb"
+    end
+  end
+end

data/lib/generators/active_messaging/processor/templates/messaging.rb

@@ -0,0 +1,12 @@
+#
+# Add your destination definitions here
+# can also be used to configure filters, and processor groups
+#
+ActiveMessaging::Gateway.define do |s|
+  #s.destination :orders, '/queue/Orders'
+  #s.filter :some_filter, :only=>:orders
+  #s.processor_group :group1, :order_processor
+  
+  s.destination :<%= singular_name %>, '/queue/<%= class_name %>'
+  
+end

data/lib/generators/active_messaging/processor/templates/processor.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Processor < ApplicationProcessor
+
+  subscribes_to :<%= singular_name %>
+
+  def on_message(message)
+    logger.debug "<%= class_name %>Processor received: " + message
+  end
+end

data/lib/generators/active_messaging/processor/templates/processor_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'activemessaging/test_helper'
+require File.dirname(__FILE__) + '/../../app/processors/application_processor'
+
+describe <%= class_name %>Processor do
+  
+  include ActiveMessaging::TestHelper
+  
+  before(:each) do
+    load File.dirname(__FILE__) + "/../../app/processors/<%= file_name %>_processor.rb"
+    @processor = <%= class_name %>Processor.new
+  end
+  
+  after(:each) do
+    @processor = nil
+  end
+  
+  it "should receive message" do
+    @processor.on_message('Your test message here!')
+  end
+
+  
+  
+end