pub_sub_model_sync 0.4.0 → 0.5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733ca5e3413a098031be8a2ca5d0c3df9bf972ed8cdbf8954a1968c517ac81f4
-  data.tar.gz: a4c419efb5446e8a8632942936589b1b0a4bad2ab913a9ddd34cffb2bfdf8f2a
+  metadata.gz: f08249ef28730afdc2a0f3b025ef66d5117694fdc4ed995e9eb907e37e60defb
+  data.tar.gz: cc8d337de6952db6e9747912178ce7fd09f93c3a600d1d4756671fb6bcefadad
 SHA512:
-  metadata.gz: 3054010e2bad46d8d2377a01757b0f52abc31f27832ddc150b12f3fb5d05f50a9aa87aa1bcafff7237918ecdc3d4cc637033dec76d32d7991d69c36d5e949ea8
-  data.tar.gz: 734be5a88e56fa6f508f1c37acdada68cf3b53db5b2d5b3d612616c27a63f4d46c305d0d2148d656c970d0a6cc9e25ec6840ead4c4a74b1c4f39b777a791e2cc
+  metadata.gz: cdca1e7397fa5fae46198fce8ae24036318d619d53cff5c06e8e8c266423a5681e48588eddcced3271747242a35fc77b1c75bf567d5461c4fa7f573ae29c4c15
+  data.tar.gz: 0c48d83f3904c5872cdc3b48f2d341be84cbe84899a3fdc0738c9ad290e5e6c1c49ca2ab226e12df4f097d6f927e603b4691f64760a8d4dd9c703431711e71ec

data/.github/workflows/ruby.yml

@@ -6,28 +6,50 @@ on:
       - master
   pull_request:
 
-
 jobs:
   build:
     name: Tests and Code Style
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6]
+        rails: [4, 5, 6]
+        include:
+          - ruby: 2.7
+            rails: 6
+        exclude: # rails 6 requires ruby >= 2.5
+          - ruby: 2.4
+            rails: 6
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
+      - name: Set up Ruby
         uses: actions/setup-ruby@v1
         with:
-          ruby-version: 2.6.x
-
+          ruby-version: ${{ matrix.ruby }}
       - name: Install sqlite3
         run: sudo apt-get install libsqlite3-dev
 
-      - name: Bundle install
+      - name: Install bundler
+        env:
+          GEMFILE_PATH: gemfiles/Gemfile_${{ matrix.rails }}
+          RAILS_V: ${{ matrix.rails }}
         run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
+          rm -f Gemfile.lock && rm -f Gemfile
+          cp $GEMFILE_PATH ./Gemfile
+          bundler_v='2.1.4'
+          if [ $RAILS_V = "4" ]; then bundler_v="1.16.6"; fi
+          gem install bundler -v "~> $bundler_v"
+          bundle _${bundler_v}_ install --jobs 4 --retry 3
+
+#      remote ssh debugger
+#      - name: Setup tmate session (remote session debugger)
+#        uses: mxschmitt/action-tmate@v3
+
       - name: Tests (rspec)
         run: |
           bundle exec rspec
+
       - name: Code style (Rubocop)
-        run: bundle exec rubocop
+        run: bundle exec rubocop
+        if: matrix.ruby == '2.6' && matrix.rails == '6'

data/.rubocop.yml

@@ -1,22 +1,27 @@
 # This is the configuration used to check the rubocop source code.
 
 AllCops:
+  TargetRubyVersion: 2.6
   Exclude:
     - 'spec/spec_helper.rb'
     - 'Gemfile'
     - 'Rakefile'
     - 'bin/*'
-  TargetRubyVersion: 2.3
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Layout/LineLength:
+  Max: 120
 
 Style/SymbolArray:
   Exclude:
     - 'Gemfile'
 
+Lint/MissingSuper:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Change Log
 
+# 0.5.0.1 (December 22, 2020)
+- fix: add missing rabbit mock method
+
+# 0.5.0 (December 22, 2020)
+- feat: add :publish! and :process! methods to payloads
+- feat: add ability to disable publisher globally
+- fix: skip notifications from the same application
+- fix: rabbitmq use fanout instead of queue to deliver messages to multiple apps
+- refactor: include payload object to carry message info
+- feat: include notification events (when publishing and when processing messages)
+
+# 0.4.2.2 (November 29, 2020, deleted cause of typo)
+- feat: rabbitMQ skip receiving messages from the same app
+- feat: rabbitmq use fanout instead of queue to deliver messages to multiple apps
+ 
+# 0.4.2.1 (August 20, 2020)
+- Improve ```ps_subscriber_changed?``` to run validations and check for changes
+ 
+# 0.4.2 (May 12, 2020)
+- chore: remove typo
+
+# 0.4.1 (May 12, 2020)
+- chore: improve log messages
+- feat: do not update model if no changes
+- feat: skip publisher after updating if no changes
+
+
 # 0.4.0 (May 06, 2020)
 - rename as_klass to from_klass and as_action to from_action for subscribers
 - refactor subscribers to be independent

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem 'rubocop'
+gem 'rubocop', '~> 1.6.0', require: false
 gem 'bunny' # rabbit-mq
 gem 'google-cloud-pubsub' # google pub/sub
 gem 'ruby-kafka' # kafka pub/sub

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (0.4.0)
-      activesupport
+    pub_sub_model_sync (0.5.0.1)
       rails
 
 GEM
@@ -66,7 +65,7 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     amq-protocol (2.3.0)
-    ast (2.4.0)
+    ast (2.4.1)
     builder (3.2.4)
     bunny (2.14.3)
       amq-protocol (~> 2.3, >= 2.3.0)
@@ -78,7 +77,7 @@ GEM
       database_cleaner (~> 1.8.0)
     diff-lcs (1.3)
     digest-crc (0.5.1)
-    erubi (1.9.0)
+    erubi (1.10.0)
     faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     globalid (0.4.2)
@@ -121,9 +120,8 @@ GEM
       grpc (~> 1.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     jwt (2.2.1)
-    loofah (2.5.0)
+    loofah (2.8.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -132,21 +130,21 @@ GEM
       mimemagic (~> 0.3.2)
     memoist (0.16.2)
     method_source (1.0.0)
-    mimemagic (0.3.4)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     multi_json (1.14.1)
     multipart-post (2.1.1)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     os (1.0.1)
-    parallel (1.19.1)
-    parser (2.7.0.4)
-      ast (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.3)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.2.2)
@@ -177,6 +175,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (2.0.1)
     rexml (3.2.4)
     rly (0.2.3)
     rspec (3.9.0)
@@ -192,14 +191,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.6.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
     ruby-kafka (1.0.0)
       digest-crc
     ruby-progressbar (1.10.1)
@@ -208,10 +210,10 @@ GEM
       faraday (~> 0.9)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
-    sprockets (4.0.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -220,10 +222,10 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    websocket-driver (0.7.1)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
     zeitwerk (2.3.0)
 
 PLATFORMS
@@ -237,7 +239,7 @@ DEPENDENCIES
   pub_sub_model_sync!
   rake
   rspec
-  rubocop
+  rubocop (~> 1.6.0)
   ruby-kafka
   sqlite3
 

data/README.md

@@ -61,6 +61,9 @@ And then execute: $ bundle install
     ```
     Note: Publishers do not need todo this
 
+- Check the service status with:    
+  ```PubSubModelSync::MessagePublisher.publish_data('Test message', {sample_value: 10}, :create)```
+
 ## Examples
 ```ruby
 # App 1 (Publisher)
@@ -118,7 +121,7 @@ class User < ActiveRecord::Base
     puts 'Class message called through custom_greeting'
   end
   
-  # def self.ps_find_model(data, settings)
+  # def self.ps_find_model(data)
   #   where(email: data[:email], ...).first_or_initialize 
   # end
 end
@@ -126,24 +129,18 @@ end
 
 Note: Be careful with collision of names
 ```
-class User
-    # ps_publish %i[name_data:name name:key] # key will be replaced with name_data 
-    ps_publish %i[name_data:name key_data:key] # use alias to avoid collision
-    
-    def key_data
-      name
-    end
-end
+  # ps_publish %i[name_data:name name:key] # key will be replaced with name_data 
+  ps_publish %i[name_data:name key_data:key] # use alias to avoid collision
 ``` 
 
 ## API
 ### Subscribers
-- Permit to configure class level listeners
+- Permit to configure class level subscriptions
   ```ps_class_subscribe(action_name, from_action: nil, from_klass: nil)```
   * from_action: (Optional) Source method name
   * from_klass: (Optional) Source class name
   
-- Permit to configure instance level listeners (CRUD)
+- Permit to configure instance level subscriptions (CRUD)
   ```ps_subscribe(attrs, from_klass: nil, actions: nil, id: nil)```
   * attrs: (Array/Required) Array of all attributes to be synced
   * from_klass: (String/Optional) Source class name (Instead of the model class name, will use this value) 
@@ -151,17 +148,20 @@ end
   * id: (Sym|Array/Optional, default: id) Attr identifier(s) to find the corresponding model
 
 - Permit to configure a custom model finder
-  ```ps_find_model(data, settings)```
+  ```ps_find_model(data)```
   * data: (Hash) Data received from sync
-  * settings: (Hash(:klass, :action)) Class and action name from sync
   Must return an existent or a new model object
 
 - Get crud subscription configured for the class   
   ```User.ps_subscriber(action_name)```  
   * action_name (default :create, :sym): can be :create, :update, :destroy
 
-- Inspect all configured listeners
-  ```PubSubModelSync::Config.listeners```    
+- Inspect all configured subscribers   
+  ```PubSubModelSync::Config.subscribers```    
+
+- Permit to customize the way to detect if the subscribed model was changed (Only for update action).   
+  ```.ps_subscriber_changed?(data)```    
+  By default: ```model.changed?```
 
 ### Publishers
 - Permit to configure crud publishers
@@ -172,6 +172,7 @@ end
 
 - Permit to cancel sync called after create/update/destroy (Before initializing sync service)
   ```model.ps_skip_callback?(action)```    
+  Default: False  
   Note: Return true to cancel sync
   
 - Callback called before preparing data for sync (Permit to stop sync)
@@ -197,11 +198,11 @@ end
   * action_name: (required, :sim) Action name    
   * as_klass: (optional, :string) Custom class name (Default current model name)
       
-- Publish a class level notification (Same as above: on demand call)    
-  ```PubSubModelSync::MessagePublisher.publish_data(Klass_name, data, action_name)```  
-  * klass_name: (required, Class) same class name as defined in ps_class_subscribe(...)
-  * data: (required, :hash) message value to deliver    
-  * action_name: (required, :sim) same action name as defined in ps_class_subscribe(...)
+- Publish a class level notification (Same as above: manual call)    
+  ```ruby
+    payload = PubSubModelSync::Payload.new({ title: 'hello' }, { action: :greeting, klass: 'User' })
+    payload.publish!
+  ```
   
 - Get crud publisher configured for the class   
   ```User.ps_publisher(action_name)```  
@@ -237,27 +238,23 @@ end
     ```ruby
     # Subscriber
     it 'receive model message' do
-      action = :create
       data = { name: 'name', id: 999 }
-      publisher = PubSubModelSync::MessageProcessor.new(data, 'User', action)
-      publisher.process
+      payload = PubSubModelSync::Payload.new(data, { klass: 'User', action: :create })
+      payload.process!
       expect(User.where(id: data[:id]).any?).to be_truth
     end
       
     it 'receive class message' do
-      action = :greeting
       data = { msg: 'hello' }
-      publisher = PubSubModelSync::MessageProcessor.new(data, 'User', action)
-      publisher.process
+      action = :greeting
+      payload = PubSubModelSync::Payload.new(data, { klass: 'User', action: action })
+      payload.process!
       expect(User).to receive(action)
     end
   
     # Publisher
     it 'publish model action' do
       publisher = PubSubModelSync::MessagePublisher  
-      data = { name: 'hello'}
-      action = :create
-      User.ps_class_publish(data, action: action)
       user = User.create(name: 'name', email: 'email')
       expect(publisher).to receive(:publish_model).with(user, :create, anything)
     end
@@ -271,6 +268,35 @@ end
     end
     ```
 
+## Extra configurations
+```ruby
+config = PubSubModelSync::Config
+config.debug = true
+```
+
+- ```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 }```    
+    (Proc) => called when a message was successfully processed
+- ```on_process_error = ->(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    
+- ```on_after_publish = ->(payload) { puts payload }```    
+    (Proc) => called after publishing a message
+- ```on_publish_error = ->(exception, payload) { sleep 1; payload.publish! }```    
+    (Proc) => called when failed publishing a message
+    
+## TODO
+- Add alias attributes when subscribing (similar to publisher)
+- Add flag ```model.ps_processing``` to indicate that the current transaction is being processed by pub/sub
+- Auto publish update only if payload has changed
+- On delete, payload must only be composed by ids 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/owen2345/pub_sub_model_sync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/gemfiles/Gemfile_4

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gem 'rubocop'
+gem 'bunny' # rabbit-mq
+gem 'google-cloud-pubsub' # google pub/sub
+gem 'ruby-kafka' # kafka pub/sub
+gem 'rails', '~> 4'
+gem 'bundler'
+gem 'sqlite3', '1.3.13'
+
+group :test do
+  gem 'database_cleaner-active_record'
+end
+
+# Specify your gem's dependencies in pub_sub_model_sync.gemspec
+gemspec