stapfen 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 19bdf4344cf49d95cee8597de1902b9a814a1b90
-  data.tar.gz: 06ad77a4f72ea1cce8269e92a19ce2cf6872474b
+  metadata.gz: 01629a450316fa2089bd559e2ec2df8bb3b79fe7
+  data.tar.gz: 84ad17b10f341ca81c599e5aadd7d13fce04cb42
 SHA512: 
-  metadata.gz: 09b0dfd450a6e4387250b0d0c4b49734891ea5f07db900b7cdb33412b731352b5cd0a192663b898e383030c2938710f29238716b0b793d181adbed35157155aa
-  data.tar.gz: 79104895c26a380204fe1cddbe0304e255e87d522ada0c1c38fe7dad16457b10d9bec4bdb82cd44b55f21bd21ecc09cba1ec8b8abc2287cf2a23663f23ed10b3
+  metadata.gz: 24f9f0557fa24b518b7b957010c4de14db38c04ad4dd81d7f900ece3e783e577f37d2f8fe3226e9896f2409ed1cb92e7e760b078344308d887049e8cef64a890
+  data.tar.gz: 82ecce67fb2b23c3cb73d47a356de210ef5ebc6f72a03a3fa1108cc1e87e95e47826000965a8c96884fcb5ff2e6db6777acea7dc5dbebf6507a423e40e7dc14a

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
+activemq-all-5.8.0.jar

data/Gemfile

@@ -8,7 +8,8 @@ gem 'stomp', '>= 1.2.14'
 
 group :development do
   gem 'rake'
-  gem 'rspec', '~> 2.11'
+  gem 'rspec'
+  gem 'rspec-its'
   gem 'pry'
   gem 'debugger', :platform => :mri
   gem 'debugger-pry', :platform => :mri

data/README.md

@@ -77,8 +77,8 @@ care when accessing other shared resources.
 
 The consume block accepts the usual subscriptions headers, as well as two
 additional headers `:dead_letter_queue` and `:max_redeliveries`.  If either of
-the latter two is present, the honsumer will unreceive any messages for which
-the block returns `false`; after `:max\_redeliveries`, it will send the message
+the latter two is present, the consumer will unreceive any messages for which
+the block returns `false`; after `:max_redeliveries`, it will send the message
 to `:dead_letter_queue`.  `consume` blocks without these headers will fail
 silently rather than unreceive.
 
@@ -97,3 +97,10 @@ Or install it yourself as:
 
     $ gem install stapfen
 
+## Running Specs
+
+Download this from jar from Maven Central
+  * [activemq-all-5.8.0.jar](http://search.maven.org/#artifactdetails%7Corg.apache.activemq%7Cactivemq-all%7C5.8.0%7Cjar)
+  * Put it in gem root
+  * ```rake spec```
+

data/lib/stapfen/client/kafka.rb

@@ -0,0 +1,76 @@
+begin
+  require 'hermann'
+  require 'hermann/consumer'
+rescue LoadError => e
+  if RUBY_PLATFORM == 'java'
+    raise
+  end
+end
+
+require 'stapfen/destination'
+
+module Stapfen
+  module Client
+    class Kafka
+      attr_reader :connection, :producer
+
+      # Initialize a Kafka client object
+      #
+      # @params [Hash] configuration object
+      # @option configuration [String] :topic The kafka topic
+      # @option configuration [String] :groupId The kafka groupId
+      # @option configuration [String] :zookeepers List of zookeepers
+      #
+      # @raises [ConfigurationError] if required configs are not present
+      def initialize(configuration)
+        super()
+        @config     = configuration
+        @topic      = @config[:topic]
+        @groupId    = @config[:groupId]
+        @zookeepers = @config[:zookeepers]
+        raise ConfigurationError unless @topic && @groupId && @zookeepers
+        @connection = Hermann::Consumer.new(@topic, @groupId, @zookeepers)
+      end
+
+      # This method is not implemenented
+      def connect(*args)
+        # No-op
+      end
+
+      # Cannot unreceive
+      def can_unreceive?
+        false
+      end
+
+      # Closes the consumer threads created by kafka.
+      #
+      # @return [Boolean] True/false depending on whether we actually closed
+      #   the connection
+      def close
+        return false unless @connection
+        @connection.shutdown
+        @connection = nil
+        return true
+      end
+
+      # Subscribes to a destination (i.e. kafka topic) and consumes messages
+      #
+      # @params [Destination] source of messages to consume
+      #
+      # @params [Hash] Not used
+      #
+      # @params [block] block to yield consumed messages
+      def subscribe(destination, headers={}, &block)
+        destination = Stapfen::Destination.from_string(destination)
+        connection.consume(destination.as_kafka, &block)
+      end
+
+      def runloop
+        loop do
+          sleep 1
+        end
+      end
+
+    end
+  end
+end

data/lib/stapfen/destination.rb

@@ -40,6 +40,10 @@ module Stapfen
       end
     end
 
+    def as_kafka
+      return name
+    end
+
     # Create a {Stapfen::Destination} from the given string
     #
     # @param [String] name

data/lib/stapfen/message.rb

@@ -1,14 +1,13 @@
-
 module Stapfen
   class Message
     attr_reader :message_id, :body, :original, :destination
 
     def initialize(opts={})
       super()
-      @body = opts[:body]
+      @body        = opts[:body]
       @destination = opts[:destination]
-      @message_id = opts[:message_id]
-      @original = opts[:original]
+      @message_id  = opts[:message_id]
+      @original    = opts[:original]
     end
 
     # Create an instance of {Stapfen::Message} from the passed in
@@ -42,5 +41,18 @@ module Stapfen
                       :message_id => message.jms_message_id,
                       :original => message)
     end
