action_cable_notifications 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10872c8c2efdc7d4bd67ea4301331116774bdff2
-  data.tar.gz: e9b661dff6fafdf5076fedd5161020e11a1c82f8
+  metadata.gz: 77099f72f8abc9a8cdddad94a14066bacf6ed237
+  data.tar.gz: 7912095ef91683daa7a35a5ae951b06674d57ee7
 SHA512:
-  metadata.gz: 2eabf026860c2ce9baf5232b99f512aed3e61160aa251cbf0c3ab4137f200f66de8242cd9e5ebd3013a8c0dde50b67913ac1f9eae42e5bea10f939e516dfd60c
-  data.tar.gz: d4a121bd883694dcf6a6a39b14737769e4095490d01ead576237d1721b2417289b6efb20738e1a1dd3f5735395f711df884cf8e28351a56ba0447d5668ee35a2
+  metadata.gz: 1dc22ba6426f9b2f06ef710e6908bb97eac861c6fd0d6810cf887e21814d1531621fcde8ab6a12ccdd75a2a0152f069100ad5b3d75d977cd221db148197c6e7c
+  data.tar.gz: d079cacae3eb059499f1f008928dd677be4aefbc873420b647a7db588b47f13d6d24fc506bae64395363b292f9fcde29e1d30a6a16f9dd20463ca11f367ac302

data/README.md

@@ -32,7 +32,7 @@ class TestChannel < ApplicationCable::Channel
   include ActionCableNotifications::Streams
 
   def subscribed
-    stream_notifications_for model, include_initial: true
+    stream_notifications_for model, include_initial: true, scope: [:all, [:limit, 5], [:order, :id]]
   end
 
   def unsubscribed
@@ -41,6 +41,28 @@ class TestChannel < ApplicationCable::Channel
 end
 ```
 
+Method stream_notifications_for receives the following parameters: 
+
+```ruby
+stream_notifications_for(model, options = {}, &block)
+```
+
+* model: **(ActiveRecord model)** - Specifies the model to be used for data fetching and event binding.
+* options: **(Hash)** - Options to be used for configuracion. Default options are:
+```ruby
+{
+  actions: [:create, :update, :destroy],     # Controller actions to attach to
+  broadcasting: model.model_name.collection, # Name of the pubsub stream
+  callback: nil,                             # Same as http://edgeapi.rubyonrails.org/classes/ActionCable/Channel/Streams.html
+  coder: nil,                                # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to the callback.
+                                             # Defaults to `coder: nil` which does no decoding, passes raw messages.
+  include_initial: false,                    # Send all records to the subscriber upon connection
+  params: params,                            # Params sent during subscription
+  scope: :all                                # Default collection scope
+}
+```
+* block: **(Proc)** - Same as options[:callback]
+
 ## Contributing
 Contribution directions go here.
 

data/lib/action_cable_notifications/callbacks.rb

@@ -45,8 +45,6 @@ module ActionCableNotifications
       end
     end
 
-    private
-
     def notify_create
       self.ActionCableNotificationsOptions.each do |broadcasting, options|
         # Checks if record is within scope before broadcasting
@@ -89,5 +87,6 @@ module ActionCableNotifications
         end
       end
     end
+
   end
 end

data/lib/action_cable_notifications/version.rb

@@ -1,3 +1,3 @@
 module ActionCableNotifications
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - ByS Sistemas de Control
@@ -44,8 +44,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails engine that provides automatic notification broadcasts for Ruby
-  on Rails models changes using Action Cable and websockets
+description: Rails engine that provides Automatic realtime notification broadcast
+  for ActiveRecord models changes using Action Cable and websockets
 email:
 - info@bys-control.com.ar
 executables: []