activity_notification 1.7.1 → 2.0.0

data/lib/activity_notification/orm/mongoid.rb

@@ -8,7 +8,7 @@ module ActivityNotification
       # @param [String] name     Association name
       # @param [Object] instance Associated instance
       # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
-      scope :filtered_by_association, ->(name, instance) { instance.present? ? where({ "#{name}_id" => instance.id, "#{name}_type" => instance.class.name }) : none }
+      scope :filtered_by_association, ->(name, instance) { where("#{name}_id" => instance.present? ? instance.id : nil, "#{name}_type" => instance.present? ? instance.class.name : nil) }
     end
 
     class_methods do
@@ -24,6 +24,8 @@ module ActivityNotification
         id_field, type_field = "#{association_name}_id", "#{association_name}_type"
         field id_field,   type: String
         field type_field, type: String
+        associated_record_field = "#{association_name}_record"
+        field associated_record_field, type: String if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
 
         self.instance_eval do
           define_method(name) do |reload = false|
@@ -41,6 +43,7 @@ module ActivityNotification
             if new_instance.nil? then instance_id, instance_type = nil, nil else instance_id, instance_type = new_instance.id, new_instance.class.name end
             self.send("#{id_field}=", instance_id)
             self.send("#{type_field}=", instance_type)
+            self.send("#{associated_record_field}=", new_instance.to_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
             self.instance_variable_set("@#{name}", nil)
           end
         end

data/lib/activity_notification/orm/mongoid/notification.rb

@@ -19,12 +19,12 @@ module ActivityNotification
         # Belongs to target instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Target instance of this notification
-        belongs_to_polymorphic_xdb_record :target
+        belongs_to_polymorphic_xdb_record :target, store_with_associated_records: true
 
         # Belongs to notifiable instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Notifiable instance of this notification
-        belongs_to_polymorphic_xdb_record :notifiable
+        belongs_to_polymorphic_xdb_record :notifiable, store_with_associated_records: true
 
         # Belongs to group instance of this notification as polymorphic association.
         # @scope instance
@@ -53,7 +53,7 @@ module ActivityNotification
         # Belongs to :otifier instance of this notification.
         # @scope instance
         # @return [Object] Notifier instance of this notification
-        belongs_to_polymorphic_xdb_record :notifier
+        belongs_to_polymorphic_xdb_record :notifier, store_with_associated_records: true
 
         validates  :target,        presence: true
         validates  :notifiable,    presence: true
@@ -170,26 +170,6 @@ module ActivityNotification
         # Dummy reload method for test of notifications.
         scope :reload,                            -> { }
 
-        # Returns latest notification instance.
-        # @return [Notification] Latest notification instance
-        def self.latest
-          latest_order.first
-        end
-
-        # Returns earliest notification instance.
-        # @return [Notification] Earliest notification instance
-        def self.earliest
-          earliest_order.first
-        end
-
-        # Selects unique keys from query for notifications.
-        # @return [Array<String>] Array of notification unique keys
-        def self.uniq_keys
-          # distinct method cannot keep original sort
-          # distinct(:key)
-          pluck(:key).uniq
-        end
-
         # Returns if the notification is group owner.
         # Calls NotificationApi#group_owner? as super method.
         # @return [Boolean] If the notification is group owner
@@ -197,9 +177,12 @@ module ActivityNotification
           super
         end
 
-        # Raise DeleteRestrictionError for notifications.
+        # Raise ActivityNotification::DeleteRestrictionError for notifications.
+        # @param [String] error_text Error text for raised exception
+        # @raise ActivityNotification::DeleteRestrictionError
+        # @return [void]
         def self.raise_delete_restriction_error(error_text)
-          raise error_text
+          raise ActivityNotification::DeleteRestrictionError, error_text
         end
 
         protected

data/lib/activity_notification/orm/mongoid/subscription.rb

@@ -26,7 +26,7 @@ module ActivityNotification
         field :subscribed_to_email_at,    type: DateTime
         field :unsubscribed_to_email_at,  type: DateTime
         field :optional_targets,          type: Hash,    default: {}
-    
+
         validates  :target,               presence: true
         validates  :key,                  presence: true
         validates_inclusion_of :subscribing,          in: [true, false]

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -95,6 +95,18 @@ module ActivityNotification
       #     acts_as_notifiable :users, targets: User.all, email_allowed: true
       #   end
       #
+      # * :action_cable_allowed
+      #   * Whether activity_notification publishes notifications to ActionCable channel.
+      #     Specified method or symbol is expected to return true (not nil) or false (nil).
+      #     This parameter is a optional since default value is false.
+      #     To use ActionCable for notifications, action_cable_allowed option must return true (not nil) in both of notifiable and target model.
+      #     This can be also configured default option in initializer.
+      # @example Enable notification ActionCable for this notifiable model
+      #   # app/models/comment.rb
+      #   class Comment < ActiveRecord::Base
+      #     acts_as_notifiable :users, targets: User.all, action_cable_allowed: true
+      #   end
+      #
       # * :notifiable_path
       #   * Path to redirect from open or move action of notification controller.
       #     You can also use this notifiable_path as notifiable link in notification view.
@@ -196,6 +208,7 @@ module ActivityNotification
       # @option options [Symbol, Proc, Object]  :notifier                (nil)                    Notifier of the notifications
       # @option options [Symbol, Proc, Hash]    :parameters              ({})                     Additional parameters of the notifications
       # @option options [Symbol, Proc, Boolean] :email_allowed           (ActivityNotification.config.email_enabled) Whether activity_notification sends notification email
+      # @option options [Symbol, Proc, Boolean] :action_cable_allowed    (ActivityNotification.config.action_cable_enabled) Whether activity_notification publishes WebSocket using ActionCable
       # @option options [Symbol, Proc, String]  :notifiable_path         (polymorphic_path(self)) Path to redirect from open or move action of notification controller
       # @option options [Boolean, Hash]         :tracked                 (nil)                    Flag or parameters for automatic tracked notifications
       # @option options [Symbol, Proc, String]  :printable_name          (ActivityNotification::Common.printable_name) Printable notifiable name
@@ -220,7 +233,7 @@ module ActivityNotification
 
         options[:printable_notifiable_name] ||= options.delete(:printable_name)
         configured_params
-          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed, :action_cable_allowed], options, "notification_")
           .merge set_acts_as_parameters_for_target(target_type, [:notifier, :notifiable_path, :printable_notifiable_name, :optional_targets], options)
       end
 
@@ -233,6 +246,7 @@ module ActivityNotification
           :notifier,
           :parameters,
           :email_allowed,
+          :action_cable_allowed,
           :notifiable_path,
           :printable_notifiable_name, :printable_name,
           :dependent_notifications,
@@ -284,11 +298,22 @@ module ActivityNotification
         # See the followings:
         #   https://github.com/rails/rails/issues/30779
         #   https://github.com/rails/rails/pull/32167
-        # :only-rails-without-callback-issue:
+
+        # :only-rails5-plus#only-rails-without-callback-issue:
+        # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+        # :except-rails5-plus#only-rails-without-callback-issue:
+        # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
         if !(Gem::Version.new("5.1.6") <= Rails.gem_version && Rails.gem_version < Gem::Version.new("5.2.2")) && respond_to?(:after_commit)
           after_commit tracked_proc, on: tracked_action
-        # :only-rails-without-callback-issue:
-        # :only-rails-with-callback-issue:
+        # :only-rails5-plus#only-rails-without-callback-issue:
+        # :only-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+        # :except-rails5-plus#only-rails-without-callback-issue:
+        # :except-rails5-plus#only-rails-without-callback-issue#except-dynamoid:
+
+        # :only-rails5-plus#only-rails-with-callback-issue:
+        # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
+        # :except-rails5-plus#only-rails-with-callback-issue:
+        # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
         else
           case tracked_action
           when :create
@@ -297,7 +322,10 @@ module ActivityNotification
             after_update tracked_proc
           end
         end
-        # :only-rails-with-callback-issue:
+        # :only-rails5-plus#only-rails-with-callback-issue:
+        # :only-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
+        # :except-rails5-plus#only-rails-with-callback-issue:
+        # :except-rails5-plus#only-rails-with-callback-issue#except-dynamoid:
       end
 
       # Adds destroy dependency.

data/lib/activity_notification/roles/acts_as_target.rb

