activity_notification 2.0.0 → 2.1.4

data/lib/generators/templates/models/README

@@ -1,10 +1,14 @@
 ===============================================================================
 
-Some setup you must do manually if you haven't yet:
+activity_notification uses internal models for notifications and subscriptions
+  - ActivityNotification::Notification
+  - ActivityNotification::Subscription
 
-  Ensure you have configured model name in your initializer activity_notification.rb.
-  For example:
+  You can use your own models with same database table used by these internal models.
 
-    #TODO
+  Ensure you have configured table name in your initializer activity_notification.rb.
+  For example:
+    config.notification_table_name = "notifications"
+    config.subscription_table_name = "subscriptions"
 
 ===============================================================================

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

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

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

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

data/package.json

@@ -0,0 +1,8 @@
+{
+  "engines": {
+     "yarn": "1.x"
+  },
+  "scripts": {
+    "postinstall": "cd ./spec/rails_app && yarn && yarn install --check-files"
+  }
+}

data/spec/channels/notification_api_channel_shared_examples.rb

@@ -0,0 +1,59 @@
+# @See https://github.com/palkan/action-cable-testing
+shared_examples_for :notification_api_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' }).merge(@auth_headers))
+      expect(subscription).to be_confirmed
+      expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_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 }).merge(@auth_headers))
+      expect(subscription).to be_confirmed
+      expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_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(@auth_headers)
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_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 }.merge(@auth_headers))
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_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.merge(@auth_headers))
+      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 }).merge(@auth_headers))
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_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_api_channel_spec.rb

@@ -0,0 +1,51 @@
+if Rails::VERSION::MAJOR >= 5
+  require 'channels/notification_api_channel_shared_examples'
+
+  # @See https://github.com/palkan/action-cable-testing
+  describe ActivityNotification::NotificationApiChannel, 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_api_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
+        @auth_headers = {}
+      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_api_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+        expect(subscription).to have_stream_from("activity_notification_api_channel_User##{test_target.id}")
+      end
+
+      it_behaves_like :notification_api_channel
+    end
+  end
+end

data/spec/channels/notification_api_with_devise_channel_spec.rb

@@ -0,0 +1,78 @@
+if Rails::VERSION::MAJOR >= 5
+  require 'channels/notification_api_channel_shared_examples'
+
+  # @See https://github.com/palkan/action-cable-testing
+  describe ActivityNotification::NotificationApiWithDeviseChannel, 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)        {}
+
+    # @See https://github.com/lynndylanhurley/devise_token_auth
+    def sign_in(current_target)
+      @auth_headers = current_target.create_new_auth_token
+    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_api_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 }).merge(@auth_headers))
+        expect(subscription).to be_rejected
+        expect {
+          expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_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_api_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.merge(@auth_headers))
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_api_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+        expect(subscription).to have_stream_from("activity_notification_api_channel_Admin##{test_target.id}")
+      end
+    end
+  end
+end

data/spec/concerns/apis/notification_api_spec.rb

@@ -123,6 +123,24 @@ shared_examples_for :notification_api do
           end
         end
       end
+
+      context "when some optional targets raise error" do
+        before do
+          require 'custom_optional_targets/raise_error'
+          @optional_target = CustomOptionalTarget::RaiseError.new
+          @current_optional_target = Comment._optional_targets[:users]
+          Comment.acts_as_notifiable :users, optional_targets: ->{ [@optional_target] }
+        end
+
+        after do
+          Comment._optional_targets[:users] = @current_optional_target
+        end
+
+        it "generates notifications even if some optional targets raise error" do
+          notifications = described_class.notify(:users, @comment_2)
+          expect(notifications.size).to eq(2)  
+        end
+      end
     end
 
     describe ".notify_later" do
@@ -465,13 +483,14 @@ shared_examples_for :notification_api do
     describe ".open_all_of" do
       before do
         described_class.notify_to(@user_1, @article, group: @article, key: 'key.1')
+        sleep(0.01)
         described_class.notify_to(@user_1, @comment_2, group: @comment_2, key: 'key.2')
         expect(@user_1.notifications.unopened_only.count).to eq(2)
         expect(@user_1.notifications.opened_only!.count).to eq(0)
       end
 
