rocketman 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52b5a1cb157137e4894f21237379ea6bfa577c1029cf3f6cfc435eb18b19c767
-  data.tar.gz: 1d47bc328a3ff19de8c15acd34ada270343d626335406878c967b4b734e3f213
+  metadata.gz: c4c53df1e5764393ba4c82cab6335b4e30e21d5fb98cabd9eedeee06269f9f49
+  data.tar.gz: ea9d6e275d988d72dda04fe568051238cc9b5e6b55b1c663d4e7e85097f51702
 SHA512:
-  metadata.gz: 26f006bd824c1993463984c6b57401fb866ad2293585c72b01506000e6af18f9358d90cd9b8558f17796820f7d20d4aa0da145cdcdd490e358d396788d187a32
-  data.tar.gz: 05ee47a76e61a3d6700e28a1208d80e856731d160330c373fa86cd4d38a471b8f7bcba481d9a55924dcc5ddd7171ccc311a355426919ec3763c2ff33cd18fd2f
+  metadata.gz: bc991a79bd61cab01af627031a5ec122ae22bfeff062c214c800fd2d1ba29442f1289b7f136b56ddfa7a8d6dee769f17d70e4a0ec6e23195f7840f6551ddca34
+  data.tar.gz: 6789a883d18b13c1b681b2f924f8a1b903e3dee130a223708822971626d711e91b0016d002865d5ceb6d0d3e444d60f61374a53c92bc08b19ab0b4e136bbfe76

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rocketman (0.2.0)
+    rocketman (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -62,23 +62,24 @@ end
 
 Simple isn't it?
 
-#### Consume events from external services
+#### Consume events from external services (Relays)
 
-If you want to also consume events from external services, you're in luck (well, as long as you're using `Redis` anyway..)
+If you want to also consume events from external services, you can do that too.
 
-Rocketman exposes a `Rocketman::Bridge`, which allows your Ruby code to start consuming events from Redis, **without any changes to your consumers**.
+Rocketman has the concept of a `Relay`. The cool thing is, `Relay`s are just `Producer`s that understand how to relay messages from external services (like `Redis`) into Rocketman events.
 
-This works because `Bridge` will listen for events from those services on behalf of you, and then it'll push those events onto the internal `Registry`.
-
-**This pattern is powerful because this means your consumers do not have to know where the events are coming from, as long as they're registed onto `Registry`.**
-
-Right now, only `Redis` is supported. Assuming you have the `redis` gem installed, this is how you register a bridge.
+Rocketman ships with a `Redis` relay, which you can use it like so (assuming you have Redis installed):
 
 ```ruby
-Rocketman::Bridge.construct(Redis.new)
+require 'rocketman/relay/redis' # This is not required by default, so you need to explicitly require it.
+Rocketman::Relay::Redis.new.start(Redis.new)
 ```
 
-That's all! Rocketman will translate the following
+> **NOTE**: You should always pass in a **new, dedicated** connection to `Redis` to `Bridge#construct`. This is because `redis.psubscribe` will hog the whole Redis connection (not just Ruby process), so `Relay` expects a dedicated connection for itself.
+
+That's it, the `Redis` relay service will now listen for events from external services on behalf of you, and then it'll push those events onto the internal `Registry`.
+
+It'll translate the following:
 
 ```
 redis-cli> PUBLISH hello payload
@@ -94,7 +95,9 @@ end
 
 Notice how it behaves exactly the same as if the events did not come from Redis :)
 
-**NOTE**: You should always pass in a **new, dedicated** connection to `Redis` to `Bridge#construct`. This is because `redis.subscribe` will hog the whole Redis connection (not just Ruby process), so `Bridge` expects a dedicated connection for itself.
+**This pattern is powerful because this means your consumers do not have to know where the events are coming from, as long as they're registed onto `Registry`.**
+
+Right now, only `Redis` is supported, but it is extremely easy to add a `Relay` yourself since it's just a `Producer`. Checkout the implementation of `rocketman/relay/redis` for reference, upstream contributions for services are very welcomed too.
 
 ## Persisting emitted events
 

data/lib/rocketman.rb

@@ -4,4 +4,3 @@ require 'rocketman/registry.rb'
 require 'rocketman/event.rb'
 require 'rocketman/producer.rb'
 require 'rocketman/consumer.rb'
-require 'rocketman/bridge.rb'

data/lib/rocketman/pool.rb

@@ -25,7 +25,7 @@ module Rocketman
     private
 
     def spawn_worker
-      Thread.abort_on_exception = true if Rocketman.configuration.debug
+      Thread.abort_on_exception if Rocketman.configuration.debug
 
       Thread.new do
         loop do

data/lib/rocketman/relay/redis.rb

@@ -0,0 +1,24 @@
+require 'redis'
+
+module Rocketman
+  module Relay
+    class Redis
+      include Rocketman::Producer
+
+      # You should always pass in a new, dedicated connection to `Redis`.
+      # This is because `redis.psubscribe` will hog the whole Redis connection, thus if you pass in an existing Redis connection, you won't be able to do anything with that connection anymore.
+      def start(service)
+        puts "Rocketman> Using Redis as external producer".freeze if Rocketman.configuration.debug
+
+        Thread.abort_on_exception = Rocketman.configuration.debug
+        Thread.new do
+          service.psubscribe("*") do |on|
+            on.pmessage do |_pattern, event, payload|
+              emit(event, payload)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rocketman/version.rb

@@ -1,3 +1,3 @@
 module Rocketman
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketman
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edison Yap
@@ -99,7 +99,6 @@ files:
 - bin/console
 - bin/setup
 - lib/rocketman.rb
-- lib/rocketman/bridge.rb
 - lib/rocketman/config.rb
 - lib/rocketman/consumer.rb
 - lib/rocketman/event.rb
@@ -107,6 +106,7 @@ files:
 - lib/rocketman/pool.rb
 - lib/rocketman/producer.rb
 - lib/rocketman/registry.rb
+- lib/rocketman/relay/redis.rb
 - lib/rocketman/version.rb
 - rocketman.gemspec
 - rocketman.jpg

data/lib/rocketman/bridge.rb

@@ -1,29 +0,0 @@
-module Rocketman
-  class Bridge
-    include Rocketman::Producer
-
-    attr_reader :service
-
-    def initialize(service)
-      @service = service
-    end
-
-    def self.construct(service)
-      instance = new(service)
-
-      case instance.service.class.to_s
-      when "Redis"
-        puts "Rocketman> Using Redis as external producer".freeze
-        Thread.new do
-          instance.service.psubscribe("*") do |on|
-            on.pmessage do |_pattern, event, payload|
-              instance.emit(event, payload)
-            end
-          end
-        end
-      else
-        puts "Rocketman> Don't know how to handle service: `#{service}`"
-      end
-    end
-  end
-end