activity_notification 1.0.2 → 1.1.0

data/lib/generators/templates/migrations/migration.rb

@@ -0,0 +1,57 @@
+# Migration responsible for creating a table with notifications
+class <%= @migration_name %> < ActiveRecord::Migration
+  # Create tables
+  def change
+    <% if @migration_tables.include?('notifications') %>create_table :notifications do |t|
+      t.belongs_to :target,     polymorphic: true, index: true, null: false
+      t.belongs_to :notifiable, polymorphic: true, index: true, null: false
+      t.string     :key,                                        null: false
+      t.belongs_to :group,      polymorphic: true, index: true
+      t.integer    :group_owner_id,                index: true
+      t.belongs_to :notifier,   polymorphic: true, index: true
+      t.text       :parameters
+      t.datetime   :opened_at
+
+      t.timestamps
+    end<% else %># create_table :notifications do |t|
+    #   t.belongs_to :target,     polymorphic: true, index: true, null: false
+    #   t.belongs_to :notifiable, polymorphic: true, index: true, null: false
+    #   t.string     :key,                                        null: false
+    #   t.belongs_to :group,      polymorphic: true, index: true
+    #   t.integer    :group_owner_id,                index: true
+    #   t.belongs_to :notifier,   polymorphic: true, index: true
+    #   t.text       :parameters
+    #   t.datetime   :opened_at
+    #
+    #   t.timestamps
+    # end<% end %>
+
+    <% if @migration_tables.include?('subscriptions') %>create_table :subscriptions do |t|
+      t.belongs_to :target,     polymorphic: true, index: true, null: false
+      t.string     :key,                           index: true, null: false
+      t.boolean    :subscribing,                                null: false, default: true
+      t.boolean    :subscribing_to_email,                       null: false, default: true
+      t.datetime   :subscribed_at
+      t.datetime   :unsubscribed_at
+      t.datetime   :subscribed_to_email_at
+      t.datetime   :unsubscribed_to_email_at
+      t.text       :parameters
+
+      t.timestamps
+    end
+    add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% else %># create_table :subscriptions do |t|
+    #   t.belongs_to :target,     polymorphic: true, index: true, null: false
+    #   t.string     :key,                           index: true, null: false
+    #   t.boolean    :subscribing,                                null: false, default: true
+    #   t.boolean    :subscribing_to_email,                       null: false, default: true
+    #   t.datetime   :subscribed_at
+    #   t.datetime   :unsubscribed_at
+    #   t.datetime   :subscribed_to_email_at
+    #   t.datetime   :unsubscribed_to_email_at
+    #   t.text       :parameters
+    #
+    #   t.timestamps
+    # end
+    # add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% end %>
+  end
+end

data/lib/generators/templates/models/README

@@ -0,0 +1,10 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  Ensure you have configured model name in your initializer activity_notification.rb.
+  For example:
+
+    #TODO
+
+===============================================================================

data/lib/generators/templates/{notification → models}/notification.rb

@@ -1,6 +1,4 @@
 # Notification model for customisation & custom methods
-class <%= @model_name %> < ActivityNotification::Notification
-
+class <%= @target_prefix %><%= @model_name %> < ActivityNotification::Notification
   # Write custom methods or override methods here
-
 end

data/lib/generators/templates/models/subscription.rb

@@ -0,0 +1,4 @@
+# Subscription model for customisation & custom methods
+class <%= @target_prefix %><%= @model_name %> < ActivityNotification::Subscription
+  # Write custom methods or override methods here
+end

data/spec/concerns/apis/notification_api_spec.rb

@@ -118,7 +118,7 @@ shared_examples_for :notification_api do
     end
 
     describe ".notify_to" do
-      it "returns reated notification" do
+      it "returns created notification" do
         notification = described_class.notify_to(@user_1, @comment_2)
         validate_expected_notification(notification, @user_1, @comment_2)
       end
@@ -299,6 +299,29 @@ shared_examples_for :notification_api do
           member_notification = described_class.notify_to(@user_1, @comment_2, key: 'key2', group: @article)
           expect(member_notification.group_owner).to eq(nil)
         end
+
+        context "with group_expiry_delay option" do
+          context "within the group expiry period" do
+            it "belongs to single group" do
+              owner_notification    = described_class.notify_to(@user_1, @comment_1, group: @article, group_expiry_delay: 1.day)
+              member_notification_1 = described_class.notify_to(@user_1, @comment_2, group: @article, group_expiry_delay: 1.day)
+              member_notification_2 = described_class.notify_to(@user_1, @comment_2, group: @article, group_expiry_delay: 1.day)
+              expect(member_notification_1.group_owner).to eq(owner_notification)
+              expect(member_notification_2.group_owner).to eq(owner_notification)
+            end
+          end
+
+          context "out of the group expiry period" do
+            it "does not belong to single group" do
+              owner_notification    = described_class.notify_to(@user_1, @comment_1, group: @article, group_expiry_delay: 1.second)
+              member_notification_1 = described_class.notify_to(@user_1, @comment_2, group: @article, group_expiry_delay: 1.second)
+              sleep(1)
+              member_notification_2 = described_class.notify_to(@user_1, @comment_2, group: @article, group_expiry_delay: 1.second)
+              expect(member_notification_1.group_owner).to eq(owner_notification)
+              expect(member_notification_2.group_owner).to be_nil
+            end
+          end
+        end
       end
     end
 
@@ -328,16 +351,16 @@ shared_examples_for :notification_api do
 
       it "opens all notification with current time" do
         expect(@user_1.notifications.first.opened_at).to be_nil
-        Timecop.freeze(DateTime.now)
+        Timecop.freeze(Time.current)
         described_class.open_all_of(@user_1)
-        expect(@user_1.notifications.first.opened_at.to_i).to eq(DateTime.now.to_i)
+        expect(@user_1.notifications.first.opened_at.to_i).to eq(Time.current.to_i)
         Timecop.return
       end
 
       context "with opened_at option" do
         it "opens all notification with specified time" do
           expect(@user_1.notifications.first.opened_at).to be_nil
-          opened_at = DateTime.now - 1.months
+          opened_at = Time.current - 1.months
           described_class.open_all_of(@user_1, opened_at: opened_at)
           expect(@user_1.notifications.first.opened_at.to_i).to eq(opened_at.to_i)
         end
@@ -507,21 +530,21 @@ shared_examples_for :notification_api do
       context "as default" do
         it "open notification with current time" do
           expect(test_instance.opened_at.blank?).to be_truthy
-          Timecop.freeze(DateTime.now)
+          Timecop.freeze(Time.current)
           test_instance.open!
           expect(test_instance.opened_at.blank?).to be_falsey
-          expect(test_instance.opened_at).to        eq(DateTime.now)
+          expect(test_instance.opened_at).to        eq(Time.current)
           Timecop.return
         end
 
         it "open group member notifications with current time" do
           group_member = create(test_class_name, group_owner: test_instance)
           expect(group_member.opened_at.blank?).to be_truthy
-          Timecop.freeze(DateTime.now)
+          Timecop.freeze(Time.current)
           test_instance.open!
           group_member = group_member.reload
           expect(group_member.opened_at.blank?).to be_falsey
-          expect(group_member.opened_at.to_i).to   eq(DateTime.now.to_i)
+          expect(group_member.opened_at.to_i).to   eq(Time.current.to_i)
           Timecop.return
         end
       end
@@ -529,7 +552,7 @@ shared_examples_for :notification_api do
       context "with opened_at option" do
         it "open notification with specified time" do
           expect(test_instance.opened_at.blank?).to be_truthy
-          opened_at = DateTime.now - 1.months
+          opened_at = Time.current - 1.months
           test_instance.open!(opened_at: opened_at)
           expect(test_instance.opened_at.blank?).to be_falsey
           expect(test_instance.opened_at).to        eq(opened_at)
@@ -538,7 +561,7 @@ shared_examples_for :notification_api do
         it "open group member notifications with specified time" do
           group_member = create(test_class_name, group_owner: test_instance)
           expect(group_member.opened_at.blank?).to be_truthy
-          opened_at = DateTime.now - 1.months
+          opened_at = Time.current - 1.months
           test_instance.open!(opened_at: opened_at)
           group_member = group_member.reload
           expect(group_member.opened_at.blank?).to be_falsey
@@ -550,7 +573,7 @@ shared_examples_for :notification_api do
         it "does not open group member notifications" do
           group_member = create(test_class_name, group_owner: test_instance)
           expect(group_member.opened_at.blank?).to be_truthy
-          opened_at = DateTime.now - 1.months
+          opened_at = Time.current - 1.months
           test_instance.open!(with_members: false)
           group_member = group_member.reload
           expect(group_member.opened_at.blank?).to be_truthy
@@ -1087,6 +1110,20 @@ shared_examples_for :notification_api do
           .to eq(test_instance.notifiable.notifiable_path(test_instance.target_type, test_instance.key))
       end
     end
+
+    describe "#subscribed?" do
+      it "returns target.subscribes_to_notification?" do
+        expect(test_instance.subscribed?)
+          .to eq(test_instance.target.subscribes_to_notification?(test_instance.key))
+      end
+    end
+
+    describe "#email_subscribed?" do
+      it "returns target.subscribes_to_notification_email?" do
+        expect(test_instance.subscribed?)
+          .to eq(test_instance.target.subscribes_to_notification_email?(test_instance.key))
+      end
+    end
   end
 
   describe "as protected instance methods" do

data/spec/concerns/apis/subscription_api_spec.rb

@@ -0,0 +1,167 @@
+shared_examples_for :subscription_api do
+  include ActiveJob::TestHelper
+  let(:test_class_name) { described_class.to_s.underscore.split('/').last.to_sym }
+  let(:test_instance) { create(test_class_name) }
+
+  describe "as public instance methods" do
+    describe "#subscribe" do
+      before do
+        test_instance.unsubscribe
+      end
+
+      it "returns if successfully updated subscription instance" do
+        expect(test_instance.subscribe).to be_truthy
+      end
+
+      context "as default" do
+        it "subscribe with current time" do
+          expect(test_instance.subscribing).to                   eq(false)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          Timecop.freeze(Time.current)
+          test_instance.subscribe
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(true)
+          expect(test_instance.subscribed_at).to                 eq(Time.current)
+          expect(test_instance.subscribed_to_email_at).to        eq(Time.current)
+          Timecop.return
+        end
+      end
+
+      context "with subscribed_at option" do
+        it "subscribe with specified time" do
+          expect(test_instance.subscribing).to                   eq(false)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          subscribed_at = Time.current - 1.months
+          test_instance.subscribe(subscribed_at: subscribed_at)
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(true)
+          expect(test_instance.subscribed_at).to                 eq(subscribed_at)
+          expect(test_instance.subscribed_to_email_at).to        eq(subscribed_at)
+        end
+      end
+
+      context "with false as with_email_subscription" do
+        it "does not subscribe to email" do
+          expect(test_instance.subscribing).to                   eq(false)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          test_instance.subscribe(with_email_subscription: false)
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+        end
+      end
+    end
+
+    describe "#unsubscribe" do
+      it "returns if successfully updated subscription instance" do
+        expect(test_instance.subscribe).to be_truthy
+      end
+
+      context "as default" do
+        it "unsubscribe with current time" do
+          expect(test_instance.subscribing).to                     eq(true)
+          expect(test_instance.subscribing_to_email).to            eq(true)
+          Timecop.freeze(Time.current)
+          test_instance.unsubscribe
+          expect(test_instance.subscribing).to                     eq(false)
+          expect(test_instance.subscribing_to_email).to            eq(false)
+          expect(test_instance.unsubscribed_at).to                 eq(Time.current)
+          expect(test_instance.unsubscribed_to_email_at).to        eq(Time.current)
+          Timecop.return
+        end
+      end
+
+      context "with unsubscribed_at option" do
+        it "unsubscribe with specified time" do
+          expect(test_instance.subscribing).to                     eq(true)
+          expect(test_instance.subscribing_to_email).to            eq(true)
+          unsubscribed_at = Time.current - 1.months
+          test_instance.unsubscribe(unsubscribed_at: unsubscribed_at)
+          expect(test_instance.subscribing).to                     eq(false)
+          expect(test_instance.subscribing_to_email).to            eq(false)
+          expect(test_instance.unsubscribed_at).to                 eq(unsubscribed_at)
+          expect(test_instance.unsubscribed_to_email_at).to        eq(unsubscribed_at)
+        end
+      end
+    end
+
+    describe "#subscribe_to_email" do
+      before do
+        test_instance.unsubscribe_to_email
+      end
+
+      context "for subscribing instance" do
+        it "returns true as successfully updated subscription instance" do
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          expect(test_instance.subscribe_to_email).to be_truthy
+        end
+      end
+
+      context "for not subscribing instance" do
+        it "returns false as successfully updated subscription instance" do
+          test_instance.unsubscribe
+          expect(test_instance.subscribing).to                   eq(false)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          expect(test_instance.subscribe_to_email).to be_falsey
+        end
+      end
+
+      context "as default" do
+        it "subscribe_to_email with current time" do
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          Timecop.freeze(Time.current)
+          test_instance.subscribe_to_email
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(true)
+          expect(test_instance.subscribed_to_email_at).to        eq(Time.current)
+          Timecop.return
+        end
+      end
+
+      context "with subscribed_to_email_at option" do
+        it "subscribe with specified time" do
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(false)
+          subscribed_to_email_at = Time.current - 1.months
+          test_instance.subscribe_to_email(subscribed_to_email_at: subscribed_to_email_at)
+          expect(test_instance.subscribing).to                   eq(true)
+          expect(test_instance.subscribing_to_email).to          eq(true)
+          expect(test_instance.subscribed_to_email_at).to        eq(subscribed_to_email_at)
+        end
+      end
+    end
+
+    describe "#unsubscribe_to_email" do
+      it "returns if successfully updated subscription instance" do
+        expect(test_instance.unsubscribe_to_email).to be_truthy
+      end
+
+      context "as default" do
+        it "unsubscribe_to_email with current time" do
+          expect(test_instance.subscribing).to                     eq(true)
+          expect(test_instance.subscribing_to_email).to            eq(true)
+          Timecop.freeze(Time.current)
+          test_instance.unsubscribe_to_email
+          expect(test_instance.subscribing).to                     eq(true)
+          expect(test_instance.subscribing_to_email).to            eq(false)
+          expect(test_instance.unsubscribed_to_email_at).to        eq(Time.current)
+          Timecop.return
+        end
+      end
+
+      context "with unsubscribed_to_email_at option" do
+        it "unsubscribe with specified time" do
+          expect(test_instance.subscribing).to                     eq(true)
+          expect(test_instance.subscribing_to_email).to            eq(true)
+          unsubscribed_to_email_at = Time.current - 1.months
+          test_instance.unsubscribe_to_email(unsubscribed_to_email_at: unsubscribed_to_email_at)
+          expect(test_instance.subscribing).to                     eq(true)
+          expect(test_instance.subscribing_to_email).to            eq(false)
+          expect(test_instance.unsubscribed_to_email_at).to        eq(unsubscribed_to_email_at)
+        end
+      end
+    end
+
+  end
+end

data/spec/concerns/models/notifiable_spec.rb

@@ -17,6 +17,7 @@ shared_examples_for :notifiable do
         described_class.set_notifiable_class_defaults
         expect(described_class._notification_targets).to       eq({})
         expect(described_class._notification_group).to         eq({})
+        expect(described_class._notification_group_expiry_delay).to         eq({})
         expect(described_class._notifier).to                   eq({})
         expect(described_class._notification_parameters).to    eq({})
         expect(described_class._notification_email_allowed).to eq({})
@@ -155,6 +156,65 @@ shared_examples_for :notifiable do
       end
     end
 
+    describe "#notification_group_expiry_delay" do
+      context "without any configuration" do
+        it "returns nil" do
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to be_nil
+        end
+      end
+
+      context "configured with overriden method" do
+        it "returns specified value" do
+          module AdditionalMethods
+            def notification_group_expiry_delay_for_users(key)
+              User.all.first
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to eq(User.all.first)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._notification_group_expiry_delay[:users] = User.all.first
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to eq(User.all.first)
+        end
+
+        it "returns specified symbol without argumentss" do
+          module AdditionalMethods
+            def custom_notification_group_expiry_delay
+              User.all.first
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notification_group_expiry_delay[:users] = :custom_notification_group_expiry_delay
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to eq(User.all.first)
+        end
+
+        it "returns specified symbol with key argument" do
+          module AdditionalMethods
+            def custom_notification_group_expiry_delay(key)
+              User.all.first
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notification_group_expiry_delay[:users] = :custom_notification_group_expiry_delay
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to eq(User.all.first)
+        end
+
+        it "returns specified lambda with single notifiable argument" do
+          described_class._notification_group_expiry_delay[:users] = ->(notifiable){ User.all.first }
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to eq(User.all.first)
+        end
+
+        it "returns specified lambda with notifiable and key arguments" do
+          described_class._notification_group_expiry_delay[:users] = ->(notifiable, key){ User.all.first }
+          expect(test_instance.notification_group_expiry_delay(User, 'dummy_key')).to eq(User.all.first)
+        end
+      end
+    end
+
     describe "#notification_parameters" do
       context "without any configuration" do
         it "returns blank hash" do