pub_sub_model_sync 0.5.0.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08249ef28730afdc2a0f3b025ef66d5117694fdc4ed995e9eb907e37e60defb
-  data.tar.gz: cc8d337de6952db6e9747912178ce7fd09f93c3a600d1d4756671fb6bcefadad
+  metadata.gz: 83c10bee147f91d55fa2fd1a8fc81f5864c2bb6af7476caa0de4044f9e6ad3e9
+  data.tar.gz: 53e28b6855a0139df908a79e532f7138cba78e153d6e51e4a8f739063df290e7
 SHA512:
-  metadata.gz: cdca1e7397fa5fae46198fce8ae24036318d619d53cff5c06e8e8c266423a5681e48588eddcced3271747242a35fc77b1c75bf567d5461c4fa7f573ae29c4c15
-  data.tar.gz: 0c48d83f3904c5872cdc3b48f2d341be84cbe84899a3fdc0738c9ad290e5e6c1c49ca2ab226e12df4f097d6f927e603b4691f64760a8d4dd9c703431711e71ec
+  metadata.gz: c269ccd1f3587605ff43342c3948cd03b171f0fc6b124815b98c5e4e2f1ab30d574f90f2c07087185042d20c2c5c1b3f7052b11b1679c002c6e24f7065125893
+  data.tar.gz: b1702e276e58ab5d796856c5a14c975fe70959f2603a27afaad2110811c1053ebc88c0b7fd7f7466910f63e578efdab26fd943d725aa3b21412f3372e4b35ab5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+# 0.5.1 (December 24, 2020)
+- feat: rename publisher callbacks to be more understandable
+- feat: add callbacks to listen when processing a message (before saving sync)
+
 # 0.5.0.1 (December 22, 2020)
 - fix: add missing rabbit mock method
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (0.5.0.1)
+    pub_sub_model_sync (0.5.1)
       rails
 
 GEM

data/README.md

@@ -59,7 +59,13 @@ And then execute: $ bundle install
     ```ruby
     rake pub_sub_model_sync:start
     ```
-    Note: Publishers do not need todo this
+    Note: Publishers do not need todo this    
+    Note2 (Rails 6+): Due to Zeitwerk, you need to load listeners manually when syncing outside ```rake pub_sub_model_sync:start```
+    ```ruby 
+      # PubSubModelSync::Config.subscribers ==> []
+      Rails.application.try(:eager_load!)
+      # PubSubModelSync::Config.subscribers ==> [#<PubSubModelSync::Subscriber:0x000.. @klass="Article", @action=:create..., ....]
+    ``` 
 
 - Check the service status with:    
   ```PubSubModelSync::MessagePublisher.publish_data('Test message', {sample_value: 10}, :create)```
@@ -163,6 +169,9 @@ Note: Be careful with collision of names
   ```.ps_subscriber_changed?(data)```    
   By default: ```model.changed?```
 
+- Permit to perform custom actions before saving sync of the model (:cancel can be returned to skip sync)   
+  ```.ps_before_save_sync(payload)```    
+
 ### Publishers
 - Permit to configure crud publishers
   ```ps_publish(attrs, actions: nil, as_klass: nil)```
@@ -278,17 +287,19 @@ config.debug = true
     (true/false*) => show advanced log messages
 - ```logger = Rails.logger```   
     (Logger) => define custom logger
-- ```disabled = true```   
-    (true/false*) => if true, does not publish model messages (Create/Update/Destroy) 
-- ```on_process_success = ->(payload, subscriber) { puts payload }```    
+- ```disabled_callback_publisher = ->(_model, _action) { false }```   
+    (true/false*) => if true, does not listen model callbacks for auto sync (Create/Update/Destroy) 
+- ```on_before_processing = ->(payload, subscriber) { puts payload }```    
+    (Proc) => called before processing received message (:cancel can be returned to skip processing)   
+- ```on_success_processing = ->(payload, subscriber) { puts payload }```    
     (Proc) => called when a message was successfully processed
-- ```on_process_error = ->(exception, payload) { sleep 1; payload.process! }```    
+- ```on_error_processing = ->(exception, payload) { sleep 1; payload.process! }```    
     (Proc) => called when a message failed when processing
 - ```on_before_publish = ->(payload) { puts payload }```    
-    (Proc) => called before publishing a message    
+    (Proc) => called before publishing a message (:cancel can be returned to skip publishing)    
 - ```on_after_publish = ->(payload) { puts payload }```    
     (Proc) => called after publishing a message
-- ```on_publish_error = ->(exception, payload) { sleep 1; payload.publish! }```    
+- ```on_error_publish = ->(exception, payload) { sleep 1; payload.publish! }```    
     (Proc) => called when failed publishing a message
     
 ## TODO

data/lib/pub_sub_model_sync/config.rb

@@ -10,12 +10,13 @@ module PubSubModelSync
     cattr_accessor(:debug) { false }
     cattr_accessor :logger # LoggerInst
 
-    cattr_accessor(:on_process_success) { ->(_payload, _subscriber) {} }
-    cattr_accessor(:on_process_error) { ->(_exception, _payload) {} }
-    cattr_accessor(:on_before_publish) { ->(_payload) {} }
+    cattr_accessor(:on_before_processing) { ->(_payload, _subscriber) {} } # return :cancel to skip
+    cattr_accessor(:on_success_processing) { ->(_payload, _subscriber) {} }
+    cattr_accessor(:on_error_processing) { ->(_exception, _payload) {} }
+    cattr_accessor(:on_before_publish) { ->(_payload) {} } # return :cancel to skip
     cattr_accessor(:on_after_publish) { ->(_payload) {} }
-    cattr_accessor(:on_publish_error) { ->(_exception, _payload) {} }
-    cattr_accessor(:disabled) { false }
+    cattr_accessor(:on_error_publish) { ->(_exception, _payload) {} }
+    cattr_accessor(:disabled_callback_publisher) { ->(_model, _action) { false } }
 
     # google service
     cattr_accessor :project, :credentials, :topic_name, :subscription_name

data/lib/pub_sub_model_sync/message_processor.rb

@@ -22,17 +22,25 @@ module PubSubModelSync
     private
 
     def run_subscriber(subscriber)
-      subscriber.eval_message(payload.data)
-      config.on_process_success.call(payload, subscriber)
+      return unless processable?(subscriber)
+
+      subscriber.process!(payload)
+      config.on_success_processing.call(payload, subscriber)
       log "processed message with: #{payload}"
     rescue => e
       print_subscriber_error(e)
     end
 
+    def processable?(subscriber)
+      cancel = config.on_before_processing.call(payload, subscriber) == :cancel
+      log("process message cancelled: #{payload}") if cancel && config.debug
+      !cancel
+    end
+
     # @param error (Error)
     def print_subscriber_error(error)
       info = [payload, error.message, error.backtrace]
-      res = config.on_process_error.call(error, payload)
+      res = config.on_error_processing.call(error, payload)
       log("Error processing message: #{info}", :error) if res != :skip_log
     end
 

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -29,8 +29,12 @@ module PubSubModelSync
       end
 
       def publish(payload)
-        log("Publishing message: #{[payload]}") if config.debug
-        config.on_before_publish.call(payload)
+        if config.on_before_publish.call(payload) == :cancel
+          log("Publish message cancelled: #{payload}") if config.debug
+          return
+        end
+
+        log("Publishing message: #{[payload]}")
         connector.publish(payload)
         config.on_after_publish.call(payload)
       rescue => e
@@ -41,7 +45,7 @@ module PubSubModelSync
 
       def notify_error(exception, payload)
         info = [payload, exception.message, exception.backtrace]