+
+    # Create an instance of {Stapfen::Message} from the passed in
+    # +String+ which a Kafka consumer should receive
+    #
+    # @param [String] message
+    # @return [Stapfen::Message] A Stapfen wrapper object
+    def self.from_kafka(message)
+      unless message.kind_of? String
+        raise Stapfen::InvalidMessageError, message.inspect
+      end
+
+      return self.new(:body => message)
+    end
   end
 end

data/lib/stapfen/version.rb

@@ -1,3 +1,3 @@
 module Stapfen
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/lib/stapfen/worker.rb

@@ -47,12 +47,12 @@ module Stapfen
         raise
       end
 
-      @use_stomp = true
+      @protocol = 'stomp'
       return true
     end
 
     def self.stomp?
-      @use_stomp.nil? || @use_stomp
+      @protocol.nil? || @protocol == 'stomp'
     end
 
     # Force the worker to use JMS as the messaging protocol.
@@ -73,12 +73,38 @@ module Stapfen
         raise
       end
 
-      @use_stomp = false
+      @protocol = 'jms'
       return true
     end
 
     def self.jms?
-      !(stomp?)
+      @protocol == 'jms'
+    end
+
+    # Force the worker to use Kafka as the messaging protocol.
+    #
+    # *Note:* Only works under JRuby
+    #
+    # @return [Boolean]
+    def self.use_kafka!
+      unless RUBY_PLATFORM == 'java'
+        raise Stapfen::ConfigurationError, "You cannot use Kafka unless you're running under JRuby!"
+      end
+
+      begin
+        require 'java'
+        require 'hermann'
+      rescue LoadError
+        puts "You need the `hermann` gem to be installed to use Kafka!"
+        raise
+      end
+
+      @protocol = 'kafka'
+      return true
+    end
+
+    def self.kafka?
+      @protocol == 'kafka'
     end
 
     # Optional method, should be passed a block which will yield a {{Logger}}
@@ -164,6 +190,9 @@ module Stapfen
       elsif self.class.jms?
         require 'stapfen/client/jms'
         @client = Stapfen::Client::JMS.new(self.class.configuration.call)
+      elsif self.class.kafka?
+        require 'stapfen/client/kafka'
+        @client = Stapfen::Client::Kafka.new(self.class.configuration.call)
       end
 
       debug("Running with #{@client} inside of Thread:#{Thread.current.inspect}")
@@ -192,6 +221,10 @@ module Stapfen
             message = Stapfen::Message.from_jms(m)
           end
 
+          if self.class.kafka?
+            message = Stapfen::Message.from_kafka(m)
+          end
+
           success = self.send(method_name, message)
 
           unless success

data/lib/stapfen.rb

@@ -11,7 +11,6 @@ rescue LoadError
   # Can't process JMS
 end
 
-
 require 'stapfen/version'
 require 'stapfen/client'
 require 'stapfen/worker'

data/spec/client/jms_spec.rb

@@ -12,7 +12,7 @@ if RUBY_PLATFORM == 'java'
     describe '#can_unreceive?' do
       subject { client.can_unreceive? }
 
-      it { should be_true }
+      it { should be true }
     end
 
     describe '#unreceive' do
@@ -158,11 +158,11 @@ if RUBY_PLATFORM == 'java'
           client.stub(:connection).and_return(double('JMS::Connection'))
         end
 
-        it { should be_false }
+        it { should be false }
       end
 
       context 'without a connection' do
