klomp 0.0.1 → 0.0.2

data/ChangeLog.md

@@ -0,0 +1,15 @@
+Changes
+--------------------------------------------------------------------------------
+
+0.0.2 (2012/06/15)
+================================================================================
+
+- Add `:logger` option to log sending and receiving of messages
+- Duck-type with `#to_json` for `:translate_json` option
+- Clean up options parsing, pass all options through to OnStomp client config
+- Clamp onstomp gem dependency version to 1.0.x
+
+0.0.1 (2012/06/08)
+================================================================================
+
+- Initial release

data/README.md

@@ -16,7 +16,8 @@ left behind.
 Ruby and JSON objects.
 
 * If a reply-to header is found in a message, a response is automatically
-sent to the reply-to destination.
+sent to the reply-to destination. The response will be the return value of the
+subscribe block.
 
 ## Installation
 
@@ -35,6 +36,31 @@ 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).
 
+### Additional options for Klomp::Client
+
+<table>
+  <tr>
+    <th>Key</th>
+    <th>Default value</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>:translate_json</td>
+    <td>true</td>
+    <td>Translate message bodies between native Ruby and JSON objects?</td>
+  </tr>
+  <tr>
+    <td>:auto_reply_to</td>
+    <td>true</td>
+    <td>Automatically send response to reply-to destination?</td>
+  </tr>
+  <tr>
+    <td>:logger</td>
+    <td>false</td>
+    <td>Logger object</td>
+  </tr>
+</table>
+
 ## Developers
 
 Set up the environment using `bundle install`. Note that the tests currently

data/klomp.gemspec

@@ -15,6 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Klomp::VERSION
 
-  gem.add_dependency("onstomp")
+  gem.add_dependency("onstomp", "~> 1.0.7")
   gem.add_dependency("json")
 end

data/lib/klomp.rb

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

data/lib/klomp/client.rb

@@ -1,44 +1,53 @@
+require 'onstomp'
+require 'onstomp/failover'
+require 'json'
+require 'logger'
+
 module Klomp
 
   class Client
-    attr_reader :options, :read_conn, :write_conn
+    attr_reader :read_conn, :write_conn
 
     def initialize(uri, options={})
-      @options ||= {
-        :translate_json => true,
-        :auto_reply_to  => true
-      }
+      @translate_json = options.fetch(:translate_json, true)
+      @auto_reply_to  = options.fetch(:auto_reply_to, true)
+      @logger         = options.fetch(:logger, nil)
 
-      ofc_options = options.inject({
-        :retry_attempts => -1,
-        :retry_delay    => 1
-      }) { |memo,(k,v)| memo.merge({k => v}) if memo.has_key?(k) }
+      # defaults for retry delay and attempts
+      options[:retry_delay]    ||= 2
+      options[:retry_attempts] ||= 10
 
       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)] }
+        @write_conn = OnStomp::Failover::Client.new(uri, options)
+        @read_conn = uri.map {|obj| OnStomp::Failover::Client.new([obj], options) }
       else
-        @write_conn = OnStomp::Failover::Client.new([uri], ofc_options)
+        @write_conn = OnStomp::Failover::Client.new([uri], options)
         @read_conn = [@write_conn]
       end
+      @all_conn = ([@write_conn] + @read_conn).uniq
+      configure_connections
     end
 
     def send(*args, &block)
-      if @options[:translate_json] && [Array, Hash].any? { |type| args[1].kind_of?(type) }
+      if @translate_json && args[1].respond_to?(:to_json)
         args[1] = args[1].to_json
-        args[2] = {} if args[2].nil?
+        args[2] ||= {}
         args[2][:'content-type'] = 'application/json'
       else
         args[1] = args[1].to_s
       end
+      log.info("[Sending] Destination=#{args[0]} Body=#{args[1]} Headers=#{args[2]}") if log
       @write_conn.send(*args, &block)
     end
+    alias puts send
+    alias publish send
 
     def subscribe(*args, &block)
       frames = []
       @read_conn.each do |c|
         frames << c.subscribe(*args) do |msg|
