rcom 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57eeb76581f7c4b2e8a370e59c286e47d4a3eeb8
-  data.tar.gz: d417c03fd9471cf183dcbb2216a62ac9d356bbb6
+  metadata.gz: a4a59231e2507f9f5010d142bfeb28efeba2e8e6
+  data.tar.gz: a141a111f2e29d337ddcad3a60626885e88430bb
 SHA512:
-  metadata.gz: 5be8b6c88113107329e7a061e04ffbd1785111f57c112df4c6edf5ae0833968595678812a0ff79f9e9688b8827eb08087a603c5055dcb2b517e460d809c649c0
-  data.tar.gz: 8bc4c1f4c67821cf3ea3190e6a8b9eb0430f7c09993e27bc13882363be3147a3263b5e0abc4b95e4e689378af3580c81993fa8989e9d0e85a4a52f8db61c5370
+  metadata.gz: b7c512e707d70fb3520bcfab86146053b14949d9d28fb3ed3a73268d1ed5df04c337f7a4766d38d5d4b7480d7e68535ac31870868fd5bc42dff2548fc5288d28
+  data.tar.gz: cf8fe056685e4024d07f5e0829c9f5c911303e75ce5b1f7254796c3a755660041fd4971a60ea353e6c3a7c5b865a0e566d15e0fedeb70831133c091323927ed3

data/README.md

@@ -24,9 +24,12 @@ Rcom supports the request-response, publish-subscribe and task queues patterns f
 
 A node represents a Redis connection to a server address specified with an ENV variable.
 
+```sh
+#.env
+LOCAL=redis://localhost
+```
+
 ```ruby
-# Specify this in your .env file.
-ENV['local'] = 'redis://localhost'
 node = Rcom::Node.new('local').connect
 ```
 

data/lib/rcom/node.rb

@@ -1,12 +1,18 @@
 module Rcom
+  # A node represents a Redis server and has an uri.
   class Node
+    # @return [String]
     attr_reader :uri
 
+    # @param uri [String] Example: 'local'
+    # @raise [ArgumentError] uri is not in .env.
     def initialize(uri)
       raise ArgumentError unless ENV[uri.upcase]
       @uri = ENV[uri.upcase]
     end
 
+    # Connects to Redis.
+    # @return [Redis]
     def connect
       Redis.new(url: uri)
     end

data/lib/rcom/rpc.rb

@@ -1,12 +1,24 @@
 module Rcom
+  # Rpc implements the request/response pattern.
   class Rpc
-    attr_reader :node, :service
+    # @return [Rcom::Node]
+    attr_reader :node
+    # @return [String]
+    attr_reader :service
 
+    # @param params [Hash]
+    # @option params :node [Rcom::Node] Example: Rcom::Node.new('local').connect
+    # @option params :service [String] Example: 'auth'
     def initialize(params)
       @node = params[:node]
       @service = params[:service]
     end
 
+    # @param params [Hash]
+    # @option params :route [String] Example: 'users.key'
+    # @option params :args Example: 1
+    # @return [reply, nil] Returns the reply or nil if the
+    # request can't be processed.
     def request(params)
       begin
         request = {
@@ -27,6 +39,8 @@ module Rcom
       end
     end
 
+    # Subscribe to the service and listen to requests.
+    # @yieldparam router [Rcom::Router] A router to match the request.
     def subscribe
       begin
         loop do
@@ -47,13 +61,16 @@ module Rcom
     end
   end
 
+  # A router can match on a particular route.
   class Router
     attr_accessor :message, :reply
 
+    # @param message [Hash] The message received with the request.
     def initialize(message)
       @message = message
     end
 
+    # @yieldparam args
     def on(route)
       return nil unless message[:route] == route
       yield message[:args]

data/lib/rcom/task.rb

@@ -1,12 +1,18 @@
 module Rcom
+  # Implements tasks and queues.
   class Task
     attr_reader :node, :queue
 
-    def initialize(args)
-      @node = args[:node]
-      @queue = args[:queue]
+    # @param params [Hash]
+    # @option params :node [Rcom::Node]
+    # @option params :queue [String] Example: 'messages'
+    def initialize(params)
+      @node = params[:node]
+      @queue = params[:queue]
     end
 
+    # @param message [Hash]
+    # @return [true, nil] True if the message can be queued, otherwise nil.
     def publish(message)
       begin
         node.lpush(queue, message.to_msgpack)
@@ -16,6 +22,7 @@ module Rcom
       end
     end
 
+    # @yieldparam message [Hash] the message received.
     def subscribe
       begin
         loop do

data/lib/rcom/topic.rb

@@ -1,12 +1,18 @@
 module Rcom
+  # Implements pub/sub over topics.
   class Topic
     attr_reader :node, :key
 
-    def initialize(args)
-      @node = args[:node]
-      @key = args[:key]
+    # @param params [Hash]
+    # @option params :node [Rcom::Node]
+    # @option params :key [String] Example: 'services'
+    def initialize(params)
+      @node = params[:node]
+      @key = params[:key]
     end
 
+    # @param message [Hash]
+    # @return [true, nil] true if it can be published, otherwise nil.
     def publish(message)
       begin
         node.publish(key, message.to_msgpack)
@@ -16,6 +22,7 @@ module Rcom
       end
     end
 
+    # @yieldparam message [Hash] the message received.
     def subscribe
       begin
         node.subscribe(key) do |on|

data/lib/rcom/version.rb

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

data/test/bin/topic_publisher.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-ENV['local'] = 'redis://localhost'
+ENV['LOCAL'] = 'redis://localhost'
 
 require 'rcom'
 

data/test/bin/topic_subscriber.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-ENV['local'] = 'redis://localhost'
+ENV['LOCAL'] = 'redis://localhost'
 
 require 'rcom'
 

metadata

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