activity_notification 1.4.4 → 2.2.4

data/lib/generators/templates/controllers/subscriptions_api_with_devise_controller.rb

@@ -0,0 +1,61 @@
+class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotification::SubscriptionsWithDeviseController
+  # GET /:target_type/:target_id/subscriptions
+  # def index
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions
+  # def create
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/subscriptions/find
+  def find
+    super
+  end
+
+  # GET /:target_type/:target_id/subscriptions/optional_target_names
+  def optional_target_names
+    super
+  end
+
+  # GET /:target_type/:target_id/subscriptions/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/subscriptions/:id
+  # def destroy
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
+  # def subscribe
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # def unsubscribe
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # def subscribe_to_email
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # def unsubscribe_to_email
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
+  #   super
+  # end
+
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_optional_target
+  # def unsubscribe_to_optional_target
+  #   super
+  # end
+end

data/lib/generators/templates/controllers/subscriptions_controller.rb

@@ -4,11 +4,16 @@ class <%= @target_prefix %>SubscriptionsController < ActivityNotification::Subsc
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions
+  # PUT /:target_type/:target_id/subscriptions
   # def create
   #   super
   # end
 
+  # GET /:target_type/:target_id/subscriptions/find
+  def find
+    super
+  end
+
   # GET /:target_type/:target_id/subscriptions/:id
   # def show
   #   super
@@ -19,61 +24,33 @@ class <%= @target_prefix %>SubscriptionsController < ActivityNotification::Subsc
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
   # def subscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
   # def unsubscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
   # def subscribe_to_email
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
   # def unsubscribe_to_email
   #   super
   # end
 
-  # protected
-
-  # def set_target
-  #   super
-  # end
-
-  # def set_subscription
-  #   super
-  # end
-
-  # def subscription_params
-  #   super
-  # end
-
-  # def set_index_options
-  #   super
-  # end
-
-  # def load_index
-  #   super
-  # end
-
-  # def controller_path
-  #   super
-  # end
-
-  # def target_view_path
-  #   super
-  # end
-
-  # def set_view_prefixes
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
   #   super
   # end
 
-  # def return_back_or_ajax
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_optional_target
+  # def unsubscribe_to_optional_target
   #   super
   # end
 end

data/lib/generators/templates/controllers/subscriptions_with_devise_controller.rb

@@ -4,11 +4,16 @@ class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotificat
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions
+  # PUT /:target_type/:target_id/subscriptions
   # def create
   #   super
   # end
 
+  # GET /:target_type/:target_id/subscriptions/find
+  def find
+    super
+  end
+
   # GET /:target_type/:target_id/subscriptions/:id
   # def show
   #   super
@@ -19,69 +24,33 @@ class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotificat
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe
   # def subscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe
   # def unsubscribe
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_email
   # def subscribe_to_email
   #   super
   # end
 
-  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
   # def unsubscribe_to_email
   #   super
   # end
 
-  # protected
-
-  # def set_target
-  #   super
-  # end
-
-  # def set_subscription
-  #   super
-  # end
-
-  # def subscription_params
-  #   super
-  # end
-
-  # def set_index_options
-  #   super
-  # end
-
-  # def load_index
-  #   super
-  # end
-
-  # def controller_path
-  #   super
-  # end
-
-  # def target_view_path
-  #   super
-  # end
-
-  # def set_view_prefixes
-  #   super
-  # end
-
-  # def return_back_or_ajax
-  #   super
-  # end
-
-  # def authenticate_devise_resource!
+  # PUT /:target_type/:target_id/subscriptions/:id/subscribe_to_optional_target
+  # def subscribe_to_optional_target
   #   super
   # end
 
-  # def authenticate_target!
+  # PUT /:target_type/:target_id/subscriptions/:id/unsubscribe_to_optional_target
+  # def unsubscribe_to_optional_target
   #   super
   # end
 end

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

@@ -1,5 +1,5 @@
 # Migration responsible for creating a table with notifications
-class <%= @migration_name %> < ActiveRecord::Migration
+class <%= @migration_name %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f}]" %>
   # Create tables
   def change
     <% if @migration_tables.include?('notifications') %>create_table :notifications do |t|
@@ -12,7 +12,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
       t.text       :parameters
       t.datetime   :opened_at
 
-      t.timestamps
+      t.timestamps null: false
     end<% else %># create_table :notifications do |t|
     #   t.belongs_to :target,     polymorphic: true, index: true, null: false
     #   t.belongs_to :notifiable, polymorphic: true, index: true, null: false
@@ -23,7 +23,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
     #   t.text       :parameters
     #   t.datetime   :opened_at
     #
-    #   t.timestamps
+    #   t.timestamps null: false
     # end<% end %>
 
     <% if @migration_tables.include?('subscriptions') %>create_table :subscriptions do |t|
@@ -37,7 +37,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
       t.datetime   :unsubscribed_to_email_at
       t.text       :optional_targets
 
-      t.timestamps
+      t.timestamps null: false
     end
     add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% else %># create_table :subscriptions do |t|
     #   t.belongs_to :target,     polymorphic: true, index: true, null: false
@@ -50,7 +50,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
     #   t.datetime   :unsubscribed_to_email_at
     #   t.text       :optional_targets
     #
-    #   t.timestamps
+    #   t.timestamps null: false
     # end
     # add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% end %>
   end

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/lib/tasks/activity_notification_tasks.rake

@@ -1,4 +1,14 @@
-# desc "Explaining what the task does"
-# task :activity_notification do
-#   # Task goes here
-# end
+namespace :activity_notification do
+  desc "Create Amazon DynamoDB tables used by activity_notification with Dynamoid"
+  task create_dynamodb_tables: :environment do
+    if ActivityNotification.config.orm == :dynamoid
+      ActivityNotification::Notification.create_table(sync: true)
+      puts "Created table: #{ActivityNotification::Notification.table_name}"
+      ActivityNotification::Subscription.create_table(sync: true)
+      puts "Created table: #{ActivityNotification::Subscription.table_name}"
+    else
+      puts "Error: ActivityNotification.config.orm is not set to :dynamoid."
+      puts "Error: Confirm to set AN_ORM environment variable to dynamoid or set ActivityNotification.config.orm to :dynamoid."
+    end
+  end
+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,49 @@
+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

data/spec/channels/notification_api_with_devise_channel_spec.rb

@@ -0,0 +1,76 @@
+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

data/spec/channels/notification_channel_shared_examples.rb

@@ -0,0 +1,59 @@
+# @See https://github.com/palkan/action-cable-testing
+shared_examples_for :notification_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' }))
+      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}")
+    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 }))
+      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}")
+    end
+  end
+
+  context "without any parameters" do
+    it "rejects subscription" do
+      subscribe
+      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_type parameter" do
+    it "rejects subscription" do
+      subscribe({ typed_target_param => 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
+  end
+
+  context "without target_id and (typed_target)_id parameters" do
+    it "rejects subscription" do
+      subscribe(target_params)
+      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 }))
+      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
+end

data/spec/channels/notification_channel_spec.rb

@@ -0,0 +1,48 @@
+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
+  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
+
+    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