stapfen 1.1.1 → 1.2.0

data/Gemfile

@@ -3,9 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in stapfen.gemspec
 gemspec
 
+
 group :development do
   gem 'rake'
   gem 'rspec', '~> 2.11'
   gem 'guard-rspec'
-  gem 'yard'
 end

data/lib/stapfen/logger.rb

@@ -0,0 +1,48 @@
+
+module Stapfen
+  # Logging module to ensure that {{Stapfen::Worker}} classes can perform
+  # logging if they've been configured to
+  module Logger
+    # Collection of methods to pass arguments through from the class and
+    # instance level to a configured logger
+    PROXY_METHODS = [:info, :debug, :warn, :error].freeze
+
+    module ClassMethods
+      PROXY_METHODS.each do |method|
+        define_method(method) do |*args|
+          proxy_log_method(method, args)
+        end
+      end
+
+      private
+
+      def proxy_log_method(method, arguments)
+        if self.logger
+          self.logger.send(method, *arguments)
+          return true
+        end
+        return false
+      end
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    PROXY_METHODS.each do |method|
+      define_method(method) do |*args|
+        proxy_log_method(method, args)
+      end
+    end
+
+    private
+
+    def proxy_log_method(method, arguments)
+      if self.class.logger
+        self.class.logger.send(method, *arguments)
+        return true
+      end
+      return false
+    end
+  end
+end

data/lib/stapfen/version.rb

@@ -1,3 +1,3 @@
 module Stapfen
-  VERSION = "1.1.#{ENV['BUILD_NUMBER'] || 'dev'}"
+  VERSION = '1.2.0'
 end

data/lib/stapfen/worker.rb

@@ -1,16 +1,22 @@
-require 'thread'
-require 'onstomp'
+require 'stomp'
+require 'stapfen/logger'
 
 module Stapfen
   class Worker
+    include Stapfen::Logger
+
     class << self
-      attr_accessor :configuration, :consumers
+      attr_accessor :configuration, :consumers, :logger
     end
 
+    # Instantiate a new +Worker+ instance and run it
     def self.run!
       self.new.run
     end
 
+    # Expects a block to be passed which will yield the appropriate
+    # configuration for the Stomp gem. Whatever the block yields will be passed
+    # directly into the {{Stomp::Client#new}} method
     def self.configure
       unless block_given?
         raise Stapfen::ConfigurationError
@@ -18,6 +24,14 @@ module Stapfen
       @configuration = yield
     end
 
+    # Optional method, should be passed a block which will yield a {{Logger}}
+    # instance for the Stapfen worker to use
+    def self.log
+      @logger = yield
+    end
+
+
+    # Main message consumption block
     def self.consume(queue_name, headers={}, &block)
       unless block_given?
         raise Stapfen::ConsumeError, "Cannot consume #{queue_name} without a block!"
@@ -32,12 +46,11 @@ module Stapfen
       handle_signals!
     end
 
-
     def run
-      @client = OnStomp::Client.new(generate_uri)
-      @client.connect
+      @client = Stomp::Client.new(self.class.configuration)
 
       self.class.consumers.each do |name, headers, block|
+
         # We're taking each block and turning it into a method so that we can
         # use the instance scope instead of the blocks originally bound scope
         # which would be at a class level
@@ -45,7 +58,6 @@ module Stapfen
         self.class.send(:define_method, method_name, &block)
 
         client.subscribe(name, headers) do |message|
-          puts "invoking #{method_name} for #{message.inspect}"
           self.send(method_name, message)
         end
       end
@@ -54,8 +66,8 @@ module Stapfen
         # Performing this join/open loop to make sure that we don't
         # experience potential deadlocks between signal handlers who might
         # close the connection, and an infinite Client#join call
-        while client.connected? do
-          sleep(0.2)
+        while client.open? do
+          client.join(1)
         end
       rescue Interrupt
         exit_cleanly
@@ -73,25 +85,9 @@ module Stapfen
     end
 
     def exit_cleanly
