klomp 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gem "onstomp"
+gem "json"
+
+group :development do
+  gem "foreman"
+  gem "rake"
+  gem "ZenTest"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.8.0)
+    foreman (0.46.0)
+      thor (>= 0.13.6)
+    json (1.7.1)
+    onstomp (1.0.6)
+    rake (0.9.2.2)
+    thor (0.15.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  foreman
+  json
+  onstomp
+  rake

data/Procfile

@@ -0,0 +1,2 @@
+apollo_primary: /usr/local/var/apollo-primary/bin/apollo-broker run
+apollo_secondary: /usr/local/var/apollo-secondary/bin/apollo-broker run

data/README.md

@@ -0,0 +1,87 @@
+# Klomp
+
+Klomp is a simple wrapper around the [OnStomp](https://github.com/meadvillerb/onstomp/)
+library with some additional HA and usability features:
+
+* When initialized with multiple broker URIs, Klomp will publish messages to
+one broker at a time, but will consume from all brokers simultaneously. This is
+a slight improvement over the regular [OnStomp::Failover::Client](http://mdvlrb.com/onstomp/OnStomp/Failover/Client.html)
+which handles all publishing and subscribing through a single "active" broker.
+This traditional one-broker-at-a-time technique can lead to a split-brain
+scenario in which messages are only received by a subset of your STOMP clients.
+By consuming from all brokers simultaneously, Klomp ensures that no message is
+left behind.
+
+* Where applicable, message bodies are automatically translated between native
+Ruby and JSON objects.
+
+* If a reply-to header is found in a message, a response is automatically
+sent to the reply-to destination.
+
+## Installation
+
+    gem install klomp
+
+## Example usage
+
+The goal is that you should be able to use most (if not all) of the standard
+OnStomp API (see [OnStomp's UserNarrative](https://github.com/meadvillerb/onstomp/blob/master/extra_doc/UserNarrative.md))
+via a `Klomp::Client`:
+
+    client = Klomp::Client.new([ ... ])
+
+However, there will be some differences in the API due to how `Klomp::Client`
+manages connections. For example, while the `connected?` method normally
+returns a boolean value, Klomp's `connected?` will return an array of booleans
+(i.e. one result for each broker).
+
+## Developers
+
+Set up the environment using `bundle install`. Note that the tests currently
+assume a specific Apollo configuration which can be created on OSX using the
+following commands:
+
+    brew install apollo
+    apollo create /usr/local/var/apollo-primary
+    apollo create /usr/local/var/apollo-secondary
+    sed -i -e 's/616/626/' /usr/local/var/apollo-secondary/etc/apollo.xml
+
+Once Apollo is configured, the brokers can be started via `foreman start`. Now
+you can run the test suite via `rake test` or `autotest`.
+
+In addition to the regular test suite, there is a rake task called
+"test_failover" that will start an infinite publish/subscribe loop. Once this
+task is running, you can randomly kill Apollo brokers to test STOMP client
+failover.
+
+## Change Log
+
+### 0.0.1
+
+* Initial release
+
+## License
+
+Copyright (C) 2012 LivingSocial
+
+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.
+
+## Credits
+
+* [Michael Paul Thomas Conigliaro](http://conigliaro.org): Original author

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+Rake::TestTask.new
+task :default => :test

data/klomp.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+require 'klomp'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["LivingSocial"]
+  gem.email         = ["dev.happiness@livingsocial.com"]
+  gem.description   = "A simple wrapper around the OnStomp library with additional features"
+  gem.summary       = "A simple wrapper around the OnStomp library with additional features"
+  gem.homepage      = "https://github.com/livingsocial/klomp"
+
+  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.name          = "klomp"
+  gem.require_paths = ["lib"]
+  gem.version       = Klomp::VERSION
+
+  gem.add_dependency("onstomp")
+  gem.add_dependency("json")
+end

data/lib/klomp.rb

@@ -0,0 +1,9 @@
+require 'onstomp'
+require 'onstomp/failover'
+require 'json'
+
+require 'klomp/client'
+
+module Klomp
+  VERSION = '0.0.1'
+end

data/lib/klomp/client.rb

@@ -0,0 +1,88 @@
+module Klomp
+
+  class Client
+    attr_reader :options, :read_conn, :write_conn
+
+    def initialize(uri, options={})
+      @options ||= {
+        :translate_json => true,
+        :auto_reply_to  => true
+      }
+
+      ofc_options = options.inject({
+        :retry_attempts => -1,
+        :retry_delay    => 1
+      }) { |memo,(k,v)| memo.merge({k => v}) if memo.has_key?(k) }
+
+      if uri.is_a?(Array)
+        @write_conn = OnStomp::Failover::Client.new(uri, ofc_options)
+        @read_conn = uri.inject([]) { |memo,obj| memo + [OnStomp::Failover::Client.new([obj], ofc_options)] }
+      else
+        @write_conn = OnStomp::Failover::Client.new([uri], ofc_options)
+        @read_conn = [@write_conn]
+      end
+    end
+
+    def send(*args, &block)
+      if @options[:translate_json] && [Array, Hash].any? { |type| args[1].kind_of?(type) }
+        args[1] = args[1].to_json
+        args[2] = {} if args[2].nil?
+        args[2][:'content-type'] = 'application/json'
+      else
+        args[1] = args[1].to_s
+      end
+      @write_conn.send(*args, &block)
+    end
+
+    def subscribe(*args, &block)
+      frames = []
+      @read_conn.each do |c|
+        frames << c.subscribe(*args) do |msg|
+          if @options[:translate_json]
+            msg.body = begin
+              JSON.parse(msg.body)
+            rescue JSON::ParserError
+              msg.body
+            end
+          end
+          reply_args = yield msg
+          if @options[:auto_reply_to] && !msg.headers[:'reply-to'].nil?
+            if reply_args.is_a?(Array)
+              send(msg.headers[:'reply-to'], *reply_args)
+            else
+              send(msg.headers[:'reply-to'], reply_args)
+            end
+          end
+        end
+      end
+      frames
+    end
+
+    def method_missing(method, *args, &block)
+      write_only_methods = [
+        :abort,
+        :begin,
+        :commit,
+      ]
+      read_only_methods = [
+        :ack,
+        :nack,
+        :unsubscribe
+      ]
+      returns = {
+        :connect => self
+      }
+
+      result = if write_only_methods.include?(method)
+        @write_conn.send(method, *args, &block)
+      elsif read_only_methods.include?(method)
+        @read_conn.map { |c| c.__send__(method, *args, &block) }
+      else
+        ([@write_conn] + @read_conn).uniq.map { |c| c.__send__(method, *args) }
+      end
+      returns.include?(method) ? returns[method] : result
+    end
+
+  end
+
+end

data/tasks/test_failover.rake

@@ -0,0 +1,35 @@
+desc "Start an infinite publish/subscribe loop to test STOMP client failover"
+task :test_failover do
+  require 'klomp'
+
+  # Set the delay between publish events. If this is too small, the consumer
+  # will never be able to catch up to the producer, giving the false impression
+  # of lost messages.
+  publish_interval = 0.01
+
+  client = Klomp::Client.new([
+    'stomp://admin:password@localhost:61613',
+    'stomp://admin:password@127.0.0.1:62613'
+  ]).connect
+
+  last_i = nil
+  client.subscribe("/queue/test") do |msg|
+    print "-"
+    last_i = msg.body.to_i
+  end
+
+  begin
+    i = 0
+    loop do
+      i += 1
+      client.send("/queue/test", i.to_s) do |r|
+        print "+"
+      end
+      sleep publish_interval
+    end
+  rescue SignalException
+    client.disconnect
+    puts
+    puts "Sent #{i}; Received #{last_i}; Lost #{i - last_i}"
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,91 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'klomp'
+
+describe Klomp::Client do
+
+  before do
+    @uris = [
+      'stomp://admin:password@localhost:61613',
+      'stomp://admin:password@127.0.0.1:62613'
+    ]
+    @destination = '/queue/test_component.test_event'
+  end
+
+  it 'accepts a single uri and establishes separate failover connections for writes and reads' do
+    client = Klomp::Client.new(@uris.first).connect
+
+    assert_equal [client.write_conn], client.read_conn
+    assert client.write_conn.connected?
+
+    client.disconnect
+  end
+
+  it 'accepts an array of uris and establishes separate failover connections for writes and reads' do
+    client = Klomp::Client.new(@uris).connect
+
+    assert client.write_conn.connected?
+    refute_empty client.read_conn
+    client.read_conn.each do |obj|
+      assert obj.connected?
+    end
+
+    client.disconnect
+  end
+
+  it 'disconnnects' do
+    client = Klomp::Client.new(@uris.first).connect
+    assert client.write_conn.connected?
+    client.disconnect
+    refute client.write_conn.connected?
+  end
+
+  it 'sends heartbeat' do
+    client = Klomp::Client.new(@uris).connect.beat
+  end
+
+  it 'sends requests and gets responses' do
+    client = Klomp::Client.new(@uris).connect
+    body  = { 'body' => rand(36**128).to_s(36) }
+
+    client.send(@destination, body, :ack=>'client')
+
+    got_message = false
+    client.subscribe(@destination) do |msg|
+      got_message = true if msg.body == body
+      client.ack(msg)
+    end
+    sleep 1
+    assert got_message
+
+    client.disconnect
+  end
+
+  it 'automatically publishes responses to the reply-to destination' do
+    client        = Klomp::Client.new(@uris).connect
+    reply_to_body = { 'reply_to_body' => rand(36**128).to_s(36) }
+
+    client.send(@destination, nil, { 'reply-to' => @destination })
+
+    got_message = false
+    client.subscribe(@destination) do |msg|
+      got_message = true if msg.body == reply_to_body
+      reply_to_body
+    end
+    sleep 1
+    assert got_message
+
+    client.disconnect
+  end
+
+  it 'unsubscribes' do
+    client = Klomp::Client.new(@uris).connect
+
+    subscribe_frames = client.subscribe(@destination) { |msg| }
+    client.unsubscribe(subscribe_frames)
+
+    client.disconnect
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: klomp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- LivingSocial
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: onstomp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple wrapper around the OnStomp library with additional features
+email:
+- dev.happiness@livingsocial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Procfile
+- README.md
+- Rakefile
+- klomp.gemspec
+- lib/klomp.rb
+- lib/klomp/client.rb
+- tasks/test_failover.rake
+- test/test_client.rb
+homepage: https://github.com/livingsocial/klomp
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple wrapper around the OnStomp library with additional features
+test_files:
+- test/test_client.rb
+has_rdoc: