stapfen 1.4.3 → 1.5.0

data/Gemfile

@@ -3,10 +3,14 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in stapfen.gemspec
 gemspec
 
+gem 'jruby-jms', :platform => :jruby
+gem 'stomp', '>= 1.2.14'
 
 group :development do
   gem 'rake'
   gem 'rspec', '~> 2.11'
   gem 'guard-rspec'
-  gem 'debugger'
+  gem 'pry'
+  gem 'debugger', :platform => :mri
+  gem 'debugger-pry', :platform => :mri
 end

data/lib/stapfen/destination.rb

@@ -0,0 +1,35 @@
+module Stapfen
+  class Destination
+    attr_accessor :name, :type
+
+    def queue?
+      @type == :queue
+    end
+
+    def topic?
+      @type == :topic
+    end
+
+    def as_stomp
+      if queue?
+        return "/queue/#{@name}"
+      end
+
+      if topic?
+        return "/topic/#{@name}"
+      end
+    end
+
+    # Create a {Stapfen::Destination} from the given string
+    #
+    # @param [String] name
+    # @return [Stapfen::Destination]
+    def self.from_string(name)
+      destination = self.new
+      pieces = name.split('/')
+      destination.type = pieces[1].to_sym
+      destination.name = pieces[2 .. -1].join('/')
+      return destination
+    end
+  end
+end

data/lib/stapfen/message.rb

@@ -0,0 +1,58 @@
+begin
+  require 'stomp'
+rescue LoadError
+  # Can't process Stomp
+end
+
+begin
+  require 'java'
+  require 'jms'
+rescue LoadError
+  # Can't process JMS
+end
+
+module Stapfen
+  class Message
+    attr_reader :message_id, :body, :original, :destination
+
+    def initialize(opts={})
+      super()
+      @body = opts[:body]
+      @destination = opts[:destination]
+      @message_id = opts[:message_id]
+      @original = opts[:original]
+    end
+
+    # Create an instance of {Stapfen::Message} from the passed in
+    # {Stomp::Message}
+    #
+    # @param [Stomp::Message] message A message created by the Stomp gem
+    # @return [Stapfen::Message] A Stapfen wrapper object
+    def self.from_stomp(message)
+      unless message.kind_of? Stomp::Message
+        raise Stapfen::InvalidMessageError, message.inspect
+      end
+
+      return self.new(:body => message.body,
+                      :destination => message.headers['destination'],
+                      :message_id => message.headers['message-id'],
+                      :original => message)
+    end
+
+    # Create an instance of {Stapfen::Message} from the passed in
+    # +ActiveMQBytesMessage+ which a JMS consumer should receive
+    #
+    # @param [ActiveMQBytesMessage] message
+    # @return [Stapfen::Message] A Stapfen wrapper object
+    def self.from_jms(message)
+      unless message.kind_of? Java::JavaxJms::Message
+        raise Stapfen::InvalidMessageError, message.inspect
+      end
+
+      return self.new(:body => message.data,
+                      :destination => message.jms_destination.getQualifiedName,
+                      :message_id => message.jms_message_id,
+                      :original => message)
+    end
+  end
+end

data/lib/stapfen/version.rb

@@ -1,3 +1,3 @@
 module Stapfen
-  VERSION = '1.4.3'
+  VERSION = '1.5.0'
 end

data/lib/stapfen/worker.rb

@@ -1,15 +1,22 @@
 require 'stomp'
 require 'stapfen/logger'
+require 'stapfen/destination'
+require 'stapfen/message'
 
 module Stapfen
   class Worker
     include Stapfen::Logger
 
+    # Class variables!
     @@signals_handled = false
     @@workers = []
 
+    # Class instance variables!
+    @use_stomp = true
+
     class << self
       attr_accessor :configuration, :consumers, :logger, :destructor
+
     end
 
     # Instantiate a new +Worker+ instance and run it
@@ -33,6 +40,51 @@ module Stapfen
       @configuration = block
     end
 
+    # Force the worker to use STOMP as the messaging protocol (default)
+    #
+    # @return [Boolean]
+    def self.use_stomp!
+      begin
+        require 'stomp'
+      rescue LoadError
+        puts "You need the `stomp` gem to be installed to use stomp!"
+        raise
+      end
+
+      @use_stomp = true
+      return true
+    end
+
+    def self.stomp?
+      @use_stomp
+    end
+
+    # Force the worker to use JMS as the messaging protocol.
+    #
+    # *Note:* Only works under JRuby
+    #
+    # @return [Boolean]
+    def self.use_jms!
+      unless RUBY_PLATFORM == 'java'
+        raise Stapfen::ConfigurationError, "You cannot use JMS unless you're running under JRuby!"
+      end
+
+      begin
+        require 'java'
+        require 'jms'
+      rescue LoadError
+        puts "You need the `jms` gem to be installed to use JMS!"
+        raise
+      end
+
+      @use_stomp = false
+      return true
+    end
+
+    def self.jms?
+      !(@use_stomp)
+    end
+
     # Optional method, should be passed a block which will yield a {{Logger}}
     # instance for the Stapfen worker to use
     def self.log
@@ -105,6 +157,53 @@ module Stapfen
     attr_accessor :client
 
     def run
+      if self.class.stomp?
+        run_stomp
+      elsif self.class.jms?
+        run_jms
+      end
+    end
+
+    def run_jms
+      JMS::Connection.start(self.class.configuration.call) do |connection|
+        @client = connection
+        debug("Running with #{@client} inside of Thread:#{Thread.current.inspect}")
+
+        self.class.consumers.each do |name, headers, block|
+          destination = Stapfen::Destination.from_string(name)
+          type = 'queue'
+          options = {}
+
+          if destination.queue?
+            options[:queue_name] = destination.name
+          end
+
+          if destination.topic?
+            type = 'topic'
+            options[:topic_name] = destination.name
+          end
+
+          method_name = "handle_#{type}_#{name}".to_sym
+          self.class.send(:define_method, method_name, &block)
+
+          connection.on_message(options) do |m|
+            message = Stapfen::Message.from_jms(m)
+            self.send(method_name, message)
+          end
+        end
+
+        begin
+          loop do
+            sleep 1
+          end
+          debug("Exiting the JMS runloop for #{self}")
+        rescue Interrupt
+          exit_cleanly
+        end
+      end
+    end
+
+    def run_stomp
       @client = Stomp::Client.new(self.class.configuration.call)
       debug("Running with #{@client} inside of Thread:#{Thread.current.inspect}")
 

data/lib/stapfen.rb

@@ -6,4 +6,6 @@ module Stapfen
   end
   class ConsumeError < StandardError
   end
+  class InvalidMessageError < StandardError
+  end
 end

data/spec/destination_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'stapfen/destination'
+
+describe Stapfen::Destination do
+  it { should respond_to :name }
+  it { should respond_to :type }
+
+  describe '#as_stomp' do
+    let(:name) { 'rspec/dlq' }
+
+    subject(:destination) do
+      d = described_class.new
+      d.type = :queue
+      d.name = name
+      d.as_stomp
+    end
+
+    it { should be_instance_of String }
+    it { should eql "/queue/#{name}" }
+  end
+
+  context 'class methods' do
+    describe '#from_string' do
+      subject(:destination) { described_class.from_string(name) }
+
+      context 'a simple queue' do
+        let(:name) { '/queue/rspec' }
+        its(:name) { should eql 'rspec' }
+        its(:type) { should eql :queue }
+      end
+
+      context 'a queue with slashes' do
+        let(:name) { '/queue/rspec/dlq' }
+        its(:name) { should eql 'rspec/dlq' }
+        its(:type) { should eql :queue }
+      end
+
+      context 'a complex topic' do
+        let(:name) { '/topic/rspec/dlq' }
+        its(:name) { should eql 'rspec/dlq' }
+        its(:type) { should eql :topic }
+      end
+    end
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'stapfen/message'
+
+if RUBY_PLATFORM == 'java'
+  require 'java'
+  require File.expand_path('./activemq-all-5.8.0.jar')
+end
+
+describe Stapfen::Message do
+  context 'accessors' do
+    it { should respond_to :message_id }
+    it { should respond_to :body }
+    it { should respond_to :original }
+    it { should respond_to :destination }
+  end
+
+  describe '#initialize' do
+    it 'should accept :body' do
+      body = 'hello'
+      m = described_class.new(:body => body)
+      expect(m.body).to eql(body)
+    end
+  end
+
+  context 'class methods' do
+    let(:body) { 'hello stapfen' }
+    let(:destination) { '/queue/rspec' }
+    let(:message_id) { rand.to_s }
+
+    describe '#from_stomp' do
+      subject(:result) { described_class.from_stomp(message) }
+
+      context 'when passed something other than a Stomp::Message' do
+        let(:message) { 'hello' }
+
+        it 'should raise an error' do
+          expect { result }.to raise_error(Stapfen::InvalidMessageError)
+        end
+      end
+
+      context 'when passed a Stomp::Message' do
+        let(:message) do
+          m = Stomp::Message.new('') # empty frame
+          m.body = body
+          headers = {'destination' => destination,
+                     'message-id' => message_id}
+          m.headers = headers
+          m
+        end
+
+        it 'should create an instance' do
+          expect(result).to be_instance_of Stapfen::Message
+        end
+
+        its(:body) { should eql body }
+        its(:destination) { should eql destination }
+        its(:message_id) { should eql message_id }
+        its(:original) { should be message }
+      end
+    end
+
+    describe '#from_jms', :java => true do
+      subject(:result) { described_class.from_jms(message) }
+
+      context 'when passed something other than a JMS message' do
+        let(:message) { 'hello' }
+
+        it 'should raise an error' do
+          expect { result }.to raise_error(Stapfen::InvalidMessageError)
+        end
+      end
+
+      context 'when passed an ActiveMQBytesMessage' do
+        let(:destination) { 'queue://rspec' }
+
+        let(:message) do
+          m = Java::OrgApacheActivemqCommand::ActiveMQBytesMessage.new
+          m.stub(:jms_destination => double('ActiveMQDestination mock', :getQualifiedName => destination))
+          m.stub(:jms_message_id => message_id)
+          m.stub(:data => body)
+          m
+        end
+
+        it 'should create an instance' do
+          expect(result).to be_instance_of Stapfen::Message
+        end
+
+        its(:body) { should eql body }
+        its(:destination) { should eql destination }
+        its(:message_id) { should eql message_id }
+        its(:original) { should be message }
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,18 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '../lib'))
 
 require 'stapfen'
-require 'debugger'
+
+
+is_java = (RUBY_PLATFORM == 'java')
+
+unless is_java
+  require 'debugger'
+  require 'debugger/pry'
+end
+
+
+RSpec.configure do |c|
+  unless is_java
+    c.filter_run_excluding :java => true
+  end
+end

data/spec/worker_spec.rb

@@ -13,6 +13,31 @@ describe Stapfen::Worker do
     it { should respond_to :log }
     it { should respond_to :shutdown }
 
+    describe '#use_stomp!' do
+      subject(:result) { worker.use_stomp! }
+
+      it 'should update the instance variable' do
+        expect(result).to be_true
+        expect(worker).to be_stomp
+        expect(worker).not_to be_jms
+      end
+    end
+
+    describe '#use_jms!', :java => true do
+      subject(:result) { worker.use_jms! }
+
+      after :each do
+        # Reset to the default since we've modified the class
+        worker.use_stomp!
+      end
+
+      it 'should update the instance variable' do
+        expect(result).to be_true
+        expect(worker).to be_jms
+        expect(worker).not_to be_stomp
+      end
+    end
+
     describe '#configure' do
       it 'should error when not passed a block' do
         expect {

data/stapfen.gemspec

@@ -16,7 +16,4 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
-
-  gem.add_dependency('stomp', '>= 1.2.14') # 1.2.14 fixes Stomp::Client#unreceive behavior
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stapfen
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: stomp
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.14
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.14
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies: []
 description: A simple gem for writing good basic STOMP workers
 email:
 - rtyler.croy@lookout.com
@@ -42,10 +26,14 @@ files:
 - Rakefile
 - examples/simple.rb
 - lib/stapfen.rb
+- lib/stapfen/destination.rb
 - lib/stapfen/logger.rb
+- lib/stapfen/message.rb
 - lib/stapfen/version.rb
 - lib/stapfen/worker.rb
+- spec/destination_spec.rb
 - spec/logger_spec.rb
+- spec/message_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb
 - stapfen.gemspec
@@ -63,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1405776487740339593
+      hash: -1455385429346077259
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1405776487740339593
+      hash: -1455385429346077259
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -80,6 +68,8 @@ signing_key:
 specification_version: 3
 summary: A simple gem for writing good basic STOMP workers
 test_files:
+- spec/destination_spec.rb
 - spec/logger_spec.rb
+- spec/message_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb