sidekiq-eventbus 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d18656702ca14b2606e45d4ac95c2b4b76ddddfe
-  data.tar.gz: bbddfe1f125ac1d78311396e4a63e3c85a83b978
+SHA256:
+  metadata.gz: e246cbcc36a0dd6d362dc9c5d505094ecd66bf11e620334cd80ca3e1b9042b97
+  data.tar.gz: ba94de9927238c7d79c018d3c4776f1c7ca35eb0f989a5994c6a2c71d5f3a888
 SHA512:
-  metadata.gz: 6b93677fca1044d58c33717d9ab8110c4862f1cbd986d7a61ca5e5af4a5de12c7b18a6f47b38733cff0acad3a69437d793f9059ae4cc72e84da9f07b813a3523
-  data.tar.gz: 801e04b38f6f341c8a01733cf883bac44206c496cd3fa444b991ff6105aaa47b6fbf99f6231146afe9845b6df9ee1805cb1b91025828e69095d2e0ed8cab3b06
+  metadata.gz: c2265fdd50b3c914024bada3ee1012044d6eb2f7aca03c3961940e07e814a01b18717124aa8fabe0d19b48a4d1b6a0e40e4d537778cf062299feb7a85219a7f2
+  data.tar.gz: f7ab5f88503302c094bd0616c60db5fd5d9d2b7b63dc7c216239e18ea1c7f920d85b1343a12f25275c93dcd13ee9e26c083429b73f4b3c12b1b3de73cd31e790

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright 2016 Rakefire LLC
+
+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,4 @@
+# sidekiq-eventbus
+
+A simple event bus implementation written to offload event handling via Sidekiq.
+

data/lib/sidekiq/event_bus.rb

@@ -1,2 +1,33 @@
-module Sidekiq::EventBus
-end
+require 'sidekiq'
+
+module Sidekiq
+  module EventBus
+    autoload :Configuration,    'sidekiq/event_bus/configuration'
+    autoload :Utils,            'sidekiq/event_bus/utils'
+
+    autoload :Consumer,         'sidekiq/event_bus/consumer'
+    autoload :Producer,         'sidekiq/event_bus/producer'
+
+    autoload :EventWorker,      'sidekiq/event_bus/event_worker'
+
+    module Adapters
+      autoload :Default,        'sidekiq/event_bus/adapters/default'
+      autoload :Buffered,       'sidekiq/event_bus/adapters/buffered'
+      autoload :Inline,         'sidekiq/event_bus/adapters/inline'
+      autoload :Test,           'sidekiq/event_bus/adapters/test'
+      autoload :Log,            'sidekiq/event_bus/adapters/log'
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    def self.utils
+      @utils ||= Utils.new(config)
+    end
+
+    def self.configure
+      yield(config) if block_given?
+    end
+  end
+end

data/lib/sidekiq/event_bus/adapters/buffered.rb

@@ -0,0 +1,53 @@
+require 'concurrent'
+
+class Sidekiq::EventBus::Adapters::Buffered
+  def initialize adapter: Sidekiq::EventBus::Adapters::Default.new
+    @adapter  = adapter
+    @bufferes = Concurrent::Map.new
+  end
+
+  def push event, payload
+    if is_buffered?
+      event_buffer << [ event, payload ]
+      nil
+    else
+      @adapter.push(event, payload)
+    end
+  end
+
+  def buffered
+    buffer!
+    begin
+      yield
+      flush!
+    ensure
+      clear!
+    end
+  end
+
+  def event_buffer
+    @bufferes[buffer_key] ||= Array.new
+  end
+
+  def is_buffered?
+    @bufferes.key?(buffer_key)
+  end
+
+  def buffer!
+    @bufferes[buffer_key] ||= Array.new
+  end
+
+  def flush!
+    event_buffer.map do |event, payload|
+      @adapter.push(event, payload)
+    end
+  end
+
+  def clear!
+    @bufferes.delete(buffer_key)
+  end
+
+  def buffer_key
+    Thread.current.object_id
+  end
+end

data/lib/sidekiq/event_bus/adapters/default.rb

@@ -0,0 +1,8 @@
+class Sidekiq::EventBus::Adapters::Default
+  def push event, payload
+    Sidekiq::Client.push({
+      'class' => Sidekiq::EventBus::EventWorker,
+      'args'  => [ event, payload ]
+    })
+  end
+end

data/lib/sidekiq/event_bus/adapters/inline.rb

@@ -0,0 +1,6 @@
+class Sidekiq::EventBus::Adapters::Inline
+  def push event, payload
+    Sidekiq::EventBus.utils.handle_event(event, payload)
+    SecureRandom.hex(8)
+  end
+end

data/lib/sidekiq/event_bus/adapters/log.rb

@@ -0,0 +1,7 @@
+class Sidekiq::EventBus::Adapters::Log
+  def push event, payload
+    id = SecureRandom.hex(8)
+    puts "event=#{event}  id=#{id}  payload=#{payload.to_json}"
+    id
+  end
+end

data/lib/sidekiq/event_bus/adapters/test.rb

@@ -0,0 +1,22 @@
+class Sidekiq::EventBus::Adapters::Test
+  attr_accessor :events
+
+  def initialize
+    self.events = []
+  end
+
+  def push event, payload
+    id = SecureRandom.hex(8)
+    self.events.push({
+      event:    event,
+      payload:  payload,
+      id:       id
+    })
+
+    id
+  end
+
+  def clear!
+    self.events.clear
+  end
+end

data/lib/sidekiq/event_bus/configuration.rb

@@ -0,0 +1,14 @@
+class Sidekiq::EventBus::Configuration
+  attr_accessor :adapter, :consumers, :sidekiq_worker_options, :error_handler
+
+  def initialize
+    self.adapter                = Sidekiq::EventBus::Adapters::Default.new
+    self.consumers              = Set.new
+    self.sidekiq_worker_options = { retry: 0, dead: true }
+  end
+
+  def register_consumer klass
+    klass = klass.name unless klass.is_a?(String)
+    consumers << klass
+  end
+end

data/lib/sidekiq/event_bus/consumer.rb

@@ -0,0 +1,44 @@
+class Sidekiq::EventBus::Consumer
+  def self.register_consumer!
+    Sidekiq::EventBus.config.register_consumer(self)
+  end
+
+  # Store handlers for this consumer
+  def self.handlers
+    @handlers ||= Hash.new { |hash, key| hash[key] = Array.new }
+  end
+
+
+  # Register a handler for a particular event
+  def self.on event, handler=nil, &block
+    if handler
+      handlers[event] << handler
+    else
+      handlers[event] << block
+    end
+  end
+
+  PAYLOAD_WITH_INDIFFERENT_ACCESS = defined?(ActiveSupport::HashWithIndifferentAccess)
+
+  def consume event, payload
+    if self.class.handlers.key? event
+      _payload = payload.merge('event'.freeze => event).freeze
+
+      if PAYLOAD_WITH_INDIFFERENT_ACCESS
+        _payload = ActiveSupport::HashWithIndifferentAccess.new(_payload)
+      end
+
+      self.class.handlers[event].each do |handler|
+        begin
+          if handler.is_a? Proc
+            instance_exec( _payload.dup, &handler )
+          else
+            handler.call( _payload.dup )
+          end
+        rescue => e
+          Sidekiq::EventBus.utils.handle_error(e)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/event_bus/event_worker.rb

@@ -0,0 +1,9 @@
+class Sidekiq::EventBus::EventWorker
+  include Sidekiq::Worker
+
+  sidekiq_options Sidekiq::EventBus.config.sidekiq_worker_options
+
+  def perform(event, payload)
+    Sidekiq::EventBus.utils.handle_event(event, payload)
+  end
+end

data/lib/sidekiq/event_bus/producer.rb

@@ -0,0 +1,11 @@
+class Sidekiq::EventBus::Producer
+  attr_reader :adapter
+
+  def initialize adapter: Sidekiq::EventBus.config.adapter
+    @adapter = adapter
+  end
+
+  def publish event, payload
+    adapter.push event, payload
+  end
+end

data/lib/sidekiq/event_bus/utils.rb

@@ -0,0 +1,25 @@
+class Sidekiq::EventBus::Utils
+  attr_reader :config
+
+  def initialize config
+    @config = config
+  end
+
+  def consumers
+    config.consumers.map do |klass_name|
+      klass_name.constantize.new
+    end
+  end
+
+  def handle_event event, payload
+    consumers.each do |consumer|
+      consumer.consume(event, payload)
+    end
+  end
+
+  def handle_error exception
+    unless config.error_handler.nil?
+      config.error_handler.call(exception)
+    end
+  end
+end

data/lib/sidekiq/event_bus/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module EventBus
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -1,28 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-eventbus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Phil Monroe
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-21 00:00:00.000000000 Z
-dependencies: []
-description: A simple Producer/Consumer event bus extension for Sidekiq
+date: 2020-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A simple asynchronous Producer/Consumer event bus extension for Sidekiq
 email: phil@rakefire.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
 - lib/sidekiq-eventbus.rb
 - lib/sidekiq/event_bus.rb
+- lib/sidekiq/event_bus/adapters/buffered.rb
+- lib/sidekiq/event_bus/adapters/default.rb
+- lib/sidekiq/event_bus/adapters/inline.rb
+- lib/sidekiq/event_bus/adapters/log.rb
+- lib/sidekiq/event_bus/adapters/test.rb
+- lib/sidekiq/event_bus/configuration.rb
+- lib/sidekiq/event_bus/consumer.rb
+- lib/sidekiq/event_bus/event_worker.rb
+- lib/sidekiq/event_bus/producer.rb
+- lib/sidekiq/event_bus/utils.rb
+- lib/sidekiq/event_bus/version.rb
 homepage: https://github.com/Rakefire/sidekiq-eventbus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -37,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: A simple Producer/Consumer event bus extension for Sidekiq
+summary: Producer/Consumer event bus via Sidekiq
 test_files: []