em-postman 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-postman.gemspec
+gemspec
+
+gem 'rake'
+gem 'em-synchrony', :git => 'git://github.com/igrigorik/em-synchrony.git'

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Vivien Schilis
+
+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,66 @@
+Getting started
+===============
+
+Postman is an EventMachine Pub/Sub resilient to failure.
+Postman uses Redis lists (brpop and lpush) to send messages to subscribers into a mailbox.
+
+Postman has been designed to be resilient to failure on both side: publisher and subscriber. 
+If your postman process dies or need to be restarted, it will be able to collect again messages from its mailbox.
+
+
+Example
+=======
+
+Server postbox: (server.rb)
+
+``` ruby
+require 'em-postman'
+
+EM.run {
+  postman = EM::Postman.new('server')
+  postman.onmessage(:greetings) {|data|
+    puts data.inspect
+    postman.send_message data['from'], :greetings, {:message => 'hello ' + data['from']}
+  }
+
+  postman.listen
+}
+```
+
+Client postbox: (client.rb)
+
+``` ruby
+require 'em-postman'
+
+EM.run {
+  postman = EM::Postman.new('client-' + Process.pid.to_s)
+  postman.onmessage(:greetings) {|data|
+    puts data.inspect
+    EM.stop
+  }
+
+  postman.send_message 'server', :greetings, {:message => 'hello server', :from => postman.mailbox}
+  postman.listen
+}
+```
+
+em-synchrony
+============
+
+To use em-postman with em-synchrony
+
+``` ruby
+require 'em-synchrony/em-hiredis'
+require 'em-postman/synchrony'
+```
+
+Credits
+=======
+
+- This gem has been extracted from http://pandastream.com.
+- Thanks to Jonas Pfenniger(zimbatm) and Martyn Loughran(mloughran)
+
+License
+=======
+
+The MIT License - Copyright (c) 2011 Vivien Schilis

data/Rakefile

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

data/em-postman.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-postman/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-postman"
+  s.version     = EventMachine::Postman::VERSION
+  s.authors     = ["Vivien Schilis"]
+  s.email       = ["vivien.schilis@gmail.com"]
+  s.homepage    = "http://github.com/vivienschilis/em-postman"
+  s.summary     = %q{EventMachine pub/sub using Redis list, resilient to failure}
+  s.description = %q{EventMachine pub/sub using Redis list, resilient to failure}
+
+  s.rubyforge_project = "em-postman"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "em-hiredis"
+  s.add_dependency "multi_json"
+  s.add_dependency "yajl-ruby"
+
+  s.add_development_dependency "em-spec"
+  s.add_development_dependency "rspec"
+
+end

data/examples/client.rb

@@ -0,0 +1,16 @@
+require 'em-postman'
+
+EM.run {
+
+  postbox = EM::Postman.new('client-' + Process.pid.to_s )
+  postbox.onmessage(:greetings) {|data|
+    puts data.inspect
+    EM.stop
+  }
+
+  100.times {|i|
+    postbox.send_message('server', :greetings, {:message => "hello server, message #{i} ", :from => postbox.mailbox})
+  }
+
+  postbox.listen
+}

data/examples/server.rb

@@ -0,0 +1,12 @@
+require 'em-postman'
+
+EM.run {
+  postman = EM::Postman.new('server')
+
+  postman.onmessage(:greetings) {|data|
+    puts data.inspect
+    postman.send_message(data['from'], :greetings, {:message => 'hello ' + data['from']})
+  }
+
+  postman.listen
+}

data/lib/em-postman.rb

@@ -0,0 +1,10 @@
+require 'logger'
+require 'eventmachine'
+require 'em-hiredis'
+
+require 'multi_json'
+require 'yajl'
+MultiJson.engine = :yajl
+
+require 'em-postman/version'
+require 'em-postman/postman'

data/lib/em-postman/postman.rb

