action_cable_notifications 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79722760dc7087e962c3dae93d08d9680d472472
-  data.tar.gz: 39dfd3ec02a502ec8005fe3eb723275bde0ccd46
+  metadata.gz: 10872c8c2efdc7d4bd67ea4301331116774bdff2
+  data.tar.gz: e9b661dff6fafdf5076fedd5161020e11a1c82f8
 SHA512:
-  metadata.gz: 8e3edd413a94cd4104ebf0499877b7c66cdf2be8d191b3cd66a08de8282ecaf0d3e47bc60ac7ddd16399137f596c4024ffc04cb4eb5ac23cfb57670f4eaa9014
-  data.tar.gz: c975d1f2af7e6b0f869f6252468fc8204cf1f61be7ae05c247d50a3452ee7969dabee84b2d721ab82c80c324e51b44cc247d3fc671a4cc8ed5526eae832a87e7
+  metadata.gz: 2eabf026860c2ce9baf5232b99f512aed3e61160aa251cbf0c3ab4137f200f66de8242cd9e5ebd3013a8c0dde50b67913ac1f9eae42e5bea10f939e516dfd60c
+  data.tar.gz: d4a121bd883694dcf6a6a39b14737769e4095490d01ead576237d1721b2417289b6efb20738e1a1dd3f5735395f711df884cf8e28351a56ba0447d5668ee35a2

data/lib/action_cable_notifications/callbacks.rb

@@ -13,25 +13,51 @@ module ActionCableNotifications
     end
 
     module ClassMethods
-      def set_action_cable_notification_options( options = {} )
-        self.ActionCableNotificationsOptions = options
+      # Options setter
+      def action_cable_notification_options= ( broadcasting, options = nil )
+        if options.present?
+          self.ActionCableNotificationsOptions[broadcasting.to_sym] = options
+        else
+          self.ActionCableNotificationsOptions.except! broadcasting.to_sym
+        end
       end
 
-      def notify_initial
-        data = {
+      # Options getter
+      def action_cable_notification_options ( broadcasting )
+        if broadcasting.present?
+          self.ActionCableNotificationsOptions[broadcasting.to_sym]
+        else
+          self.ActionCableNotificationsOptions
+        end
+      end
+
+      def scoped_collection ( scope )
+        Array(Array(scope).inject(self) {|o, a| o.try(*a)})
+      end
+
+      def notify_initial ( broadcasting )
+        options = self.action_cable_notification_options( broadcasting )
+        {
           collection: self.model_name.collection,
-          msg: 'add',
-          data: self.all
+          msg: 'add_collection',
+          data: self.scoped_collection(options[:scope])
         }
       end
     end
 
+    private
+
     def notify_create
-      ActionCable.server.broadcast self.ActionCableNotificationsOptions[:broadcast_name],
-        collection: self.model_name.collection,
-        msg: 'create',
-        id: self.id,
-        fields: self
+      self.ActionCableNotificationsOptions.each do |broadcasting, options|
+        # Checks if record is within scope before broadcasting
+        if self.class.scoped_collection(options[:scope]).include? self
+          ActionCable.server.broadcast broadcasting,
+            collection: self.model_name.collection,
+            msg: 'create',
+            id: self.id,
+            data: self
+        end
+      end
     end
 
     def notify_update
@@ -40,18 +66,28 @@ module ActionCableNotifications
         changes[k] = v[1]
       end
 
-      ActionCable.server.broadcast self.ActionCableNotificationsOptions[:broadcast_name],
-        collection: self.model_name.collection,
-        msg: 'update',
-        id: self.id,
-        fields: changes
+      self.ActionCableNotificationsOptions.each do |broadcasting, options|
+        # Checks if record is within scope before broadcasting
+        if self.class.scoped_collection(options[:scope]).include? self
+          ActionCable.server.broadcast broadcasting,
+            collection: self.model_name.collection,
+            msg: 'update',
+            id: self.id,
+            data: changes
+        end
+      end
     end
 
     def notify_destroy
-      ActionCable.server.broadcast self.ActionCableNotificationsOptions[:broadcast_name],
-        collection: self.model_name.collection,
-        msg: 'destroy',
-        id: self.id
+      self.ActionCableNotificationsOptions.each do |broadcasting, options|
+        # Checks if record is within scope before broadcasting
+        if self.class.scoped_collection(options[:scope]).include? self
+          ActionCable.server.broadcast broadcasting,
+            collection: self.model_name.collection,
+            msg: 'destroy',
+            id: self.id
+        end
+      end
     end
   end
 end

data/lib/action_cable_notifications/streams.rb

@@ -3,34 +3,50 @@ module ActionCableNotifications
     extend ActiveSupport::Concern
 
     included do
-
+      # Actions to be done when the module is included
     end
 
     private
 
-    def stream_notifications_for(model, options = {}, callback = nil)
+    def stream_notifications_for(model, options = {}, &block)
+      @model = model
+
       # Default options
-      options = {
+      @options = {
+        actions: [:create, :update, :destroy],
+        broadcasting: model.model_name.collection,
+        callback: nil,
+        coder: nil,
         include_initial: false, # Send all records to the subscriber on connection
-        broadcast_name: model.model_name.collection
+        params: params,
+        scope: :all             # Default collection scope
         }.merge(options)
 
       # Checks if model already includes notification callbacks
-      if !model.respond_to? :ActionCableNotificationsOptions
-        model.send('include', ActionCableNotifications::Callbacks)
+      if !@model.respond_to? :ActionCableNotificationsOptions
+        @model.send('include', ActionCableNotifications::Callbacks)
       end
 
       # Set specified options on model
-      model.send('set_action_cable_notification_options', options)
+      @model.send('action_cable_notification_options=', @options[:broadcasting], @options)
 
-      stream_from(options[:broadcast_name], callback)
+      # Start streaming
+      stream_from(@options[:broadcasting], options[:callback] || block, @options.slice(:coder))
 
       # Transmit initial state if required
-      if options[:include_initial]
-        transmit model.notify_initial
+      if @options[:include_initial]
+        # XXX: Check if data should be transmitted
+        transmit @model.notify_initial @options[:broadcasting]
       end
 
     end
 
+    def unsubscribed
+      stop_all_streams
+
+      # Unset options for this channel on model
+      @model.send('action_cable_notification_options=', @options[:broadcasting], nil)
+    end
+
   end
 end

data/lib/action_cable_notifications/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - ByS Sistemas de Control
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Realtime notification broadcast for Ruby on Rails models changes using Action
-  Cable and websockets
+summary: Automatic realtime notification broadcast for ActiveRecord models changes
+  using Action Cable and websockets
 test_files: []