activity_notification 1.1.0 → 1.2.0

data/spec/helpers/view_helpers_spec.rb

@@ -377,6 +377,34 @@ describe ActivityNotification::ViewHelpers, type: :helper do
     end
   end
 
+  describe '#subscribe_to_optional_target_subscription_path_for' do
+    it "returns path for the subscription target" do
+      expect(subscribe_to_optional_target_subscription_path_for(subscription))
+        .to eq(subscribe_to_optional_target_user_subscription_path(target_user, subscription))
+    end
+  end
+
+  describe '#subscribe_to_optional_target_path_for' do
+    it "returns path for the subscription target" do
+      expect(subscribe_to_optional_target_path_for(subscription))
+        .to eq(subscribe_to_optional_target_user_subscription_path(target_user, subscription))
+    end
+  end
+
+  describe '#unsubscribe_to_optional_target_subscription_path_for' do
+    it "returns path for the subscription target" do
+      expect(unsubscribe_to_optional_target_subscription_path_for(subscription))
+        .to eq(unsubscribe_to_optional_target_user_subscription_path(target_user, subscription))
+    end
+  end
+
+  describe '#unsubscribe_to_optional_target_path_for' do
+    it "returns path for the subscription target" do
+      expect(unsubscribe_to_optional_target_path_for(subscription))
+        .to eq(unsubscribe_to_optional_target_user_subscription_path(target_user, subscription))
+    end
+  end
+
   describe '#subscriptions_url_for' do
     it "returns url for the subscription target" do
       expect(subscriptions_url_for(target_user))
@@ -447,4 +475,32 @@ describe ActivityNotification::ViewHelpers, type: :helper do
     end
   end
 
+  describe '#subscribe_to_optional_target_subscription_url_for' do
+    it "returns url for the subscription target" do
+      expect(subscribe_to_optional_target_subscription_url_for(subscription))
+        .to eq(subscribe_to_optional_target_user_subscription_url(target_user, subscription))
+    end
+  end
+
+  describe '#subscribe_to_optional_target_url_for' do
+    it "returns url for the subscription target" do
+      expect(subscribe_to_optional_target_url_for(subscription))
+        .to eq(subscribe_to_optional_target_user_subscription_url(target_user, subscription))
+    end
+  end
+
+  describe '#unsubscribe_to_optional_target_subscription_url_for' do
+    it "returns url for the subscription target" do
+      expect(unsubscribe_to_optional_target_subscription_url_for(subscription))
+        .to eq(unsubscribe_to_optional_target_user_subscription_url(target_user, subscription))
+    end
+  end
+
+  describe '#unsubscribe_to_optional_target_url_for' do
+    it "returns url for the subscription target" do
+      expect(unsubscribe_to_optional_target_url_for(subscription))
+        .to eq(unsubscribe_to_optional_target_user_subscription_url(target_user, subscription))
+    end
+  end
+
 end

data/spec/optional_targets/amazon_sns_spec.rb

@@ -0,0 +1,46 @@
+require 'activity_notification/optional_targets/amazon_sns'
+describe ActivityNotification::OptionalTarget::AmazonSNS do
+  let(:test_instance) { ActivityNotification::OptionalTarget::AmazonSNS.new }
+
+  describe "as public instance methods" do
+    describe "#to_optional_target_name" do
+      it "is return demodulized symbol class name" do
+        expect(test_instance.to_optional_target_name).to eq(:amazon_sns)
+      end
+    end
+
+    describe "#initialize_target" do
+      #TODO
+      it "does not raise NotImplementedError" do
+        expect { test_instance.initialize_target }
+          .not_to raise_error(NotImplementedError)
+      end
+    end
+
+    describe "#notify" do
+      #TODO
+      it "raises NotImplementedError" do
+        expect { test_instance.notify(create(:notification)) }
+          .not_to raise_error(NotImplementedError)
+      end
+    end
+  end
+
+  describe "as protected instance methods" do
+    describe "#render_notification_message" do
+      context "as default" do
+        it "renders notification message with default template" do
+          expect(test_instance.send(:render_notification_message, create(:notification))).to be_include("Move to notified") 
+        end
+      end
+
+      context "with unexisting template as fallback option" do
+        it "raise ActionView::MissingTemplate" do
+          expect { expect(test_instance.send(:render_notification_message, create(:notification), fallback: :hoge)) }
+            .to raise_error(ActionView::MissingTemplate)
+        end
+      end
+    end
+  end
+  
+end

data/spec/optional_targets/base_spec.rb

@@ -0,0 +1,43 @@
+describe ActivityNotification::OptionalTarget::Base do
+  let(:test_instance) { ActivityNotification::OptionalTarget::Base.new }
+
+  describe "as public instance methods" do
+    describe "#to_optional_target_name" do
+      it "is return demodulized symbol class name" do
+        expect(test_instance.to_optional_target_name).to eq(:base)
+      end
+    end
+
+    describe "#initialize_target" do
+      it "raises NotImplementedError" do
+        expect { test_instance.initialize_target }
+          .to raise_error(NotImplementedError, /You have to implement ActivityNotification::OptionalTarget::Base#initialize_target/)
+      end
+    end
+
+    describe "#notify" do
+      it "raises NotImplementedError" do
+        expect { test_instance.notify(create(:notification)) }
+          .to raise_error(NotImplementedError, /You have to implement ActivityNotification::OptionalTarget::Base#notify/)
+      end
+    end
+  end
+
+  describe "as protected instance methods" do
+    describe "#render_notification_message" do
+      context "as default" do
+        it "renders notification message with default template" do
+          expect(test_instance.send(:render_notification_message, create(:notification))).to be_include("Move to notified") 
+        end
+      end
+
+      context "with unexisting template as fallback option" do
+        it "raise ActionView::MissingTemplate" do
+          expect { expect(test_instance.send(:render_notification_message, create(:notification), fallback: :hoge)) }
+            .to raise_error(ActionView::MissingTemplate)
+        end
+      end
+    end
+  end
+  
+end

data/spec/optional_targets/slack_spec.rb

@@ -0,0 +1,46 @@
+require 'activity_notification/optional_targets/slack'
+describe ActivityNotification::OptionalTarget::Slack do
+  let(:test_instance) { ActivityNotification::OptionalTarget::Slack.new }
+
+  describe "as public instance methods" do
+    describe "#to_optional_target_name" do
+      it "is return demodulized symbol class name" do
+        expect(test_instance.to_optional_target_name).to eq(:slack)
+      end
+    end
+
+    describe "#initialize_target" do
+      #TODO
+      it "does not raise NotImplementedError" do
+        expect { test_instance.initialize_target }
+          .not_to raise_error(NotImplementedError)
+      end
+    end
+
+    describe "#notify" do
+      #TODO
+      it "raises NotImplementedError" do
+        expect { test_instance.notify(create(:notification)) }
+          .not_to raise_error(NotImplementedError)
+      end
+    end
+  end
+
+  describe "as protected instance methods" do
+    describe "#render_notification_message" do
+      context "as default" do
+        it "renders notification message with slack default template" do
+          expect(test_instance.send(:render_notification_message, create(:notification))).to be_include("<!channel>") 
+        end
+      end
+
+      context "with unexisting template as fallback option" do
+        it "raise ActionView::MissingTemplate" do
+          expect { expect(test_instance.send(:render_notification_message, create(:notification), fallback: :hoge)) }
+            .to raise_error(ActionView::MissingTemplate)
+        end
+      end
+    end
+  end
+  
+end

data/spec/rails_app/app/controllers/comments_controller.rb

@@ -8,6 +8,7 @@ class CommentsController < ApplicationController
 
     if @comment.save
       @comment.notify :users
+      @comment.notify :admins
       redirect_to @comment.article, notice: 'Comment was successfully created.'
     else
       redirect_to @comment.article

data/spec/rails_app/app/models/admin.rb

@@ -2,8 +2,7 @@ class Admin < ActiveRecord::Base
   belongs_to :user
   validates :user, presence: true
 
-  acts_as_notification_target email: :email,
-    email_allowed: ->(admin, key) { admin.user.confirmed_at.present? },
+  acts_as_notification_target email_allowed: false,
     subscription_allowed: true,
     devise_resource: :user,
     printable_name: ->(admin) { "admin (#{admin.user.name})" }

data/spec/rails_app/app/models/article.rb

@@ -5,9 +5,8 @@ class Article < ActiveRecord::Base
   validates :user, presence: true
 
   acts_as_notifiable :users,
-    targets: ->(article, key) { User.all.to_a - [article.user] },
-    notifier: :user,
-    email_allowed: true,
+    targets: ->(article) { User.all.to_a - [article.user] },
+    notifier: :user, email_allowed: true,
     printable_name: ->(article) { "new article \"#{article.title}\"" },
     dependent_notifications: :delete_all
   acts_as_notification_group printable_name: ->(article) { "article \"#{article.title}\"" }

data/spec/rails_app/app/models/comment.rb

@@ -5,16 +5,28 @@ class Comment < ActiveRecord::Base
   validates :user, presence: true
 
   acts_as_notifiable :users,
-    targets: ->(comment, key) {
-      ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq
-    },
-    group: :article,
-    notifier: :user,
-    email_allowed: true,
+    targets: ->(comment, key) { ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq },
+    group: :article, notifier: :user, email_allowed: true,
     parameters: { test_default_param: '1' },
     notifiable_path: :article_notifiable_path,
     printable_name: ->(comment) { "comment \"#{comment.body}\"" },
-    dependent_notifications: :delete_all
+    dependent_notifications: :update_group_and_delete_all
+
+  # require 'activity_notification/optional_targets/amazon_sns'
+  # require 'activity_notification/optional_targets/slack'
+  require 'custom_optional_targets/console_output'
+  acts_as_notifiable :admins, targets: Admin.all,
+    group: :article, notifier: :user, notifiable_path: :article_notifiable_path,
+    printable_name: ->(comment) { "comment \"#{comment.body}\"" }, dependent_notifications: :delete_all,
+    optional_targets: {
+      # ActivityNotification::OptionalTarget::AmazonSNS => { topic_arn: 'arn:aws:sns:XXXXX:XXXXXXXXXXXX:XXXXX' },
+      # # ActivityNotification::OptionalTarget::AmazonSNS => { phone_number: :phone_number },
+      # ActivityNotification::OptionalTarget::Slack  => {
+        # webhook_url: 'https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX',
+        # slack_name: :slack_name, channel: 'activity_notification', username: 'ActivityNotification', icon_emoji: ":ghost:"
+      # },
+      CustomOptionalTarget::ConsoleOutput => {}
+    }
 
   def article_notifiable_path
     article_path(article)

data/spec/rails_app/app/views/activity_notification/optional_targets/admins/amazon_sns/comment/_default.text.erb

@@ -0,0 +1,8 @@
+[This notification is delivered by ActivityNotification with Amazon SNS]
+
+Dear <%= @target.printable_target_name %>
+
+<%= @notification.notifier.present? ? @notification.notifier.printable_notifier_name : 'Someone' %> notified you of <%= @notification.notifiable.printable_notifiable_name(@notification.target) %><%= " in #{@notification.group.printable_group_name}" if @notification.group.present? %>.
+
+<%= "Move to notified #{@notification.notifiable.printable_type.downcase}:" %>
+  <%= move_notification_url_for(@notification, open: true) %>

data/spec/rails_app/db/migrate/20160715050420_create_activity_notification_tables.rb

@@ -24,7 +24,7 @@ class CreateActivityNotificationTables < ActiveRecord::Migration
       t.datetime   :unsubscribed_at
       t.datetime   :subscribed_to_email_at
       t.datetime   :unsubscribed_to_email_at
-      t.text       :parameters
+      t.text       :optional_targets
 
       t.timestamps
     end

data/spec/rails_app/db/migrate/20160715050433_create_test_tables.rb

@@ -17,6 +17,8 @@ class CreateTestTables < ActiveRecord::Migration
 
     create_table :admins do |t|
       t.references :user, index: true
+      t.string     :phone_number
+      t.string     :slack_name
 
       t.timestamps
     end

data/spec/rails_app/db/schema.rb

@@ -14,6 +14,8 @@ ActiveRecord::Schema.define(version: 20160715050433) do
 
   create_table "admins", force: :cascade do |t|
     t.integer  "user_id"
+    t.string   "phone_number"
+    t.string   "slack_name"
     t.datetime "created_at"
     t.datetime "updated_at"
     t.index ["user_id"], name: "index_admins_on_user_id"
@@ -70,7 +72,7 @@ ActiveRecord::Schema.define(version: 20160715050433) do
     t.datetime "unsubscribed_at"
     t.datetime "subscribed_to_email_at"
     t.datetime "unsubscribed_to_email_at"
-    t.text     "parameters"
+    t.text     "optional_targets"
     t.datetime "created_at"
     t.datetime "updated_at"
     t.index ["key"], name: "index_subscriptions_on_key"

data/spec/rails_app/db/seeds.rb

@@ -21,7 +21,7 @@ end
 
 ['Ichiro'].each do |name|
   user = User.find_by_name(name)
-  Admin.create(user: user)
+  Admin.create(user: user, slack_name: name.downcase)
 end
 
 User.all.each do |user|

data/spec/rails_app/lib/custom_optional_targets/console_output.rb

@@ -0,0 +1,13 @@
+module CustomOptionalTarget
+  # Optional target implementation for mobile push notification or SMS using AWS SNS.
+  class ConsoleOutput < ActivityNotification::OptionalTarget::Base
+    def initialize_target(options = {})
+    end
+
+    def notify(notification, options = {})
+      puts "----- Optional targets: #{self.class.name} -----"
+      puts render_notification_message(notification, options)
+      puts "-----------------------------------------------------------------"
+    end
+  end
+end

data/spec/rails_app/lib/custom_optional_targets/wrong_target.rb

@@ -0,0 +1,10 @@
+module CustomOptionalTarget
+  # Wrong optional target implementation for tests.
+  class WrongTarget
+    def initialize_target(options = {})
+    end
+
+    def notify(notification, options = {})
+    end
+  end
+end

data/spec/roles/acts_as_notifiable_spec.rb

@@ -1,8 +1,15 @@
 describe ActivityNotification::ActsAsNotifiable do
-  let(:dummy_model_class) { Dummy::DummyBase }
+  let(:dummy_model_class)      { Dummy::DummyBase }
+  let(:dummy_notifiable_class) { Dummy::DummyNotifiable }
+  let(:dummy_target)           { create(:dummy_target) }
 
   describe "as public class methods" do
     describe ".acts_as_notifiable" do
+      before do
+        dummy_notifiable_class.set_notifiable_class_defaults
+        @notifiable = dummy_notifiable_class.create
+      end
+
       it "have not included Notifiable before calling" do
         expect(dummy_model_class.respond_to?(:available_as_notifiable?)).to be_falsey
       end
@@ -19,13 +26,128 @@ describe ActivityNotification::ActsAsNotifiable do
         end
       end
 
+      context "with :dependent_notifications option" do
+        before do
+          dummy_notifiable_class.reset_callbacks :destroy
+          @notifiable_1, @notifiable_2, @notifiable_3 = dummy_notifiable_class.create, dummy_notifiable_class.create, dummy_notifiable_class.create
+          @group_owner  = create(:notification, target: dummy_target, notifiable: @notifiable_1, group: @notifiable_1)
+          @group_member = create(:notification, target: dummy_target, notifiable: @notifiable_2, group: @notifiable_1, group_owner: @group_owner)
+                          create(:notification, target: dummy_target, notifiable: @notifiable_3, group: @notifiable_1, group_owner: @group_owner)
+          expect(@group_owner.group_member_count).to eq(2)
+        end
+
+        it "returns hash of :dependent_notifications option" do
+          expect(dummy_notifiable_class.acts_as_notifiable :users, dependent_notifications: :restrict_with_exception)
+            .to eq({ dependent_notifications: :restrict_with_exception })
+        end
+
+        context "without option" do
+          it "does not deletes any notifications when notifiable is deleted" do
+            dummy_notifiable_class.acts_as_notifiable :users
+            expect(dummy_target.notifications.reload.size).to eq(3)
+            expect { @notifiable_1.destroy }.to change(dummy_notifiable_class, :count).by(-1)
+            expect(dummy_target.notifications.reload.size).to eq(3)
+          end
+        end
+
+        context ":delete_all" do
+          it "deletes all notifications when notifiable is deleted" do
+            dummy_notifiable_class.acts_as_notifiable :users, dependent_notifications: :delete_all
+            expect(dummy_target.notifications.reload.size).to eq(3)
+            expect { @notifiable_1.destroy }.to change(dummy_notifiable_class, :count).by(-1)
+            expect(dummy_target.notifications.reload.size).to eq(2)
+            expect(@group_member.reload.group_owner?).to be_falsey
+          end
+        end
+
+        context ":destroy" do
+          it "destroies all notifications when notifiable is deleted" do
+            dummy_notifiable_class.acts_as_notifiable :users, dependent_notifications: :destroy
+            expect(dummy_target.notifications.reload.size).to eq(3)
+            expect { @notifiable_1.destroy }.to change(dummy_notifiable_class, :count).by(-1)
+            expect(dummy_target.notifications.reload.size).to eq(2)
+            expect(@group_member.reload.group_owner?).to be_falsey
+          end
+        end
+
+        context ":restrict_with_exception" do
+          it "can not be deleted when it has generated notifications" do
+            dummy_notifiable_class.acts_as_notifiable :users, dependent_notifications: :restrict_with_exception
+            expect(dummy_target.notifications.reload.size).to eq(3)
+            expect { @notifiable_1.destroy }.to raise_error(ActiveRecord::DeleteRestrictionError)
+          end
+        end
+
+        context ":update_group_and_delete_all" do
+          it "deletes all notifications and update notification group when notifiable is deleted" do
+            dummy_notifiable_class.acts_as_notifiable :users, dependent_notifications: :update_group_and_delete_all
+            expect(dummy_target.notifications.reload.size).to eq(3)
+            expect { @notifiable_1.destroy }.to change(dummy_notifiable_class, :count).by(-1)
+            expect(dummy_target.notifications.reload.size).to eq(2)
+            expect(@group_member.reload.group_owner?).to be_truthy
+          end
+        end
+
+        context ":update_group_and_destroy" do
+          it "destroies all notifications and update notification group when notifiable is deleted" do
+            dummy_notifiable_class.acts_as_notifiable :users, dependent_notifications: :update_group_and_destroy
+            expect(dummy_target.notifications.reload.size).to eq(3)
+            expect { @notifiable_1.destroy }.to change(dummy_notifiable_class, :count).by(-1)
+            expect(dummy_target.notifications.reload.size).to eq(2)
+            expect(@group_member.reload.group_owner?).to be_truthy
+          end
+        end
+      end
+
+      context "with :optional_targets option" do
+        require 'custom_optional_targets/console_output'
+        require 'custom_optional_targets/wrong_target'
+
+        it "returns hash of :optional_targets option" do
+          result_hash = dummy_notifiable_class.acts_as_notifiable :users, optional_targets: { CustomOptionalTarget::ConsoleOutput => {} }
+          expect(result_hash).to be_a(Hash)
+          expect(result_hash[:optional_targets]).to       be_a(Array)
+          expect(result_hash[:optional_targets].first).to be_a(CustomOptionalTarget::ConsoleOutput)
+        end
+
+        context "without option" do
+          it "does not configure optional_targets and notifiable#optional_targets returns empty array" do
+            dummy_notifiable_class.acts_as_notifiable :users
+            expect(@notifiable.optional_targets(:users)).to eq([])
+          end
+        end
+
+        context "with hash configuration" do
+          it "configure optional_targets and notifiable#optional_targets returns optional_target array" do
+            dummy_notifiable_class.acts_as_notifiable :users, optional_targets: { CustomOptionalTarget::ConsoleOutput => {} }
+            expect(@notifiable.optional_targets(:users)).to       be_a(Array)
+            expect(@notifiable.optional_targets(:users).first).to be_a(CustomOptionalTarget::ConsoleOutput)
+          end
+        end
+
+        context "with hash configuration but specified class does not extends ActivityNotification::OptionalTarget::Base" do
+          it "raise TypeError" do
+            expect { dummy_notifiable_class.acts_as_notifiable :users, optional_targets: { CustomOptionalTarget::WrongTarget => {} } }
+              .to raise_error(TypeError, /.+ is not a kind of ActivityNotification::OptionalTarget::Base/)
+          end
+        end
+
+        context "with lambda function configuration" do
+          it "configure optional_targets and notifiable#optional_targets returns optional_target array" do
+            dummy_notifiable_class.acts_as_notifiable :users, optional_targets: ->(notifiable, key){ key == 'dummy_key' ? [ActivityNotification::OptionalTarget::Base.new] : [] }
+            expect(@notifiable.optional_targets(:users)).to eq([])
+            expect(@notifiable.optional_targets(:users, 'dummy_key').first).to be_a(ActivityNotification::OptionalTarget::Base)
+          end
+        end
+      end
+
       #TODO test other options
     end
 
     describe ".available_notifiable_options" do
       it "returns list of available options in acts_as_notifiable" do
         expect(dummy_model_class.available_notifiable_options)
-          .to eq([:targets, :group, :group_expiry_delay, :notifier, :parameters, :email_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications])
+          .to eq([:targets, :group, :group_expiry_delay, :notifier, :parameters, :email_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications, :optional_targets])
       end
     end
   end