@@ -34,6 +34,57 @@ module ActivityNotification
       #     acts_as_target email: :email, email_allowed: :confirmed_at
       #   end
       #
+      # * :batch_email_allowed
+      #   * Whether activity_notification sends batch notification email to this target.
+      #     Specified method or symbol is expected to return true (not nil) or false (nil).
+      #     This parameter is a optional since default value is false.
+      #     To use batch notification email, both of batch_email_allowed and subscription_allowed options must return true (not nil) in target model.
+      #     This can be also configured default option in initializer.
+      # @example Always enable batch email notification for this target
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_target email: :email, batch_email_allowed: true
+      #   end
+      # @example Use confirmed_at of devise field to decide whether activity_notification sends batch notification email to this user
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_target email: :email, batch_email_allowed: :confirmed_at
+      #   end
+      #
+      # * :subscription_allowed
+      #   * Whether activity_notification manages subscriptions of this target.
+      #     Specified method or symbol is expected to return true (not nil) or false (nil).
+      #     This parameter is a optional since default value is false.
+      #     This can be also configured default option in initializer.
+      # @example Subscribe notifications for this target
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_target subscription_allowed: true
+      #   end
+      #
+      # * :action_cable_allowed
+      #   * Whether activity_notification publishes WebSocket notifications using ActionCable to this target.
+      #     Specified method or symbol is expected to return true (not nil) or false (nil).
+      #     This parameter is a optional since default value is false.
+      #     To use ActionCable for notifications, action_cable_enabled option must return true (not nil) in both of notifiable and target model.
+      #     This can be also configured default option in initializer.
+      # @example Enable notification ActionCable for this target
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_target action_cable_allowed: true
+      #   end
+      #
+      # * :action_cable_with_devise
+      #   * Whether activity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise.
+      #     Specified method or symbol is expected to return true (not nil) or false (nil).
+      #     This parameter is a optional since default value is false.
+      #     To use ActionCable for notifications, also action_cable_enabled option must return true (not nil) in the target model.
+      # @example Enable notification ActionCable for this target
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_target action_cable_allowed: true, action_cable_with_devise* true
+      #   end
+      #
       # * :devise_resource
       #   * Integrated resource with devise authentication.
       #     This parameter is a optional since `self` is used as default value.
@@ -121,20 +172,22 @@ module ActivityNotification
       #   end
       #
       # @param [Hash] options Options for notifiable model configuration
-      # @option options [Symbol, Proc, String]  :email                 (nil)                                              Email address to send notification email
-      # @option options [Symbol, Proc, Boolean] :email_allowed         (ActivityNotification.config.email_enabled)        Whether activity_notification sends notification email to this target
-      # @option options [Symbol, Proc, Boolean] :batch_email_allowed   (ActivityNotification.config.email_enabled)        Whether activity_notification sends batch notification email to this target
-      # @option options [Symbol, Proc, Boolean] :subscription_allowed  (ActivityNotification.config.subscription_enabled) Whether activity_notification manages subscriptions of this target
-      # @option options [Symbol, Proc, Object]  :devise_resource       (->(model) { model })                              Integrated resource with devise authentication
-      # @option options [Symbol, Proc, Object]  :current_devise_target (->(current_resource) { current_resource })        Current authenticated target by devise authentication
-      # @option options [Symbol, Proc, String]  :printable_name        (ActivityNotification::Common.printable_name)      Printable notification target name
+      # @option options [Symbol, Proc, String]  :email                    (nil)                                              Email address to send notification email
+      # @option options [Symbol, Proc, Boolean] :email_allowed            (ActivityNotification.config.email_enabled)        Whether activity_notification sends notification email to this target
+      # @option options [Symbol, Proc, Boolean] :batch_email_allowed      (ActivityNotification.config.email_enabled)        Whether activity_notification sends batch notification email to this target
+      # @option options [Symbol, Proc, Boolean] :subscription_allowed     (ActivityNotification.config.subscription_enabled) Whether activity_notification manages subscriptions of this target
+      # @option options [Symbol, Proc, Boolean] :action_cable_allowed     (ActivityNotification.config.action_cable_enabled) Whether activity_notification publishes WebSocket notifications using ActionCable to this target
+      # @option options [Symbol, Proc, Boolean] :action_cable_with_devise (false)                                            Whether activity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise
+      # @option options [Symbol, Proc, Object]  :devise_resource          (->(model) { model })                              Integrated resource with devise authentication
+      # @option options [Symbol, Proc, Object]  :current_devise_target    (->(current_resource) { current_resource })        Current authenticated target by devise authentication
+      # @option options [Symbol, Proc, String]  :printable_name           (ActivityNotification::Common.printable_name)      Printable notification target name
       # @return [Hash] Configured parameters as target model
       def acts_as_target(options = {})
         include Target
 
         options[:printable_notification_target_name] ||= options.delete(:printable_name)
         options[:batch_notification_email_allowed] ||= options.delete(:batch_email_allowed)
-        acts_as_params = set_acts_as_parameters([:email, :email_allowed, :subscription_allowed, :devise_resource, :current_devise_target], options, "notification_")
+        acts_as_params = set_acts_as_parameters([:email, :email_allowed, :subscription_allowed, :action_cable_allowed, :action_cable_with_devise, :devise_resource, :current_devise_target], options, "notification_")
                            .merge set_acts_as_parameters([:batch_notification_email_allowed, :printable_notification_target_name], options)
         include Subscriber if subscription_enabled?
         acts_as_params
@@ -144,7 +197,7 @@ module ActivityNotification
       # Returns array of available target options in acts_as_target.
       # @return [Array<Symbol>] Array of available target options
       def available_target_options
-        [:email, :email_allowed, :batch_email_allowed, :subscription_allowed, :devise_resource, :printable_notification_target_name, :printable_name].freeze
+        [:email, :email_allowed, :batch_email_allowed, :subscription_allowed, :action_cable_enabled, :action_cable_with_devise, :devise_resource, :printable_notification_target_name, :printable_name].freeze
       end
     end
   end

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "1.7.1"
+  VERSION = "2.0.0"
 end

data/lib/generators/templates/activity_notification.rb

@@ -1,14 +1,14 @@
 ActivityNotification.configure do |config|
 
-  # Configure ORM name for ActivityNotification.
-  # Set :active_record or :mongoid.
-  ENV['AN_ORM'] = 'active_record' unless ENV['AN_ORM'] == 'mongoid'
-  config.orm = ENV['AN_ORM']
-
-  # Configure if all activity notifications are enabled.
-  # Set false when you want to turn off activity notifications.
+  # Configure if all activity notifications are enabled
+  # Set false when you want to turn off activity notifications
   config.enabled = true
 
+  # Configure ORM name for ActivityNotification.
+  # Set :active_record, :mongoid or :dynamoid.
+  ENV['AN_ORM'] = 'active_record' if ['mongoid', 'dynamoid'].exclude?(ENV['AN_ORM'])
+  config.orm = ENV['AN_ORM'].to_sym
+
   # Configure table name to store notification data.
   config.notification_table_name = "notifications"
 
@@ -47,6 +47,9 @@ ActivityNotification.configure do |config|
   # Configure the parent class for activity_notification controllers.
   # config.parent_controller = 'ApplicationController'
 
+  # Configure the parent class for activity_notification channels.
+  # config.parent_channel = 'ActionCable::Channel::Base'
+
   # Configure the custom mailer templates directory
   # config.mailer_templates_dir = 'activity_notification/mailer'
 
@@ -56,4 +59,24 @@ ActivityNotification.configure do |config|
   # Configure ActiveJob queue name for delayed notifications.
   config.active_job_queue = :activity_notification
 
+  # Configure delimiter of composite key for DynamoDB.
+  # config.composite_key_delimiter = '#'
+
+  # Configure if activity_notification stores notificaion records including associated records like target and notifiable..
+  # This store_with_associated_records option can be set true only when you use mongoid or dynamoid ORM.
+  config.store_with_associated_records = false
+
+  # Configure if WebSocket subscription using ActionCable is enabled.
+  # Note that you can configure them for each model by acts_as roles.
+  # Set true when you want to turn on WebSocket subscription using ActionCable as default.
+  config.action_cable_enabled = false
+
+  # Configure if ctivity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise.
+  # Note that you can configure them for each model by acts_as roles.
+  # Set true when you want to use Device integration with WebSocket subscription using ActionCable as default.
+  config.action_cable_with_devise = false
+
+  # Configure notification channel prefix for ActionCable.
+  config.notification_channel_prefix = 'activity_notification_channel'
+
 end

data/lib/tasks/activity_notification_tasks.rake

@@ -1,4 +1,14 @@
-# desc "Explaining what the task does"
-# task :activity_notification do
-#   # Task goes here
-# end
+namespace :activity_notification do
+  desc "Create Amazon DynamoDB tables used by activity_notification with Dynamoid"
+  task create_dynamodb_tables: :environment do
+    if ActivityNotification.config.orm == :dynamoid
+      ActivityNotification::Notification.create_table(sync: true)
+      puts "Created table: #{ActivityNotification::Notification.table_name}"
+      ActivityNotification::Subscription.create_table(sync: true)
+      puts "Created table: #{ActivityNotification::Subscription.table_name}"
+    else
+      puts "Error: ActivityNotification.config.orm is not set to :dynamoid."
+      puts "Error: Confirm to set AN_ORM environment variable to dynamoid or set ActivityNotification.config.orm to :dynamoid."
+    end
+  end
+end

data/spec/channels/notification_channel_shared_examples.rb

@@ -0,0 +1,59 @@
+# @See https://github.com/palkan/action-cable-testing
+shared_examples_for :notification_channel do
+  let(:target_params) { { target_type: target_type }.merge(extra_params || {}) }
+
+  before { stub_connection }
+
+  context "with target_type and target_id parameters" do
+    it "successfully subscribes" do
+      subscribe(target_params.merge({ target_id: test_target.id, typed_target_param => 'dummy' }))
+      expect(subscription).to be_confirmed
+      expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+    end
+  end
+
+  context "with target_type and (typed_target)_id parameters" do
+    it "successfully subscribes" do
+      subscribe(target_params.merge({ typed_target_param => test_target.id }))
+      expect(subscription).to be_confirmed
+      expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+    end
+  end
+
+  context "without any parameters" do
+    it "rejects subscription" do
+      subscribe
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      }.to raise_error(/Must be subscribed!/)
+    end
+  end
+
+  context "without target_type parameter" do
+    it "rejects subscription" do
+      subscribe({ typed_target_param => test_target.id })
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      }.to raise_error(/Must be subscribed!/)
+    end
+  end
+
+  context "without target_id and (typed_target)_id parameters" do
+    it "rejects subscription" do
+      subscribe(target_params)
+      expect(subscription).to be_rejected
+    end
+  end
+
+  context "with not found (typed_target)_id parameter" do
+    it "rejects subscription" do
+      subscribe(target_params.merge({ typed_target_param => 0 }))
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      }.to raise_error(/Must be subscribed!/)
+    end
+  end
+end

data/spec/channels/notification_channel_spec.rb

@@ -0,0 +1,50 @@
+if Rails::VERSION::MAJOR >= 5
+  require 'channels/notification_channel_shared_examples'
+
+  # @See https://github.com/palkan/action-cable-testing
+  describe ActivityNotification::NotificationChannel, type: :channel do
+    let(:test_target)        { create(:user) }
+    let(:target_type)        { "User" }
+    let(:typed_target_param) { "user_id" }
+    let(:extra_params)       { {} }
+
+    context "when target.notification_action_cable_with_devise? returns true" do
+      before do
+        @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
+        User._notification_action_cable_with_devise = true
+      end
+
+      after do
+        User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
+      end
+
+      it "rejects subscription even if target_type and target_id parameters are passed" do
+        subscribe({ target_type: target_type, target_id: test_target.id })
+        expect(subscription).to be_rejected
+        expect {
+          expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+        }.to raise_error(/Must be subscribed!/)
+      end
+    end
+
+    context "when target.notification_action_cable_with_devise? returns false" do
+      before do
+        @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
+        User._notification_action_cable_with_devise = false
+      end
+
+      after do
+        User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
+      end
+
+      it "successfully subscribes with target_type and target_id parameters" do
+        subscribe({ target_type: target_type, target_id: test_target.id })
+        expect(subscription).to be_confirmed
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+        expect(subscription).to have_stream_from("activity_notification_channel_User##{test_target.id}")
+      end
+
+      it_behaves_like :notification_channel
+    end
+  end
+end