@@ -0,0 +1,118 @@
+module EventMachine
+  class Postman
+      attr_accessor :mailbox
+      attr_writer :logger
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def handlers
+        @handlers ||= {}
+      end
+
+      def initialize(mailbox, options = {})
+        @mailbox = mailbox
+        @timeout = options[:timeout] || 5
+        @redis_options = {:db => 0, :host => 'localhost', :port => 6379}
+
+        @options = options
+        if options[:redis].is_a?(EventMachine::Hiredis::Client)
+          @redis = options[:redis]
+          @redis_options = extract_redis_options(@redis)
+        else
+          @redis_options.merge(options[:redis] || {})
+        end
+      end
+
+      def redis
+        @redis ||= new_redis_client
+      end
+
+      def clear
+        redis.del(inbox_name)
+      end
+
+      def onmessage(method, &callback)
+        debug "##{method} registered"
+
+        handlers[method.to_s] ||= []
+        handlers[method.to_s] << callback
+      end
+
+      def unlisten(method, callback)
+        if cbs = handlers[method.to_s]
+          cbs.delete(callback)
+        end
+      end
+      
+      def send_message(recipient, method, body)
+        message = MultiJson.encode({
+          'method' => method,
+          'body' => body
+        })
+
+        debug "-> #{recipient}##{method}: #{body.inspect}"
+        redis.lpush("postman:inbox_#{recipient}", message)
+      end
+
+      def listen
+        listen_messages
+      end
+
+      private
+
+      def new_redis_client
+        new_redis_client = EventMachine::Hiredis::Client.connect(@redis_options[:host], @redis_options[:port])
+        new_redis_client.select(@redis_options[:db])
+        new_redis_client
+      end
+
+      def extract_redis_options(redis)
+        {
+          :host => redis.host,
+          :port => redis.port,
+          :db => redis.db
+        }
+      end
+
+      def inbox_name
+        "postman:inbox_#{@mailbox}"
+      end
+
+      def debug(message)
+        logger.debug "Postman[#{mailbox}]: #{message}"
+      end
+
+      def listen_messages(redis = new_redis_client)
+        EM.next_tick do
+          deferable = redis.brpop(inbox_name, @timeout)
+          deferable.callback do |channel, message|
+            handle_rpop(channel, message) unless channel.nil?
+            listen_messages(redis)
+          end
+
+          deferable.errback do |error|
+            logger.error "Postman[#{mailbox}]: #{error.inspect}"
+            listen_messages(redis)
+          end
+        end
+      end
+
+      def handle_rpop(channel, message)
+        begin
+          debug "<- #{message}"
+          data = MultiJson.decode(message)
+          if (callbacks = handlers[data['method'].to_s]) && !callbacks.empty?
+            callbacks.each {|cb| cb.call(data['body'])}
+          else
+            logger.warn "Postman[#{mailbox}]: no handler found for #{data['method']}"
+          end
+        rescue MultiJson::DecodeError => error
+          logger.error "Postman[#{mailbox}]: unable to parse message #{message}"
+        rescue  => error
+          logger.error "Postman[#{mailbox}]: #{error}"
+        end
+      end
+  end
+end

data/lib/em-postman/synchrony.rb

@@ -0,0 +1,15 @@
+module EventMachine
+  class Postman
+    def listen_messages(redis = new_redis_client)
+      channel, message = redis.brpop(inbox_name, @timeout)
+
+      handle_rpop(channel, message) if channel && message
+
+      EM.next_tick do
+        Fiber.new { 
+          listen_messages(redis)
+        }.resume
+      end
+    end
+  end
+end

data/lib/em-postman/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  class Postman
+    VERSION = "0.1.0"
+  end
+end

data/spec/postman_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe EventMachine::Postman do
+  describe "when listening for messages" do
+    let(:redis) {
+      redis = EventMachine::Hiredis.connect("redis://localhost:6379/0")
+      redis.flushall
+      redis
+    }
+
+    let(:postman) { 
+      p = EM::Postman.new('test', :redis => redis)
+      p.logger = Logger.new(nil)
+      p
+    }
+
+    it "should send and receive messages asynchronously" do
+        em(1) do
+          postman.send_message("test", 'cb', {:value => 'abc'})
+        
+          responses = []
+          postman.onmessage(:cb) do |msg|
+            responses << msg
+          end
+          postman.onmessage(:cb) do |msg|
+            responses << msg
+          end
+          postman.listen
+        
+          EM.add_timer(0.2) do
+            responses.should == [{"value"=>"abc"}, {"value"=>"abc"}]
+            done
+          end
+        end
+    end
+
+    it "should unregister handlers" do 
+        em(1) do
+          postman.send_message("test", 'cb', {:value => 'abc'})
+          responses = []
+          proc = Proc.new {|msg|
+            responses << msg
+            postman.unlisten(:cb, proc)
+          }
+          postman.onmessage(:cb, &proc)
+
+          postman.listen
+
+          EM.add_timer(0.2) do
+            postman.send_message("test", 'cb', {:value => 'cdf'})
+          end
+
+          EM.add_timer(0.4) do
+            responses.should == [{"value"=>"abc"}]
+            done
+          end
+        end
+    end
+
+    it "should gracefully handle a Redis.rpop error" do
+        em(1) do
+          redis.lpush("postman:inbox_test", MultiJson.encode({:method => 'cb', :body => 'a'}))
+          redis.lpush("postman:inbox_test", "error")
+          redis.lpush("postman:inbox_test", MultiJson.encode({:method => 'cb', :body => 'b'}))
+
+          responses = []
+          postman.onmessage(:cb) do |msg|
+            responses << msg
+          end
+          postman.listen
+
+          EM.add_timer(0.2) do
+            responses.should == ["a", "b"]
+            done
+          end
+        end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+require 'em-postman'
+require 'rspec'
+require 'em-spec/rspec'
+
+RSpec.configure do |config|
+  config.include EventMachine::SpecHelper
+end

data/spec/synchrony_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'em-synchrony'
+require 'em-synchrony/em-hiredis'
+require 'em-postman/synchrony'
+
+describe EventMachine::Postman do
+  describe "when listening for messages" do
+
+    it "should send and receive messages using em-sychrony" do
+      EventMachine.synchrony do
+        
+        redis = EM::Hiredis::Client.connect('localhost', 6379)
+        redis.flushall
+        
+        postman = EM::Postman.new('test', :redis => redis)
+        postman.logger = Logger.new(nil)
+        
+        postman.send_message("test", 'cb', {:value => 'abc'})
+        
+        responses = []
+        postman.onmessage(:cb) do |msg|
+          responses << msg
+        end
+
+        postman.listen
+                
+        responses.should == [{"value"=>"abc"}]
+        EventMachine.stop
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: em-postman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Vivien Schilis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: &70337885041680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337885041680
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70337885041120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337885041120
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70337885037840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337885037840
+- !ruby/object:Gem::Dependency
+  name: em-spec
+  requirement: &70337885037340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70337885037340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70337885036920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70337885036920
+description: EventMachine pub/sub using Redis list, resilient to failure
+email:
+- vivien.schilis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- em-postman.gemspec
+- examples/client.rb
+- examples/server.rb
+- lib/em-postman.rb
+- lib/em-postman/postman.rb
+- lib/em-postman/synchrony.rb
+- lib/em-postman/version.rb
+- spec/postman_spec.rb
+- spec/spec_helper.rb
+- spec/synchrony_spec.rb
+homepage: http://github.com/vivienschilis/em-postman
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2381599360813571691
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2381599360813571691
+requirements: []
+rubyforge_project: em-postman
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: EventMachine pub/sub using Redis list, resilient to failure
+test_files:
+- spec/postman_spec.rb
+- spec/spec_helper.rb
+- spec/synchrony_spec.rb