pub_sub_model_sync 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caaffd468399e03dbf5582bf6973339ec61348a6dcc67a87bda1d930f9271aae
-  data.tar.gz: 9db2cb5f4a70c218d720130761a24ad7f6450531d845f9517e74968f409c9743
+  metadata.gz: 6e73c2af5a62d4b0ae32ea40f3c3c369a049edfd47360a50386eeb5e4ff97cd1
+  data.tar.gz: 5d1892ee41ada21c9bf70bcc3601e435edfdf55d7b51b443369bf3307da60436
 SHA512:
-  metadata.gz: ac6c2b0087e411969e4a0fbe6fa4aa57e3fe46b6ff93f4d675e2a213cd0fd75786b5e16e1a4c1df6aee92296eac0c94a054a6b62543a0f7f643ba2ea0bc8ff7b
-  data.tar.gz: 9816c7cedd0d6289d0d73a55f35ede63a46bca7f38805c4c566012fed04a58595498a80fd272ce89b617e34b1d1487ff2ee7f6e050c9712bfd6d75b364ad910a
+  metadata.gz: 962defddfdc780ce185d01e9069485207bdf66be9b3554a1003b5ec71211c467223c288fbb6c6a59ae819a9ba37ff118a470942bdef9e69c68e94f34ff899c9a
+  data.tar.gz: c6e771a40a96dcdf00161aa49fbe7c1b5f283709d5b42b87421c6655e4cb9972e9f7d3bb7d203d47c9757dc681f8c755c7026447f6582ffa1f43a553ba90197a

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+# 1.0.1 (August 20, 2021)
+- refactor: improve service exit when running in k8s
+
 # 1.0 (June 13, 2021)
 This version includes many changes that was refactored from previous version, and thus it needs manual changes to migrate into this version. 
 - Refactor: Subscribers param renamed `from_action` into `to_action` and added support for block or lambda 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (1.0)
+    pub_sub_model_sync (1.0.1)
       rails
 
 GEM
@@ -158,8 +158,6 @@ GEM
     nio4r (2.5.7)
     nokogiri (1.11.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.11.3-x86_64-linux)
-      racc (~> 1.4)
     os (1.1.1)
     parallel (1.20.1)
     parser (3.0.1.1)

data/README.md

@@ -3,8 +3,8 @@
 ![Ruby badge](https://img.shields.io/badge/Ruby-2.4+-success.png)
 ![Production badge](https://img.shields.io/badge/Production-ready-success.png)
 
-This gem permits to sync automatically models and custom data between multiple Rails applications by publishing notifications via pubsub (Google PubSub, RabbitMQ, or Apache Kafka) and automatically processed by all connected applications. Out of the scope, this gem includes transactions to keep Data consistency by processing notifications in the order they were delivered. 
-These notifications use JSON format to easily be decoded by subscribers (Rails applications and even other languages) 
+This gem permits to sync automatically models and custom data between multiple Rails applications by publishing notifications via pubsub (Google PubSub, RabbitMQ, or Apache Kafka) and automatically processed by all connected applications. Out of the scope, this gem includes transactions to keep Data consistency by processing notifications in the order they were delivered.     
+These notifications use JSON format to easily be decoded by subscribers (Rails applications and even other languages, soon for [Cristal-lang](https://crystal-lang.org/)) 
 
 - [**PubSubModelSync**](#pubsubmodelsync)
   - [**Features**](#features)
@@ -104,6 +104,7 @@ And then execute: $ bundle install
 ![Diagram](/docs/notifications-diagram.png?raw=true)
 
 ## **Examples**
+See sample apps in [/samples](/samples/)   
 ### **Basic Example**
 ```ruby
 # App 1 (Publisher)
@@ -561,6 +562,8 @@ config.debug = true
 - Last notification is not being delivered immediately in google pubsub (maybe force with timeout 10secs and service.deliver_messages)
 - Update folder structure
 - Services support to deliver multiple payloads from transactions
+- Fix deprecation warnings: pub_sub_model_sync/service_google.rb:39: warning: Splitting the last argument into positional and keyword parameters is deprecated
+- Add if/unless to ps_after_action
 
 ## **Q&A**
 - I'm getting error "could not obtain a connection from the pool within 5.000 seconds"... what does this mean?

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -54,9 +54,9 @@ module PubSubModelSync
         publish(payload)
       end
 
-      # @param model (ActiveRecord::Base)
-      # @param action (Symbol: @see PublishConcern::ps_publish)
-      # @param settings (Hash: @see PayloadBuilder.settings)
+      # @param model (ActiveRecord::Base,PubSubModelSync::PublisherConcern)
+      # @param action (Symbol,String @see PublishConcern::ps_publish)
+      # @param settings (Hash @see PayloadBuilder.settings)
       def publish_model(model, action, settings = {})
         log("Building payload for: #{[model, action].inspect}") if config.debug
         payload = PubSubModelSync::PayloadBuilder.new(model, action, settings).call
@@ -80,7 +80,7 @@ module PubSubModelSync
       end
 
       def connector_publish(payload)
-        log("Publishing message #{payload.inspect}...") if config.debug
+        log("Publishing message #{[payload]}...") if config.debug
         connector.publish(payload)
         log("Published message: #{[payload]}")
         config.on_after_publish.call(payload)
@@ -99,7 +99,7 @@ module PubSubModelSync
 
       def ensure_publish(payload)
         cancelled = config.on_before_publish.call(payload) == :cancel
-        log("Publish cancelled by config.on_before_publish: #{payload}") if config.debug && cancelled
+        log("Publish cancelled by config.on_before_publish: #{[payload]}") if config.debug && cancelled
         !cancelled
       end
 
@@ -110,7 +110,7 @@ module PubSubModelSync
       def ensure_model_publish(model, action, payload)
         res_before = model.ps_before_publish(action, payload)
         cancelled = res_before == :cancel
-        log("Publish cancelled by model.ps_before_publish: #{payload}") if config.debug && cancelled
+        log("Publish cancelled by model.ps_before_publish: #{[payload]}") if config.debug && cancelled
         !cancelled
       end
 

data/lib/pub_sub_model_sync/payload_builder.rb

@@ -4,7 +4,7 @@ module PubSubModelSync
   class PayloadBuilder < PubSubModelSync::Base
     attr_accessor :model, :action, :data, :mapping, :headers, :as_klass
 
-    # @param model (ActiveRecord::Base)
+    # @param model (ActiveRecord::Base,PubSubModelSync::PublisherConcern)
     # @param action (@see PublishConcern::ps_publish)
     # @param settings (@see PublishConcern::ps_publish): { data:, mapping:, headers:, as_klass: }
     def initialize(model, action, settings = {})

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -18,14 +18,14 @@ module PubSubModelSync
     alias ps_after_sync ps_after_publish # @deprecated
 
     # Delivers a notification via pubsub
-    # @param action (Sym|String) Sample: create|update|save|destroy|<any_other_key>
+    # @param action (Symbol,String) Sample: create|update|save|destroy|<any_other_key>
     # @param mapping? (Array<String>) If present will generate data using the mapping and added to the payload.
     #   Sample: ["id", "full_name:name"]
-    # @param data? (Hash|Symbol|Proc)
+    # @param data? (Hash,Symbol,Proc)
     #   Hash: Data to be added to the payload
     #   Symbol: Method name to be called to retrieve payload data (must return a hash value, receives :action name)
     #   Proc: Block to be called to retrieve payload data
-    # @param headers? (Hash|Symbol|Proc): (All available attributes in Payload.headers)
+    # @param headers? (Hash,Symbol,Proc): (All available attributes in @Payload.headers)
     #   Hash: Data that will be merged with default header values
     #   Symbol: Method name that will be called to retrieve header values (must return a hash, receives :action name)
     #   Proc: Block to be called to retrieve header values
@@ -57,7 +57,7 @@ module PubSubModelSync
         klass.publish_data((as_klass || name).to_s, data, action.to_sym, headers: headers)
       end
 
-      # @param crud_actions (Symbol|Array<Symbol>): :create, :update, :destroy
+      # @param crud_actions (Symbol,Array<Symbol>): :create, :update, :destroy
       # @param method_name (Symbol, optional) method to be called
       def ps_after_action(crud_actions, method_name = nil, &block)
         actions = Array(crud_actions).map(&:to_sym)

data/lib/pub_sub_model_sync/runner.rb

@@ -3,7 +3,6 @@
 require 'active_support/core_ext/module'
 module PubSubModelSync
   class Runner
-    class ShutDown < StandardError; end
     delegate :preload_listeners, to: :class
     attr_accessor :connector
 
@@ -12,11 +11,10 @@ module PubSubModelSync
     end
 
     def run
+      at_exit { connector.stop }
       trap_signals!
       preload_listeners
       start_listeners
-    rescue ShutDown
-      connector.stop
     end
 
     def self.preload_listeners
@@ -32,8 +30,8 @@ module PubSubModelSync
 
     def trap_signals!
       handler = proc do |signal|
-        puts "received #{Signal.signame(signal)}"
-        raise ShutDown
+        puts "PS_MSYNC ==> received #{Signal.signame(signal)}"
+        exit
       end
       %w[INT QUIT TERM].each { |signal| Signal.trap(signal, handler) }
     end

data/lib/pub_sub_model_sync/service_google.rb

@@ -44,7 +44,7 @@ module PubSubModelSync
 
     def stop
       log('Listener stopping...')
-      subscribers.each(&:stop!)
+      (subscribers || []).each(&:stop!)
     end
 
     private

data/lib/pub_sub_model_sync/service_kafka.rb

@@ -76,8 +76,8 @@ module PubSubModelSync
     end
 
     # Check topic existence, create if missing topic
-    # @param names (Array<String>|String)
-    # @return (Array|String) return @param names
+    # @param names (Array<String>,String)
+    # @return (Array,String) return @param names
     def ensure_topics(names)
       missing_topics = Array(names) - (@known_topics || service.topics)
       missing_topics.each do |name|

data/lib/pub_sub_model_sync/subscriber_concern.rb

@@ -9,16 +9,16 @@ module PubSubModelSync
     end
 
     module ClassMethods
-      # @param actions (Symbol|Array<Symbol>) Notification.action name: save|create|update|destroy|<any_other_action>
+      # @param actions (Symbol,Array<Symbol>) Notification.action name: save|create|update|destroy|<any_other_action>
       # @param mapping (Array<String,Symbol>) Attributes mapping with aliasing support, sample: ["id", "full_name:name"]
       # @param settings (Hash<:from_klass, :to_action, :id, :if, :unless>)
       #   from_klass (String) Notification.class name
-      #   to_action (Symbol|Proc):
+      #   to_action (Symbol,Proc):
       #     Symbol: Method to process the notification
       #     Proc: Block to process the notification
-      #   id (Symbol|Array<Symbol|String>) attribute(s) DB primary identifier(s). Supports for mapping format.
-      #   if (Symbol|Proc|Array<Symbol>) Method or block called as the conformation before calling the callback
-      #   unless (Symbol|Proc|Array<Symbol>) Method or block called as the negation before calling the callback
+      #   id (Symbol,Array<Symbol,String>) attribute(s) DB primary identifier(s). Supports for mapping format.
+      #   if (Symbol,Proc,Array<Symbol>) Method or block called as the conformation before calling the callback
+      #   unless (Symbol,Proc,Array<Symbol>) Method or block called as the negation before calling the callback
       def ps_subscribe(actions, mapping = [], settings = {}, &block)
         settings[:to_action] ||= block if block
         Array(actions).map do |action|

data/lib/pub_sub_model_sync/transaction.rb

@@ -5,7 +5,7 @@ module PubSubModelSync
     PUBLISHER_KLASS = PubSubModelSync::MessagePublisher
     attr_accessor :key, :payloads, :max_buffer, :root, :children, :finished
 
-    # @param key (String|nil) Transaction key, if empty will use the ordering_key from first payload
+    # @param key (String,Null) Transaction key, if empty will use the ordering_key from first payload
     # @param max_buffer (Integer) Once this quantity of notifications is reached, then all notifications
     #   will immediately be delivered.
     #   Note: There is no way to rollback delivered notifications if current transaction fails

data/lib/pub_sub_model_sync/version.rb

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

data/samples/README.md

@@ -6,7 +6,7 @@ This is a sample to sync information between rails applications using RabbitMQ
   ```docker network create shared_app_services```
   
 * Start RabbitMQ server   
-  ```docker-compose up pubsub```
+  ```cd samples/app1 && docker-compose up pubsub```
 
 * In another tab access to App1 to publish notifications (Wait for step 2)  
   - Access to the application    

data/samples/app1/Gemfile

@@ -18,7 +18,7 @@ gem 'bootsnap', '>= 1.4.4', require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
 # gem 'rack-cors'
 
-gem 'pub_sub_model_sync'
+gem 'pub_sub_model_sync', '>= 1.0'
 gem 'bunny' # to use rabbit-mq pub/sub service
 gem 'annotate'
 

data/samples/app1/Gemfile.lock

@@ -96,7 +96,7 @@ GEM
     nokogiri (1.11.3)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    pub_sub_model_sync (1.0.beta1)
+    pub_sub_model_sync (1.0)
       rails
     puma (5.3.1)
       nio4r (~> 2.0)
@@ -160,7 +160,7 @@ DEPENDENCIES
   bunny
   byebug
   listen (~> 3.3)
-  pub_sub_model_sync (= 1.0.beta2)
+  pub_sub_model_sync (>= 1.0)
   puma (~> 5.0)
   rails (~> 6.1.3, >= 6.1.3.2)
   spring
@@ -168,4 +168,4 @@ DEPENDENCIES
   tzinfo-data
 
 BUNDLED WITH
-   2.1.4
+   2.2.17

data/samples/app1/config/master.key

@@ -0,0 +1 @@
+f76db08751757e296d844ca18dcdb0a1

data/samples/app2/Gemfile

@@ -18,7 +18,7 @@ gem 'bootsnap', '>= 1.4.4', require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
 # gem 'rack-cors'
 
-gem 'pub_sub_model_sync'
+gem 'pub_sub_model_sync', '>= 1.0'
 gem 'bunny' # to use rabbit-mq pub/sub service
 gem 'annotate'
 

data/samples/app2/Gemfile.lock

@@ -96,7 +96,7 @@ GEM
     nokogiri (1.11.3)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    pub_sub_model_sync (1.0.beta1)
+    pub_sub_model_sync (1.0)
       rails
     puma (5.3.1)
       nio4r (~> 2.0)
@@ -160,7 +160,7 @@ DEPENDENCIES
   bunny
   byebug
   listen (~> 3.3)
-  pub_sub_model_sync (= 1.0.beta2)
+  pub_sub_model_sync (>= 1.0)
   puma (~> 5.0)
   rails (~> 6.1.3, >= 6.1.3.2)
   spring
@@ -168,4 +168,4 @@ DEPENDENCIES
   tzinfo-data
 
 BUNDLED WITH
-   2.1.4
+   2.2.17

data/samples/app2/config/master.key

@@ -0,0 +1 @@
+ca702da1b8c8f8405ed03739ca90b0e5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -134,8 +134,6 @@ files:
 - lib/pub_sub_model_sync/version.rb
 - pub_sub_model_sync.gemspec
 - samples/README.md
-- samples/app1/.gitattributes
-- samples/app1/.gitignore
 - samples/app1/Dockerfile
 - samples/app1/Gemfile
 - samples/app1/Gemfile.lock
@@ -168,6 +166,7 @@ files:
 - samples/app1/config/initializers/pubsub.rb
 - samples/app1/config/initializers/wrap_parameters.rb
 - samples/app1/config/locales/en.yml
+- samples/app1/config/master.key
 - samples/app1/config/puma.rb
 - samples/app1/config/routes.rb
 - samples/app1/config/spring.rb
@@ -177,8 +176,6 @@ files:
 - samples/app1/db/seeds.rb
 - samples/app1/docker-compose.yml
 - samples/app1/log/.keep
-- samples/app2/.gitattributes
-- samples/app2/.gitignore
 - samples/app2/Dockerfile
 - samples/app2/Gemfile
 - samples/app2/Gemfile.lock
@@ -211,9 +208,11 @@ files:
 - samples/app2/config/initializers/pubsub.rb
 - samples/app2/config/initializers/wrap_parameters.rb
 - samples/app2/config/locales/en.yml
+- samples/app2/config/master.key
 - samples/app2/config/puma.rb
 - samples/app2/config/routes.rb
 - samples/app2/config/spring.rb
+- samples/app2/db/development.sqlite3
 - samples/app2/db/migrate/20210513080956_create_customers.rb
 - samples/app2/db/migrate/20210513135203_create_posts.rb
 - samples/app2/db/schema.rb

data/samples/app1/.gitattributes

@@ -1,8 +0,0 @@
-# See https://git-scm.com/docs/gitattributes for more about git attribute files.
-
-# Mark the database schema as having been generated.
-db/schema.rb linguist-generated
-
-
-# Mark any vendored files as having been vendored.
-vendor/* linguist-vendored

data/samples/app1/.gitignore

@@ -1,28 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-*
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/
-!/tmp/pids/.keep
-
-.byebug_history
-
-# Ignore master key for decrypting credentials and more.
-/config/master.key

data/samples/app2/.gitattributes

@@ -1,8 +0,0 @@
-# See https://git-scm.com/docs/gitattributes for more about git attribute files.
-
-# Mark the database schema as having been generated.
-db/schema.rb linguist-generated
-
-
-# Mark any vendored files as having been vendored.
-vendor/* linguist-vendored

data/samples/app2/.gitignore

@@ -1,28 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-*
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/
-!/tmp/pids/.keep
-
-.byebug_history
-
-# Ignore master key for decrypting credentials and more.
-/config/master.key