babs 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in babs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jay OConnor
+
+MIT License
+
+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,110 @@
+# Babs
+
+Do you like RabbitMQ, but want to use it for more than asynchronous messaging?  This will help.  Babs is a Rabbit client using the Bunny gem that goes through the motions of setting up a listener, sending a message and waiting for a response on the listener queue.
+
+Most of this code came from the Bunny tutorials.  The client wrapper and opinions were added on for this gem.
+
+This is demonstration quality code (debug output is left in).  If you like it, let me know and we'll knock it out and set up better automated tests.
+
+Why would someone want to do this??  Isn't this better served with DCell?  Yes, but no.  RabbitMQ will act as your broker, elminating the need for a directory server that remembers where all of your nodes are.
+
+tl;dr - See the usage section
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'babs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install babs
+
+## Usage
+
+```ruby
+require 'babs/client'
+
+client = Babs::Client.new(server_queue: 'rpc_queue')
+
+(1..1000).each do |c|
+  response = client.request(method: :fib, params: { number: 20 })
+  # response is a Hashie::Mash of the response (the resonse is expected to be a json string)
+  puts "i got this #{response.data.value}"
+end
+
+client.close_connection
+```
+
+What's a consumer (where you send the request) look like? -- it return a json string.  This is important.
+```ruby
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bunny"
+require 'hashie'
+require 'json'
+
+conn = Bunny.new(:automatically_recover => false)
+conn.start
+
+ch   = conn.create_channel
+
+class FibonacciServer
+
+  def initialize(ch)
+    @ch = ch
+  end
+
+  def start(queue_name)
+    @q = @ch.queue(queue_name, durable: true)
+    @x = @ch.default_exchange
+
+    @q.subscribe(:block => true, ack: true) do |delivery_info, properties, payload|
+      req = Hashie::Mash.new(JSON.parse(payload))
+      if req[:method] == 'fib'
+        n = req.params.number.to_i
+        r = self.class.fib(n)
+        puts " [.] fib(#{n})"
+        data_string = {data: { value: r } }.to_json
+        @x.publish(data_string, :routing_key => properties.reply_to, :correlation_id => properties.correlation_id)
+        @ch.acknowledge(delivery_info.delivery_tag, false)
+      end
+    end
+  end
+
+
+  def self.fib(n)
+    case n
+    when 0 then 0
+    when 1 then 1
+    else
+      fib(n - 1) + fib(n - 2)
+    end
+  end
+end
+
+begin
+  server = FibonacciServer.new(ch)
+  " [x] Awaiting RPC requests"
+  server.start("rpc_queue")
+rescue Interrupt => _
+  ch.close
+  conn.close
+
+  exit(0)
+end
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/babs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/babs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'babs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "babs"
+  spec.version       = Babs::VERSION
+  spec.authors       = ["Jay OConnor"]
+  spec.email         = ["jaydoconnor@gmail.com"]
+  spec.summary       = %q{ Client for a request response (synchronous) pattern using RabbitMQ. }
+  spec.description   = %q{ }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "bunny"
+  spec.add_dependency "hashie"
+end

data/lib/babs.rb

@@ -0,0 +1,5 @@
+require "babs/version"
+
+module Babs
+  # Your code goes here...
+end

data/lib/babs/client.rb

@@ -0,0 +1,81 @@
+module Babs
+  class Client
+    require "bunny"
+    require "thread"
+    require "hashie"
+    require 'json'
+
+    attr_accessor :route
+    attr_accessor :response, :call_id
+    attr_reader :lock, :condition
+    attr_reader :reply_queue
+
+    def initialize(options = {})
+      # make this connection part a singleton and a LOT of time is saved, as well as reusing the same connection
+      @conn = Bunny.new(:automatically_recover => false)
+      @conn.start
+      @ch   = @conn.create_channel
+
+      @defaults = Hashie::Mash.new({
+          server_queue: nil,
+          exchange: @ch.default_exchange
+        }.merge(options)
+      )
+
+      @lock      = Mutex.new
+      @condition = ConditionVariable.new
+
+    end
+
+    def close_connection
+      @ch.close
+      @conn.close
+    end
+
+    def listen_for_response
+      # listen on a new queue for this response
+      @reply_queue = @ch.queue("", :exclusive => true)
+      @reply_queue.subscribe do |delivery_info, properties, payload|
+        puts "response_id #{properties[:correlation_id]}"
+        puts properties[:correlation_id] == self.call_id ? "correct id" : "BAD id"
+        if properties[:correlation_id] == self.call_id
+          self.response = payload
+          self.lock.synchronize{self.condition.signal}
+        end
+      end
+    end
+
+    def send_request(routing_options, method, params)
+      self.call_id = SecureRandom.uuid
+
+      data_string = {method: method, params: params}.to_json
+
+      routing_options.exchange.publish(
+        data_string,
+        routing_key:    routing_options.server_queue,
+        correlation_id: call_id,
+        reply_to:       @reply_queue.name)
+      puts "call id #{call_id}"
+      self.response = nil
+      # params to synchronize are mutex, timeout_in_seconds
+      lock.synchronize{condition.wait(lock, 5)}
+      response
+    end
+
+    def request(options = {})
+      options = Hashie::Mash.new(options)
+      # grab out the expected data
+      method = options.delete(:method)
+      params = options.delete(:params)
+
+      # merge the connection options with the defaults
+      routing_options = @defaults.merge(options)
+
+      response = listen_for_response
+      response = send_request(routing_options, method, params)
+      # parse and return response
+      Hashie::Mash.new(JSON.parse(response))
+    end
+
+  end
+end

data/lib/babs/version.rb

@@ -0,0 +1,3 @@
+module Babs
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: babs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jay OConnor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' '
+email:
+- jaydoconnor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- babs.gemspec
+- lib/babs.rb
+- lib/babs/client.rb
+- lib/babs/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Client for a request response (synchronous) pattern using RabbitMQ.
+test_files: []