pub_sub_model_sync 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6108e077451c0ffc3d3a4b277528ccf036a64edf85c84bb810bc7ce2769bdc35
-  data.tar.gz: 63924273967917c2b5f740f0f917fa772341bc7fbd7c77b52037e9c264e5a080
+  metadata.gz: 6f3074098a97136efdb1698c4e0d3161e02f20d36d3ce4803608dcacdc826700
+  data.tar.gz: 0408d088ec5ee19373a6e49fa639830948d41387efc27a9fc904c04e2b5e11fe
 SHA512:
-  metadata.gz: 480a5c3d69cf06837e443ed6abfef5d927ddfc3df1c48e9948487e470666cdbb11711bb73e17c85d594c29c176a3fc0108867563a14d630152f078f2034d54af
-  data.tar.gz: 57ec430feef5ed8a5b2318703620b2d5f0d6faba14d1227f108a5411ee6fde587219e00fd3cedb8735211c9ff24dac5127af4b88428749164ce3631eb5691e45
+  metadata.gz: e80c2eda985a22d547f2cce08c97a997e8d06da9ff2324e5760832d81070526a34d31e9f6c5e5d6156932ce839bd70eb4e033d1c17a86ac9207b7ae582f9f854
+  data.tar.gz: 13c9e536b71740620f5aaa2a4bce195f0a10dddc5fe5e2ba36e41e48191b7a4f7dce3077a7cf76f3f8882b29054a9b5b015d9150872f641e9875bf66f0748586

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+# 0.2.1
+- Add on demand model sync method
+
 # 0.2.0
 - Add apache kafka support
 - Add Service interface for future references

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (0.2.0)
+    pub_sub_model_sync (0.2.1)
       activesupport
       rails
 

data/README.md

@@ -83,6 +83,8 @@ end
 
 # Samples
 User.create(name: 'test user', email: 'sample@gmail.com') # Review your App 2 to see the created user (only name will be saved)
+User.new(name: 'test user').ps_perform_sync(:create) # similar to above to perform sync on demand
+
 User.ps_class_publish({ msg: 'Hello' }, action: :greeting) # User.greeting method (Class method) will be called in App2
 PubSubModelSync::Publisher.new.publish_data(User, { msg: 'Hello' }, :greeting) # similar to above when not included publisher concern
 ```
@@ -113,6 +115,33 @@ class User < ActiveRecord::Base
 end
 ```
 
+## API
+- Perform sync on demand (:create, :update, :destroy):   
+  The target model will receive a notification to perform the indicated action  
+  ```my_model.ps_perform_sync(action_name)```
+    
+- Class level notification:     
+  ```User.ps_class_publish(data, action: action_name, as_klass: custom_klass_name)```
+  Target class ```User.action_name``` will be called when message is received    
+  * data: (required, :hash) message value to deliver    
+  * action_name: (required, :sim) same action name as defined in ps_class_subscribe(...)    
+  * as_klass: (optional, :string) same class name as defined in ps_class_subscribe(...)
+      
+- Class level notification (Same as above: on demand call)    
+  ```PubSubModelSync::Publisher.new.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(...)
+  
+- Get crud subscription configured for the class   
+  ```User.ps_subscriber(action_name)```  
+  * action_name (default :create, :sym): can be :create, :update, :destroy
+- Get crud publisher configured for the class   
+  ```User.ps_publisher(action_name)```  
+  * action_name (default :create, :sym): can be :create, :update, :destroy
+- Inspect all listeners configured for a class  
+  ```PubSubModelSync::Config.listeners```
+  
 ## Testing with RSpec
 - Config: (spec/rails_helper.rb)
     ```ruby
@@ -178,15 +207,6 @@ end
       expect_any_instance_of(publisher).to receive(:publish_data).with('User', data, action)
     end
     ```
-    
-    There are two special methods to extract crud configuration settings (attrs, id, ...):
-    
-    Subscribers: ```User.ps_subscriber```
-    
-    Publishers: ```User.ps_publisher```
-    
-    Note: Inspect all configured listeners with: 
-    ``` PubSubModelSync::Config.listeners ```
 
 ## Contributing
 

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -11,6 +11,11 @@ module PubSubModelSync
       false
     end
 
+    def ps_perform_sync(action = :create)
+      service = self.class.ps_publisher_service
+      service.publish_model(self, action, self.class.ps_publisher_info(action))
+    end
+
     module ClassMethods
       # Permit to publish crud actions (:create, :update, :destroy)
       # @param settings (Hash): { actions: nil, as_klass: nil, id: nil }

data/lib/pub_sub_model_sync/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Owen