redis_message_capsule 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 redis_message_capsule.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Arbind
+
+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,63 @@
+# RedisMessageCapsule
+
+Send and receive real-time messages between applications (via redis).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_message_capsule'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_message_capsule
+
+## Usage
+
+Open terminal window one (to send messages):
+
+    $ irb
+    require 'redis_message_capsule'
+    channel_cat = RedisMessageCapsule.channel('cat')
+    channel_cat.send('meow')
+    channel_cat.send('meow')
+
+Open terminal window two (to listen for messages):
+
+    $ irb
+    require 'redis_message_capsule'
+    RedisMessageCapsule.listen('cat') do |msg| 
+        puts msg
+    end
+    # => meow
+
+Go back to terminal window one:
+
+    channel_cat.send 9
+    channel_cat.send say: 'roar', time: Time.now
+    channel_cat.send :purr
+
+Watch for messages in terminal window two:
+
+    # => 9 
+    # => {"say"=>"roar", "time"=>"2012-11-19 23:16:08 -0800"} 
+    # => purr
+
+(Make sure you have redis running)
+
+## Comming Soon
+
+A node.js version you can use to send messages back and forth between node and rails apps.
+
+
+## Contributing
+
+1. Fork it
+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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/redis_message_capsule/version.rb

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

data/lib/redis_message_capsule.rb

@@ -0,0 +1,146 @@
+require "redis_message_capsule/version"
+require 'redis'
+require 'json'
+require 'uri'
+
+module RedisMessageCapsule
+  class Configuration
+    attr_accessor :environment, :db_number, :redis_url
+
+    def initialize
+      self.environment = ENV["RACK_ENV"] || "development"
+      self.db_number = 7 if self.environment.eql? 'production'
+      self.db_number = 8 if self.environment.eql? 'development'
+      self.db_number = 9 if self.environment.eql? 'test'
+      self.db_number ||= 9
+      self.redis_url = ENV["REDIS_URL"] || ENV["REDISTOGO_URL"] || "redis://localhost:6379/"
+    end
+  end
+
+  class << self
+    attr_accessor :configuration, :redis_clients, :capsule_channels, :listener_threads, :handlers
+  end
+
+  def self.redis_clients
+    @redis_clients ||=  {}
+  end
+
+  def self.capsule_channels
+    @capsule_channels ||=  {}
+  end
+
+  def self.listener_threads
+    @listener_threads ||=  {}
+  end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+  def self.config() configuration end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  class Channel
+    attr_accessor :name, :redis_client
+    def initialize(name, redis_client)
+      self.name = name
+      self.redis_client = redis_client
+    end
+
+    def send (message)
+      payload = { 'data' => message }
+      redis_client.rpush name, payload.to_json
+    end
+
+  end
+
+  def self.make_client_key(url, db_num)
+    "#{url}.#{db_num}"
+  end
+
+  def self.make_channel_key(name, url, db_num)
+    "#{name}.#{url}.#{db_num}"
+  end
+
+  def self.make_listener_key(channels, url, db_num)
+    [ *channels, url, db_num].join('.')
+  end
+
+  def self.channel(name, redis_url=nil, db_number=-1)
+    url = redis_url || config.redis_url
+    db_num = db_number
+    db_num = config.db_number if db_num < 0
+
+    channel_key = make_channel_key(name, url, db_num)
+    return capsule_channels[channel_key] unless capsule_channels[channel_key].nil?
+
+    client_key = make_client_key(url, db_num)
+    redis_client = redis_clients[client_key]
+
+    if redis_client.nil?
+      uri = URI.parse(url)
+      redis_client = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password) rescue nil
+      if redis_client.nil?
+        puts "!!!\n!!! Can not connect to redis server at #{uri}\n!!!"
+        return nil
+      end
+      redis_client.select db_num
+      redis_clients[client_key] = redis_client
+    end
+    channel = Channel.new(name, redis_client)
+    capsule_channels[channel_key] = channel
+    channel
+  end
+
+
+  def self.listen(channels_array, redis_url=nil, db_number=-1)
+    url = redis_url || config.redis_url
+    db_num = db_number
+    db_num = config.db_number if db_num < 0
+    channels = *channels_array
+    key = make_listener_key(channels, url, db_number)
+    return true unless listener_threads[key].nil?
+    
+    listener_threads[key] = Thread.new do
+      Thread.current[:name] = :RedisMessageCapsule
+      Thread.current[:description] = "Listening for messages from #{url.to_s} on chanel: #{[*channels].join(',')} "
+
+      redis_client = nil # establish redis connection: 
+      until !redis_client.nil? and redis_client.ping
+        uri = URI.parse(url)
+        redis_client = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password) rescue nil
+        if redis_client.nil?
+          puts "!!!\n!!! Can not connect to redis server at #{uri}\n!!!"
+          sleep 10
+        else
+          redis_client.select db_num
+          puts "connected!"
+          Thread.current[:redis_client] = redis_client
+        end
+      end
+
+      puts "Listening for messages on #{[*channels].join(', ')}"
+      loop do
+        channel_element = redis_client.blpop *channels, 0
+        channel = channel_element.first
+        element = channel_element.last
+        payload = ( JSON.parse(element) rescue {} )
+        message = payload['data']
+        # fire event on channel
+        puts "#{channel}: #{message}"
+        yield(message) if block_given?
+      end
+    end
+  end
+
+end
+
+
+def start_redis_listeners(channels_array, redis_url=nil)
+  channels = *channels_array
+
+  url = redis_url || ENV["REDIS_URL"] || ENV["REDISTOGO_URL"] || "redis://localhost:6379/"
+  key = url.to_s + channels.to_s
+end

data/redis_message_capsule.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_message_capsule/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis_message_capsule"
+  gem.version       = RedisMessageCapsule::VERSION
+  gem.authors       = ["Arbind"]
+  gem.email         = ["arbind@carbonfive.com"]
+  gem.description   = "Send and receive real-time messages between applications (via redis)."
+  gem.summary       = ""
+  gem.homepage      = ""
+
+  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_runtime_dependency 'redis'
+  gem.add_runtime_dependency 'json'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# setup for test environment
+ENV['RACK_ENV'] = 'test'
+
+# set up test coverage
+require 'simplecov'
+SimpleCov.start do
+  minimum_coverage 100
+end
+
+require 'RedisMessageCapsule'
+
+# Dont let tests overwrite any production or development data
+abort('Redis not configured for test environment !!!')    unless REDIS_DB.eql? REDIS_DB_ENVIRONMENTS[:test]

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: redis_message_capsule
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arbind
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: json
+  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: 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: rspec
+  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: simplecov
+  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'
+description: Send and receive real-time messages between applications (via redis).
+email:
+- arbind@carbonfive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_message_capsule.rb
+- lib/redis_message_capsule/version.rb
+- redis_message_capsule.gemspec
+- spec/spec_helper.rb
+homepage: ''
+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'
+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: ''
+test_files:
+- spec/spec_helper.rb