klomp 1.0.7 → 1.0.8

data/ChangeLog.md

@@ -1,6 +1,11 @@
 Klomp Changes
 --------------------------------------------------------------------------------
 
+1.0.8 (2013/04/16)
+================================================================================
+- Allow headers to be passed to subscribe and unsubscribe.
+
+
 1.0.7 (2013/02/04)
 ================================================================================
 

data/Manifest.txt

@@ -12,6 +12,7 @@ lib/klomp.rb
 lib/klomp/connection.rb
 lib/klomp/frames.rb
 lib/klomp/sentinel.rb
+lib/klomp/subscription.rb
 spec/acceptance/acceptance_spec.rb
 spec/acceptance/reconnect_spec.rb
 spec/frames/auth_error.txt

data/README.md

@@ -38,6 +38,10 @@ end
 klomp.subscribe("/queue/klomp", Klompen.new)
 klomp.unsubscribe("/queue/klomp")
 
+# subscribe with custom headers
+klomp.subscribe("/queue/klomp", Klompen.new, :persistent => :true)
+klomp.subscribe("/queue/klomp", :persistent => :true) do ... end
+
 klomp.disconnect
 ```
 

data/klomp.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = "klomp"
-  s.version = "1.0.7"
+  s.version = "1.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Sieger"]
-  s.date = "2013-02-04"
+  s.date = "2013-04-17"
   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"]
-  s.files = [".gemtest", ".rspec", ".simplecov", "ChangeLog.md", "Gemfile", "Gemfile.lock", "Manifest.txt", "README.md", "Rakefile", "klomp.gemspec", "lib/klomp.rb", "lib/klomp/connection.rb", "lib/klomp/frames.rb", "lib/klomp/sentinel.rb", "spec/acceptance/acceptance_spec.rb", "spec/acceptance/reconnect_spec.rb", "spec/frames/auth_error.txt", "spec/frames/connect.txt", "spec/frames/connect_vhost.txt", "spec/frames/connected.txt", "spec/frames/disconnect.txt", "spec/frames/error.txt", "spec/frames/greeting.txt", "spec/frames/message.txt", "spec/frames/receipt.txt", "spec/frames/subscribe.txt", "spec/frames/unsubscribe.txt", "spec/klomp/connection_spec.rb", "spec/klomp/frames_spec.rb", "spec/klomp/sentinel_spec.rb", "spec/klomp_spec.rb", "spec/spec_helper.rb", "spec/support/have_received.rb", "spec/support/shared_contexts.rb"]
+  s.files = [".gemtest", ".rspec", ".simplecov", "ChangeLog.md", "Gemfile", "Gemfile.lock", "Manifest.txt", "README.md", "Rakefile", "klomp.gemspec", "lib/klomp.rb", "lib/klomp/connection.rb", "lib/klomp/frames.rb", "lib/klomp/sentinel.rb", "lib/klomp/subscription.rb", "spec/acceptance/acceptance_spec.rb", "spec/acceptance/reconnect_spec.rb", "spec/frames/auth_error.txt", "spec/frames/connect.txt", "spec/frames/connect_vhost.txt", "spec/frames/connected.txt", "spec/frames/disconnect.txt", "spec/frames/error.txt", "spec/frames/greeting.txt", "spec/frames/message.txt", "spec/frames/receipt.txt", "spec/frames/subscribe.txt", "spec/frames/unsubscribe.txt", "spec/klomp/connection_spec.rb", "spec/klomp/frames_spec.rb", "spec/klomp/sentinel_spec.rb", "spec/klomp_spec.rb", "spec/spec_helper.rb", "spec/support/have_received.rb", "spec/support/shared_contexts.rb"]
   s.homepage = "http://github.com/livingsocial/klomp"
   s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]

data/lib/klomp.rb

@@ -1,5 +1,5 @@
 class Klomp
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 
   class Error < StandardError; end
 
@@ -23,17 +23,18 @@ class Klomp
     end
   end
 
-  def subscribe(queue, subscriber = nil, &block)
-    connections.map {|conn| conn.subscribe(queue, subscriber, &block) }
+
+  def subscribe(queue, subscriber = nil, headers = {}, &block)
+    connections.map {|conn| conn.subscribe(queue, subscriber, headers, &block) }
   end
 
-  def unsubscribe(queue)
+  def unsubscribe(queue, headers = {})
     if Array === queue
       raise ArgumentError,
         "wrong size array for #{connections.size} (#{queue.size})" unless connections.size == queue.size
-      connections.zip(queue).map {|conn,arg| conn.unsubscribe arg rescue nil }
+      connections.zip(queue).map {|conn,arg| conn.unsubscribe(arg, headers) rescue nil }
     else
-      connections.map {|conn| conn.unsubscribe(queue) rescue nil }
+      connections.map {|conn| conn.unsubscribe(queue, headers) rescue nil }
     end
   end
 
@@ -48,6 +49,7 @@ class Klomp
   end
 end
 
+require 'klomp/subscription'
 require 'klomp/connection'
 require 'klomp/sentinel'
 require 'klomp/frames'

data/lib/klomp/connection.rb

@@ -32,18 +32,23 @@ class Klomp
       connect
     end
 
-    def publish(queue, body, headers={})
+    def publish(queue, body, headers = {})
       write Frames::Send.new(queue, body, headers)
     end
 
-    def subscribe(queue, subscriber = nil, &block)
+    def subscribe(queue, subscriber = nil, headers = {}, &block)
+      if subscriber.is_a?(Hash)
+        headers = subscriber
+        subscriber = nil
+      end
+
       raise Klomp::Error, "no subscriber provided" unless subscriber || block
       raise Klomp::Error, "subscriber does not respond to #call" if subscriber && !subscriber.respond_to?(:call)
       previous = subscriptions[queue]
-      subscriptions[queue] = subscriber || block
-      frame = Frames::Subscribe.new(queue)
+      subscriptions[queue] = Subscription.new(subscriber || block, headers)
+      frame = Frames::Subscribe.new(queue, headers)
       if previous
-        frame.previous_subscriber = previous
+        frame.previous_subscriber = previous.subscriber
       else
         write frame
       end
@@ -51,9 +56,9 @@ class Klomp
       frame
     end
 
-    def unsubscribe(queue)
+    def unsubscribe(queue, headers = {})
       queue = queue.headers['destination'] if Frames::Subscribe === queue
-      write Frames::Unsubscribe.new(queue) if subscriptions.delete queue
+      write Frames::Unsubscribe.new(queue, headers) if subscriptions.delete queue
     end
 
     def connected?()    @socket end
@@ -75,7 +80,9 @@ class Klomp
       connect
       subs = subscriptions.dup
       subscriptions.clear
-      subs.each {|queue, subscriber| subscribe(queue, subscriber) }
+      subs.each do |queue, subscription|
+        subscribe(queue, subscription.subscriber, subscription.headers)
+      end
       @sentinel = nil
     ensure
       @subscriptions = subs if subs && subs.size != @subscriptions.size
@@ -152,8 +159,8 @@ class Klomp
           begin
             message = read Frames::Message
             raise Error, message.headers['message'] if message.error?
-            if subscriber = subscriptions[message.headers['destination']]
-              subscriber.call message
+            if subscription = subscriptions[message.headers['destination']]
+              subscription.call(message)
             end
           rescue INTERRUPT
             break

data/lib/klomp/frames.rb

@@ -26,6 +26,12 @@ class Klomp
           pair.map {|x| x.to_s.gsub("\n","\\n").gsub(":","\\c").gsub("\\", "\\\\") }.join(':')
         end.join("\n").tap {|s| s << "\n" unless s.empty? }
       end
+
+      def stringify_headers(hdrs)
+        new_hdrs = {}
+        hdrs.each { |k, v| new_hdrs[k.to_s] = v }
+        new_hdrs
+      end
     end
 
     class ServerFrame < Frame
@@ -87,7 +93,7 @@ class Klomp
     class Send < Frame
       def initialize(queue, body, hdrs)
         headers['destination'] = queue
-        headers.update(hdrs.reject{|k,v| %w(destination content-length).include? k })
+        headers.update(stringify_headers(hdrs).reject { |k,v| %w(destination content-length).include? k })
         headers['content-type'] ||= 'text/plain'
         headers['content-length'] = body.bytesize.to_s
         @body = body
@@ -96,16 +102,18 @@ class Klomp
 
     class Subscribe < Frame
       attr_accessor :previous_subscriber
-      def initialize(queue)
-        headers['id'] = queue
+      def initialize(queue, hdrs = {})
+        headers.update(stringify_headers(hdrs).reject { |k,v| %w(destination ack).include? k })
+        headers['id'] ||= queue
         headers['destination'] = queue
         headers['ack'] = 'auto'
       end
     end
 
     class Unsubscribe < Frame
-      def initialize(queue)
+      def initialize(queue, hdrs = {})
         headers['id'] = queue
+        headers.update(stringify_headers(hdrs).reject { |k,v| %w(id).include? k })
       end
     end
 

data/lib/klomp/subscription.rb

@@ -0,0 +1,14 @@
+class Klomp
+  class Subscription
+    attr_reader :subscriber, :headers
+
+    def initialize(subscriber, headers)
+      @subscriber = subscriber
+      @headers = headers
+    end
+
+    def call(message = nil)
+      @subscriber.call(message)
+    end
+  end
+end

data/spec/klomp/connection_spec.rb

@@ -137,7 +137,35 @@ describe Klomp::Connection do
 
       When { connection.subscribe("/queue/foo", subscriber) }
 
-      Then { connection.subscriptions["/queue/foo"].should == subscriber }
+      Then { connection.subscriptions["/queue/foo"].subscriber.should == subscriber }
+
+    end
+
+    context "and accepts custom headers" do
+
+      Given(:headers) { { :foo => "bar" } }
+
+      Given  { Klomp::Frames::Subscribe.stub!(:new => Klomp::Frames::Subscribe.new("/queue/foo")) }
+
+      When { connection.subscribe("/queue/foo", subscriber, headers) }
+
+      Then { Klomp::Frames::Subscribe.should have_received(:new).with("/queue/foo", headers) }
+
+    end
+
+    context "and accepts custom headers plus subscriber object" do
+
+      Given(:headers) { { :foo => "bar" } }
+
+      Given  { Klomp::Frames::Subscribe.stub!(:new => Klomp::Frames::Subscribe.new("/queue/foo")) }
+
+      When { connection.subscribe("/queue/foo", subscriber, headers) }
+
+      Then do
+        Klomp::Frames::Subscribe.should have_received(:new).with("/queue/foo", headers)
+        connection.subscriptions["/queue/foo"].subscriber.should == subscriber
+        connection.subscriptions["/queue/foo"].headers.should == headers
+      end
 
     end
 

data/spec/klomp_spec.rb

@@ -117,7 +117,7 @@ describe Klomp do
 
       When(:result) { klomp.subscribe("/queue/greeting") { true } }
 
-      Then { connections.values.each {|conn| conn.should have_received(:subscribe).with("/queue/greeting", nil) } }
+      Then { connections.values.each {|conn| conn.should have_received(:subscribe).with("/queue/greeting", nil, {}) } }
 
       context "and returns the results of all Connection#subscribe as an array" do
 
@@ -147,7 +147,7 @@ describe Klomp do
 
       When(:result) { klomp.unsubscribe("/queue/greeting") }
 
-      Then { connections.values.each {|conn| conn.should have_received(:unsubscribe).with("/queue/greeting") } }
+      Then { connections.values.each {|conn| conn.should have_received(:unsubscribe).with("/queue/greeting", {}) } }
 
       context "and returns the results of all Connection#unsubscribe as an array" do
 
@@ -163,7 +163,7 @@ describe Klomp do
 
       When { klomp.unsubscribe("/queue/greeting") }
 
-      Then { connections.values.each {|conn| conn.should have_received(:unsubscribe).with("/queue/greeting") } }
+      Then { connections.values.each {|conn| conn.should have_received(:unsubscribe).with("/queue/greeting", {}) } }
 
     end
 
@@ -177,7 +177,7 @@ describe Klomp do
 
         When { klomp.unsubscribe arg }
 
-        Then { connections.values.each {|conn| conn.should have_received(:unsubscribe).with(42) } }
+        Then { connections.values.each {|conn| conn.should have_received(:unsubscribe).with(42, {}) } }
 
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klomp
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -238,6 +238,7 @@ files:
 - lib/klomp/connection.rb
 - lib/klomp/frames.rb
 - lib/klomp/sentinel.rb
+- lib/klomp/subscription.rb
 - spec/acceptance/acceptance_spec.rb
 - spec/acceptance/reconnect_spec.rb
 - spec/frames/auth_error.txt
@@ -274,7 +275,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2933496602827248730
+      hash: 2253396799858323588
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: