rcom 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95a36229bc381e17c5190154a0679add12a794bf
-  data.tar.gz: ab8d5adbcb9b0a599a3da61badd4197dfec6c732
+  metadata.gz: 57eeb76581f7c4b2e8a370e59c286e47d4a3eeb8
+  data.tar.gz: d417c03fd9471cf183dcbb2216a62ac9d356bbb6
 SHA512:
-  metadata.gz: d2199539d074722c55d225ac420f953fc6299d15c24569d7e2e9ce1f58031d3ddc1b3782a23b2c340083b13768a1a6a0f485958c5aee4284e5f840ebc5a67df2
-  data.tar.gz: 28cf9fd25c94b73073c0cd3aeaa77fdccb2544c1a27a518d7da2401f1252c347eaea9d38fdeddd6f5c4f4b0a15396263dedf001440c873a815ffeba10ebcdc55
+  metadata.gz: 5be8b6c88113107329e7a061e04ffbd1785111f57c112df4c6edf5ae0833968595678812a0ff79f9e9688b8827eb08087a603c5055dcb2b517e460d809c649c0
+  data.tar.gz: 8bc4c1f4c67821cf3ea3190e6a8b9eb0430f7c09993e27bc13882363be3147a3263b5e0abc4b95e4e689378af3580c81993fa8989e9d0e85a4a52f8db61c5370

data/README.md

@@ -1,6 +1,6 @@
 # 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).
+[Redis](http://redis.io) inter-service messaging: request-response, publish-subscribe and task queues. A thin, minimal layer on top of [Redis-rb](https://github.com/redis/redis-rb).
 
 ## Installation.
 
@@ -18,8 +18,121 @@ gem 'rcom'
 
 ## Usage.
 
+Rcom supports the request-response, publish-subscribe and task queues patterns for inter-service messaging. Publishers are non-blocking, subscribers/consumers are blocking and should be run as independent processes. Processes communicate using MessagePack internally.
+
+### Node.
+
+A node represents a Redis connection to a server address specified with an ENV variable.
+
+```ruby
+# Specify this in your .env file.
+ENV['local'] = 'redis://localhost'
+node = Rcom::Node.new('local').connect
+```
+
+### Topics.
+
+One service might need to update many different services about an event, following the publish-subscribe pattern. You can publish and subscribe to topics on a node, specifying a key.
+
+- Publisher.
+
+```ruby
+message = {
+  id: 1,
+  key: 'xxxccc'
+}
+
+node = Rcom::Node.new('local').connect
+topic = Rcom::Topic.new(node: node, key: 'users')
+
+topic.publish(message)
+```
+
+- Subscriber.
+
+```ruby
+node = Rcom::Node.new('local').connect
+topic = Rcom::Topic.new(node: node, key: 'users')
+
+topic.subscribe do |message|
+  p message
+end
+```
+
+## Tasks.
+
+A service might need to push expensive tasks into a queue and forget about them. Tasks will be processed by consumers listening to the queue.
+
+- Publisher.
+
+```ruby
+message = {
+  id: 1,
+  key: 'xxxccc'
+}
+
+node = Rcom::Node.new('local').connect
+messages = Rcom::Task.new(node: node, queue: 'messages')
+
+messages.publish(message)
+```
+
+- Consumer.
+
+```ruby
+node = Rcom::Node.new('local').connect
+messages = Rcom::Task.new(node: node, queue: 'messages')
+
+messages.subscribe do |message|
+  sleep 1
+  p message
+end
+```
+
+## RPC, requests and responses.
+
+In some cases services need real time informations from other services that can't be asynchronously processed. A service can create a request on a route. The other service listening on the same route will reply to the request.
+
+- Publisher.
+
+```ruby
+message = {
+  route: 'user.key',
+  args: 1
+}
+
+node = Rcom::Node.new('local').connect
+auth = Rcom::Rpc.new(node: node, service: 'auth')
+
+auth.request(message)
+```
+
+- Consumer.
+
+```ruby
+node = Rcom::Node.new('local').connect
+auth = Rcom::Rpc.new(node: node, service: 'auth')
+
+auth.subscribe do |request|
+  request.on('user.key') do |params|
+    request.reply = 'xxxccc'
+  end
+
+  request.on('user.password') do |params|
+    request.reply = 'not authorized'
+  end
+end
+```
+
 ## Test.
 
+- Be sure you have a local Redis server running.
+
+- run tests with:
+```ruby
+bundle exec rake test:spec
+```
+
 ## Contributing.
 
 1. Fork it ( https://github.com/badshark/rcom/fork )

data/lib/rcom/rpc.rb

@@ -8,29 +8,38 @@ module Rcom
     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
-      )
+      begin
+        request = {
+          id: SecureRandom.hex,
+          route: params[:route],
+          args: params[:args] || ''
+        }
+
+        node.rpush(service, request.to_msgpack)
+        ch, response = node.brpop(request[:id], timeout=10)
+
+        MessagePack.unpack(
+          response,
+          symbolize_keys: true
+        )
+      rescue
+        return nil
+      end
     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 => _
@@ -45,8 +54,8 @@ module Rcom
       @message = message
     end
 
-    def on(method)
-      return nil unless message[:method] == method
+    def on(route)
+      return nil unless message[:route] == route
       yield message[:args]
     end
   end

data/lib/rcom/task.rb

@@ -8,7 +8,12 @@ module Rcom
     end
 
     def publish(message)
-      node.lpush(queue, message.to_msgpack)
+      begin
+        node.lpush(queue, message.to_msgpack)
+        return true
+      rescue
+        return nil
+      end
     end
 
     def subscribe

data/lib/rcom/topic.rb

@@ -8,7 +8,12 @@ module Rcom
     end
 
     def publish(message)
-      node.publish(key, message.to_msgpack)
+      begin
+        node.publish(key, message.to_msgpack)
+        return true
+      rescue
+        return nil
+      end
     end
 
     def subscribe

data/lib/rcom/version.rb

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

data/test/bin/rpc_consumer.rb

@@ -2,12 +2,11 @@
 ENV['LOCAL'] = 'redis://localhost'
 
 require 'rcom'
-require 'json'
 
 node = Rcom::Node.new('local').connect
-service = Rcom::Rpc.new(node: node, service: 'auth')
+auth = Rcom::Rpc.new(node: node, service: 'auth')
 
-service.subscribe do |request|
+auth.subscribe do |request|
   request.on('user.key') do |params|
     request.reply = 'xxxccc'
   end

data/test/bin/rpc_publisher.rb

@@ -2,12 +2,11 @@
 ENV['LOCAL'] = 'redis://localhost'
 
 require 'rcom'
-require 'json'
 
 message = {
-  method: 'user.key',
+  route: 'user.key',
   args: 1
 }
 node = Rcom::Node.new('local').connect
-service = Rcom::Rpc.new(node: node, service: 'auth')
-p service.request(message)
+auth = Rcom::Rpc.new(node: node, service: 'auth')
+p auth.request(message)

data/test/bin/task_consumer.rb

@@ -2,7 +2,6 @@
 ENV['LOCAL'] = 'redis://localhost'
 
 require 'rcom'
-require 'json'
 
 node = Rcom::Node.new('local').connect
 messages = Rcom::Task.new(node: node, queue: 'messages')

data/test/bin/task_publisher.rb

@@ -2,7 +2,6 @@
 ENV['LOCAL'] = 'redis://localhost'
 
 require 'rcom'
-require 'json'
 
 message = {
   id: 1,

data/test/bin/topic_publisher.rb

@@ -2,13 +2,12 @@
 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')
+users = Rcom::Topic.new(node: node, key: 'users')
 
-topic.publish(message)
+users.publish(message)

data/test/bin/topic_subscriber.rb

@@ -2,11 +2,10 @@
 ENV['local'] = 'redis://localhost'
 
 require 'rcom'
-require 'json'
 
 node = Rcom::Node.new('local').connect
-topic = Rcom::Topic.new(node: node, key: 'users')
+users = Rcom::Topic.new(node: node, key: 'users')
 
-topic.subscribe do |message|
+users.subscribe do |message|
   p message
 end

data/test/spec/rpc_spec.rb

@@ -4,11 +4,15 @@ describe 'Rpc' do
   before do
     ENV['LOCAL'] = 'redis://localhost'
     @node = Rcom::Node.new('local').connect
+    @service = Rcom::Rpc.new(node: @node, service: 'auth')
   end
 
   it 'represents a remote procedure call' do
-    service = Rcom::Rpc.new(node: @node, service: 'auth')
-    service.must_be_instance_of Rcom::Rpc
+    @service.must_be_instance_of Rcom::Rpc
+  end
+
+  it 'returns nil if the request cannot be processed' do
+    @service.request(route: 'nonexistent').must_equal nil
   end
 
   it 'works in a request/response scenario' do
@@ -17,19 +21,16 @@ describe 'Rpc' do
     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.
-
+    # Spawn consumer and wait for requests.
     consumer_pid = spawn(consumer)
     sleep 1
 
-    Open3.popen3(publisher) do |stdin, stdout, stderr, wait_thr|
+    # Spawn a request and record stdout,
+    # then kill both consumer and publisher.
+    Open3.popen3(publisher) do |stdin, stdout, stderr, thr|
       response = stdout.gets
-      Process.kill('INT', wait_thr.pid)
+      Process.kill('INT', thr.pid)
     end
-
     Process.kill('INT', consumer_pid)
 
     eval(response.chomp).must_equal user_key

data/test/spec/task_spec.rb

@@ -1,15 +1,22 @@
 require_relative './_init'
 
 describe 'Task' do
-  # Doesn't stop processes
   before do
     ENV['LOCAL'] = 'redis://localhost'
     @node = Rcom::Node.new('local').connect
+    @task = Rcom::Task.new(node: @node, queue: 'messages')
   end
 
   it 'represents a Task' do
-    task = Rcom::Task.new(node: @node, queue: 'messages')
-    task.must_be_instance_of Rcom::Task
+    @task.must_be_instance_of Rcom::Task
+  end
+
+  it 'can pubish a task' do
+    message = {
+      id: 1,
+      key: 'xxxccc'
+    }
+    @task.publish(message).must_equal true
   end
 
   it 'works in a pub/consumer scenario' do
@@ -26,6 +33,7 @@ describe 'Task' do
     # on the consumer side. Process, then kill
     # the long-running consumer.
     Open3.popen3(consumer) do |stdin, stdout, stderr, wait_thr|
+      sleep 1
       spawn(publisher)
       completed_job = stdout.gets
       Process.kill('INT', wait_thr.pid)

data/test/spec/topic_spec.rb

@@ -4,11 +4,19 @@ describe 'Topic' do
   before do
     ENV['LOCAL'] = 'redis://localhost'
     @node = Rcom::Node.new('local').connect
+    @topic = Rcom::Topic.new(node: @node, key: 'users')
   end
 
   it 'represents a Topic' do
-    topic = Rcom::Topic.new(node: @node, key: 'users')
-    topic.must_be_instance_of Rcom::Topic
+    @topic.must_be_instance_of Rcom::Topic
+  end
+
+  it 'can publish a message' do
+    message = {
+      id: 1,
+      key: 'xxxccc'
+    }
+    @topic.publish(message).must_equal true
   end
 
   it 'works in a pub/sub scenario' do
@@ -25,13 +33,13 @@ describe 'Topic' do
     # on the subscriber side. Then kill
     # the long-running subscriber.
     Open3.popen3(subscriber) do |stdin, stdout, stderr, wait_thr|
-      sleep 1
+      sleep 2
       spawn(publisher)
       read_message = stdout.gets
       Process.kill('INT', wait_thr.pid)
     end
 
-    output = eval read_message.chomp
+    output = eval(read_message.chomp)
     output.must_equal message
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcom
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marco Lisci