easy_bunny_rpc 0.1.0.alpha → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c7753440ae7622d08014667722d7d607b5e2ff7
-  data.tar.gz: d6f58efefd2f73e5f2cc0dea692acae2dc14852d
+  metadata.gz: 8ea967e4d8823b80adb2ac43a1e1ab7d96d4d072
+  data.tar.gz: c5bf00052c37e0c693682298d9d52be8b939f72a
 SHA512:
-  metadata.gz: 605aba5b4e0aa19e103e7e83c7c5cff7483d66fe104fabdf420f1bdab4489d464391e5f057c60376ee1648fbeefecd24a0df92efd1e43b2fed415a259027fa4c
-  data.tar.gz: 2c53c15a9dd254a7a6a6032faca6e3b13ee23f00a72a24e00adf6620308e02ddc2e3aa3b36e8304a5a565c3b6816fcfb683165d4982818774b7d1ad44ca524ce
+  metadata.gz: 9bdf3cca67b828f1ba04254339dc4776f3f998a4421ba22834c43ff20f3a2e1289914f0276e5f7c7da0bb980315ff3cf1b9afd3f12b980e5cdb184b4d73c2ad4
+  data.tar.gz: 42109a3a629698e06eeb7d8aeb753be54dc20f48d2174b83b4427a03937d0f163b92fa64a39c83e654b86c7b24ef36ae3be94eb6f4f2ee73bfbfa259d7cb885b

data/README.md

@@ -5,24 +5,9 @@ easy\_bunny\_rpc
 Generic RPC client/worker library handling data serialization built on top of bunny.
 
 Example usage
------
+-------------
 
-Create an EchoWorker class which simply echoes whatever is received:
-
-``` ruby
-class EchoWorker < EasyBunnyRPC::Worker
-  def mediate
-    subscribe do |payload|
-      publish_success(payload) # Send a success message to the client
-      # publish_failure(payload) # Send a failure message to the client
-    end
-  rescue Interrupt => _
-    # close
-  end
-end
-```
-
-Now you can initialize it. Please note the :bunny key Hash is directly fed to Bunny.new:
+The worker. Please note the :bunny key Hash is directly fed to Bunny.new:
 
 ``` ruby
 options = {
@@ -34,34 +19,18 @@ options = {
   }
 }
 
-echo_worker = EchoWorker.new options
-echo_worker.mediate
-```
-
-
-Create an EchoClient class:
-
-``` ruby
-class EchoClient < EasyBunnyRPC::Client
-  def perform
-    set_timeout(2) # timeout in seconds, default is 5
-    
-    # The first argument is the payload, the send argument is the correlation_id
-    # The correlation_id is always send back as-is by the worker
-    # This way you can correlate the replies with your requests
-    publish('hi there', 'call 1')
-    publish('hi there again', 'call 2')
-
-    # Pop will raise a ::Timeout::Error when a timeout occurs and no message is received
-    p pop 
-    p pop
-  end
+worker = EasyBunnyRPC::Worker.new(options)
+worker.subscribe do |payload|
+  publish_success(payload) # Send a success message to the client
+  # publish_failure(payload) # Send a failure message to the client
 end
 ```
 
-Now you can initialize it:
+
+The client:
 
 ``` ruby
+# initialization options
 options = {
   queue: 'echo',
   bunny: {
@@ -71,8 +40,25 @@ options = {
   }
 }
 
-echo_client = EchoClient.new(options)
-echo_client.perform
+client = EasyBunnyRPC::Client.new(options)
+
+# timeout in seconds, default is 5
+client.set_timeout(2)
+
+# The first argument is the payload. The payload can be anything, just keep in
+# mind it must be serializable to a String because .to_json is called on it
+# 
+# The second argument is the correlation_id.
+# The correlation_id is always send back as-is by the worker.
+# This way you can correlate the replies with your requests.
+client.publish('hi there', 'call 1')
+client.publish('hi there again', 'call 2')
+
+# Pop will raise a ::Timeout::Error when a timeout occurs and no message is received
+puts client.pop
+puts client.pop
+
+client.close
 ```
 
 Output:
@@ -83,7 +69,7 @@ Output:
 
 
 Notes
-_____
+-----
 
 - Tested with RabbitMQ
 - Uses the expiration feature of RabbitMQ to expire messages sent by the client

data/easy_bunny_rpc.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
   gem.authors       = ['Tom van Leeuwen']
   gem.email         = 'tom@vleeuwen.eu'
-  gem.homepage      = 'https://rubygems.org/gems/easy_bunny_rpc'
+  gem.homepage      = 'https://github.com/TvL2386/easy_bunny_rpc'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/easy_bunny_rpc/client.rb

@@ -15,8 +15,6 @@ module EasyBunnyRPC
       set_timeout(5)
     end
 
-    private
-
     def pop
       correlation_id, payload = @timed_queue.pop_with_timeout(@timeout)
 
@@ -27,6 +25,26 @@ module EasyBunnyRPC
       @timeout = value
     end
 
+    def publish(payload, correlation_id=default_correlation_id)
+      start_subscription unless @subscribed
+      exchange.publish([payload].to_json, routing_key: @options[:queue], correlation_id: correlation_id, reply_to: queue.name, expiration: (@timeout*1000).to_i)
+    end
+
+    def close
+      if defined?(@channel)
+        channel.close
+        remove_instance_variable :@channel
+        remove_instance_variable :@queue
+      end
+
+      if defined?(@connection)
+        connection.close
+        remove_instance_variable :@connection
+      end
+    end
+
+    private
+
     def start_subscription
       queue.subscribe(block: false) do |delivery_info, properties, payload|
         @timed_queue.push([properties.correlation_id, payload])
@@ -35,11 +53,6 @@ module EasyBunnyRPC
       @subscribed = true
     end
 
-    def publish(payload, correlation_id=default_correlation_id)
-      start_subscription unless @subscribed
-      exchange.publish([payload].to_json, routing_key: @options[:queue], correlation_id: correlation_id, reply_to: queue.name, expiration: (@timeout*1000).to_i)
-    end
-
     def connection
       return @connection if defined?(@connection)
 

data/lib/easy_bunny_rpc/timed_queue.rb

@@ -26,6 +26,7 @@ module EasyBunnyRPC
 
             raise(Timeout::Error, "Waited #{timeout} seconds to pop") if(remaining <= 0)
 
+            # unlocks mutex, waits for remaining seconds, locks mutex on wake-up
             @cv.wait(@mutex, remaining)
           else
             return @array.pop

data/lib/easy_bunny_rpc/version.rb

@@ -1,4 +1,4 @@
 module EasyBunnyRPC
   # easy_bunny_rpc version
-  VERSION = '0.1.0.alpha'
+  VERSION = '0.1.1'
 end

data/lib/easy_bunny_rpc/worker.rb

@@ -7,7 +7,13 @@ module EasyBunnyRPC
       @options = options
     end
 
-    private
+    def publish_success(payload)
+      publish true, payload
+    end
+
+    def publish_failure(payload)
+      publish false, payload
+    end
 
     def subscribe
       queue.subscribe(block: true) do |delivery_info, properties, payload|
@@ -17,18 +23,25 @@ module EasyBunnyRPC
       end
     end
 
-    def publish(success, payload)
-      obj = { 'success' => success, 'payload' => payload }.to_json
+    def close
+      if defined?(@channel)
+        channel.close
+        remove_instance_variable :@channel
+        remove_instance_variable :@queue
+      end
 
-      exchange.publish(obj, routing_key: @properties.reply_to, correlation_id: @properties.correlation_id)
+      if defined?(@connection)
+        connection.close
+        remove_instance_variable :@connection
+      end
     end
 
-    def publish_success(payload)
-      publish true, payload
-    end
+    private
 
-    def publish_failure(payload)
-      publish false, payload
+    def publish(success, payload)
+      obj = { 'success' => success, 'payload' => payload }.to_json
+
+      exchange.publish(obj, routing_key: @properties.reply_to, correlation_id: @properties.correlation_id)
     end
 
     def connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_bunny_rpc
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom van Leeuwen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -85,7 +85,7 @@ files:
 - lib/easy_bunny_rpc/timed_queue.rb
 - lib/easy_bunny_rpc/version.rb
 - lib/easy_bunny_rpc/worker.rb
-homepage: https://rubygems.org/gems/easy_bunny_rpc
+homepage: https://github.com/TvL2386/easy_bunny_rpc
 licenses:
 - MIT
 metadata: {}
@@ -100,9 +100,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.0