-        it { should be_true }
+        it { should be true }
       end
     end
 
@@ -177,7 +177,7 @@ if RUBY_PLATFORM == 'java'
       context 'without an existing session' do
         it 'should close the client' do
           connection.should_receive(:close)
-          expect(result).to be_true
+          expect(result).to be true
         end
       end
 
@@ -191,7 +191,7 @@ if RUBY_PLATFORM == 'java'
         it 'should close the client and session' do
           session.should_receive(:close)
           connection.should_receive(:close)
-          expect(result).to be_true
+          expect(result).to be true
         end
       end
     end

data/spec/client/kafka_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+require 'stapfen/client/kafka'
+
+describe Stapfen::Client::Kafka, :java => true do
+  let(:config)   { { :topic => 'test', :groupId => 'groupId', :zookeepers => 'foo' } }
+  let(:consumer) { double('Hermann::Consumer') }
+
+  subject(:client) { described_class.new(config) }
+
+  before do
+    allow(Hermann::Consumer).to receive(:new) { consumer }
+  end
+
+  it { should respond_to :connect }
+
+  describe '#can_unreceive?' do
+    subject { client.can_unreceive? }
+    it { should be false }
+  end
+
+  describe '#close' do
+    subject(:result) { client.close }
+
+    context 'with a connection' do
+      it 'should close the client' do
+        allow(consumer).to receive(:shutdown)
+        expect(result).to be true
+      end
+    end
+    context 'without a connection' do
+      it 'returns false' do
+        expect(Hermann::Consumer).to receive(:new) { nil }
+        expect(consumer).to_not receive(:shutdown)
+        expect(result).to be false
+      end
+    end
+  end
+
+  describe '#subscribe' do
+    let(:topic) { 'topic' }
+    let(:destination) { double('Destination') }
+    let(:msg) { 'foo' }
+    it 'yields to the block and passes in consumed message' do
+      allow(destination).to receive(:as_kafka) { topic }
+      allow(Stapfen::Destination).to receive(:from_string) { destination }
+      allow(consumer).to receive(:consume).with(topic).and_yield(msg)
+
+      expect{ |b|
+        client.subscribe(destination, nil, &b)
+      }.to yield_with_args(msg)
+    end
+  end
+end

data/spec/destination_spec.rb

@@ -5,6 +5,19 @@ describe Stapfen::Destination do
   it { should respond_to :name }
   it { should respond_to :type }
 
+  describe '#as_kafka' do
+    let(:name) { 'topic' }
+    subject(:destination) do
+      d = described_class.new
+      d.type = :topic
+      d.name = name
+      d.as_kafka
+    end
+
+    it { should be_instance_of String }
+    it { should eql "topic" }
+  end
+
   describe '#as_jms' do
     let(:name) { 'rspec/dlq' }
     subject(:destination) do

data/spec/logger_spec.rb

@@ -21,7 +21,7 @@ describe Stapfen::Logger do
       end
 
       it 'should discard info messages' do
-        expect(logger.info('rspec')).to be_false
+        expect(logger.info('rspec')).to be false
       end
     end
 
@@ -34,8 +34,7 @@ describe Stapfen::Logger do
 
       it 'should pass info messages along' do
         plogger.should_receive(:info)
-
-        expect(logger.info('rspec')).to be_true
+        expect(logger.info('rspec')).to be true
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '../lib'))
 
 require 'stapfen'
-
+require 'rspec/its'
 
 is_java = (RUBY_PLATFORM == 'java')
 
@@ -12,6 +12,9 @@ end
 
 
 RSpec.configure do |c|
+  c.color = true
+  c.order = "random"
+
   unless is_java
     c.filter_run_excluding :java => true
   end

data/spec/worker_spec.rb

@@ -17,7 +17,7 @@ describe Stapfen::Worker do
       subject(:result) { worker.use_stomp! }
 
       it 'should update the instance variable' do
-        expect(result).to be_true
+        expect(result).to be true
         expect(worker).to be_stomp
         expect(worker).not_to be_jms
       end
@@ -32,7 +32,7 @@ describe Stapfen::Worker do
       end
 
       it 'should update the instance variable' do
-        expect(result).to be_true
+        expect(result).to be true
         expect(worker).to be_jms
         expect(worker).not_to be_stomp
       end
@@ -55,6 +55,7 @@ describe Stapfen::Worker do
     end
 
     describe '#configure' do
+      let(:config) { {:valid => true} }
       it 'should error when not passed a block' do
         expect {
           worker.configure
@@ -62,21 +63,26 @@ describe Stapfen::Worker do
       end
 
       it 'should save the return value from the block' do
-        config = {:valid => true}
-
         worker.configure do
           config
         end
-
         expect(worker.configuration.call).to eql(config)
       end
     end
 
-    describe '#exit_cleanly' do
+    describe '#exit_cleanly', :java => true do
       subject(:result) { worker.exit_cleanly }
 
+      before do
+        allow(Java::JavaLang::System).to receive(:exit).with(0)
+      end
+
+      after do
+        worker.class_variable_set(:@@workers, [])
+      end
+
       context 'with no worker classes' do
-        it { should be_false }
+        it { should be false }
       end
 
       context 'with a single worker class' do
@@ -88,12 +94,12 @@ describe Stapfen::Worker do
 
         it "should execute the worker's #exit_cleanly method" do
           w.should_receive(:exit_cleanly)
-          expect(result).to be_true
+          expect(result).to be true
         end
 
         it "should return false if the worker's #exit_cleanly method" do
           w.should_receive(:exit_cleanly).and_raise(StandardError)
-          expect(result).to be_false
+          expect(result).to be false
         end
       end
 
@@ -101,14 +107,14 @@ describe Stapfen::Worker do
         let(:w1) { double('Fake Worker 1') }
         let(:w2) { double('Fake Worker 2') }
 
-        before :each do
+        before do
           worker.class_variable_set(:@@workers, [w1, w2])
         end
 
         it 'should invoke both #exit_cleanly methods' do
-          w1.should_receive(:exit_cleanly)
-          w2.should_receive(:exit_cleanly)
-          expect(result).to be_true
+          expect(w1).to receive(:exit_cleanly)
+          expect(w2).to receive(:exit_cleanly)
+          expect(worker.exit_cleanly).to be true
         end
       end
     end
@@ -125,6 +131,10 @@ describe Stapfen::Worker do
       context 'with just a queue name' do
         let(:name) { 'jms.queue.lol' }
 
+        before do
+          worker.instance_variable_set(:@consumers, [])
+        end
+
         it 'should add an entry for the queue name' do
           worker.consume(name) do |msg|
             nil
@@ -163,6 +173,16 @@ describe Stapfen::Worker do
           client.stub(:subscribe) do |name, headers, &block|
             block.call(message)
           end
+
+          config = {:valid => true}
+
+          worker.configure do
+            config
+          end
+        end
+
+        after do
+          worker.class_variable_set(:@@workers, [])
         end
 
         context 'with just a queue name' do
@@ -189,6 +209,7 @@ describe Stapfen::Worker do
             { :dead_letter_queue => '/queue/foo',
             :max_redeliveries => 3 }
           end
+
           let(:raw_headers) { unrec_headers.merge(:other_header => 'foo!') }
           context 'on a failed message' do
             it 'should unreceive' do

data/stapfen.gemspec

@@ -3,17 +3,22 @@ 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::Specification.new do |s|
+  s.name          = "stapfen"
+  s.version       = Stapfen::VERSION
+  s.authors       = ["R. Tyler Croy"]
+  s.email         = ["rtyler.croy@lookout.com"]
+  s.description   = "A simple gem for writing good basic STOMP workers"
+  s.summary       = "A simple gem for writing good basic STOMP workers"
+  s.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"]
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  if RUBY_PLATFORM == "java"
+    s.add_dependency 'hermann', "~> 0.20.0"
+    s.platform = 'java'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stapfen
 version: !ruby/object:Gem::Version 
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors: 
 - R. Tyler Croy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-28 00:00:00 Z
+date: 2014-11-03 00:00:00 Z
 dependencies: []
 
 description: A simple gem for writing good basic STOMP workers
@@ -32,6 +32,7 @@ files:
 - lib/stapfen.rb
 - lib/stapfen/client.rb
 - lib/stapfen/client/jms.rb
+- lib/stapfen/client/kafka.rb
 - lib/stapfen/client/stomp.rb
 - lib/stapfen/destination.rb
 - lib/stapfen/logger.rb
@@ -39,6 +40,7 @@ files:
 - lib/stapfen/version.rb
 - lib/stapfen/worker.rb
 - spec/client/jms_spec.rb
+- spec/client/kafka_spec.rb
 - spec/client/stomp_spec.rb
 - spec/client_spec.rb
 - spec/destination_spec.rb
@@ -69,12 +71,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A simple gem for writing good basic STOMP workers
 test_files: 
 - spec/client/jms_spec.rb
+- spec/client/kafka_spec.rb
 - spec/client/stomp_spec.rb
 - spec/client_spec.rb
 - spec/destination_spec.rb