rcom 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95a36229bc381e17c5190154a0679add12a794bf
+  data.tar.gz: ab8d5adbcb9b0a599a3da61badd4197dfec6c732
+SHA512:
+  metadata.gz: d2199539d074722c55d225ac420f953fc6299d15c24569d7e2e9ce1f58031d3ddc1b3782a23b2c340083b13768a1a6a0f485958c5aee4284e5f840ebc5a67df2
+  data.tar.gz: 28cf9fd25c94b73073c0cd3aeaa77fdccb2544c1a27a518d7da2401f1252c347eaea9d38fdeddd6f5c4f4b0a15396263dedf001440c873a815ffeba10ebcdc55

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marco Lisci
+
+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,33 @@
+# Rcom
+
+Redis inter-service messaging: request-response, publish-subscribe and tasks. A thin, minimal layer on top of [Redis-rb](https://github.com/redis/redis-rb).
+
+## Installation.
+
+- [Install](http://redis.io/topics/quickstart) a local Redis server and start it:
+```sh
+# OSX example
+$ brew install redis
+$ redis-server
+```
+
+- Add rcom to your Gemfile:
+```ruby
+gem 'rcom'
+```
+
+## Usage.
+
+## Test.
+
+## Contributing.
+
+1. Fork it ( https://github.com/badshark/rcom/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 a new Pull Request
+
+## License.
+
+[MIT](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:spec) do |t|
+    t.pattern = 'test/spec/*_spec.rb'
+  end
+
+  Rake::TestTask.new(:all) do |t|
+    t.pattern = 'test/**/*.rb'
+  end
+end
+
+

data/lib/rcom/node.rb

@@ -0,0 +1,14 @@
+module Rcom
+  class Node
+    attr_reader :uri
+
+    def initialize(uri)
+      raise ArgumentError unless ENV[uri.upcase]
+      @uri = ENV[uri.upcase]
+    end
+
+    def connect
+      Redis.new(url: uri)
+    end
+  end
+end

data/lib/rcom/rpc.rb

@@ -0,0 +1,53 @@
+module Rcom
+  class Rpc
+    attr_reader :node, :service
+
+    def initialize(params)
+      @node = params[:node]
+      @service = params[:service]
+    end
+
+    def request(params)
+      request = {
+        id: SecureRandom.hex,
+        method: params[:method],
+        args: params[:args]
+      }
+      node.rpush(service, request.to_msgpack)
+      ch, response = node.brpop(request[:id], timeout=10)
+      MessagePack.unpack(
+        response,
+        symbolize_keys: true
+      )
+    end
+
+    def subscribe
+      begin
+        loop do
+          ch, request = node.brpop(service)
+          message = MessagePack.unpack(
+            request,
+            symbolize_keys: true
+          )
+          router = Rcom::Router.new(message)
+          yield router
+          node.rpush(message[:id], router.reply.to_msgpack)
+        end
+      rescue Interrupt => _
+      end
+    end
+  end
+
+  class Router
+    attr_accessor :message, :reply
+
+    def initialize(message)
+      @message = message
+    end
+
+    def on(method)
+      return nil unless message[:method] == method
+      yield message[:args]
+    end
+  end
+end

data/lib/rcom/task.rb

@@ -0,0 +1,28 @@
+module Rcom
+  class Task
+    attr_reader :node, :queue
+
+    def initialize(args)
+      @node = args[:node]
+      @queue = args[:queue]
+    end
+
+    def publish(message)
+      node.lpush(queue, message.to_msgpack)
+    end
+
+    def subscribe
+      begin
+        loop do
+          ch, request = node.brpop(queue)
+          message = MessagePack.unpack(
+            request,
+            symbolize_keys: true
+          )
+          yield message
+        end
+      rescue Interrupt => _
+      end
+    end
+  end
+end

data/lib/rcom/topic.rb

@@ -0,0 +1,29 @@
+module Rcom
+  class Topic
+    attr_reader :node, :key
+
+    def initialize(args)
+      @node = args[:node]
+      @key = args[:key]
+    end
+
+    def publish(message)
+      node.publish(key, message.to_msgpack)
+    end
+
+    def subscribe
+      begin
+        node.subscribe(key) do |on|
+          on.message do |channel, message|
+            message = MessagePack.unpack(
+              message,
+              symbolize_keys: true
+            )
+            yield message
+          end
+        end
+      rescue Interrupt => _
+      end
+    end
+  end
+end

data/lib/rcom/version.rb

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

data/lib/rcom.rb

@@ -0,0 +1,8 @@
+require 'securerandom'
+require 'redis'
+require 'msgpack'
+require 'rcom/version'
+require 'rcom/node'
+require 'rcom/topic'
+require 'rcom/task'
+require 'rcom/rpc'

data/rcom.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rcom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rcom"
+  spec.version       = Rcom::VERSION
+  spec.authors       = ["Marco Lisci"]
+  spec.email         = ["info@badshark.io"]
+  spec.summary       = %q{Redis inter-service messaging.}
+  spec.description   = %q{Redis inter-service messaging: request-response, publish-subscribe and tasks.}
+  spec.homepage      = "https://github.com/badshark/rcom"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+
+  spec.add_dependency "redis", "~> 3.1.0"
+  spec.add_dependency "msgpack", "~> 0.5.9"
+end

data/test/bin/rpc_consumer.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+ENV['LOCAL'] = 'redis://localhost'
+
+require 'rcom'
+require 'json'
+
+node = Rcom::Node.new('local').connect
+service = Rcom::Rpc.new(node: node, service: 'auth')
+
+service.subscribe do |request|
+  request.on('user.key') do |params|
+    request.reply = 'xxxccc'
+  end
+end

data/test/bin/rpc_publisher.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+ENV['LOCAL'] = 'redis://localhost'
+
+require 'rcom'
+require 'json'
+
+message = {
+  method: 'user.key',
+  args: 1
+}
+node = Rcom::Node.new('local').connect
+service = Rcom::Rpc.new(node: node, service: 'auth')
+p service.request(message)

data/test/bin/task_consumer.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+ENV['LOCAL'] = 'redis://localhost'
+
+require 'rcom'
+require 'json'
+
+node = Rcom::Node.new('local').connect
+messages = Rcom::Task.new(node: node, queue: 'messages')
+
+messages.subscribe do |message|
+  sleep 1
+  p message
+end

data/test/bin/task_publisher.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+ENV['LOCAL'] = 'redis://localhost'
+
+require 'rcom'
+require 'json'
+
+message = {
+  id: 1,
+  key: 'xxxccc'
+}
+node = Rcom::Node.new('local').connect
+messages = Rcom::Task.new(node: node, queue: 'messages')
+messages.publish(message)

data/test/bin/topic_publisher.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+ENV['local'] = 'redis://localhost'
+
+require 'rcom'
+require 'json'
+
+message = {
+  id: 1,
+  key: 'xxxccc'
+}
+node = Rcom::Node.new('local').connect
+topic = Rcom::Topic.new(node: node, key: 'users')
+
+topic.publish(message)

data/test/bin/topic_subscriber.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+ENV['local'] = 'redis://localhost'
+
+require 'rcom'
+require 'json'
+
+node = Rcom::Node.new('local').connect
+topic = Rcom::Topic.new(node: node, key: 'users')
+
+topic.subscribe do |message|
+  p message
+end

data/test/spec/_init.rb

@@ -0,0 +1,3 @@
+require 'rcom'
+require 'minitest/autorun'
+require 'minitest/pride'

data/test/spec/node_spec.rb

@@ -0,0 +1,23 @@
+require_relative './_init'
+
+describe 'Node' do
+  before do
+    ENV['LOCAL'] = 'redis://127.0.0.1'
+    @local = Rcom::Node.new('local')
+  end
+
+  it 'represents a Redis connection to a node' do
+    @local.must_be_instance_of Rcom::Node
+  end
+
+  it 'cannot represent a node not present in ENV' do
+    lambda do
+      Rcom::Node.new('mail')
+    end.must_raise ArgumentError
+  end
+
+  it 'can connect to the Redis node' do
+    connection = @local.connect
+    connection.must_be_instance_of Redis
+  end
+end

data/test/spec/rpc_spec.rb

@@ -0,0 +1,37 @@
+require_relative './_init'
+
+describe 'Rpc' do
+  before do
+    ENV['LOCAL'] = 'redis://localhost'
+    @node = Rcom::Node.new('local').connect
+  end
+
+  it 'represents a remote procedure call' do
+    service = Rcom::Rpc.new(node: @node, service: 'auth')
+    service.must_be_instance_of Rcom::Rpc
+  end
+
+  it 'works in a request/response scenario' do
+    user_key = 'xxxccc'
+    response = ''
+    publisher = 'bundle exec ruby test/bin/rpc_publisher.rb'
+    consumer = 'bundle exec ruby test/bin/rpc_consumer.rb'
+
+    # Start the consumer, wait for it to be up,
+    # start the publisher and wait for the message
+    # on the consumer side. Process, then kill
+    # the long-running consumer.
+
+    consumer_pid = spawn(consumer)
+    sleep 1
+
+    Open3.popen3(publisher) do |stdin, stdout, stderr, wait_thr|
+      response = stdout.gets
+      Process.kill('INT', wait_thr.pid)
+    end
+
+    Process.kill('INT', consumer_pid)
+
+    eval(response.chomp).must_equal user_key
+  end
+end

data/test/spec/task_spec.rb

@@ -0,0 +1,36 @@
+require_relative './_init'
+
+describe 'Task' do
+  # Doesn't stop processes
+  before do
+    ENV['LOCAL'] = 'redis://localhost'
+    @node = Rcom::Node.new('local').connect
+  end
+
+  it 'represents a Task' do
+    task = Rcom::Task.new(node: @node, queue: 'messages')
+    task.must_be_instance_of Rcom::Task
+  end
+
+  it 'works in a pub/consumer scenario' do
+    message = {
+      id: 1,
+      key: 'xxxccc'
+    }
+    completed_job = ''
+    publisher = 'bundle exec ruby test/bin/task_publisher.rb'
+    consumer = 'bundle exec ruby test/bin/task_consumer.rb'
+
+    # Start the consumer, wait for it to be up,
+    # start the publisher and wait for the message
+    # on the consumer side. Process, then kill
+    # the long-running consumer.
+    Open3.popen3(consumer) do |stdin, stdout, stderr, wait_thr|
+      spawn(publisher)
+      completed_job = stdout.gets
+      Process.kill('INT', wait_thr.pid)
+    end
+
+    eval(completed_job.chomp).must_equal message
+  end
+end

data/test/spec/topic_spec.rb

@@ -0,0 +1,37 @@
+require_relative './_init'
+
+describe 'Topic' do
+  before do
+    ENV['LOCAL'] = 'redis://localhost'
+    @node = Rcom::Node.new('local').connect
+  end
+
+  it 'represents a Topic' do
+    topic = Rcom::Topic.new(node: @node, key: 'users')
+    topic.must_be_instance_of Rcom::Topic
+  end
+
+  it 'works in a pub/sub scenario' do
+    message = {
+      id: 1,
+      key: 'xxxccc'
+    }
+    read_message = ''
+    publisher = 'bundle exec ruby test/bin/topic_publisher.rb'
+    subscriber = 'bundle exec ruby test/bin/topic_subscriber.rb'
+
+    # Start the subscriber, wait for it to be up,
+    # start the publisher and wait for the message
+    # on the subscriber side. Then kill
+    # the long-running subscriber.
+    Open3.popen3(subscriber) do |stdin, stdout, stderr, wait_thr|
+      sleep 1
+      spawn(publisher)
+      read_message = stdout.gets
+      Process.kill('INT', wait_thr.pid)
+    end
+
+    output = eval read_message.chomp
+    output.must_equal message
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: rcom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marco Lisci
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9
+description: 'Redis inter-service messaging: request-response, publish-subscribe and
+  tasks.'
+email:
+- info@badshark.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rcom.rb
+- lib/rcom/node.rb
+- lib/rcom/rpc.rb
+- lib/rcom/task.rb
+- lib/rcom/topic.rb
+- lib/rcom/version.rb
+- rcom.gemspec
+- test/bin/rpc_consumer.rb
+- test/bin/rpc_publisher.rb
+- test/bin/task_consumer.rb
+- test/bin/task_publisher.rb
+- test/bin/topic_publisher.rb
+- test/bin/topic_subscriber.rb
+- test/spec/_init.rb
+- test/spec/node_spec.rb
+- test/spec/rpc_spec.rb
+- test/spec/task_spec.rb
+- test/spec/topic_spec.rb
+homepage: https://github.com/badshark/rcom
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Redis inter-service messaging.
+test_files:
+- test/bin/rpc_consumer.rb
+- test/bin/rpc_publisher.rb
+- test/bin/task_consumer.rb
+- test/bin/task_publisher.rb
+- test/bin/topic_publisher.rb
+- test/bin/topic_subscriber.rb
+- test/spec/_init.rb
+- test/spec/node_spec.rb
+- test/spec/rpc_spec.rb
+- test/spec/task_spec.rb
+- test/spec/topic_spec.rb
+has_rdoc: