activity_notification 1.7.1 → 2.0.0

data/spec/rails_app/config/environments/production.rb

@@ -25,7 +25,7 @@ Rails.application.configure do
   config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
   # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
+  # config.assets.js_compressor = :uglifier
   # config.assets.css_compressor = :sass
 
   # Do not fallback to assets pipeline if a precompiled asset is missed.

data/spec/rails_app/config/initializers/activity_notification.rb

@@ -1,18 +1,18 @@
 ActivityNotification.configure do |config|
 
-  # Configure ORM name for ActivityNotification.
-  # Set :active_record or :mongoid.
-  ENV['AN_ORM'] = 'active_record' unless ENV['AN_ORM'] == 'mongoid'
-  config.orm = ENV['AN_ORM']
-
   # Configure if all activity notifications are enabled
   # Set false when you want to turn off activity notifications
   config.enabled = true
 
-  # Configure table name to store notification data
+  # Configure ORM name for ActivityNotification.
+  # Set :active_record, :mongoid or :dynamoid.
+  ENV['AN_ORM'] = 'active_record' if ['mongoid', 'dynamoid'].exclude?(ENV['AN_ORM'])
+  config.orm = ENV['AN_ORM'].to_sym
+
+  # Configure table name to store notification data.
   config.notification_table_name = "notifications"
 
-  # Configure table name to store subscription data
+  # Configure table name to store subscription data.
   config.subscription_table_name = "subscriptions"
 
   # Configure if email notification is enabled as default.
@@ -47,6 +47,9 @@ ActivityNotification.configure do |config|
   # Configure the parent class for activity_notification controllers.
   # config.parent_controller = 'ApplicationController'
 
+  # Configure the parent class for activity_notification channels.
+  # config.parent_channel = 'ActionCable::Channel::Base'
+
   # Configure the custom mailer templates directory
   # config.mailer_templates_dir = 'activity_notification/mailer'
 
@@ -56,4 +59,24 @@ ActivityNotification.configure do |config|
   # Configure ActiveJob queue name for delayed notifications.
   config.active_job_queue = :activity_notification
 
+  # Configure delimiter of composite key for DynamoDB.
+  # config.composite_key_delimiter = '#'
+
+  # Configure if activity_notification stores notificaion records including associated records like target and notifiable..
+  # This store_with_associated_records option can be set true only when you use mongoid or dynamoid ORM.
+  config.store_with_associated_records = false
+
+  # Configure if WebSocket subscription using ActionCable is enabled.
+  # Note that you can configure them for each model by acts_as roles.
+  # Set true when you want to turn on WebSocket subscription using ActionCable as default.
+  config.action_cable_enabled = false
+
+  # Configure if ctivity_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
+
+  # Configure notification channel prefix for ActionCable.
+  config.notification_channel_prefix = 'activity_notification_channel'
+
 end

data/spec/rails_app/config/locales/activity_notification.en.yml

@@ -11,6 +11,8 @@ en:
         destroy:
           text: 'Some user removed an article!'
       comment:
+        create:
+          text: '%{notifier_name} posted a comment on the article "%{article_title}"'
         post:
           text:
             one: "<p>%{notifier_name} posted a comment on your article %{article_title}</p>"

data/spec/rails_app/db/seeds.rb

@@ -1,9 +1,9 @@
 # coding: utf-8
 # This file is seed file for test data on development environment.
 
-def clear_database
-  [ActivityNotification::Notification, ActivityNotification::Subscription, Comment, Article, Admin, User].each do |model|
-    model.delete_all
+def clean_database
+  [ActivityNotification::Notification, ActivityNotification::Subscription, Comment, Article, Admin, User].each do |model_class|
+    model_class.delete_all
   end
 end
 
@@ -29,8 +29,11 @@ def reset_pk_sequence
   end
 end
 
-clear_database
+clean_database
+puts "* Cleaned database"
+
 reset_pk_sequence
+puts "* Reset sequences for primary keys"
 
 ['Ichiro', 'Stephen', 'Klay', 'Kevin'].each do |name|
   user = User.new(
@@ -42,6 +45,7 @@ reset_pk_sequence
   user.skip_confirmation!
   user.save!
 end
+puts "* Created #{User.count} user records"
 
 ['Ichiro'].each do |name|
   user = User.find_by(name: name)
@@ -51,6 +55,7 @@ end
     slack_username: ENV['OPTIONAL_TARGET_SLACK_USERNAME']
   )
 end
+puts "* Created #{Admin.count} admin records"
 
 User.all.each do |user|
   article = user.articles.create(
@@ -59,6 +64,10 @@ User.all.each do |user|
   )
   article.notify :users, send_email: false
 end
+puts "* Created #{Article.count} article records"
+notifications = ActivityNotification::Notification.filtered_by_type("Article")
+puts "** Generated #{ActivityNotification::Notification.filtered_by_type("Article").count} notification records for new articles"
+puts "*** #{ActivityNotification::Notification.filtered_by_type("Article").filtered_by_target_type("User").count} notifications as #{ActivityNotification::Notification.filtered_by_type("Article").filtered_by_target_type("User").group_owners_only.count} groups to users"
 
 Article.all.each do |article|
   User.all.each do |user|
@@ -68,4 +77,11 @@ Article.all.each do |article|
     )
     comment.notify :users, send_email: false
   end
-end
+end
+puts "* Created #{Comment.count} comment records"
+notifications = ActivityNotification::Notification.filtered_by_type("Comment")
+puts "** Generated #{ActivityNotification::Notification.filtered_by_type("Comment").count} notification records for new comments"
+puts "*** #{ActivityNotification::Notification.filtered_by_type("Comment").filtered_by_target_type("User").count} notifications as #{ActivityNotification::Notification.filtered_by_type("Comment").filtered_by_target_type("User").group_owners_only.count} groups to users"
+puts "*** #{ActivityNotification::Notification.filtered_by_type("Comment").filtered_by_target_type("Admin").count} notifications as #{ActivityNotification::Notification.filtered_by_type("Comment").filtered_by_target_type("Admin").group_owners_only.count} groups to admins"
+
+puts "Created ActivityNotification test records!"

data/spec/rails_app/lib/mailer_previews/mailer_preview.rb

@@ -1,14 +1,22 @@
 class ActivityNotification::MailerPreview < ActionMailer::Preview
 
   def send_notification_email_single
-    target_notification = ActivityNotification::Notification.where(group: nil).first
+    target_notification =
+      case ActivityNotification.config.orm
+      when :active_record then ActivityNotification::Notification.where(group: nil).first
+      when :mongoid       then ActivityNotification::Notification.where(group: nil).first
+      when :dynamoid      then ActivityNotification::Notification.where('group_key.null': true).first
+      end
     ActivityNotification::Mailer.send_notification_email(target_notification)
   end
 
   def send_notification_email_with_group
-    target_notification = ActivityNotification.config.orm == :active_record ?
-      ActivityNotification::Notification.where.not(group: nil).first :
-      ActivityNotification::Notification.where(:group_id.nin => ["", nil]).first
+    target_notification =
+      case ActivityNotification.config.orm
+      when :active_record then ActivityNotification::Notification.where.not(group: nil).first
+      when :mongoid       then ActivityNotification::Notification.where(:group_id.nin => ["", nil]).first
+      when :dynamoid      then ActivityNotification::Notification.where('group_key.not_null': true).first
+      end
     ActivityNotification::Mailer.send_notification_email(target_notification)
   end
 

data/spec/roles/acts_as_notifiable_spec.rb

@@ -312,7 +312,7 @@ describe ActivityNotification::ActsAsNotifiable do
             if ActivityNotification.config.orm == :active_record
               expect { @notifiable_1.destroy }.to raise_error(ActiveRecord::DeleteRestrictionError)
             else
