klomp 1.0.1 → 1.0.2

data/ChangeLog.md

@@ -1,6 +1,14 @@
 Klomp Changes
 --------------------------------------------------------------------------------
 
+1.0.2 (2012/10/10)
+================================================================================
+
+- Frames now respond to `#[]` and `#[]=` (for header access) and `#body=` (for
+  setting body after construction)
+- Configurable foreground IO.select timeout through `options['select_timeout']`
+- Add logging of read frames and exceptions when going offline
+
 1.0.1 (2012/10/5)
 ================================================================================
 

data/klomp.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "klomp"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Sieger"]
-  s.date = "2012-10-03"
+  s.date = "2012-10-10"
   s.description = "Klomp is a simple [Stomp] messaging client that keeps your sanity intact.\n\nThe purpose of Klomp is to be the simplest possible Stomp client. No in-memory\nbuffering of outgoing messages, no fanout subscriptions in-process, no\ntransactions, no complicated messaging patterns. Code simple enough so that when\nsomething goes wrong, the problem is obvious.\n\n[Stomp]: http://stomp.github.com/"
   s.email = ["nick.sieger@livingsocial.com"]
   s.extra_rdoc_files = ["Manifest.txt"]

data/lib/klomp.rb

@@ -1,5 +1,5 @@
 class Klomp
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 
   class Error < StandardError; end
 

data/lib/klomp/connection.rb

@@ -28,6 +28,7 @@ class Klomp
       @options['host']   ||= host
       @subscriptions = {}
       @logger = options['logger']
+      @select_timeout = options['select_timeout'] || 0.1
       connect
     end
 
@@ -82,7 +83,7 @@ class Klomp
       @socket  = TCPSocket.new *options['server']
       @socket.set_encoding 'UTF-8'
       write Frames::Connect.new(options)
-      frame = read Frames::Connected, 0.1
+      frame = read Frames::Connected, @select_timeout
       log_frame frame if logger
       raise Error, frame.headers['message'] if frame.error?
     end
@@ -91,7 +92,7 @@ class Klomp
       raise Error, "connection closed" if closed?
       raise Error, "disconnected"      unless connected?
 
-      rs, ws, = IO.select(nil, [@socket], nil, 0.1)
+      rs, ws, = IO.select(nil, [@socket], nil, @select_timeout)
       raise Error, "connection unavailable for write" unless ws && !ws.empty?
 
       @socket.write frame.to_s
@@ -99,19 +100,19 @@ class Klomp
       frame
     rescue Error
       raise
-    rescue
-      go_offline
+    rescue => e
+      go_offline e
       raise
     end
 
     def read(type, timeout = nil)
       rs, = IO.select([@socket], nil, nil, timeout)
       raise Error, "connection unavailable for read" unless rs && !rs.empty?
-      type.new @socket.gets(FRAME_SEP)
+      type.new(@socket.gets(FRAME_SEP)).tap {|frame| log_frame frame if logger }
     rescue Error
       raise
-    rescue
-      go_offline
+    rescue => e
+      go_offline e
       raise
     end
 
@@ -122,8 +123,8 @@ class Klomp
       logger.debug "frame=#{frame.name} #{frame.headers.map{|k,v| k + '=' + v }.join(' ')} body=#{body}"
     end
 
-    def log_exception(ex, level = :error)
-      logger.send level, "exception=#{ex.class.name} message=#{ex.message.inspect} backtrace[0]=#{ex.backtrace[0]} backtrace[1]=#{ex.backtrace[1]}"
+    def log_exception(ex, level = :error, msg_start = '')
+      logger.send level, "#{msg_start}exception=#{ex.class.name} message=#{ex.message.inspect} backtrace[0]=#{ex.backtrace[0]} backtrace[1]=#{ex.backtrace[1]}"
       logger.debug "exception=#{ex.class.name} full_backtrace=" + ex.backtrace.join("\n")
     end
 
@@ -131,12 +132,8 @@ class Klomp
       @closing = true
     end
 
-    def go_offline
-      if logger
-        msg = "offline server=#{options['server'].join(':')}"
-        msg << " exception=#{$!.class.name} message=#{$!.message.inspect}" if $!
-        logger.warn msg
-      end
+    def go_offline(ex)
+      log_exception(ex, :warn, "offline server=#{options['server'].join(':')} ") if logger
       @socket.close rescue nil
       @socket = nil
       Sentinel.new(self)

data/lib/klomp/frames.rb

@@ -3,17 +3,14 @@ class Klomp
 
   module Frames
     class Frame
-      def name
-        @name ||= self.class.name.split('::').last.upcase
-      end
+      def name; @name ||= self.class.name.split('::').last.upcase; end
 
-      def headers
-        @headers ||= {}
-      end
+      def headers;         @headers ||= {};       end
+      def [](key);          headers[key];         end
+      def []=(key, value);  headers[key] = value; end
 
-      def body
-        @body ||= ""
-      end
+      def body; @body ||= ""; end
+      def body=(b); @body = b; end
 
       def to_s
         "#{name}\n#{dump_headers}\n#{@body}#{FRAME_SEP}"

data/spec/klomp/frames_spec.rb

@@ -2,9 +2,10 @@ require 'spec_helper'
 
 describe Klomp::Frames do
 
+  Given(:options) { {'login' => 'admin', 'passcode' => 'password', 'host' => '127.0.0.1'} }
+
   context "CONNECT" do
 
-    Given(:options) { {'login' => 'admin', 'passcode' => 'password', 'host' => '127.0.0.1'} }
 
     When(:connect) { Klomp::Frames::Connect.new(options).to_s }
 
@@ -20,4 +21,28 @@ describe Klomp::Frames do
 
   end
 
+  context "#[] is an alias for #headers" do
+
+    When(:connect) { Klomp::Frames::Connect.new(options) }
+
+    When { connect['my-header'] = 'my-value' }
+
+    Then { connect['login'].should == 'admin' }
+
+    Then { connect['passcode'].should == 'password' }
+
+    Then { connect['my-header'].should == 'my-value' }
+
+  end
+
+  context "body can be assigned after construction" do
+
+    Given(:send_frame) { Klomp::Frames::Send.new("/queue/q", "", {}) }
+
+    When { send_frame.body = "hello" }
+
+    Then { send_frame.body.should == "hello" }
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klomp
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -224,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2110109472818919447
+      hash: 4534787410900240650
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: