mantle 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9faf822274115317d82c5b0e254b7551df79b3f5
-  data.tar.gz: 2f9d06db2359478ca001df1b124eae4a46f84511
+  metadata.gz: 51daa43f7ab8c8a6c1b285092b2bec67b2ebc719
+  data.tar.gz: 8e45e8def173bd53d1ab532e76a4587d6487b304
 SHA512:
-  metadata.gz: 8aa2b4e2059be5955e1f3cf033e0a775db5ffc29fb54947887a709024f9bc8e774ffc00b23d8fc9071685cbaff906b80459ce4908244efd873b981f36703a63f
-  data.tar.gz: 946357abc8c54760e04b0b94f2f66c0238279181fa1b7cda362ae294a20bbf799104079662ef282e9ed6e5ba81aad2a73d600ebe0feefac7aaf13200e7106ad0
+  metadata.gz: 20d6e42054ffaa76766efc3e72ee186d750be5526fc5584c22d5ae5dc278166cc9370efa8e2419afcfb168a7fe112f0256dc24eea6981de881107bb0ef8cfd48
+  data.tar.gz: 5b45d490e2c750fc56a6627aeadbebabdd1f1c8464ab286fe461e854a652f7d9e8839f0905fde09e1a11f72e2243b94156d6943f87ee22b7468bda2a580d1037

data/README.md

@@ -17,12 +17,12 @@ Setup a Rails initializer(`config/initializers/mantle.rb`):
 
 
 ```Ruby
-require_relative '../../app/models/mantle_message_handler'
-
 Mantle.configure do |config|
-  config.message_bus_channels = %w[account:update orders]
   config.message_bus_redis = Redis.new(host: ENV["MESSAGE_BUS_REDIS_URL"] || 'localhost')
-  config.message_handler = MantleMessageHandler
+  config.message_handlers = {
+    'account:update' => 'MyMessageHandler',
+    'order' => ['MyMessageHandler', 'MyOtherMessageHandler']
+  }
 end
 ```
 
@@ -30,11 +30,10 @@ The config takes a number of options, many of which have defaults:
 
 ```Ruby
 Mantle.configure do |config|
-  config.message_bus_channels = ['deal:update', 'create:person'] # default: []
   config.message_bus_redis = Redis.new(host: 'localhost') # default: localhost
-  config.message_handler = MyMessageHandler # requires implementation
   config.logger = Rails.logger # default: Logger.new(STDOUT)
   config.redis_namespace = "my-namespace" # default: no namespace
+  config.message_handlers = {'deal:update' => 'MyHandler'} # default: {}
 end
 ```
 

data/lib/generators/mantle/install/templates/mantle.rb

@@ -1,9 +1,9 @@
 # require 'sidekiq-pro'
-require_relative '../../app/models/mantle_message_handler'
 
 Mantle.configure do |config|
-  config.message_bus_channels = %w[]
-  config.message_bus_redis = Redis.new(host: ENV["MESSAGE_BUS_REDIS_URL"] || 'localhost')
-  config.message_handler = MantleMessageHandler
+  config.message_bus_redis = Redis.new(
+    host: ENV.fetch('MESSAGE_BUS_REDIS_URL', 'localhost')
+  )
+  config.message_handlers = {}
 end
 

data/lib/mantle.rb

@@ -12,11 +12,14 @@ require_relative 'mantle/catch_up'
 require_relative 'mantle/configuration'
 require_relative 'mantle/error'
 require_relative 'mantle/local_redis'
+require_relative 'mantle/logger'
 require_relative 'mantle/message'
 require_relative 'mantle/message_bus'
 require_relative 'mantle/message_handler'
+require_relative 'mantle/message_handlers'
 require_relative 'mantle/message_router'
 require_relative 'mantle/workers/catch_up_cleanup_worker'
+require_relative 'mantle/workers/message_handler_worker'
 require_relative 'mantle/workers/process_worker'
 require_relative 'mantle/version'
 
@@ -29,14 +32,18 @@ module Mantle
 
   def self.configure
     self.configuration ||= Configuration.new
-    yield(configuration) if block_given?
+    yield configuration if block_given?
   end
 
   def self.receive_message(channel, message)
     Mantle.logger.debug("Message received on channel: #{channel}")
     Mantle.logger.debug("Mantle message: #{message}")
 
-    self.configuration.message_handler.receive(channel, message)
+    self.configuration.message_handlers.receive_message channel, message
+  end
+
+  def self.channels
+    configuration.message_handlers.channels
   end
 
   def self.logger

data/lib/mantle/catch_up.rb

@@ -9,7 +9,7 @@ module Mantle
 
     def initialize
       @redis = Mantle.configuration.message_bus_redis
-      @message_bus_channels = Mantle.configuration.message_bus_channels
+      @message_bus_channels = Mantle.channels
       @key = KEY
     end
 
@@ -32,7 +32,7 @@ module Mantle
 
     def clear_expired
       max_time_to_clear = hours_ago_in_seconds(HOURS_TO_KEEP)
-      redis.zremrangebyscore(key, 0 , max_time_to_clear)
+      redis.zremrangebyscore(key, 0, max_time_to_clear)
     end
 
     def catch_up
@@ -65,8 +65,7 @@ module Mantle
     end
 
     def deserialize_payload(payload)
-      res = JSON.parse(payload)
-      [res.fetch("channel"), res.fetch("message")]
+      JSON(payload).values_at 'channel', 'message'
     end
 
     def hours_ago_in_seconds(hours)
@@ -77,8 +76,7 @@ module Mantle
     private
 
     def serialize_payload(channel, message)
-      payload = { channel: channel, message: message }
-      JSON.generate(payload)
+      JSON({channel: channel, message: message})
     end
   end
 end

data/lib/mantle/cli.rb

@@ -40,11 +40,9 @@ module Mantle
     end
 
     def load_config
-      if options[:config]
-        require File.expand_path(options[:config])
-      else
-        require File.expand_path("./config/initializers/mantle")
-      end
+      require File.expand_path(
+        options.fetch :config, './config/initializers/mantle'
+      )
     end
 
     def configure_sidekiq

data/lib/mantle/configuration.rb

@@ -1,27 +1,19 @@
-require 'logger'
-
 module Mantle
   class Configuration
+    attr_accessor :message_bus_redis,
+                  :logger,
+                  :redis_namespace
 
-    attr_accessor :message_bus_channels,
-      :message_bus_redis,
-      :message_handler,
-      :logger,
-      :redis_namespace
+    attr_reader :message_handlers
 
     def initialize
-      @message_bus_channels = []
-      @message_handler = Mantle::MessageHandler
-      @logger = default_logger
+      @message_handlers = Mantle::MessageHandlers.new
+      @logger = Logger.new
       @redis_namespace = nil
     end
 
-    private
-
-    def default_logger
-      logger = Logger.new(STDOUT)
-      logger.level = Logger::INFO
-      logger
+    def message_handlers=(hash_instance)
+      @message_handlers = Mantle::MessageHandlers.new(hash_instance)
     end
   end
 end

data/lib/mantle/error.rb

@@ -1,6 +1,11 @@
 module Mantle
-  module Error
-    MissingRedisConnection = Class.new(StandardError)
-    MissingImplementation = Class.new(StandardError)
+  class Error < StandardError
+    MissingRedisConnection = Class.new(Error)
+
+    class MissingImplementation < Error
+      def message
+        "Implement self.receive(channel, object) and assign class to the message handler"
+      end
+    end
   end
 end

data/lib/mantle/logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Mantle
+  class Logger < Logger
+    def initialize
+      super STDOUT
+      self.level = Logger::INFO
+      self
+    end
+  end
+end

data/lib/mantle/message_bus.rb

@@ -4,7 +4,6 @@ module Mantle
 
     def initialize
       @redis = Mantle.configuration.message_bus_redis
-      @channels = Mantle.configuration.message_bus_channels
     end
 
     def publish(channel, message)
@@ -27,9 +26,13 @@ module Mantle
     def subscribe_to_channels
       raise Mantle::Error::MissingRedisConnection unless redis
 
-      Mantle.logger.info("Subscribing to message bus for #{channels} ")
+      if Mantle.channels.any?
+        Mantle.logger.info("Subscribing to message bus for #{Mantle.channels} ")
+      else
+        Mantle.logger.info("No channels configured for subscription. Configure 'message_handlers' if this was unintentional.") and return
+      end
 
-      redis.subscribe(channels) do |on|
+      redis.subscribe(Mantle.channels) do |on|
         on.message do |channel, json_message|
           message = JSON.parse(json_message)
           Mantle::MessageRouter.new(channel, message).route
@@ -39,6 +42,6 @@ module Mantle
 
     private
 
-    attr_reader :redis, :channels
+    attr_reader :redis
   end
 end

data/lib/mantle/message_handler.rb

@@ -1,7 +1,7 @@
 module Mantle
   class MessageHandler
     def self.receive(channel, message)
-      raise Mantle::Error::MissingImplementation.new("Implement self.receive(channel, object) and assign class to the message handler")
+      raise Mantle::Error::MissingImplementation
     end
   end
 end

data/lib/mantle/message_handlers.rb

@@ -0,0 +1,19 @@
+module Mantle
+  class MessageHandlers < SimpleDelegator
+    def initialize(hash_instance = {})
+      super hash_instance
+    end
+
+    def receive_message(channel, message)
+      Array(fetch(channel)).each do |string_handler|
+        Mantle::Workers::MessageHandlerWorker.perform_async(
+          string_handler, channel, message
+        )
+      end
+    end
+
+    def channels
+      keys
+    end
+  end
+end

data/lib/mantle/version.rb

@@ -1,3 +1,3 @@
 module Mantle
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/lib/mantle/workers/message_handler_worker.rb

@@ -0,0 +1,15 @@
+module Mantle
+  module Workers
+    class MessageHandlerWorker
+      include Sidekiq::Worker
+
+      sidekiq_options queue: :mantle
+
+      def perform(string_handler, channel, message)
+        handler = Object.const_get(string_handler)
+        handler.receive channel, message
+      end
+    end
+  end
+end
+

data/spec/lib/mantle/configuration_spec.rb

@@ -1,35 +1,22 @@
 require 'spec_helper'
 
 describe Mantle::Configuration do
-  it 'can set/get message_bus_channels' do
-    config = Mantle::Configuration.new
-    config.message_bus_channels = ["update"]
-    expect(config.message_bus_channels).to eq(Array("update"))
-  end
-
-  it 'sets default message_bus_channels' do
-    config = Mantle::Configuration.new
-    expect(config.message_bus_channels).to eq([])
-  end
-
   it 'can set/get message_bus_redis' do
     redis = double("redis")
     config = Mantle::Configuration.new
-    config.message_bus_channels = redis
-    expect(config.message_bus_channels).to eq(redis)
+    config.message_bus_redis = redis
+    expect(config.message_bus_redis).to eq(redis)
   end
 
-  it 'can set/get message_handler' do
-    FakeHandler = Class.new
-
+  it 'can set/get message_handlers' do
     config = Mantle::Configuration.new
-    config.message_handler = FakeHandler
-    expect(config.message_handler).to eq(FakeHandler)
+    config.message_handlers = {'a_channel' => 'FakeHandler'}
+    expect(config.message_handlers).to eq({'a_channel' => 'FakeHandler'})
   end
 
   it 'configures default message handler' do
     config = Mantle::Configuration.new
-    expect(config.message_handler).to eq(Mantle::MessageHandler)
+    expect(config.message_handlers).to be_instance_of(Mantle::MessageHandlers)
   end
 
   it 'can set/get logger' do
@@ -55,5 +42,3 @@ describe Mantle::Configuration do
     expect(config.redis_namespace).to eq(nil)
   end
 end
-
-

data/spec/lib/mantle/message_bus_spec.rb

@@ -38,6 +38,35 @@ describe Mantle::MessageBus do
   end
 
   describe "#subscribe_to_channels" do
+    context 'properly setup message handlers' do
+      before :each do
+        Mantle.configure do |c|
+          c.message_handlers = {
+          "order" => "OrderHandler",
+          "call" => "CallHandler"
+          }
+        end
+      end
+
+      it "subscribes to channels configured" do
+        redis = double("redis")
+        mb = Mantle::MessageBus.new
+        mb.redis = redis
+
+        expect(redis).to receive(:subscribe).with(["order", "call"]) { true }
+        mb.subscribe_to_channels
+      end
+    end
+
+    it "skips subscription if no channels" do
+      redis = double("redis")
+      mb = Mantle::MessageBus.new
+      mb.redis = redis
+
+      expect(redis).to_not receive(:subscribe) { true }
+      mb.subscribe_to_channels
+    end
+
     it "raises without redis connection" do
       mb = Mantle::MessageBus.new
       mb.redis = nil

data/spec/lib/mantle/message_handler_spec.rb

@@ -9,4 +9,3 @@ describe Mantle::MessageHandler do
     end
   end
 end
-

data/spec/lib/mantle/message_handlers_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Mantle::MessageHandlers do
+  describe '#receive_message' do
+    it 'enqueues a job for each handler' do
+      channel = "person:create"
+      message = { "id" => 4 }
+      message_handlers = {
+        "person:create" => ['FakeHandler', 'OtherFakeHandler']
+      }
+
+      expect {
+        Mantle::MessageHandlers.new(message_handlers).receive_message(channel, message)
+      }.to change(Mantle::Workers::MessageHandlerWorker.jobs, :size).by(2)
+
+      args = Mantle::Workers::MessageHandlerWorker.jobs[0]["args"]
+      expect(args[0]).to eq("FakeHandler")
+      expect(args[1]).to eq(channel)
+      expect(args[2]).to eq(message)
+
+      args = Mantle::Workers::MessageHandlerWorker.jobs[1]["args"]
+      expect(args[0]).to eq("OtherFakeHandler")
+      expect(args[1]).to eq(channel)
+      expect(args[2]).to eq(message)
+    end
+  end
+end

data/spec/lib/mantle/workers/message_handler_worker_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Mantle::Workers::MessageHandlerWorker do
+  let(:channel) { "person:create" }
+  let(:message) { {'data' => {'whatever' => 1234}} }
+
+  describe "#perform" do
+    it "delegates to handler with channel/message" do
+      class_double('FakeHandler').as_stubbed_const
+      FakeHandler.define_singleton_method :receive do |channel, message|
+      end
+
+      expect(FakeHandler).to receive(:receive).with(channel, message)
+      Mantle::Workers::MessageHandlerWorker.new.perform("FakeHandler", channel, message)
+    end
+  end
+end

data/spec/lib/mantle_spec.rb

@@ -7,12 +7,24 @@ describe Mantle do
       Mantle.configuration.message_bus_redis = "redis"
       expect(Mantle.configuration.message_bus_redis).to eq("redis")
     end
+
+    it 'allows message_handlers to be set' do
+      handler_config = { "order" => "OrderHandler" }
+      Mantle.configure { |c| c.message_handlers = handler_config }
+      expect(Mantle.configuration.message_handlers).to eq(handler_config)
+    end
   end
 
   describe ".receive_message" do
-    it 'delegates to message handler' do
-      expect(Mantle.configuration.message_handler).to receive(:receive).with("deal:update", {})
-      Mantle.receive_message("deal:update", {})
+    it "delegates to the given channel's message handlers" do
+      message = double('message')
+
+      Mantle.configuration.message_handlers = {
+        'deal:update' => ['MessageHandler', 'MessageHandler2']
+      }
+
+      expect(Mantle.configuration.message_handlers).to receive(:receive_message).with 'deal:update', message
+      Mantle.receive_message 'deal:update', message
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mantle
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Grant Ammons
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -94,13 +94,16 @@ files:
 - lib/mantle/configuration.rb
 - lib/mantle/error.rb
 - lib/mantle/local_redis.rb
+- lib/mantle/logger.rb
 - lib/mantle/message.rb
 - lib/mantle/message_bus.rb
 - lib/mantle/message_handler.rb
+- lib/mantle/message_handlers.rb
 - lib/mantle/message_router.rb
 - lib/mantle/railtie.rb
 - lib/mantle/version.rb
 - lib/mantle/workers/catch_up_cleanup_worker.rb
+- lib/mantle/workers/message_handler_worker.rb
 - lib/mantle/workers/process_worker.rb
 - mantle.gemspec
 - spec/lib/mantle/catch_up_spec.rb
@@ -108,9 +111,11 @@ files:
 - spec/lib/mantle/local_redis_spec.rb
 - spec/lib/mantle/message_bus_spec.rb
 - spec/lib/mantle/message_handler_spec.rb
+- spec/lib/mantle/message_handlers_spec.rb
 - spec/lib/mantle/message_router_spec.rb
 - spec/lib/mantle/message_spec.rb
 - spec/lib/mantle/workers/catch_up_cleanup_worker_spec.rb
+- spec/lib/mantle/workers/message_handler_worker_spec.rb
 - spec/lib/mantle/workers/process_worker_spec.rb
 - spec/lib/mantle_spec.rb
 - spec/spec_helper.rb
@@ -133,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby application message bus subscriptions with Sidekiq and Redis Pubsub.
@@ -143,9 +148,11 @@ test_files:
 - spec/lib/mantle/local_redis_spec.rb
 - spec/lib/mantle/message_bus_spec.rb
 - spec/lib/mantle/message_handler_spec.rb
+- spec/lib/mantle/message_handlers_spec.rb
 - spec/lib/mantle/message_router_spec.rb
 - spec/lib/mantle/message_spec.rb
 - spec/lib/mantle/workers/catch_up_cleanup_worker_spec.rb
+- spec/lib/mantle/workers/message_handler_worker_spec.rb
 - spec/lib/mantle/workers/process_worker_spec.rb
 - spec/lib/mantle_spec.rb
 - spec/spec_helper.rb