-              expect { @notifiable_1.destroy }.to raise_error(RuntimeError)
+              expect { @notifiable_1.destroy }.to raise_error(ActivityNotification::DeleteRestrictionError)
             end
           end
         end
@@ -427,7 +427,7 @@ describe ActivityNotification::ActsAsNotifiable do
     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, :optional_targets])
+          .to eq([:targets, :group, :group_expiry_delay, :notifier, :parameters, :email_allowed, :action_cable_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications, :optional_targets])
       end
     end
   end

data/spec/roles/acts_as_target_spec.rb

@@ -33,7 +33,7 @@ describe ActivityNotification::ActsAsTarget do
     describe ".available_target_options" do
       it "returns list of available options in acts_as_target" do
         expect(dummy_model_class.available_target_options)
-          .to eq([:email, :email_allowed, :batch_email_allowed, :subscription_allowed, :devise_resource, :printable_notification_target_name, :printable_name])
+          .to eq([:email, :email_allowed, :batch_email_allowed, :subscription_allowed, :action_cable_enabled, :action_cable_with_devise, :devise_resource, :printable_notification_target_name, :printable_name])
       end
     end
   end

data/spec/spec_helper.rb

@@ -16,35 +16,42 @@ SimpleCov.start('rails') do
   add_filter '/lib/generators/templates/'
   add_filter '/lib/activity_notification/version.rb'
   if Rails::VERSION::MAJOR >= 5
-    nocov_token 'except-rails5+'
+    skip_token_tag = 'except-rails5-plus'
   else
-    nocov_token 'only-rails5+'
+    skip_token_tag = 'only-rails5-plus'
+    add_filter '/app/channels/activity_notification/'
   end
   if Gem::Version.new("5.1.6") <= Rails.gem_version && Rails.gem_version < Gem::Version.new("5.2.2")
-    nocov_token 'only-rails-without-callback-issue'
+    skip_token_tag += '#only-rails-without-callback-issue'
   else
-    nocov_token 'only-rails-with-callback-issue'
+    skip_token_tag += '#only-rails-with-callback-issue'
   end
   if ENV['AN_ORM'] == 'mongoid'
     add_filter '/lib/activity_notification/orm/active_record'
+    add_filter '/lib/activity_notification/orm/dynamoid'
+  elsif ENV['AN_ORM'] == 'dynamoid'
+    add_filter '/lib/activity_notification/orm/active_record'
+    add_filter '/lib/activity_notification/orm/mongoid'
+    skip_token_tag += '#except-dynamoid'
   else
     add_filter '/lib/activity_notification/orm/mongoid'
+    add_filter '/lib/activity_notification/orm/dynamoid'
   end
+  skip_token skip_token_tag
 end
 
-# Testing with Devise
-require 'devise'
 # Dummy application
 require 'rails_app/config/environment'
 
 require 'rspec/rails'
 require 'ammeter/init'
+require "action_cable/testing/rspec" if Rails::VERSION::MAJOR == 5
 require 'factory_bot_rails'
 require 'activity_notification'
 
 Dir[Rails.root.join("../../spec/support/**/*.rb")].each { |file| require file }
 
-def clear_database
+def clean_database
   [ActivityNotification::Notification, ActivityNotification::Subscription, Comment, Article, Admin, User].each do |model_class|
     model_class.delete_all
   end
@@ -54,7 +61,7 @@ RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
   config.before(:all) do
     FactoryBot.reload
-    clear_database
+    clean_database
   end
   config.include Devise::Test::ControllerHelpers, type: :controller
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activity_notification
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Shota Yamazaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +19,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -65,9 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.13
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,9 +86,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.13
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -113,19 +121,33 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: dynamoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -263,9 +285,12 @@ files:
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
+- Procfile
 - README.md
 - Rakefile
 - activity_notification.gemspec
+- app/channels/activity_notification/notification_channel.rb
+- app/channels/activity_notification/notification_with_devise_channel.rb
 - app/controllers/activity_notification/notifications_controller.rb
 - app/controllers/activity_notification/notifications_with_devise_controller.rb
 - app/controllers/activity_notification/subscriptions_controller.rb
@@ -302,10 +327,17 @@ files:
 - app/views/activity_notification/subscriptions/default/unsubscribe.js.erb
 - app/views/activity_notification/subscriptions/default/unsubscribe_to_email.js.erb
 - app/views/activity_notification/subscriptions/default/unsubscribe_to_optional_target.js.erb
+- bin/_dynamodblocal
+- bin/bundle_update.sh
+- bin/deploy_on_heroku.sh
+- bin/install_dynamodblocal.sh
+- bin/start_dynamodblocal.sh
+- bin/stop_dynamodblocal.sh
 - gemfiles/Gemfile.rails-4.2
 - gemfiles/Gemfile.rails-5.0
 - gemfiles/Gemfile.rails-5.1
 - gemfiles/Gemfile.rails-5.2
+- gemfiles/Gemfile.rails-6.0.rc
 - lib/activity_notification.rb
 - lib/activity_notification/apis/notification_api.rb
 - lib/activity_notification/apis/subscription_api.rb
@@ -314,6 +346,7 @@ files:
 - lib/activity_notification/controllers/common_controller.rb
 - lib/activity_notification/controllers/devise_authentication_controller.rb
 - lib/activity_notification/controllers/store_controller.rb
+- lib/activity_notification/helpers/errors.rb
 - lib/activity_notification/helpers/polymorphic_helpers.rb
 - lib/activity_notification/helpers/view_helpers.rb
 - lib/activity_notification/mailers/helpers.rb
@@ -331,6 +364,10 @@ files:
 - lib/activity_notification/orm/active_record.rb
 - lib/activity_notification/orm/active_record/notification.rb
 - lib/activity_notification/orm/active_record/subscription.rb
+- lib/activity_notification/orm/dynamoid.rb
+- lib/activity_notification/orm/dynamoid/extension.rb
+- lib/activity_notification/orm/dynamoid/notification.rb
+- lib/activity_notification/orm/dynamoid/subscription.rb
 - lib/activity_notification/orm/mongoid.rb
 - lib/activity_notification/orm/mongoid/notification.rb
 - lib/activity_notification/orm/mongoid/subscription.rb
@@ -361,7 +398,9 @@ files:
 - lib/generators/templates/models/notification.rb
 - lib/generators/templates/models/subscription.rb
 - lib/tasks/activity_notification_tasks.rake
-- scripts/bundle_update.sh
+- spec/channels/notification_channel_shared_examples.rb
+- spec/channels/notification_channel_spec.rb
+- spec/channels/notification_with_devise_channel_spec.rb
 - spec/concerns/apis/notification_api_spec.rb
 - spec/concerns/apis/subscription_api_spec.rb
 - spec/concerns/common_spec.rb
@@ -412,8 +451,10 @@ files:
 - spec/optional_targets/amazon_sns_spec.rb
 - spec/optional_targets/base_spec.rb
 - spec/optional_targets/slack_spec.rb
+- spec/orm/dynamoid_spec.rb
 - spec/rails_app/Rakefile
 - spec/rails_app/app/assets/javascripts/application.js
+- spec/rails_app/app/assets/javascripts/cable.js
 - spec/rails_app/app/assets/stylesheets/application.css
 - spec/rails_app/app/assets/stylesheets/reset.css
 - spec/rails_app/app/assets/stylesheets/style.css
@@ -428,7 +469,6 @@ files:
 - spec/rails_app/app/helpers/application_helper.rb
 - spec/rails_app/app/mailers/.keep
 - spec/rails_app/app/mailers/custom_notification_mailer.rb
-- spec/rails_app/app/models/.keep
 - spec/rails_app/app/models/admin.rb
 - spec/rails_app/app/models/article.rb
 - spec/rails_app/app/models/comment.rb
@@ -445,7 +485,7 @@ files:
 - spec/rails_app/app/views/activity_notification/notifications/default/custom/_test.html.erb
 - spec/rails_app/app/views/activity_notification/notifications/users/_custom_index.html.erb
 - spec/rails_app/app/views/activity_notification/notifications/users/custom/_test.html.erb
-- spec/rails_app/app/views/activity_notification/notifications/users/overriden/custom/_test.html.erb
+- spec/rails_app/app/views/activity_notification/notifications/users/overridden/custom/_test.html.erb
 - spec/rails_app/app/views/activity_notification/optional_targets/admins/amazon_sns/comment/_default.text.erb
 - spec/rails_app/app/views/articles/_form.html.erb
 - spec/rails_app/app/views/articles/edit.html.erb
@@ -461,7 +501,9 @@ files:
 - spec/rails_app/config.ru
 - spec/rails_app/config/application.rb
 - spec/rails_app/config/boot.rb
+- spec/rails_app/config/cable.yml
 - spec/rails_app/config/database.yml
+- spec/rails_app/config/dynamoid.rb
 - spec/rails_app/config/environment.rb
 - spec/rails_app/config/environments/development.rb
 - spec/rails_app/config/environments/production.rb
@@ -517,12 +559,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Integrated user activity notifications for Ruby on Rails
 test_files:
+- spec/channels/notification_channel_shared_examples.rb
+- spec/channels/notification_channel_spec.rb
+- spec/channels/notification_with_devise_channel_spec.rb
 - spec/concerns/apis/notification_api_spec.rb
 - spec/concerns/apis/subscription_api_spec.rb
 - spec/concerns/common_spec.rb
@@ -573,8 +617,10 @@ test_files:
 - spec/optional_targets/amazon_sns_spec.rb
 - spec/optional_targets/base_spec.rb
 - spec/optional_targets/slack_spec.rb
+- spec/orm/dynamoid_spec.rb
 - spec/rails_app/Rakefile
 - spec/rails_app/app/assets/javascripts/application.js
+- spec/rails_app/app/assets/javascripts/cable.js
 - spec/rails_app/app/assets/stylesheets/application.css
 - spec/rails_app/app/assets/stylesheets/reset.css
 - spec/rails_app/app/assets/stylesheets/style.css
@@ -589,7 +635,6 @@ test_files:
 - spec/rails_app/app/helpers/application_helper.rb
 - spec/rails_app/app/mailers/.keep
 - spec/rails_app/app/mailers/custom_notification_mailer.rb
-- spec/rails_app/app/models/.keep
 - spec/rails_app/app/models/admin.rb
 - spec/rails_app/app/models/article.rb
 - spec/rails_app/app/models/comment.rb
@@ -606,7 +651,7 @@ test_files:
 - spec/rails_app/app/views/activity_notification/notifications/default/custom/_test.html.erb
 - spec/rails_app/app/views/activity_notification/notifications/users/_custom_index.html.erb
 - spec/rails_app/app/views/activity_notification/notifications/users/custom/_test.html.erb
-- spec/rails_app/app/views/activity_notification/notifications/users/overriden/custom/_test.html.erb
+- spec/rails_app/app/views/activity_notification/notifications/users/overridden/custom/_test.html.erb
 - spec/rails_app/app/views/activity_notification/optional_targets/admins/amazon_sns/comment/_default.text.erb
 - spec/rails_app/app/views/articles/_form.html.erb
 - spec/rails_app/app/views/articles/edit.html.erb
@@ -622,7 +667,9 @@ test_files:
 - spec/rails_app/config.ru
 - spec/rails_app/config/application.rb
 - spec/rails_app/config/boot.rb
+- spec/rails_app/config/cable.yml
 - spec/rails_app/config/database.yml
+- spec/rails_app/config/dynamoid.rb
 - spec/rails_app/config/environment.rb
 - spec/rails_app/config/environments/development.rb
 - spec/rails_app/config/environments/production.rb