-      if client.connected?
-        client.disconnect
+      unless client.closed?
+        client.close
       end
     end
-
-    # Convert Stapfen configuration into an OnStomp URL
-    #
-    # @return [String]
-    def generate_uri
-      config = self.class.configuration
-      raise Stapfen::ConfigurationError if config.nil? || config.empty?
-
-      user_info = nil
-
-      if config[:login] && config[:passcode]
-        user_info = "#{config[:login]}:#{config[:passcode]}@"
-      end
-
-      "stomp://#{user_info}#{config[:host]}:#{config[:port]}"
-    end
   end
 end

data/spec/logger_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Stapfen::Logger do
+  let(:mixin) do
+    Class.new do
+      include Stapfen::Logger
+    end
+  end
+
+  subject(:logger) { mixin.new }
+
+  context 'instance methods' do
+    it { should respond_to :info }
+    it { should respond_to :debug }
+    it { should respond_to :warn }
+    it { should respond_to :error }
+
+    context 'without an initialized logger' do
+      before :each do
+        logger.class.stub(:logger)
+      end
+
+      it 'should discard info messages' do
+        expect(logger.info('rspec')).to be_false
+      end
+    end
+
+    context 'with an initialized logger' do
+      let(:plogger) { double('RSpec Logger') }
+
+      before :each do
+        logger.class.stub(:logger).and_return(plogger)
+      end
+
+      it 'should pass info messages along' do
+        plogger.should_receive(:info)
+
+        expect(logger.info('rspec')).to be_true
+      end
+    end
+  end
+end

data/spec/worker_spec.rb

@@ -10,6 +10,7 @@ describe Stapfen::Worker do
     it { should respond_to :run! }
     it { should respond_to :configure }
     it { should respond_to :consume }
+    it { should respond_to :logger }
 
     describe '#configure' do
       it 'should error when not passed a block' do
@@ -53,38 +54,4 @@ describe Stapfen::Worker do
     end
   end
 
-  context 'instance methods' do
-    describe '#generate_uri' do
-      subject(:uri) { worker.generate_uri }
-      let(:conf) { {} }
-
-      before :each do
-        worker.class.stub(:configuration).and_return(conf)
-      end
-
-      context 'with a blank configuration' do
-        it 'should raise an error' do
-          expect { worker.generate_uri }.to raise_error(Stapfen::ConfigurationError)
-        end
-      end
-
-      context 'with an unauthenticated non-ssl host' do
-        let(:conf) { {:host => 'localhost', :port => 61613} }
-
-        it { should eql('stomp://localhost:61613') }
-      end
-
-      context 'with an authentication ssl host' do
-        let(:conf) do
-          {:host => 'localhost',
-           :port => 61613,
-           :login => 'admin',
-           :passcode => 'admin'}
-        end
-
-        it { should eql('stomp://admin:admin@localhost:61613') }
-      end
-    end
-
-  end
 end

data/stapfen.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
 
-  gem.add_dependency('onstomp', '>= 1.0.7')
+  gem.add_dependency('stomp', '>= 1.2.8')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stapfen
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2013-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: onstomp
+  name: stomp
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 1.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 1.2.8
 description: A simple gem for writing good basic STOMP workers
 email:
 - rtyler.croy@lookout.com
@@ -42,8 +42,10 @@ files:
 - Rakefile
 - examples/simple.rb
 - lib/stapfen.rb
+- lib/stapfen/logger.rb
 - lib/stapfen/version.rb
 - lib/stapfen/worker.rb
+- spec/logger_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb
 - stapfen.gemspec
@@ -61,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4532487508502136780
+      hash: -644536034951123366
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -70,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4532487508502136780
+      hash: -644536034951123366
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -78,6 +80,6 @@ signing_key:
 specification_version: 3
 summary: A simple gem for writing good basic STOMP workers
 test_files:
+- spec/logger_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb
-has_rdoc: