easy_bunny_rpc 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c7753440ae7622d08014667722d7d607b5e2ff7
+  data.tar.gz: d6f58efefd2f73e5f2cc0dea692acae2dc14852d
+SHA512:
+  metadata.gz: 605aba5b4e0aa19e103e7e83c7c5cff7483d66fe104fabdf420f1bdab4489d464391e5f057c60376ee1648fbeefecd24a0df92efd1e43b2fed415a259027fa4c
+  data.tar.gz: 2c53c15a9dd254a7a6a6032faca6e3b13ee23f00a72a24e00adf6620308e02ddc2e3aa3b36e8304a5a565c3b6816fcfb683165d4982818774b7d1ad44ca524ce

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+pkg/
+vendor/cache/*.gem
+.idea
+private

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2015-06-19
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Tom van Leeuwen
+
+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.

data/README.md

@@ -0,0 +1,103 @@
+easy\_bunny\_rpc
+=================
+[![Gem Version](https://badge.fury.io/rb/easy_bunny_rpc.svg)](https://rubygems.org/gems/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:
+
+``` ruby
+options = {
+  queue: 'echo',
+  bunny: {
+    user: 'user',
+    password: 'secret',
+    host: 'localhost'
+  }
+}
+
+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
+end
+```
+
+Now you can initialize it:
+
+``` ruby
+options = {
+  queue: 'echo',
+  bunny: {
+    user: 'user',
+    password: 'secret',
+    host: 'localhost'
+  }
+}
+
+echo_client = EchoClient.new(options)
+echo_client.perform
+```
+
+Output:
+``` text
+{"success"=>true, "payload"=>"hi there", "correlation_id"=>"call 1"}
+{"success"=>true, "payload"=>"hi there again", "correlation_id"=>"call 2"}
+```
+
+
+Notes
+_____
+
+- Tested with RabbitMQ
+- Uses the expiration feature of RabbitMQ to expire messages sent by the client
+
+
+Install
+-------
+
+```
+$ gem install easy_bunny_rpc
+```
+
+
+Author
+------
+
+Tom van Leeuwen, [@tvl2386](https://twitter.com/tvl2386)

data/Rakefile

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new

data/easy_bunny_rpc.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/easy_bunny_rpc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'easy_bunny_rpc'
+  gem.version       = EasyBunnyRPC::VERSION
+  gem.summary       = %q{A simple rabbitmq rpc server/client library built on bunny with message serialization using json}
+  gem.description   = gem.summary
+  gem.license       = 'MIT'
+  gem.authors       = ['Tom van Leeuwen']
+  gem.email         = 'tom@vleeuwen.eu'
+  gem.homepage      = 'https://rubygems.org/gems/easy_bunny_rpc'
+
+  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.require_paths = ['lib']
+
+  gem.add_dependency 'bunny', '~> 1.7'
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/lib/easy_bunny_rpc.rb

@@ -0,0 +1,5 @@
+
+require 'easy_bunny_rpc/version'
+require 'easy_bunny_rpc/timed_queue'
+require 'easy_bunny_rpc/client'
+require 'easy_bunny_rpc/worker'

data/lib/easy_bunny_rpc/client.rb

@@ -0,0 +1,72 @@
+require 'bunny'
+require 'json'
+require 'securerandom'
+
+module EasyBunnyRPC
+  class Client
+    def initialize options={}
+      @options = options
+      @subscribed = false
+
+      # The timed queue which will collect incoming messages
+      @timed_queue = EasyBunnyRPC::TimedQueue.new
+
+      # Need to set a default timeout. How about 5 seconds?
+      set_timeout(5)
+    end
+
+    private
+
+    def pop
+      correlation_id, payload = @timed_queue.pop_with_timeout(@timeout)
+
+      JSON.parse(payload).merge!({ 'correlation_id' => correlation_id })
+    end
+
+    def set_timeout(value)
+      @timeout = value
+    end
+
+    def start_subscription
+      queue.subscribe(block: false) do |delivery_info, properties, payload|
+        @timed_queue.push([properties.correlation_id, payload])
+      end
+
+      @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)
+
+      @connection = Bunny.new(@options[:bunny])
+      @connection.start
+      @connection
+    end
+
+    def channel
+      @channel ||= connection.create_channel
+    end
+
+    # The exclusive no-name queue that is created for communicating back to me
+    def queue
+      @queue ||= channel.queue(generate_queue_name, exclusive: true)
+    end
+
+    def generate_queue_name
+      [@options[:queue], '-client_', SecureRandom.hex].join
+    end
+
+    def exchange
+      @exchange ||= channel.default_exchange
+    end
+
+    def default_correlation_id
+      ''
+    end
+  end
+end

data/lib/easy_bunny_rpc/timed_queue.rb

@@ -0,0 +1,37 @@
+require 'thread'
+require 'timeout'
+
+module EasyBunnyRPC
+  class TimedQueue
+    def initialize
+      @array = Array.new
+      @mutex = Mutex.new
+      @cv = ConditionVariable.new
+    end
+
+    def push(item)
+      @mutex.synchronize do
+        @array.push(item)
+        @cv.signal
+      end
+    end
+
+    def pop_with_timeout(timeout=0.5)
+      timeout_at = Time.now + timeout
+
+      @mutex.synchronize do
+        loop do
+          if @array.empty?
+            remaining = timeout_at - Time.now
+
+            raise(Timeout::Error, "Waited #{timeout} seconds to pop") if(remaining <= 0)
+
+            @cv.wait(@mutex, remaining)
+          else
+            return @array.pop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/easy_bunny_rpc/version.rb

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

data/lib/easy_bunny_rpc/worker.rb

@@ -0,0 +1,58 @@
+require 'bunny'
+require 'json'
+
+module EasyBunnyRPC
+  class Worker
+    def initialize(options={})
+      @options = options
+    end
+
+    private
+
+    def subscribe
+      queue.subscribe(block: true) do |delivery_info, properties, payload|
+        @delivery_info, @properties, @payload = delivery_info, properties, payload
+
+        yield JSON.parse(payload).first
+      end
+    end
+
+    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 publish_success(payload)
+      publish true, payload
+    end
+
+    def publish_failure(payload)
+      publish false, payload
+    end
+
+    def connection
+      return @connection if defined?(@connection)
+
+      @connection = Bunny.new(@options[:bunny])
+      @connection.start
+      @connection
+    end
+
+    def channel
+      return @channel if defined?(@channel)
+
+      @channel = connection.create_channel
+      @channel.prefetch(1)
+      @channel
+    end
+
+    def queue
+      @queue ||= channel.queue(@options[:queue])
+    end
+
+    def exchange
+      @exchange ||= channel.default_exchange
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: easy_bunny_rpc
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha
+platform: ruby
+authors:
+- Tom van Leeuwen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A simple rabbitmq rpc server/client library built on bunny with message
+  serialization using json
+email: tom@vleeuwen.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_bunny_rpc.gemspec
+- lib/easy_bunny_rpc.rb
+- lib/easy_bunny_rpc/client.rb
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A simple rabbitmq rpc server/client library built on bunny with message serialization
+  using json
+test_files: []