-          if @options[:translate_json]
+          log.info("[Received] Body=#{msg.body} Headers=#{msg.headers.to_hash.sort}") if log
+          if @translate_json
             msg.body = begin
               JSON.parse(msg.body)
             rescue JSON::ParserError
@@ -46,7 +55,7 @@ module Klomp
             end
           end
           reply_args = yield msg
-          if @options[:auto_reply_to] && !msg.headers[:'reply-to'].nil?
+          if @auto_reply_to && !msg.headers[:'reply-to'].nil?
             if reply_args.is_a?(Array)
               send(msg.headers[:'reply-to'], *reply_args)
             else
@@ -58,31 +67,44 @@ module Klomp
       frames
     end
 
-    def method_missing(method, *args, &block)
-      write_only_methods = [
-        :abort,
-        :begin,
-        :commit,
-      ]
-      read_only_methods = [
-        :ack,
-        :nack,
-        :unsubscribe
-      ]
-      returns = {
-        :connect => self
-      }
+    def log
+      @logger
+    end
+
+    WRITE_ONLY_METHODS = [
+      :abort,
+      :begin,
+      :commit,
+    ]
+
+    READ_ONLY_METHODS = [
+      :ack,
+      :nack,
+      :unsubscribe,
+    ]
 
-      result = if write_only_methods.include?(method)
+    def method_missing(method, *args, &block)
+      case method
+      when *WRITE_ONLY_METHODS
         @write_conn.send(method, *args, &block)
-      elsif read_only_methods.include?(method)
-        @read_conn.map { |c| c.__send__(method, *args, &block) }
+      when *READ_ONLY_METHODS
+        @read_conn.map {|c| c.__send__(method, *args, &block) }
+      when :connect
+        @all_conn.each {|c| c.connect}
+        self
       else
-        ([@write_conn] + @read_conn).uniq.map { |c| c.__send__(method, *args) }
+        @all_conn.map {|c| c.__send__(method, *args) }
       end
-      returns.include?(method) ? returns[method] : result
     end
 
+    private
+    def configure_connections
+      @all_conn.each do |c|
+        c.on_failover_connect_failure do
+          raise if OnStomp::FatalConnectionError === $!
+        end
+      end
+    end
   end
 
 end

data/test/test_client.rb

@@ -34,6 +34,12 @@ describe Klomp::Client do
     client.disconnect
   end
 
+  it 'raises an error if authentication fails' do
+    assert_raises OnStomp::ConnectFailedError do
+      Klomp::Client.new(@uris.first.sub('password', 'psswrd')).connect
+    end
+  end
+
   it 'disconnnects' do
     client = Klomp::Client.new(@uris.first).connect
     assert client.write_conn.connected?
@@ -41,6 +47,15 @@ describe Klomp::Client do
     refute client.write_conn.connected?
   end
 
+  it 'has a logger' do
+    logger = Logger.new(STDOUT)
+    client = Klomp::Client.new(@uris, :logger=>logger).connect
+
+    assert_equal client.log, logger
+
+    client.disconnect
+  end
+
   it 'sends heartbeat' do
     client = Klomp::Client.new(@uris).connect.beat
   end
@@ -66,7 +81,7 @@ describe Klomp::Client 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 })
+    client.puts(@destination, nil, { 'reply-to' => @destination })
 
     got_message = false
     client.subscribe(@destination) do |msg|
@@ -88,4 +103,9 @@ describe Klomp::Client do
     client.disconnect
   end
 
+  it 'sends all unknown options through to OnStomp' do
+    client = Klomp::Client.new(@uris.first, :haz_cheezburgers => true, :retry_attempts => 42).connect
+    assert client.write_conn.connected?
+    assert_equal 42, client.write_conn.retry_attempts
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klomp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-06-15 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'
+        version: 1.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- ChangeLog.md
 - Gemfile
 - Gemfile.lock
 - Procfile
@@ -81,10 +82,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: A simple wrapper around the OnStomp library with additional features
 test_files:
 - test/test_client.rb
-has_rdoc: