stapfen 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,11 @@
+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'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 R. Tyler Croy
+
+MIT License
+
+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.md

@@ -0,0 +1,57 @@
+# Stapfen
+
+Stapfen is a simple gem to make writing stand-alone STOMP workers easier.
+
+
+## Usage
+
+(Examples can be found in the `examples/` directory)
+
+
+Consider the following `myworker.rb` file:
+
+    class MyWorker < Stapfen::Worker
+      configure do
+        {:hosts => [
+          {
+            :host => 'localhost',
+            :port => 61613,
+            :login => 'guest',
+            :passcode => 'guest',
+            :ssl => false
+          }
+        ]}
+      end
+
+      consume 'thequeue' do |message|
+        data = expensive_computation(message.body)
+        persist(data)
+      end
+    end
+
+    MyWorker.run!
+
+
+The value returned from the `configure` block is expected to be a valid
+`Stomp::Client` [connection
+hash](https://github.com/stompgem/stomp#hash-login-example-usage-this-is-the-recommended-login-technique).
+
+It is also important to note that the `consume` block will be invoked inside an
+**instance** of `MyWorker` and will execute inside its own `Thread`, so take
+care when accessing other shared resources.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stapfen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stapfen
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = '--color --fail-fast'
+end
+
+task :test => :spec
+
+task :default => [:spec, :build]

data/examples/simple.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'stapfen'
+
+
+class Worker < Stapfen::Worker
+
+  configure do
+    {:hosts => [
+      {
+        :host => 'localhost',
+        :port => 61613,
+        :login => 'guest',
+        :passcode => 'guest',
+        :ssl => false
+      }
+    ]}
+  end
+
+  consume 'jms.queue.test' do |message|
+    puts "received: #{message}"
+  end
+
+  consume 'jms.topic.foo', {:ack => 'client'} do |message|
+    main_thread do
+      client.acknowledge(message)
+    end
+  end
+end
+
+
+Worker.run!

data/lib/stapfen/version.rb

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

data/lib/stapfen/worker.rb

@@ -0,0 +1,103 @@
+require 'stomp'
+
+module Stapfen
+  class Worker
+    class << self
+      attr_accessor :configuration, :consumers
+    end
+
+    def self.run!
+      self.new.run
+    end
+
+    def self.configure
+      unless block_given?
+        raise Stapfen::ConfigurationError
+      end
+      @configuration = yield
+    end
+
+    def self.consume(queue_name, headers={}, &block)
+      unless block_given?
+        raise Stapfen::ConsumeError, "Cannot consume #{queue_name} without a block!"
+      end
+      @consumers ||= []
+      @consumers << [queue_name, headers, block]
+    end
+
+    attr_accessor :client
+
+    def initialize
+      @pool = []
+      @workqueue = Queue.new
+      handle_signals!
+    end
+
+    def main_thread(&block)
+      @workqueue << block
+    end
+
+    def run
+      @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
+        method_name = name.gsub(/[.|\-]/, '_').to_sym
+        self.class.send(:define_method, method_name, &block)
+
+        client.subscribe(name, headers) do |message|
+          @pool << Thread.new do
+            self.send(method_name, message)
+          end
+        end
+      end
+
+      begin
+        # 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.open? do
+          client.join(1)
+
+          until @workqueue.empty?
+            block = @workqueue.pop
+            begin
+              block.call
+            rescue => e
+              puts "Exception! #{e}"
+            end
+          end
+
+          @pool = @pool.select { |t| t.alive? }
+        end
+      rescue Interrupt
+        exit_cleanly
+      end
+    end
+
+    def handle_signals!
+      Signal.trap(:INT) do
+        exit_cleanly
+        exit!
+      end
+      Signal.trap(:TERM) do
+        exit_cleanly
+      end
+    end
+
+    def exit_cleanly
+      unless @pool.empty?
+        puts "Giving #{@pool.size} threads 10s each to finish up"
+        @pool.each do |t|
+          t.join(10)
+        end
+      end
+      unless client.closed?
+        client.close
+      end
+    end
+  end
+end

data/lib/stapfen.rb

@@ -0,0 +1,9 @@
+require 'stapfen/version'
+require 'stapfen/worker'
+
+module Stapfen
+  class ConfigurationError < StandardError
+  end
+  class ConsumeError < StandardError
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '../lib'))
+
+require 'stapfen'

data/spec/worker_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+
+describe Stapfen::Worker do
+  let(:worker) { subject }
+
+  context 'class methods' do
+    subject { described_class }
+    let(:worker) { described_class }
+
+    it { should respond_to :run! }
+    it { should respond_to :configure }
+    it { should respond_to :consume }
+
+    describe '#configure' do
+      it 'should error when not passed a block' do
+        expect {
+          worker.configure
+        }.to raise_error(Stapfen::ConfigurationError)
+      end
+
+      it 'should save the return value from the block' do
+        config = {:valid => true}
+
+        worker.configure do
+          config
+        end
+
+        worker.configuration.should == config
+      end
+    end
+
+
+    describe 'consume' do
+      it 'should raise an error if no block is passed' do
+        expect {
+          worker.consume 'jms.queue.lol'
+        }.to raise_error(Stapfen::ConsumeError)
+      end
+
+      context 'with just a queue name' do
+        let(:name) { 'jms.queue.lol' }
+
+        it 'should add an entry for the queue name' do
+          worker.consume(name)  do
+            nil
+          end
+
+          worker.consumers.should_not be_empty
+          entry = worker.consumers.first
+          entry.first.should eq(name)
+        end
+      end
+    end
+  end
+end

data/stapfen.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stapfen/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stapfen"
+  gem.version       = Stapfen::VERSION
+  gem.authors       = ["R. Tyler Croy"]
+  gem.email         = ["rtyler.croy@lookout.com"]
+  gem.description   = "A simple gem for writing good basic STOMP workers"
+  gem.summary       = "A simple gem for writing good basic STOMP workers"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  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.8')
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: stapfen
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-02 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.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: A simple gem for writing good basic STOMP workers
+email:
+- rtyler.croy@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/simple.rb
+- lib/stapfen.rb
+- lib/stapfen/version.rb
+- lib/stapfen/worker.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb
+- stapfen.gemspec
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -2006440266819501787
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2006440266819501787
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A simple gem for writing good basic STOMP workers
+test_files:
+- spec/spec_helper.rb
+- spec/worker_spec.rb