activity_notification 1.7.1 → 2.0.0

data/spec/channels/notification_with_devise_channel_spec.rb

@@ -0,0 +1,99 @@
+if Rails::VERSION::MAJOR >= 5
+  require 'channels/notification_channel_shared_examples'
+
+  #TODO Make it more smart test method
+  module ActivityNotification
+    module Test
+      class NotificationWithDeviseChannel < ::ActivityNotification::NotificationWithDeviseChannel
+        @@custom_current_target = nil
+
+        def set_custom_current_target(custom_current_target)
+          @@custom_current_target = custom_current_target
+        end
+
+        def find_current_target(devise_type = nil)
+          super(devise_type)
+        rescue NoMethodError
+          devise_type = (devise_type || @target.notification_devise_resource.class.name).to_s
+          @@custom_current_target.is_a?(devise_type.to_model_class) ? @@custom_current_target : nil
+        end
+      end
+    end
+  end
+
+  # @See https://github.com/palkan/action-cable-testing
+  describe ActivityNotification::Test::NotificationWithDeviseChannel, type: :channel do
+    let(:test_user)            { create(:confirmed_user) }
+    let(:unauthenticated_user) { create(:confirmed_user) }
+    let(:test_target)          { create(:admin, user: test_user) }
+    let(:target_type)          { "Admin" }
+    let(:typed_target_param)   { "admin_id" }
+    let(:extra_params)         { { devise_type: :users } }
+    let(:valid_session)        {}
+
+    #TODO Make it more smart test method
+    #include Devise::Test::IntegrationHelpers
+    def sign_in(current_target)
+      described_class.new(ActionCable::Channel::ConnectionStub.new, {}).set_custom_current_target(current_target)
+    end
+
+    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
+
+    context "signed in with devise as authenticated user" do
+      before do
+        sign_in test_user
+      end
+    
+      it_behaves_like :notification_channel
+    end
+
+    context "signed in with devise as unauthenticated user" do
+      let(:target_params) { { target_type: target_type, devise_type: :users } }
+
+      before do
+        sign_in unauthenticated_user
+      end
+
+      it "rejects subscription" do
+        subscribe(target_params.merge({ typed_target_param => test_target }))
+        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 "unsigned in with devise" do
+      let(:target_params) { { target_type: target_type, devise_type: :users } }
+
+      it "rejects subscription" do
+        subscribe(target_params.merge({ typed_target_param => test_target }))
+        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 for devise integrated channel with devise_type option" do
+      let(:target_params) { { target_type: target_type, devise_type: :users } }
+
+      before do
+        sign_in test_target.user
+      end
+
+      it "successfully subscribes" do
+        subscribe(target_params)
+        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_Admin##{test_target.id}")
+      end
+    end
+  end
+end

data/spec/concerns/apis/notification_api_spec.rb

@@ -308,7 +308,7 @@ shared_examples_for :notification_api do
           end
 
           it "has parameters of notifiable.notification_parameters" do
-            expect(created_notification.parameters)
+            expect(created_notification.parameters.stringify_keys)
               .to eq(
                 created_notification.notifiable.notification_parameters(
                   @user_1.class,
@@ -605,7 +605,7 @@ shared_examples_for :notification_api do
     describe ".available_options" do
       it "returns list of available options in notify api" do
         expect(described_class.available_options)
-          .to eq([:key, :group, :parameters, :notifier, :send_email, :send_later])
+          .to eq([:key, :group, :group_expiry_delay, :notifier, :parameters, :send_email, :send_later])
       end
     end
   end

data/spec/concerns/apis/subscription_api_spec.rb

@@ -279,7 +279,7 @@ shared_examples_for :subscription_api do
           test_instance.subscribe_to_optional_target(:console_output)
           expect(test_instance.subscribing?).to                                         eq(true)
           expect(test_instance.subscribing_to_optional_target?(:console_output)).to     eq(true)
-          expect(test_instance.optional_targets[:subscribed_to_console_output_at]).to   eq(Time.current)
+          expect(test_instance.optional_targets[:subscribed_to_console_output_at]).to   eq(ActivityNotification::Subscription.convert_time_as_hash(Time.current))
           Timecop.return
         end
       end
@@ -310,7 +310,7 @@ shared_examples_for :subscription_api do
           test_instance.unsubscribe_to_optional_target(:console_output)
           expect(test_instance.subscribing?).to                                         eq(true)
           expect(test_instance.subscribing_to_optional_target?(:console_output)).to     eq(false)
-          expect(test_instance.optional_targets[:unsubscribed_to_console_output_at]).to eq(Time.current)
+          expect(test_instance.optional_targets[:unsubscribed_to_console_output_at]).to eq(ActivityNotification::Subscription.convert_time_as_hash(Time.current))
           Timecop.return
         end
       end

data/spec/concerns/models/notifiable_spec.rb

@@ -21,6 +21,7 @@ shared_examples_for :notifiable do
         expect(described_class._notifier).to                        eq({})
         expect(described_class._notification_parameters).to         eq({})
         expect(described_class._notification_email_allowed).to      eq({})
+        expect(described_class._notification_action_cable_allowed).to      eq({})
         expect(described_class._notifiable_path).to                 eq({})
         expect(described_class._printable_notifiable_name).to       eq({})
       end
@@ -47,7 +48,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notification_users(key)
@@ -116,7 +117,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notification_group_for_users(key)
@@ -175,7 +176,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notification_group_expiry_delay_for_users(key)
@@ -234,7 +235,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notification_parameters_for_users(key)
@@ -293,7 +294,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notifier_for_users(key)
@@ -357,7 +358,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notification_email_allowed_for_users?(target, key)
@@ -409,6 +410,70 @@ shared_examples_for :notifiable do
       end
     end
 
+    describe "#notification_action_cable_allowed?" do
+      context "without any configuration" do
+        it "returns ActivityNotification.config.action_cable_enabled" do
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key'))
+            .to eq(ActivityNotification.config.action_cable_enabled)
+        end
+
+        it "returns false as default" do
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to be_falsey
+        end
+      end
+
+      context "configured with overridden method" do
+        it "returns specified value" do
+          module AdditionalMethods
+            def notification_action_cable_allowed_for_users?(target, key)
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._notification_action_cable_allowed[:users] = true
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol without arguments" do
+          module AdditionalMethods
+            def custom_notification_action_cable_allowed?
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notification_action_cable_allowed[:users] = :custom_notification_action_cable_allowed?
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol with target and key arguments" do
+          module AdditionalMethods
+            def custom_notification_action_cable_allowed?(target, key)
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notification_action_cable_allowed[:users] = :custom_notification_action_cable_allowed?
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with single notifiable argument" do
+          described_class._notification_action_cable_allowed[:users] = ->(notifiable){ true }
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with notifiable, target and key arguments" do
+          described_class._notification_action_cable_allowed[:users] = ->(notifiable, target, key){ true }
+          expect(test_instance.notification_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+      end
+    end
+
     describe "#notifiable_path" do
       context "without any configuration" do
         it "raises NotImplementedError" do
@@ -424,7 +489,7 @@ shared_examples_for :notifiable do
         end
       end
 
-      context "configured with overriden method" do
+      context "configured with overridden method" do
         it "returns specified value" do
           module AdditionalMethods
             def notifiable_path_for_users(key)

data/spec/concerns/models/subscriber_spec.rb

@@ -15,7 +15,7 @@ shared_examples_for :subscriber do
       expect(test_instance.subscriptions.count).to                eq(2)
       expect(test_instance.subscriptions.earliest_order.first).to eq(subscription_1)
       expect(test_instance.subscriptions.latest_order.first).to   eq(subscription_2)
-      expect(test_instance.subscriptions.latest_order).to         eq(ActivityNotification::Subscription.filtered_by_target(test_instance).latest_order)
+      expect(test_instance.subscriptions.latest_order.to_a).to    eq(ActivityNotification::Subscription.filtered_by_target(test_instance).latest_order.to_a)
     end
   end    
 
@@ -30,13 +30,13 @@ shared_examples_for :subscriber do
   describe "as public instance methods" do
     describe "#find_subscription" do
       before do
-        expect(test_instance.subscriptions).to be_empty
+        expect(test_instance.subscriptions.to_a).to be_empty
       end
 
       context "when the cofigured subscription exists" do
         it "returns subscription record" do
           subscription = test_instance.create_subscription(key: 'test_key')
-          expect(test_instance.subscriptions.reload).not_to be_empty
+          expect(test_instance.subscriptions.reload.to_a).not_to be_empty
           expect(test_instance.find_subscription('test_key')).to eq(subscription)
         end
       end
@@ -50,13 +50,13 @@ shared_examples_for :subscriber do
 
     describe "#find_or_create_subscription" do
       before do
-        expect(test_instance.subscriptions).to be_empty
+        expect(test_instance.subscriptions.to_a).to be_empty
       end
 
       context "when the cofigured subscription exists" do
         it "returns subscription record" do
           subscription = test_instance.create_subscription(key: 'test_key')
-          expect(test_instance.subscriptions.reload).not_to be_empty
+          expect(test_instance.subscriptions.reload.to_a).not_to be_empty
           expect(test_instance.find_or_create_subscription('test_key')).to eq(subscription)
         end
       end
@@ -70,14 +70,14 @@ shared_examples_for :subscriber do
 
     describe "#create_subscription" do
       before do
-        expect(test_instance.subscriptions).to be_empty
+        expect(test_instance.subscriptions.to_a).to be_empty
       end
 
       context "without params" do
         it "does not create a new subscription since it is invalid" do
           new_subscription = test_instance.create_subscription
           expect(new_subscription).to                        be_nil
-          expect(test_instance.subscriptions.reload).to      be_empty
+          expect(test_instance.subscriptions.reload.to_a).to be_empty
         end
       end
 
@@ -85,8 +85,8 @@ shared_examples_for :subscriber do
         it "creates a new subscription" do
           params = { key: 'key_1' }
           new_subscription = test_instance.create_subscription(params)
-          expect(new_subscription.subscribing?).to            be_truthy
-          expect(new_subscription.subscribing_to_email?).to   be_truthy
+          expect(new_subscription.subscribing?).to           be_truthy
+          expect(new_subscription.subscribing_to_email?).to  be_truthy
           expect(test_instance.subscriptions.reload.size).to eq(1)
         end
       end
@@ -95,8 +95,8 @@ shared_examples_for :subscriber do
         it "creates a new subscription" do
           params = { key: 'key_1', subscribing: false }
           new_subscription = test_instance.create_subscription(params)
-          expect(new_subscription.subscribing?).to            be_falsey
-          expect(new_subscription.subscribing_to_email?).to   be_falsey
+          expect(new_subscription.subscribing?).to           be_falsey
+          expect(new_subscription.subscribing_to_email?).to  be_falsey
           expect(test_instance.subscriptions.reload.size).to eq(1)
         end
       end
@@ -105,8 +105,8 @@ shared_examples_for :subscriber do
         it "creates a new subscription" do
           params = { key: 'key_1', subscribing_to_email: false }
           new_subscription = test_instance.create_subscription(params)
-          expect(new_subscription.subscribing?).to            be_truthy
-          expect(new_subscription.subscribing_to_email?).to   be_falsey
+          expect(new_subscription.subscribing?).to           be_truthy
+          expect(new_subscription.subscribing_to_email?).to  be_falsey
           expect(test_instance.subscriptions.reload.size).to eq(1)
         end
       end
@@ -115,8 +115,8 @@ shared_examples_for :subscriber do
         it "creates a new subscription" do
           params = { key: 'key_1', subscribing: true, subscribing_to_email: false }
           new_subscription = test_instance.create_subscription(params)
-          expect(new_subscription.subscribing?).to            be_truthy
-          expect(new_subscription.subscribing_to_email?).to   be_falsey
+          expect(new_subscription.subscribing?).to           be_truthy
+          expect(new_subscription.subscribing_to_email?).to  be_falsey
           expect(test_instance.subscriptions.reload.size).to eq(1)
         end
       end
@@ -126,7 +126,7 @@ shared_examples_for :subscriber do
           params = { key: 'key_1', subscribing: false, subscribing_to_email: true }
           new_subscription = test_instance.create_subscription(params)
           expect(new_subscription).to                        be_nil
-          expect(test_instance.subscriptions.reload).to      be_empty
+          expect(test_instance.subscriptions.reload.to_a).to be_empty
         end
       end
 
@@ -167,7 +167,7 @@ shared_examples_for :subscriber do
           params = { key: 'key_1', subscribing: false, optional_targets: { subscribing_to_console_output: true } }
           new_subscription = test_instance.create_subscription(params)
           expect(new_subscription).to                        be_nil
-          expect(test_instance.subscriptions.reload).to      be_empty
+          expect(test_instance.subscriptions.reload.to_a).to be_empty
         end
       end
     end
@@ -187,8 +187,8 @@ shared_examples_for :subscriber do
 
         context "without any options" do
           it "returns the array of subscriptions" do
-            expect(test_instance.subscription_index[0]).to eq(@subscription1)
-            expect(test_instance.subscription_index[1]).to eq(@subscription2)
+            expect(test_instance.subscription_index[0]).to   eq(@subscription1)
+            expect(test_instance.subscription_index[1]).to   eq(@subscription2)
             expect(test_instance.subscription_index.size).to eq(2)
           end
         end
@@ -196,7 +196,7 @@ shared_examples_for :subscriber do
         context "with limit" do
           it "returns the same as subscriptions with limit" do
             options = { limit: 1 }
-            expect(test_instance.subscription_index(options)[0]).to eq(@subscription1)
+            expect(test_instance.subscription_index(options)[0]).to   eq(@subscription1)
             expect(test_instance.subscription_index(options).size).to eq(1)
           end
         end
@@ -204,8 +204,8 @@ shared_examples_for :subscriber do
         context "with reverse" do
           it "returns the earliest order" do
             options = { reverse: true }
-            expect(test_instance.subscription_index(options)[0]).to eq(@subscription2)
-            expect(test_instance.subscription_index(options)[1]).to eq(@subscription1)
+            expect(test_instance.subscription_index(options)[0]).to   eq(@subscription2)
+            expect(test_instance.subscription_index(options)[1]).to   eq(@subscription1)
             expect(test_instance.subscription_index(options).size).to eq(2)
           end
         end
@@ -213,37 +213,36 @@ shared_examples_for :subscriber do
         context 'with filtered_by_key options' do
           it "returns filtered notifications only" do
             options = { filtered_by_key: 'subscription_key_2' }
-            expect(test_instance.subscription_index(options)[0]).to eq(@subscription2)
+            expect(test_instance.subscription_index(options)[0]).to   eq(@subscription2)
             expect(test_instance.subscription_index(options).size).to eq(1)
           end
         end
 
         context 'with custom_filter options' do
-          it "returns filtered notifications only" do
-            if ActivityNotification.config.orm == :active_record
-              options = { custom_filter: ["subscriptions.key = ?", 'subscription_key_2'] }
-              expect(test_instance.subscription_index(options)[0]).to eq(@subscription2)
-              expect(test_instance.subscription_index(options).size).to eq(1)
-            end
-
+          it "returns filtered subscriptions only" do
             options = { custom_filter: { key: 'subscription_key_1' } }
-            expect(test_instance.subscription_index(options)[0]).to eq(@subscription1)
+            expect(test_instance.subscription_index(options)[0]).to   eq(@subscription1)
             expect(test_instance.subscription_index(options).size).to eq(1)
           end
-        end
 
-        #TODO
-        # context 'with with_target options' do
-          # it "calls includes(:target)" do
-            # expect(ActiveRecord::Base).to receive(:includes).with(:target)
-            # test_instance.subscription_index(with_target: true)
-          # end
-        # end
+          it "returns filtered subscriptions only with filter depending on ORM" do
+            options =
+              case ActivityNotification.config.orm
+              when :active_record then { custom_filter: ["subscriptions.key = ?", 'subscription_key_2'] }
+              when :mongoid       then { custom_filter: { key: {'$eq': 'subscription_key_2'} } }
+              when :dynamoid      then { custom_filter: {'key.begins_with': 'subscription_key_2'} }
+              end
+            expect(test_instance.subscription_index(options)[0]).to   eq(@subscription2)
+            expect(test_instance.subscription_index(options).size).to eq(1)
+          end
+        end
 
-        context 'without with_target options' do
-          it "does not call includes(:target)" do
-            expect(ActiveRecord::Base).not_to receive(:includes).with(:target)
-            test_instance.subscription_index
+        if ActivityNotification.config.orm == :active_record
+          context 'with with_target options' do
+            it "calls with_target" do
+              expect(ActivityNotification::Subscription).to receive_message_chain(:with_target)
+              test_instance.subscription_index(with_target: true)
+            end
           end
         end
       end
@@ -322,16 +321,21 @@ shared_examples_for :subscriber do
 
         context 'with custom_filter options' do
           it "returns filtered notifications only" do
-            if ActivityNotification.config.orm == :active_record
-              options = { custom_filter: ["notifications.key = ?", 'notification_key_2'] }
-              expect(test_instance.notification_keys(options)[0]).to eq('notification_key_2')
-              expect(test_instance.notification_keys(options).size).to eq(1)
-            end
-
             options = { custom_filter: { key: 'notification_key_1' } }
             expect(test_instance.notification_keys(options)[0]).to eq('notification_key_1')
             expect(test_instance.notification_keys(options).size).to eq(1)
           end
+
+          it "returns filtered notifications only with filter depending on ORM" do
+            options =
+              case ActivityNotification.config.orm
+              when :active_record then { custom_filter: ["notifications.key = ?", 'notification_key_2'] }
+              when :mongoid       then { custom_filter: { key: {'$eq': 'notification_key_2'} } }
+              when :dynamoid      then { custom_filter: {'key.begins_with': 'notification_key_2'} }
+              end
+            expect(test_instance.notification_keys(options)[0]).to eq('notification_key_2')
+            expect(test_instance.notification_keys(options).size).to eq(1)
+          end
         end
       end
     end