-      it "returns the number of opened notification records" do
-        expect(described_class.open_all_of(@user_1)).to eq(2)
+      it "returns array of opened notification records" do
+        expect(described_class.open_all_of(@user_1).size).to eq(2)
       end
 
       it "opens all notifications of the target" do
@@ -534,6 +553,22 @@ shared_examples_for :notification_api do
           expect(@user_1.notifications.opened_only!.count).to eq(1)
         end
       end
+
+      context 'with later_than options' do
+        it "opens filtered notifications only" do
+          described_class.open_all_of(@user_1, { later_than: (@user_1.notifications.earliest.created_at.in_time_zone + 0.001).iso8601(3) })
+          expect(@user_1.notifications.unopened_only.count).to eq(1)
+          expect(@user_1.notifications.opened_only!.count).to eq(1)
+        end
+      end
+
+      context 'with earlier_than options' do
+        it "opens filtered notifications only" do
+          described_class.open_all_of(@user_1, { earlier_than: @user_1.notifications.latest.created_at.iso8601(3) })
+          expect(@user_1.notifications.unopened_only.count).to eq(1)
+          expect(@user_1.notifications.opened_only!.count).to eq(1)
+        end
+      end
     end
 
     describe ".group_member_exists?" do
@@ -605,7 +640,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, :group_expiry_delay, :notifier, :parameters, :send_email, :send_later])
+          .to eq([:key, :group, :group_expiry_delay, :notifier, :parameters, :send_email, :send_later, :pass_full_options])
       end
     end
   end

data/spec/concerns/models/notifiable_spec.rb

@@ -21,7 +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_action_cable_allowed).to eq({})
         expect(described_class._notifiable_path).to                 eq({})
         expect(described_class._printable_notifiable_name).to       eq({})
       end
@@ -410,66 +410,130 @@ shared_examples_for :notifiable do
       end
     end
 
-    describe "#notification_action_cable_allowed?" do
+    describe "#notifiable_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'))
+          expect(test_instance.notifiable_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
+          expect(test_instance.notifiable_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)
+            def notifiable_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)
+          expect(test_instance.notifiable_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)
+          described_class._notifiable_action_cable_allowed[:users] = true
+          expect(test_instance.notifiable_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?
+            def custom_notifiable_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)
+          described_class._notifiable_action_cable_allowed[:users] = :custom_notifiable_action_cable_allowed?
+          expect(test_instance.notifiable_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)
+            def custom_notifiable_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)
+          described_class._notifiable_action_cable_allowed[:users] = :custom_notifiable_action_cable_allowed?
+          expect(test_instance.notifiable_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)
+          described_class._notifiable_action_cable_allowed[:users] = ->(notifiable){ true }
+          expect(test_instance.notifiable_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)
+          described_class._notifiable_action_cable_allowed[:users] = ->(notifiable, target, key){ true }
+          expect(test_instance.notifiable_action_cable_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+      end
+    end
+
+    describe "#notifiable_action_cable_api_allowed?" do
+      context "without any configuration" do
+        it "returns ActivityNotification.config.action_cable_api_enabled" do
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key'))
+            .to eq(ActivityNotification.config.action_cable_api_enabled)
+        end
+
+        it "returns false as default" do
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to be_falsey
+        end
+      end
+
+      context "configured with overridden method" do
+        it "returns specified value" do
+          module AdditionalMethods
+            def notifiable_action_cable_api_allowed_for_users?(target, key)
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._notifiable_action_cable_api_allowed[:users] = true
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol without arguments" do
+          module AdditionalMethods
+            def custom_notifiable_action_cable_api_allowed?
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notifiable_action_cable_api_allowed[:users] = :custom_notifiable_action_cable_api_allowed?
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol with target and key arguments" do
+          module AdditionalMethods
+            def custom_notifiable_action_cable_api_allowed?(target, key)
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notifiable_action_cable_api_allowed[:users] = :custom_notifiable_action_cable_api_allowed?
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with single notifiable argument" do
+          described_class._notifiable_action_cable_api_allowed[:users] = ->(notifiable){ true }
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with notifiable, target and key arguments" do
+          described_class._notifiable_action_cable_api_allowed[:users] = ->(notifiable, target, key){ true }
+          expect(test_instance.notifiable_action_cable_api_allowed?(test_target, 'dummy_key')).to eq(true)
         end
       end
     end