activity_notification 2.1.2 → 2.2.2

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "2.1.2"
+  VERSION = "2.2.2"
 end

data/lib/generators/templates/activity_notification.rb

@@ -31,6 +31,16 @@ ActivityNotification.configure do |config|
   # Set false when you want to unsubscribe to any notifications as default.
   config.subscribe_as_default = true
 
+  # Configure default email subscription value to use when the subscription record does not configured.
+  # Note that you can configure them for each method calling as default argument.
+  # Set false when you want to unsubscribe to email notifications as default.
+  # config.subscribe_to_email_as_default = true
+
+  # Configure default optional target subscription value to use when the subscription record does not configured.
+  # Note that you can configure them for each method calling as default argument.
+  # Set false when you want to unsubscribe to optinal target notifications as default.
+  # config.subscribe_to_optional_targets_as_default = true
+
   # Configure the e-mail address which will be shown in ActivityNotification::Mailer,
   # note that it will be overwritten if you use your own mailer class with default "from" parameter.
   config.mailer_sender = 'please-change-me-at-config-initializers-activity_notification@example.com'
@@ -76,7 +86,7 @@ ActivityNotification.configure do |config|
   # Set true when you want to turn on WebSocket API subscription using ActionCable as default.
   config.action_cable_api_enabled = false
 
-  # Configure if ctivity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise.
+  # Configure if activity_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

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

@@ -1,5 +1,5 @@
 # Migration responsible for creating a table with notifications
-class <%= @migration_name %> < ActiveRecord::Migration<%= Rails::VERSION::MAJOR >= 5 ? "[#{Rails.version.to_f}]" : "" %>
+class <%= @migration_name %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f}]" %>
   # Create tables
   def change
     <% if @migration_tables.include?('notifications') %>create_table :notifications do |t|

data/spec/channels/notification_api_channel_spec.rb

@@ -1,51 +1,49 @@
-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
+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
 
-    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
+    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
+    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}")
-        expect(subscription).to have_stream_from("activity_notification_api_channel_User##{test_target.id}")
-      end
+      }.to raise_error(/Must be subscribed!/)
+    end
+  end
 
-      it_behaves_like :notification_api_channel
+  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

@@ -1,78 +1,76 @@
-if Rails::VERSION::MAJOR >= 5
-  require 'channels/notification_api_channel_shared_examples'
+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/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
+  # @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
+  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
+  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
+  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 } }
+  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
+    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
+    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 } }
+  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
+    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 } }
+  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
+    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
+    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

data/spec/channels/notification_channel_spec.rb

@@ -1,50 +1,48 @@
-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
+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
 
-    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
+    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
+    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}")
-        expect(subscription).to have_stream_from("activity_notification_channel_User##{test_target.id}")
-      end
+      }.to raise_error(/Must be subscribed!/)
+    end
+  end
 
-      it_behaves_like :notification_channel
+  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

data/spec/channels/notification_with_devise_channel_spec.rb

@@ -1,99 +1,97 @@
-if Rails::VERSION::MAJOR >= 5
-  require 'channels/notification_channel_shared_examples'
+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
+#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
+# @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)        {}
 
-    before do
-      @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
-      User._notification_action_cable_with_devise = true
-    end
+  #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
 
-    after do
-      User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
-    end
+  before do
+    @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
+    User._notification_action_cable_with_devise = true
+  end
 
-    context "signed in with devise as authenticated user" do
-      before do
-        sign_in test_user
-      end
-    
-      it_behaves_like :notification_channel
+  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 } }
+  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
+    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
+    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 } }
+  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
+    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 } }
+  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
+    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
+    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