-        res = config.on_publish_error.call(exception, payload)
+        res = config.on_error_publish.call(exception, payload)
         log("Error publishing: #{info}", :error) if res != :skip_log
       end
     end

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -11,13 +11,12 @@ module PubSubModelSync
       false
     end
 
-    # TODO: make it using respond_to?(:ps_skip_sync?)
     # before preparing data to sync
     def ps_skip_sync?(_action)
       false
     end
 
-    # before delivering data
+    # before delivering data (return :cancel to cancel sync)
     def ps_before_sync(_action, _data); end
 
     # after delivering data
@@ -64,7 +63,7 @@ module PubSubModelSync
 
       def ps_register_callback(action, publisher)
         after_commit(on: action) do |model|
-          disabled = PubSubModelSync::Config.disabled
+          disabled = PubSubModelSync::Config.disabled_callback_publisher.call(model, action)
           if !disabled && !model.ps_skip_callback?(action)
             klass = PubSubModelSync::MessagePublisher
             klass.publish_model(model, action.to_sym, publisher)

data/lib/pub_sub_model_sync/subscriber.rb

@@ -3,6 +3,7 @@
 module PubSubModelSync
   class Subscriber
     attr_accessor :klass, :action, :attrs, :settings
+    attr_reader :payload
 
     # @param settings: (Hash) { id: :id, direct_mode: false,
     #                           from_klass: klass, from_action: action }
@@ -15,48 +16,51 @@ module PubSubModelSync
       @settings = def_settings.merge(settings)
     end
 
-    def eval_message(message)
+    def process!(payload)
+      @payload = payload
       if settings[:direct_mode]
-        run_class_message(message)
+        run_class_message
       else
-        run_model_message(message)
+        run_model_message
       end
     end
 
     private
 
-    def run_class_message(message)
+    def run_class_message
       model_class = klass.constantize
-      model_class.send(action, message)
+      model_class.send(action, payload.data)
     end
 
     # support for: create, update, destroy
-    def run_model_message(message)
-      model = find_model(message)
+    def run_model_message
+      model = find_model
+      return if model.ps_before_save_sync(payload) == :cancel
+
       if action == :destroy
         model.destroy!
       else
-        populate_model(model, message)
-        return if action == :update && !model.ps_subscriber_changed?(message)
+        populate_model(model)
+        return if action == :update && !model.ps_subscriber_changed?(payload.data)
 
         model.save!
       end
     end
 
-    def find_model(message)
+    def find_model
       model_class = klass.constantize
-      return model_class.ps_find_model(message) if model_class.respond_to?(:ps_find_model)
+      return model_class.ps_find_model(payload.data) if model_class.respond_to?(:ps_find_model)
 
-      model_class.where(model_identifiers(message)).first_or_initialize
+      model_class.where(model_identifiers).first_or_initialize
     end
 
-    def model_identifiers(message)
+    def model_identifiers
       identifiers = Array(settings[:id])
-      identifiers.map { |key| [key, message[key.to_sym]] }.to_h
+      identifiers.map { |key| [key, payload.data[key.to_sym]] }.to_h
     end
 
-    def populate_model(model, message)
-      values = message.slice(*attrs)
+    def populate_model(model)
+      values = payload.data.slice(*attrs)
       values.each do |attr, value|
         model.send("#{attr}=", value)
       end

data/lib/pub_sub_model_sync/subscriber_concern.rb

@@ -12,6 +12,10 @@ module PubSubModelSync
       changed?
     end
 
+    # permit to apply custom actions before applying sync
+    # @return (nil|:cancel): nil to continue sync OR :cancel to skip sync
+    def ps_before_save_sync(_payload); end
+
     module ClassMethods
       def ps_subscribe(attrs, actions: nil, from_klass: name, id: :id)
         settings = { id: id, from_klass: from_klass }

data/lib/pub_sub_model_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PubSubModelSync
-  VERSION = '0.5.0.1'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 0.5.0.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails