mumukit-nuntius 6.3.1 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c255b6de165a624e8515c2393202a3a30f7a08e9663aaab171b29865ddf4063
-  data.tar.gz: 33ce0083c8f04e3dae69c7a1e801148cc1b418f9afc80f503684c7bb4af78593
+  metadata.gz: 4fc18f07275f31c47b7c319636d863c478db44480df61bd8ccb756b28b8a4ed6
+  data.tar.gz: 062df9f35a58b132f6ee384469024716f99cdab2ee705fb25288bd9b5019d31b
 SHA512:
-  metadata.gz: de02006aad7b5526224b7f9e37b116cd195e1efc1e22ca5e97c25346d0a0c54196e6fa42a4bb3cb658371f2bcd4ca0756ee61503ed743635db7eaa4847e0f83b
-  data.tar.gz: 63bd041fb5c674a2816a5da0d646356054c4e901b1a0d99b3b62c2594f46ca9271e2998d730dc44a8f79b398e2be677e71dd8213af97b215d17a2a05f5695abd
+  metadata.gz: e832561715b9600fc68fb20f1d0f81f246a7ef9a5255184d67827b91b028b306a33303cb9c74ab41b19c4695581c5e87d03caa2c6c69e421bc31b12a33918dcf
+  data.tar.gz: 58d7e01c8438e97a2d647f6f0263192fb7adc3ca8bfc11a4e08ddba02085838fe16a39fba46b1b4507616f1ae31dd407ba6db3cab06641ffac04b1296d767310

data/lib/mumukit/nuntius/event_consumer.rb

@@ -1,62 +1,34 @@
 module Mumukit::Nuntius::EventConsumer
-  class Builder
-    def initialize
-      @handlers = {}
-    end
 
-    def event(key, &block)
-      @handlers[key] = block
-    end
+  extend Mumukit::Nuntius::TaskConsumer
 
-    def build
-      @handlers.with_indifferent_access
-    end
+  class Builder < Mumukit::Nuntius::TaskConsumer::Builder
+    alias_method :event, :task
   end
 
   class << self
-    @@handlers = {}
-
-    def handle(&block)
-      register_handlers! Builder.new.tap { |it| it.instance_eval(&block) }.build
-    end
 
-    def handled_events
-      @@handlers.keys
-    end
+    alias_method :handled_events, :handled_tasks
+    alias_method :handle_event!, :handle_tasks!
 
-    def register_handlers!(handlers)
-      @@handlers = handlers
+    def builder
+      Mumukit::Nuntius::EventConsumer::Builder
     end
 
-    def start!
-      queue_name = "#{Mumukit::Nuntius.config.app_name}-events"
-      Mumukit::Nuntius::Consumer.start queue_name, 'events' do |_delivery_info, properties, body|
-        handle_event!(properties, body)
-      end
+    def tasks_type
+      task_type.pluralize
     end
 
-    def handles?(event)
-      @@handlers.include? event
+    def task_type
+      'event'
     end
 
     def handle_event!(properties, body)
-      return if body[:data][:sender] == Mumukit::Nuntius.config.app_name
-      event = properties[:type]
-      if handles? event
-        @@handlers[event].call body[:data].except(:sender)
-      else
-        log_unknown_event event
-      end
-    rescue => e
-      log_exception(event, e, body[:data])
-    end
-
-    def log_unknown_event(event)
-      Mumukit::Nuntius::Logger.info "Unhandled event: #{event} does not exists."
+      handle_tasks! properties, body
     end
 
-    def log_exception(event, e, body)
-      Mumukit::Nuntius::Logger.error "Failed to proccess #{event}, error was: #{e}, body was: #{body}"
+    def skip_process?(body)
+      body[:data][:sender] == Mumukit::Nuntius.config.app_name
     end
   end
 end

data/lib/mumukit/nuntius/event_publisher.rb

@@ -2,9 +2,9 @@ module Mumukit::Nuntius::EventPublisher
 
   class << self
 
-    def publish(event, payload)
-      payload.merge!(sender: Mumukit::Nuntius.config.app_name)
-      Mumukit::Nuntius::Publisher.publish "events", { data: payload }, { type: event }
+    def publish(event, payload, **options)
+      payload.merge!(sender: Mumukit::Nuntius.config.app_name).merge!(options)
+      Mumukit::Nuntius::Publisher.publish "events", {data: payload}, {type: event}
     end
 
   end

data/lib/mumukit/nuntius/job_consumer.rb

@@ -0,0 +1,30 @@
+module Mumukit::Nuntius::JobConsumer
+
+  extend Mumukit::Nuntius::TaskConsumer
+
+  class Builder < Mumukit::Nuntius::TaskConsumer::Builder
+    alias_method :job, :task
+  end
+
+  class << self
+
+    alias_method :handled_jobs, :handled_tasks
+    alias_method :handle_job!, :handle_tasks!
+
+    def builder
+      Mumukit::Nuntius::JobConsumer::Builder
+    end
+
+    def tasks_type
+      task_type.pluralize
+    end
+
+    def task_type
+      'job'
+    end
+
+    def skip_process?(body)
+      body[:data][:sender].try { |sender| sender != Mumukit::Nuntius.config.app_name }
+    end
+  end
+end

data/lib/mumukit/nuntius/job_publisher.rb

@@ -0,0 +1,11 @@
+module Mumukit::Nuntius::JobPublisher
+
+  class << self
+
+    def publish(job, payload)
+      payload.merge!(sender: Mumukit::Nuntius.config.app_name)
+      Mumukit::Nuntius::Publisher.publish "jobs", {data: payload}, {type: job}
+    end
+
+  end
+end

data/lib/mumukit/nuntius/notification_mode/deaf.rb

@@ -3,6 +3,9 @@ module Mumukit::Nuntius::NotificationMode
     def notify!(*)
     end
 
+    def notify_job!(*)
+    end
+
     def notify_event!(*)
     end
 

data/lib/mumukit/nuntius/notification_mode/nuntius.rb

@@ -4,8 +4,12 @@ module Mumukit::Nuntius::NotificationMode
       Mumukit::Nuntius::Publisher.publish queue_name, event
     end
 
-    def notify_event!(type, data)
-      Mumukit::Nuntius::EventPublisher.publish type, data
+    def notify_job!(type, data)
+      Mumukit::Nuntius::JobPublisher.publish type, data
+    end
+
+    def notify_event!(type, data, **options)
+      Mumukit::Nuntius::EventPublisher.publish type, data, **options
     end
 
     def establish_connection

data/lib/mumukit/nuntius/task_consumer.rb

@@ -0,0 +1,75 @@
+module Mumukit::Nuntius::TaskConsumer
+
+  class Builder
+    def initialize
+      @handlers = {}
+    end
+
+    def task(key, &block)
+      @handlers[key] = with_database_reconnection &block
+    end
+
+    def build
+      @handlers.with_indifferent_access
+    end
+
+    private
+
+    def with_database_reconnection(&block)
+      return block unless defined? ActiveRecord
+      proc do |*args|
+        ActiveRecord::Base.connection_pool.with_connection do
+          block.call(*args)
+        end
+      end
+    end
+
+  end
+
+  def handlers
+    @@handlers ||= {}
+  end
+
+  def handle(&block)
+    register_handlers! builder.new.tap { |it| it.instance_eval(&block) }.build
+  end
+
+  def handled_tasks
+    handlers.keys
+  end
+
+  def register_handlers!(handlers)
+    @@handlers = handlers
+  end
+
+  def start!
+    queue_name = "#{Mumukit::Nuntius.config.app_name}-#{tasks_type}"
+    Mumukit::Nuntius::Consumer.start queue_name, tasks_type do |_delivery_info, properties, body|
+      handle_tasks!(properties, body)
+    end
+  end
+
+  def handles?(task)
+    handlers.include? task
+  end
+
+  def handle_tasks!(properties, body)
+    return if skip_process? body
+    task = properties[:type]
+    if handles? task
+      handlers[task].call body[:data].except(:sender)
+    else
+      log_unknown_task task
+    end
+  rescue => e
+    log_exception(task, e, body[:data])
+  end
+
+  def log_unknown_task(task)
+    Mumukit::Nuntius::Logger.info "Unhandled #{task_type}: #{task} does not exists."
+  end
+
+  def log_exception(task, e, body)
+    Mumukit::Nuntius::Logger.error "Failed to proccess #{task}, error was: #{e}, body was: #{body}"
+  end
+end

data/lib/mumukit/nuntius/version.rb

@@ -1,5 +1,5 @@
 module Mumukit
   module Nuntius
-    VERSION = '6.3.1'
+    VERSION = '6.6.0'
   end
 end

data/lib/mumukit/nuntius.rb

@@ -43,8 +43,30 @@ module Mumukit
     #
     # @param [String|Symbol] type the type of event.
     # @param [Hash] event a json-like hash with the event data
-    def self.notify_event!(type, event)
-      notification_mode.notify_event! type, event
+    def self.notify_event!(type, event, **options)
+      notification_mode.notify_event! type, event, **options
+    end
+
+    # Notifies a job of the given type.
+    #
+    # Jobs are very similar to normal messages, with the following differences:
+    #
+    #   * they are published to a single queue, named `jobs`
+    #   * job data is augmented with the sender app name,
+    #     so that consumers can consume only jobs sent from themselves.
+    #
+    # This makes jobs lighter and easier to send. You should send application
+    # jobs to here if:
+    #
+    #   * you expect to send a lot of those jobs
+    #   * you expect those jobs processing to be slow
+    #
+    # Events are consumed using the Mumukit::Nuntius::JobConsumer module
+    #
+    # @param [String|Symbol] type the type of job.
+    # @param [Hash] job a json-like hash with the job data
+    def self.notify_job!(type, job)
+      notification_mode.notify_job! type, job
     end
 
     def self.establish_connection
@@ -68,6 +90,9 @@ require 'mumukit/nuntius/connection'
 require 'mumukit/nuntius/channel'
 require 'mumukit/nuntius/publisher'
 require 'mumukit/nuntius/consumer'
+require 'mumukit/nuntius/task_consumer'
 require 'mumukit/nuntius/event_consumer'
 require 'mumukit/nuntius/event_publisher'
+require 'mumukit/nuntius/job_consumer'
+require 'mumukit/nuntius/job_publisher'
 require 'mumukit/nuntius/notification_mode'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mumukit-nuntius
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.6.0
 platform: ruby
 authors:
 - Agustin Pina
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mumukit-core
   requirement: !ruby/object:Gem::Requirement
@@ -96,10 +96,13 @@ files:
 - lib/mumukit/nuntius/consumer.rb
 - lib/mumukit/nuntius/event_consumer.rb
 - lib/mumukit/nuntius/event_publisher.rb
+- lib/mumukit/nuntius/job_consumer.rb
+- lib/mumukit/nuntius/job_publisher.rb
 - lib/mumukit/nuntius/notification_mode.rb
 - lib/mumukit/nuntius/notification_mode/deaf.rb
 - lib/mumukit/nuntius/notification_mode/nuntius.rb
 - lib/mumukit/nuntius/publisher.rb
+- lib/mumukit/nuntius/task_consumer.rb
 - lib/mumukit/nuntius/version.rb
 homepage: http://github.com/mumuki/mumukit-nuntius
 licenses:
@@ -121,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Library for working with rabbit queues