activity_notification 1.4.4 → 2.2.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/ISSUE_TEMPLATE/bug_report.md +22 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +17 -0
- data/.github/pull_request_template.md +13 -0
- data/.github/workflows/build.yml +116 -0
- data/.gitignore +15 -3
- data/CHANGELOG.md +200 -1
- data/Gemfile +17 -2
- data/Procfile +2 -0
- data/README.md +168 -1033
- data/Rakefile +19 -10
- data/activity_notification.gemspec +14 -9
- data/app/channels/activity_notification/notification_api_channel.rb +12 -0
- data/app/channels/activity_notification/notification_api_with_devise_channel.rb +46 -0
- data/app/channels/activity_notification/notification_channel.rb +37 -0
- data/app/channels/activity_notification/notification_with_devise_channel.rb +51 -0
- data/app/controllers/activity_notification/apidocs_controller.rb +75 -0
- data/app/controllers/activity_notification/notifications_api_controller.rb +143 -0
- data/app/controllers/activity_notification/notifications_api_with_devise_controller.rb +7 -0
- data/app/controllers/activity_notification/notifications_controller.rb +60 -54
- data/app/controllers/activity_notification/subscriptions_api_controller.rb +197 -0
- data/app/controllers/activity_notification/subscriptions_api_with_devise_controller.rb +7 -0
- data/app/controllers/activity_notification/subscriptions_controller.rb +83 -73
- data/app/jobs/activity_notification/notify_all_job.rb +25 -0
- data/app/jobs/activity_notification/notify_job.rb +26 -0
- data/app/jobs/activity_notification/notify_to_job.rb +25 -0
- data/app/views/activity_notification/notifications/default/_default.html.erb +23 -23
- data/app/views/activity_notification/notifications/default/_default_without_grouping.html.erb +19 -19
- data/app/views/activity_notification/notifications/default/_index.html.erb +3 -3
- data/app/views/activity_notification/notifications/default/index.html.erb +60 -7
- data/app/views/activity_notification/notifications/default/open.js.erb +2 -2
- data/app/views/activity_notification/notifications/default/open_all.js.erb +2 -2
- data/app/views/activity_notification/notifications/default/show.html.erb +2 -2
- data/app/views/activity_notification/optional_targets/default/action_cable_channel/_default.html.erb +176 -0
- data/app/views/activity_notification/optional_targets/default/base/_default.text.erb +1 -1
- data/app/views/activity_notification/optional_targets/default/slack/_default.text.erb +1 -1
- data/app/views/activity_notification/subscriptions/default/_form.html.erb +2 -2
- data/app/views/activity_notification/subscriptions/default/_notification_keys.html.erb +5 -33
- data/app/views/activity_notification/subscriptions/default/_subscription.html.erb +8 -8
- data/app/views/activity_notification/subscriptions/default/index.html.erb +13 -9
- data/app/views/activity_notification/subscriptions/default/show.html.erb +3 -3
- data/app/views/activity_notification/subscriptions/default/subscribe.js.erb +1 -1
- data/app/views/activity_notification/subscriptions/default/subscribe_to_email.js.erb +1 -1
- data/app/views/activity_notification/subscriptions/default/subscribe_to_optional_target.js.erb +1 -1
- data/app/views/activity_notification/subscriptions/default/unsubscribe.js.erb +1 -1
- data/app/views/activity_notification/subscriptions/default/unsubscribe_to_email.js.erb +1 -1
- data/app/views/activity_notification/subscriptions/default/unsubscribe_to_optional_target.js.erb +1 -1
- data/bin/_dynamodblocal +4 -0
- data/bin/bundle_update.sh +7 -0
- data/bin/deploy_on_heroku.sh +16 -0
- data/bin/install_dynamodblocal.sh +5 -0
- data/bin/start_dynamodblocal.sh +47 -0
- data/bin/stop_dynamodblocal.sh +34 -0
- data/docs/CODE_OF_CONDUCT.md +76 -0
- data/docs/CONTRIBUTING.md +36 -0
- data/docs/Functions.md +1146 -0
- data/docs/Setup.md +817 -0
- data/docs/Testing.md +148 -0
- data/gemfiles/Gemfile.rails-5.0 +8 -1
- data/gemfiles/Gemfile.rails-5.1 +7 -1
- data/gemfiles/Gemfile.rails-5.2 +24 -0
- data/gemfiles/Gemfile.rails-6.0 +23 -0
- data/gemfiles/Gemfile.rails-6.1 +22 -0
- data/gemfiles/Gemfile.rails-7.0 +25 -0
- data/lib/activity_notification/apis/notification_api.rb +356 -159
- data/lib/activity_notification/apis/subscription_api.rb +98 -59
- data/lib/activity_notification/apis/swagger.rb +6 -0
- data/lib/activity_notification/common.rb +18 -7
- data/lib/activity_notification/config.rb +176 -30
- data/lib/activity_notification/controllers/common_api_controller.rb +30 -0
- data/lib/activity_notification/controllers/common_controller.rb +47 -27
- data/lib/activity_notification/controllers/concerns/swagger/error_responses.rb +55 -0
- data/lib/activity_notification/controllers/concerns/swagger/notifications_api.rb +273 -0
- data/lib/activity_notification/controllers/concerns/swagger/notifications_parameters.rb +92 -0
- data/lib/activity_notification/controllers/concerns/swagger/subscriptions_api.rb +405 -0
- data/lib/activity_notification/controllers/concerns/swagger/subscriptions_parameters.rb +50 -0
- data/lib/activity_notification/controllers/devise_authentication_controller.rb +22 -5
- data/lib/activity_notification/gem_version.rb +14 -0
- data/lib/activity_notification/helpers/errors.rb +6 -0
- data/lib/activity_notification/helpers/view_helpers.rb +118 -28
- data/lib/activity_notification/mailers/helpers.rb +19 -12
- data/lib/activity_notification/models/concerns/notifiable.rb +142 -55
- data/lib/activity_notification/models/concerns/subscriber.rb +28 -13
- data/lib/activity_notification/models/concerns/swagger/error_schema.rb +36 -0
- data/lib/activity_notification/models/concerns/swagger/notification_schema.rb +209 -0
- data/lib/activity_notification/models/concerns/swagger/subscription_schema.rb +162 -0
- data/lib/activity_notification/models/concerns/target.rb +131 -32
- data/lib/activity_notification/models/notification.rb +1 -0
- data/lib/activity_notification/models/subscription.rb +1 -0
- data/lib/activity_notification/models.rb +23 -1
- data/lib/activity_notification/optional_targets/action_cable_api_channel.rb +69 -0
- data/lib/activity_notification/optional_targets/action_cable_channel.rb +68 -0
- data/lib/activity_notification/optional_targets/base.rb +9 -15
- data/lib/activity_notification/orm/active_record/notification.rb +23 -34
- data/lib/activity_notification/orm/active_record/subscription.rb +1 -1
- data/lib/activity_notification/orm/active_record.rb +1 -1
- data/lib/activity_notification/orm/dynamoid/extension.rb +262 -0
- data/lib/activity_notification/orm/dynamoid/notification.rb +224 -0
- data/lib/activity_notification/orm/dynamoid/subscription.rb +82 -0
- data/lib/activity_notification/orm/dynamoid.rb +530 -0
- data/lib/activity_notification/orm/mongoid/notification.rb +29 -28
- data/lib/activity_notification/orm/mongoid/subscription.rb +3 -3
- data/lib/activity_notification/orm/mongoid.rb +33 -1
- data/lib/activity_notification/rails/routes.rb +273 -60
- data/lib/activity_notification/renderable.rb +22 -7
- data/lib/activity_notification/roles/acts_as_notifiable.rb +64 -1
- data/lib/activity_notification/roles/acts_as_target.rb +99 -9
- data/lib/activity_notification/version.rb +1 -1
- data/lib/activity_notification.rb +14 -0
- data/lib/generators/activity_notification/controllers_generator.rb +2 -1
- data/lib/generators/templates/activity_notification.rb +61 -7
- data/lib/generators/templates/controllers/README +2 -2
- data/lib/generators/templates/controllers/notifications_api_controller.rb +31 -0
- data/lib/generators/templates/controllers/notifications_api_with_devise_controller.rb +31 -0
- data/lib/generators/templates/controllers/notifications_controller.rb +1 -37
- data/lib/generators/templates/controllers/notifications_with_devise_controller.rb +1 -45
- data/lib/generators/templates/controllers/subscriptions_api_controller.rb +61 -0
- data/lib/generators/templates/controllers/subscriptions_api_with_devise_controller.rb +61 -0
- data/lib/generators/templates/controllers/subscriptions_controller.rb +14 -37
- data/lib/generators/templates/controllers/subscriptions_with_devise_controller.rb +14 -45
- data/lib/generators/templates/migrations/migration.rb +5 -5
- data/lib/generators/templates/models/README +8 -4
- data/lib/generators/templates/models/notification.rb +1 -1
- data/lib/generators/templates/models/subscription.rb +1 -1
- data/lib/tasks/activity_notification_tasks.rake +14 -4
- data/package.json +8 -0
- data/spec/channels/notification_api_channel_shared_examples.rb +59 -0
- data/spec/channels/notification_api_channel_spec.rb +49 -0
- data/spec/channels/notification_api_with_devise_channel_spec.rb +76 -0
- data/spec/channels/notification_channel_shared_examples.rb +59 -0
- data/spec/channels/notification_channel_spec.rb +48 -0
- data/spec/channels/notification_with_devise_channel_spec.rb +97 -0
- data/spec/concerns/apis/notification_api_spec.rb +177 -12
- data/spec/concerns/apis/subscription_api_spec.rb +146 -4
- data/spec/concerns/common_spec.rb +25 -3
- data/spec/concerns/models/notifiable_spec.rb +161 -11
- data/spec/concerns/models/subscriber_spec.rb +253 -79
- data/spec/concerns/models/target_spec.rb +180 -47
- data/spec/concerns/renderable_spec.rb +35 -16
- data/spec/config_spec.rb +52 -1
- data/spec/controllers/controller_spec_utility.rb +100 -0
- data/spec/controllers/notifications_api_controller_shared_examples.rb +506 -0
- data/spec/controllers/notifications_api_controller_spec.rb +19 -0
- data/spec/controllers/notifications_api_with_devise_controller_spec.rb +60 -0
- data/spec/controllers/notifications_controller_shared_examples.rb +55 -76
- data/spec/controllers/notifications_controller_spec.rb +1 -2
- data/spec/controllers/notifications_with_devise_controller_spec.rb +14 -8
- data/spec/controllers/subscriptions_api_controller_shared_examples.rb +750 -0
- data/spec/controllers/subscriptions_api_controller_spec.rb +19 -0
- data/spec/controllers/subscriptions_api_with_devise_controller_spec.rb +60 -0
- data/spec/controllers/subscriptions_controller_shared_examples.rb +99 -121
- data/spec/controllers/subscriptions_controller_spec.rb +1 -2
- data/spec/controllers/subscriptions_with_devise_controller_spec.rb +14 -8
- data/spec/factories/notifications.rb +1 -1
- data/spec/factories/subscriptions.rb +3 -3
- data/spec/factories/users.rb +3 -3
- data/spec/generators/migration/migration_generator_spec.rb +29 -4
- data/spec/helpers/view_helpers_spec.rb +31 -21
- data/spec/jobs/notify_all_job_spec.rb +23 -0
- data/spec/jobs/notify_job_spec.rb +23 -0
- data/spec/jobs/notify_to_job_spec.rb +23 -0
- data/spec/mailers/mailer_spec.rb +42 -1
- data/spec/models/dummy/dummy_group_spec.rb +4 -0
- data/spec/models/dummy/dummy_notifiable_spec.rb +4 -0
- data/spec/models/dummy/dummy_notifier_spec.rb +4 -0
- data/spec/models/dummy/dummy_subscriber_spec.rb +3 -0
- data/spec/models/dummy/dummy_target_spec.rb +4 -0
- data/spec/models/notification_spec.rb +181 -45
- data/spec/models/subscription_spec.rb +77 -27
- data/spec/optional_targets/action_cable_api_channel_spec.rb +34 -0
- data/spec/optional_targets/action_cable_channel_spec.rb +41 -0
- data/spec/optional_targets/amazon_sns_spec.rb +0 -2
- data/spec/optional_targets/slack_spec.rb +0 -2
- data/spec/orm/dynamoid_spec.rb +115 -0
- data/spec/rails_app/Rakefile +9 -0
- data/spec/rails_app/app/assets/config/manifest.js +3 -0
- data/spec/rails_app/app/assets/javascripts/application.js +2 -1
- data/spec/rails_app/app/assets/javascripts/cable.js +12 -0
- data/spec/rails_app/app/controllers/admins_controller.rb +21 -0
- data/spec/rails_app/app/controllers/application_controller.rb +1 -1
- data/spec/rails_app/app/controllers/articles_controller.rb +6 -1
- data/spec/rails_app/app/controllers/comments_controller.rb +3 -1
- data/spec/rails_app/app/controllers/spa_controller.rb +7 -0
- data/spec/rails_app/app/controllers/users/notifications_controller.rb +0 -65
- data/spec/rails_app/app/controllers/users/notifications_with_devise_controller.rb +0 -73
- data/spec/rails_app/app/controllers/users/subscriptions_controller.rb +0 -77
- data/spec/rails_app/app/controllers/users/subscriptions_with_devise_controller.rb +0 -85
- data/spec/rails_app/app/controllers/users_controller.rb +26 -0
- data/spec/rails_app/app/javascript/App.vue +40 -0
- data/spec/rails_app/app/javascript/components/DeviseTokenAuth.vue +82 -0
- data/spec/rails_app/app/javascript/components/Top.vue +98 -0
- data/spec/rails_app/app/javascript/components/notifications/Index.vue +200 -0
- data/spec/rails_app/app/javascript/components/notifications/Notification.vue +133 -0
- data/spec/rails_app/app/javascript/components/notifications/NotificationContent.vue +122 -0
- data/spec/rails_app/app/javascript/components/subscriptions/Index.vue +279 -0
- data/spec/rails_app/app/javascript/components/subscriptions/NewSubscription.vue +112 -0
- data/spec/rails_app/app/javascript/components/subscriptions/NotificationKey.vue +141 -0
- data/spec/rails_app/app/javascript/components/subscriptions/Subscription.vue +226 -0
- data/spec/rails_app/app/javascript/config/development.js +5 -0
- data/spec/rails_app/app/javascript/config/environment.js +7 -0
- data/spec/rails_app/app/javascript/config/production.js +5 -0
- data/spec/rails_app/app/javascript/config/test.js +5 -0
- data/spec/rails_app/app/javascript/packs/application.js +18 -0
- data/spec/rails_app/app/javascript/packs/spa.js +14 -0
- data/spec/rails_app/app/javascript/router/index.js +73 -0
- data/spec/rails_app/app/javascript/store/index.js +37 -0
- data/spec/rails_app/app/models/admin.rb +15 -10
- data/spec/rails_app/app/models/article.rb +25 -20
- data/spec/rails_app/app/models/comment.rb +27 -62
- data/spec/rails_app/app/models/dummy/dummy_base.rb +1 -0
- data/spec/rails_app/app/models/dummy/dummy_group.rb +9 -0
- data/spec/rails_app/app/models/dummy/dummy_notifiable.rb +1 -0
- data/spec/rails_app/app/models/dummy/dummy_notifiable_target.rb +27 -0
- data/spec/rails_app/app/models/dummy/dummy_notifier.rb +1 -0
- data/spec/rails_app/app/models/dummy/dummy_subscriber.rb +1 -0
- data/spec/rails_app/app/models/dummy/dummy_target.rb +1 -0
- data/spec/rails_app/app/models/user.rb +44 -18
- data/spec/rails_app/app/views/activity_notification/notifications/default/article/_update.html.erb +146 -0
- data/spec/rails_app/app/views/activity_notification/notifications/users/overridden/custom/_test.html.erb +1 -0
- data/spec/rails_app/app/views/activity_notification/optional_targets/admins/amazon_sns/comment/_default.text.erb +1 -1
- data/spec/rails_app/app/views/articles/index.html.erb +68 -20
- data/spec/rails_app/app/views/articles/show.html.erb +1 -1
- data/spec/rails_app/app/views/layouts/_header.html.erb +9 -3
- data/spec/rails_app/app/views/spa/index.html.erb +2 -0
- data/spec/rails_app/babel.config.js +72 -0
- data/spec/rails_app/bin/webpack +18 -0
- data/spec/rails_app/bin/webpack-dev-server +18 -0
- data/spec/rails_app/config/application.rb +26 -6
- data/spec/rails_app/config/cable.yml +8 -0
- data/spec/rails_app/config/database.yml +1 -1
- data/spec/rails_app/config/dynamoid.rb +13 -0
- data/spec/rails_app/config/environment.rb +5 -1
- data/spec/rails_app/config/environments/development.rb +5 -0
- data/spec/rails_app/config/environments/production.rb +7 -1
- data/spec/rails_app/config/environments/test.rb +7 -11
- data/spec/rails_app/config/initializers/activity_notification.rb +63 -9
- data/spec/rails_app/config/initializers/copy_it.aws.rb.template +6 -0
- data/spec/rails_app/config/initializers/devise_token_auth.rb +55 -0
- data/spec/rails_app/config/initializers/mysql.rb +9 -0
- data/spec/rails_app/config/locales/activity_notification.en.yml +10 -4
- data/spec/rails_app/config/routes.rb +42 -1
- data/spec/rails_app/config/webpack/development.js +5 -0
- data/spec/rails_app/config/webpack/environment.js +7 -0
- data/spec/rails_app/config/webpack/loaders/vue.js +6 -0
- data/spec/rails_app/config/webpack/production.js +5 -0
- data/spec/rails_app/config/webpack/test.js +5 -0
- data/spec/rails_app/config/webpacker.yml +97 -0
- data/spec/rails_app/db/migrate/{20160715050433_create_test_tables.rb → 20160716000000_create_test_tables.rb} +1 -1
- data/spec/rails_app/db/migrate/{20160715050420_create_activity_notification_tables.rb → 20181209000000_create_activity_notification_tables.rb} +3 -3
- data/spec/rails_app/db/migrate/20191201000000_add_tokens_to_users.rb +10 -0
- data/spec/rails_app/db/schema.rb +46 -43
- data/spec/rails_app/db/seeds.rb +28 -4
- data/spec/rails_app/lib/custom_optional_targets/raise_error.rb +14 -0
- data/spec/rails_app/lib/mailer_previews/mailer_preview.rb +14 -4
- data/spec/rails_app/package.json +23 -0
- data/spec/rails_app/postcss.config.js +12 -0
- data/spec/roles/acts_as_group_spec.rb +0 -2
- data/spec/roles/acts_as_notifiable_spec.rb +80 -20
- data/spec/roles/acts_as_notifier_spec.rb +0 -2
- data/spec/roles/acts_as_target_spec.rb +1 -5
- data/spec/spec_helper.rb +13 -11
- data/spec/version_spec.rb +31 -0
- metadata +306 -53
- data/.travis.yml +0 -85
- data/Gemfile.lock +0 -234
- data/gemfiles/Gemfile.rails-4.2 +0 -17
- data/gemfiles/Gemfile.rails-4.2.lock +0 -225
- data/gemfiles/Gemfile.rails-5.0.lock +0 -234
- data/gemfiles/Gemfile.rails-5.1.lock +0 -234
- data/spec/rails_app/app/views/activity_notification/notifications/users/overriden/custom/_test.html.erb +0 -1
- /data/spec/rails_app/app/{models → assets/images}/.keep +0 -0
data/Rakefile
CHANGED
@@ -2,18 +2,27 @@ require "bundler/gem_tasks"
|
|
2
2
|
|
3
3
|
task default: :test
|
4
4
|
|
5
|
-
|
6
|
-
require 'rspec/core
|
7
|
-
|
8
|
-
RSpec
|
9
|
-
|
5
|
+
begin
|
6
|
+
require 'rspec/core'
|
7
|
+
require 'rspec/core/rake_task'
|
8
|
+
desc 'Run RSpec test for the activity_notification plugin.'
|
9
|
+
RSpec::Core::RakeTask.new(:test) do |spec|
|
10
|
+
spec.pattern = FileList['spec/**/*_spec.rb']
|
11
|
+
end
|
12
|
+
rescue LoadError
|
10
13
|
end
|
11
14
|
|
12
|
-
|
13
|
-
require 'yard
|
14
|
-
|
15
|
-
|
16
|
-
|
15
|
+
begin
|
16
|
+
require 'yard'
|
17
|
+
require 'yard/rake/yardoc_task'
|
18
|
+
desc 'Generate documentation for the activity_notification plugin.'
|
19
|
+
YARD::Rake::YardocTask.new do |doc|
|
20
|
+
doc.files = ['app/**/*.rb', 'lib/**/*.rb']
|
21
|
+
end
|
22
|
+
rescue LoadError
|
17
23
|
end
|
18
24
|
|
19
25
|
Bundler::GemHelper.install_tasks
|
26
|
+
|
27
|
+
require File.expand_path('../spec/rails_app/config/application', __FILE__)
|
28
|
+
Rails.application.load_tasks
|
@@ -20,20 +20,25 @@ Gem::Specification.new do |s|
|
|
20
20
|
s.require_paths = ["lib"]
|
21
21
|
s.required_ruby_version = '>= 2.1.0'
|
22
22
|
|
23
|
-
s.add_dependency 'railties', '>=
|
23
|
+
s.add_dependency 'railties', '>= 5.0.0', '< 7.1'
|
24
24
|
s.add_dependency 'i18n', '>= 0.5.0'
|
25
25
|
s.add_dependency 'jquery-rails', '>= 3.1.1'
|
26
|
+
s.add_dependency 'swagger-blocks', '>= 3.0.0'
|
26
27
|
|
27
|
-
s.add_development_dependency '
|
28
|
-
s.add_development_dependency '
|
29
|
-
s.add_development_dependency '
|
28
|
+
s.add_development_dependency 'puma', '>= 3.12.0'
|
29
|
+
s.add_development_dependency 'sqlite3', '>= 1.3.13'
|
30
|
+
s.add_development_dependency 'mysql2', '>= 0.5.2'
|
31
|
+
s.add_development_dependency 'pg', '>= 1.0.0'
|
30
32
|
s.add_development_dependency 'mongoid', '>= 4.0.0'
|
31
|
-
s.add_development_dependency '
|
32
|
-
s.add_development_dependency '
|
33
|
+
s.add_development_dependency 'dynamoid', '3.1.0'
|
34
|
+
s.add_development_dependency 'rspec-rails', '>= 3.8.0'
|
35
|
+
s.add_development_dependency 'factory_bot_rails', '>= 4.11.0', '< 5.0.0'
|
33
36
|
s.add_development_dependency 'simplecov', '~> 0'
|
34
|
-
s.add_development_dependency 'yard', '
|
35
|
-
s.add_development_dependency 'yard-activesupport-concern', '
|
36
|
-
s.add_development_dependency 'devise', '
|
37
|
+
s.add_development_dependency 'yard', '>= 0.9.16'
|
38
|
+
s.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
|
39
|
+
s.add_development_dependency 'devise', '>= 4.5.0'
|
40
|
+
s.add_development_dependency 'devise_token_auth', '>= 1.1.3'
|
41
|
+
s.add_development_dependency 'mongoid-locker', '>= 2.0.0'
|
37
42
|
s.add_development_dependency 'aws-sdk-sns', '~> 1'
|
38
43
|
s.add_development_dependency 'slack-notifier', '>= 1.5.1'
|
39
44
|
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
if defined?(ActionCable)
|
2
|
+
# Action Cable API channel to subscribe broadcasted notifications.
|
3
|
+
class ActivityNotification::NotificationApiChannel < ActivityNotification::NotificationChannel
|
4
|
+
# ActionCable::Channel::Base#subscribed
|
5
|
+
# @see https://api.rubyonrails.org/classes/ActionCable/Channel/Base.html#method-i-subscribed
|
6
|
+
def subscribed
|
7
|
+
stream_from "#{ActivityNotification.config.notification_api_channel_prefix}_#{@target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{@target.id}"
|
8
|
+
rescue
|
9
|
+
reject
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
if defined?(ActionCable)
|
2
|
+
# Action Cable API channel to subscribe broadcasted notifications with Devise authentication.
|
3
|
+
class ActivityNotification::NotificationApiWithDeviseChannel < ActivityNotification::NotificationApiChannel
|
4
|
+
# Include PolymorphicHelpers to resolve string extentions
|
5
|
+
include ActivityNotification::PolymorphicHelpers
|
6
|
+
|
7
|
+
protected
|
8
|
+
|
9
|
+
# Find current authenticated target from auth token headers with Devise Token Auth.
|
10
|
+
# @api protected
|
11
|
+
# @param [String] devise_type Class name of Devise resource to authenticate
|
12
|
+
# @return [Object] Current authenticated target from auth token headers
|
13
|
+
def find_current_target(devise_type = nil)
|
14
|
+
devise_type = (devise_type || @target.notification_devise_resource.class.name).to_s
|
15
|
+
current_target = devise_type.to_model_class.find_by!(uid: params[:uid])
|
16
|
+
return nil unless current_target.valid_token?(params[:'access-token'], params[:client])
|
17
|
+
current_target
|
18
|
+
end
|
19
|
+
|
20
|
+
# Set @target instance variable from request parameters.
|
21
|
+
# This method overrides super (ActivityNotiication::NotificationChannel#set_target)
|
22
|
+
# to set devise authenticated target when the target_id params is not specified.
|
23
|
+
# @api protected
|
24
|
+
# @return [Object] Target instance (Reject subscription when request parameters are not enough)
|
25
|
+
def set_target
|
26
|
+
reject and return if (target_type = params[:target_type]).blank?
|
27
|
+
if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name[/([^\/]+)$/]}_id"].blank?
|
28
|
+
reject and return if params[:devise_type].blank?
|
29
|
+
current_target = find_current_target(params[:devise_type])
|
30
|
+
params[:target_id] = target_type.to_model_class.resolve_current_devise_target(current_target)
|
31
|
+
reject and return if params[:target_id].blank?
|
32
|
+
end
|
33
|
+
super
|
34
|
+
end
|
35
|
+
|
36
|
+
# Authenticate the target of requested notification with authenticated devise resource.
|
37
|
+
# @api protected
|
38
|
+
# @return [Response] Returns connected or rejected
|
39
|
+
def authenticate_target!
|
40
|
+
current_resource = find_current_target
|
41
|
+
reject unless @target.authenticated_with_devise?(current_resource)
|
42
|
+
rescue
|
43
|
+
reject
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
if defined?(ActionCable)
|
2
|
+
# Action Cable channel to subscribe broadcasted notifications.
|
3
|
+
class ActivityNotification::NotificationChannel < ActivityNotification.config.parent_channel.constantize
|
4
|
+
before_subscribe :set_target
|
5
|
+
before_subscribe :authenticate_target!
|
6
|
+
|
7
|
+
# ActionCable::Channel::Base#subscribed
|
8
|
+
# @see https://api.rubyonrails.org/classes/ActionCable/Channel/Base.html#method-i-subscribed
|
9
|
+
def subscribed
|
10
|
+
stream_from "#{ActivityNotification.config.notification_channel_prefix}_#{@target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{@target.id}"
|
11
|
+
rescue
|
12
|
+
reject
|
13
|
+
end
|
14
|
+
|
15
|
+
protected
|
16
|
+
|
17
|
+
# Sets @target instance variable from request parameters.
|
18
|
+
# @api protected
|
19
|
+
# @return [Object] Target instance (Reject subscription when request parameters are not enough)
|
20
|
+
def set_target
|
21
|
+
target_type = params[:target_type]
|
22
|
+
target_class = target_type.to_s.to_model_class
|
23
|
+
@target = params[:target_id].present? ?
|
24
|
+
target_class.find_by!(id: params[:target_id]) :
|
25
|
+
target_class.find_by!(id: params["#{target_type.to_s.to_resource_name[/([^\/]+)$/]}_id"])
|
26
|
+
rescue
|
27
|
+
reject
|
28
|
+
end
|
29
|
+
|
30
|
+
# Allow the target to subscribe notification channel if notification_action_cable_with_devise? returns false
|
31
|
+
# @api protected
|
32
|
+
# @return [Response] Returns connected or rejected
|
33
|
+
def authenticate_target!
|
34
|
+
reject if @target.nil? || @target.notification_action_cable_with_devise?
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
if defined?(ActionCable)
|
2
|
+
# Action Cable channel to subscribe broadcasted notifications with Devise authentication.
|
3
|
+
class ActivityNotification::NotificationWithDeviseChannel < ActivityNotification::NotificationChannel
|
4
|
+
# Include PolymorphicHelpers to resolve string extentions
|
5
|
+
include ActivityNotification::PolymorphicHelpers
|
6
|
+
|
7
|
+
protected
|
8
|
+
|
9
|
+
# Find current signed-in target from Devise session data.
|
10
|
+
# @api protected
|
11
|
+
# @param [String] devise_type Class name of authenticated Devise resource
|
12
|
+
# @return [Object] Current signed-in target
|
13
|
+
def find_current_target(devise_type = nil)
|
14
|
+
devise_type = (devise_type || @target.notification_devise_resource.class.name).to_s
|
15
|
+
devise_type.to_model_class.find(session["warden.user.#{devise_type.to_resource_name}.key"][0][0])
|
16
|
+
end
|
17
|
+
|
18
|
+
# Get current session from cookies.
|
19
|
+
# @api protected
|
20
|
+
# @return [Hash] Session from cookies
|
21
|
+
def session
|
22
|
+
@session ||= connection.__send__(:cookies).encrypted[Rails.application.config.session_options[:key]]
|
23
|
+
end
|
24
|
+
|
25
|
+
# Sets @target instance variable from request parameters.
|
26
|
+
# This method override super (ActivityNotiication::NotificationChannel#set_target)
|
27
|
+
# to set devise authenticated target when the target_id params is not specified.
|
28
|
+
# @api protected
|
29
|
+
# @return [Object] Target instance (Reject subscription when request parameters are not enough)
|
30
|
+
def set_target
|
31
|
+
reject and return if (target_type = params[:target_type]).blank?
|
32
|
+
if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name[/([^\/]+)$/]}_id"].blank?
|
33
|
+
reject and return if params[:devise_type].blank?
|
34
|
+
current_target = find_current_target(params[:devise_type])
|
35
|
+
params[:target_id] = target_type.to_model_class.resolve_current_devise_target(current_target)
|
36
|
+
reject and return if params[:target_id].blank?
|
37
|
+
end
|
38
|
+
super
|
39
|
+
end
|
40
|
+
|
41
|
+
# Authenticate the target of requested notification with authenticated devise resource.
|
42
|
+
# @api protected
|
43
|
+
# @return [Response] Returns connected or rejected
|
44
|
+
def authenticate_target!
|
45
|
+
current_resource = find_current_target
|
46
|
+
reject unless @target.authenticated_with_devise?(current_resource)
|
47
|
+
rescue
|
48
|
+
reject
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,75 @@
|
|
1
|
+
module ActivityNotification
|
2
|
+
# Controller to manage Swagger API references.
|
3
|
+
# @See https://github.com/fotinakis/swagger-blocks/blob/master/spec/lib/swagger_v3_blocks_spec.rb
|
4
|
+
class ApidocsController < ActivityNotification.config.parent_controller.constantize
|
5
|
+
include ::Swagger::Blocks
|
6
|
+
|
7
|
+
swagger_root do
|
8
|
+
key :openapi, '3.0.0'
|
9
|
+
info version: ActivityNotification::VERSION do
|
10
|
+
key :description, 'A default REST API created by activity_notification which provides integrated user activity notifications for Ruby on Rails'
|
11
|
+
key :title, 'ActivityNotification'
|
12
|
+
key :termsOfService, 'https://github.com/simukappu/activity_notification'
|
13
|
+
contact do
|
14
|
+
key :name, 'activity_notification community'
|
15
|
+
key :url, 'https://github.com/simukappu/activity_notification#help'
|
16
|
+
end
|
17
|
+
license do
|
18
|
+
key :name, 'MIT'
|
19
|
+
key :url, 'https://github.com/simukappu/activity_notification/blob/master/MIT-LICENSE'
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
server do
|
24
|
+
key :url, 'https://activity-notification-example.herokuapp.com/api/{version}'
|
25
|
+
key :description, 'ActivityNotification online demo including REST API'
|
26
|
+
|
27
|
+
variable :version do
|
28
|
+
key :enum, ['v2']
|
29
|
+
key :default, :"v#{ActivityNotification::GEM_VERSION::MAJOR}"
|
30
|
+
end
|
31
|
+
end
|
32
|
+
server do
|
33
|
+
key :url, 'http://localhost:3000/api/{version}'
|
34
|
+
key :description, 'Example Rails application at localhost including REST API'
|
35
|
+
|
36
|
+
variable :version do
|
37
|
+
key :enum, ['v2']
|
38
|
+
key :default, :"v#{ActivityNotification::GEM_VERSION::MAJOR}"
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
tag do
|
43
|
+
key :name, 'notifications'
|
44
|
+
key :description, 'Operations about user activity notifications'
|
45
|
+
externalDocs do
|
46
|
+
key :description, 'Find out more'
|
47
|
+
key :url, 'https://github.com/simukappu/activity_notification#creating-notifications'
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
tag do
|
52
|
+
key :name, 'subscriptions'
|
53
|
+
key :description, 'Operations about subscription management'
|
54
|
+
externalDocs do
|
55
|
+
key :description, 'Find out more'
|
56
|
+
key :url, 'https://github.com/simukappu/activity_notification#subscription-management'
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
SWAGGERED_CLASSES = [
|
62
|
+
Notification,
|
63
|
+
NotificationsApiController,
|
64
|
+
Subscription,
|
65
|
+
SubscriptionsApiController,
|
66
|
+
self
|
67
|
+
].freeze
|
68
|
+
|
69
|
+
# Returns root JSON of Swagger API references.
|
70
|
+
# GET /apidocs
|
71
|
+
def index
|
72
|
+
render json: ::Swagger::Blocks.build_root_json(SWAGGERED_CLASSES)
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
@@ -0,0 +1,143 @@
|
|
1
|
+
module ActivityNotification
|
2
|
+
# Controller to manage notifications API.
|
3
|
+
class NotificationsApiController < NotificationsController
|
4
|
+
# Include Swagger API reference
|
5
|
+
include Swagger::NotificationsApi
|
6
|
+
# Include CommonApiController to select target and define common methods
|
7
|
+
include CommonApiController
|
8
|
+
protect_from_forgery except: [:open_all]
|
9
|
+
rescue_from ActivityNotification::NotifiableNotFoundError, with: :render_notifiable_not_found
|
10
|
+
|
11
|
+
# Returns notification index of the target.
|
12
|
+
#
|
13
|
+
# GET /:target_type/:target_id/notifications
|
14
|
+
# @overload index(params)
|
15
|
+
# @param [Hash] params Request parameter options for notification index
|
16
|
+
# @option params [String] :filter (nil) Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
|
17
|
+
# @option params [String] :limit (nil) Maximum number of notifications to return
|
18
|
+
# @option params [String] :reverse ('false') Whether notification index will be ordered as earliest first
|
19
|
+
# @option params [String] :without_grouping ('false') Whether notification index will include group members
|
20
|
+
# @option params [String] :with_group_members ('false') Whether notification index will include group members
|
21
|
+
# @option params [String] :filtered_by_type (nil) Notifiable type to filter notification index
|
22
|
+
# @option params [String] :filtered_by_group_type (nil) Group type to filter notification index, valid with :filtered_by_group_id
|
23
|
+
# @option params [String] :filtered_by_group_id (nil) Group instance ID to filter notification index, valid with :filtered_by_group_type
|
24
|
+
# @option params [String] :filtered_by_key (nil) Key of notifications to filter notification index
|
25
|
+
# @option params [String] :later_than (nil) ISO 8601 format time to filter notification index later than specified time
|
26
|
+
# @option params [String] :earlier_than (nil) ISO 8601 format time to filter notification index earlier than specified time
|
27
|
+
# @return [JSON] count: number of notification index records, notifications: notification index
|
28
|
+
def index
|
29
|
+
super
|
30
|
+
render json: {
|
31
|
+
count: @notifications.size,
|
32
|
+
notifications: @notifications.as_json(notification_json_options)
|
33
|
+
}
|
34
|
+
end
|
35
|
+
|
36
|
+
# Opens all notifications of the target.
|
37
|
+
#
|
38
|
+
# POST /:target_type/:target_id/notifications/open_all
|
39
|
+
# @overload open_all(params)
|
40
|
+
# @param [Hash] params Request parameters
|
41
|
+
# @option params [String] :filtered_by_type (nil) Notifiable type to filter notification index
|
42
|
+
# @option params [String] :filtered_by_group_type (nil) Group type to filter notification index, valid with :filtered_by_group_id
|
43
|
+
# @option params [String] :filtered_by_group_id (nil) Group instance ID to filter notification index, valid with :filtered_by_group_type
|
44
|
+
# @option params [String] :filtered_by_key (nil) Key of notifications to filter notification index
|
45
|
+
# @option params [String] :later_than (nil) ISO 8601 format time to filter notification index later than specified time
|
46
|
+
# @option params [String] :earlier_than (nil) ISO 8601 format time to filter notification index earlier than specified time
|
47
|
+
# @return [JSON] count: number of opened notification records, notifications: opened notifications
|
48
|
+
def open_all
|
49
|
+
super
|
50
|
+
render json: {
|
51
|
+
count: @opened_notifications.size,
|
52
|
+
notifications: @opened_notifications.as_json(notification_json_options)
|
53
|
+
}
|
54
|
+
end
|
55
|
+
|
56
|
+
# Returns a single notification.
|
57
|
+
#
|
58
|
+
# GET /:target_type/:target_id/notifications/:id
|
59
|
+
# @overload show(params)
|
60
|
+
# @param [Hash] params Request parameters
|
61
|
+
# @return [JSON] Found single notification
|
62
|
+
def show
|
63
|
+
super
|
64
|
+
render json: notification_json
|
65
|
+
end
|
66
|
+
|
67
|
+
# Deletes a notification.
|
68
|
+
#
|
69
|
+
# DELETE /:target_type/:target_id/notifications/:id
|
70
|
+
# @overload destroy(params)
|
71
|
+
# @param [Hash] params Request parameters
|
72
|
+
# @return [JSON] 204 No Content
|
73
|
+
def destroy
|
74
|
+
super
|
75
|
+
head 204
|
76
|
+
end
|
77
|
+
|
78
|
+
# Opens a notification.
|
79
|
+
#
|
80
|
+
# PUT /:target_type/:target_id/notifications/:id/open
|
81
|
+
# @overload open(params)
|
82
|
+
# @param [Hash] params Request parameters
|
83
|
+
# @option params [String] :move ('false') Whether it redirects to notifiable_path after the notification is opened
|
84
|
+
# @return [JSON] count: number of opened notification records, notification: opened notification
|
85
|
+
def open
|
86
|
+
super
|
87
|
+
unless params[:move].to_s.to_boolean(false)
|
88
|
+
render json: {
|
89
|
+
count: @opened_notifications_count,
|
90
|
+
notification: notification_json
|
91
|
+
}
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
# Moves to notifiable_path of the notification.
|
96
|
+
#
|
97
|
+
# GET /:target_type/:target_id/notifications/:id/move
|
98
|
+
# @overload open(params)
|
99
|
+
# @param [Hash] params Request parameters
|
100
|
+
# @option params [String] :open ('false') Whether the notification will be opened
|
101
|
+
# @return [JSON] location: notifiable path, count: number of opened notification records, notification: specified notification
|
102
|
+
def move
|
103
|
+
super
|
104
|
+
render status: 302, location: @notification.notifiable_path, json: {
|
105
|
+
location: @notification.notifiable_path,
|
106
|
+
count: (@opened_notifications_count || 0),
|
107
|
+
notification: notification_json
|
108
|
+
}
|
109
|
+
end
|
110
|
+
|
111
|
+
protected
|
112
|
+
|
113
|
+
# Returns options for notification JSON
|
114
|
+
# @api protected
|
115
|
+
def notification_json_options
|
116
|
+
{
|
117
|
+
include: {
|
118
|
+
target: { methods: [:printable_type, :printable_target_name] },
|
119
|
+
notifiable: { methods: [:printable_type] },
|
120
|
+
group: { methods: [:printable_type, :printable_group_name] },
|
121
|
+
notifier: { methods: [:printable_type, :printable_notifier_name] },
|
122
|
+
group_members: {}
|
123
|
+
},
|
124
|
+
methods: [:notifiable_path, :printable_notifiable_name, :group_member_notifier_count, :group_notification_count]
|
125
|
+
}
|
126
|
+
end
|
127
|
+
|
128
|
+
# Returns JSON of @notification
|
129
|
+
# @api protected
|
130
|
+
def notification_json
|
131
|
+
@notification.as_json(notification_json_options)
|
132
|
+
end
|
133
|
+
|
134
|
+
# Render associated notifiable record not found error with 500 status
|
135
|
+
# @api protected
|
136
|
+
# @param [Error] error Error object
|
137
|
+
# @return [void]
|
138
|
+
def render_notifiable_not_found(error)
|
139
|
+
render status: 500, json: error_response(code: 500, message: "Associated record not found", type: error.message)
|
140
|
+
end
|
141
|
+
|
142
|
+
end
|
143
|
+
end
|
@@ -0,0 +1,7 @@
|
|
1
|
+
module ActivityNotification
|
2
|
+
# Controller to manage notifications API with Devise authentication.
|
3
|
+
class NotificationsApiWithDeviseController < NotificationsApiController
|
4
|
+
include DeviseTokenAuth::Concerns::SetUserByToken if defined?(DeviseTokenAuth)
|
5
|
+
include DeviseAuthenticationController
|
6
|
+
end
|
7
|
+
end
|
@@ -10,24 +10,22 @@ module ActivityNotification
|
|
10
10
|
# GET /:target_type/:target_id/notifications
|
11
11
|
# @overload index(params)
|
12
12
|
# @param [Hash] params Request parameter options for notification index
|
13
|
-
# @option params [String] :filter (nil) Filter option to load notification index (Nothing as auto, 'opened' or 'unopened')
|
14
|
-
# @option params [String] :limit (nil)
|
15
|
-
# @option params [String] :reverse ('false')
|
16
|
-
# @option params [String] :without_grouping ('false')
|
17
|
-
# @option params [String] :with_group_members ('false')
|
18
|
-
# @option params [String] :filtered_by_type (nil) Notifiable type
|
19
|
-
# @option params [String] :filtered_by_group_type (nil) Group type
|
20
|
-
# @option params [String] :filtered_by_group_id (nil) Group instance
|
21
|
-
# @option params [String] :filtered_by_key (nil) Key of
|
13
|
+
# @option params [String] :filter (nil) Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
|
14
|
+
# @option params [String] :limit (nil) Maximum number of notifications to return
|
15
|
+
# @option params [String] :reverse ('false') Whether notification index will be ordered as earliest first
|
16
|
+
# @option params [String] :without_grouping ('false') Whether notification index will include group members
|
17
|
+
# @option params [String] :with_group_members ('false') Whether notification index will include group members
|
18
|
+
# @option params [String] :filtered_by_type (nil) Notifiable type to filter notification index
|
19
|
+
# @option params [String] :filtered_by_group_type (nil) Group type to filter notification index, valid with :filtered_by_group_id
|
20
|
+
# @option params [String] :filtered_by_group_id (nil) Group instance ID to filter notification index, valid with :filtered_by_group_type
|
21
|
+
# @option params [String] :filtered_by_key (nil) Key of notifications to filter notification index
|
22
|
+
# @option params [String] :later_than (nil) ISO 8601 format time to filter notification index later than specified time
|
23
|
+
# @option params [String] :earlier_than (nil) ISO 8601 format time to filter notification index earlier than specified time
|
22
24
|
# @option params [String] :reload ('true') Whether notification index will be reloaded
|
23
|
-
# @return [
|
25
|
+
# @return [Response] HTML view of notification index
|
24
26
|
def index
|
25
27
|
set_index_options
|
26
28
|
load_index if params[:reload].to_s.to_boolean(true)
|
27
|
-
respond_to do |format|
|
28
|
-
format.html # index.html.erb
|
29
|
-
format.json { render json: @notifications.to_json(include: [:target, :notifiable, :group]) }
|
30
|
-
end
|
31
29
|
end
|
32
30
|
|
33
31
|
# Opens all notifications of the target.
|
@@ -35,18 +33,20 @@ module ActivityNotification
|
|
35
33
|
# POST /:target_type/:target_id/notifications/open_all
|
36
34
|
# @overload open_all(params)
|
37
35
|
# @param [Hash] params Request parameters
|
38
|
-
# @option params [String] :filter
|
39
|
-
# @option params [String] :limit
|
40
|
-
# @option params [String] :
|
41
|
-
# @option params [String] :
|
42
|
-
# @option params [String] :
|
43
|
-
# @option params [String] :
|
44
|
-
# @option params [String] :
|
45
|
-
# @option params [String] :
|
46
|
-
# @option params [String] :
|
47
|
-
# @
|
36
|
+
# @option params [String] :filter (nil) Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
|
37
|
+
# @option params [String] :limit (nil) Maximum number of notifications to return
|
38
|
+
# @option params [String] :without_grouping ('false') Whether notification index will include group members
|
39
|
+
# @option params [String] :with_group_members ('false') Whether notification index will include group members
|
40
|
+
# @option params [String] :filtered_by_type (nil) Notifiable type to filter notification index
|
41
|
+
# @option params [String] :filtered_by_group_type (nil) Group type to filter notification index, valid with :filtered_by_group_id
|
42
|
+
# @option params [String] :filtered_by_group_id (nil) Group instance ID to filter notification index, valid with :filtered_by_group_type
|
43
|
+
# @option params [String] :filtered_by_key (nil) Key of notifications to filter notification index
|
44
|
+
# @option params [String] :later_than (nil) ISO 8601 format time to filter notification index later than specified time
|
45
|
+
# @option params [String] :earlier_than (nil) ISO 8601 format time to filter notification index earlier than specified time
|
46
|
+
# @option params [String] :reload ('true') Whether notification index will be reloaded
|
47
|
+
# @return [Response] JavaScript view for ajax request or redirects to back as default
|
48
48
|
def open_all
|
49
|
-
@target.open_all_notifications(params)
|
49
|
+
@opened_notifications = @target.open_all_notifications(params)
|
50
50
|
return_back_or_ajax
|
51
51
|
end
|
52
52
|
|
@@ -55,22 +55,21 @@ module ActivityNotification
|
|
55
55
|
# GET /:target_type/:target_id/notifications/:id
|
56
56
|
# @overload show(params)
|
57
57
|
# @param [Hash] params Request parameters
|
58
|
-
# @return [
|
58
|
+
# @return [Response] HTML view as default
|
59
59
|
def show
|
60
60
|
end
|
61
61
|
|
62
62
|
# Deletes a notification.
|
63
63
|
#
|
64
64
|
# DELETE /:target_type/:target_id/notifications/:id
|
65
|
-
#
|
66
65
|
# @overload destroy(params)
|
67
66
|
# @param [Hash] params Request parameters
|
68
|
-
# @option params [String] :filter
|
69
|
-
# @option params [String] :limit
|
70
|
-
# @option params [String] :
|
71
|
-
# @option params [String] :
|
72
|
-
# @option params [String] :
|
73
|
-
# @return [
|
67
|
+
# @option params [String] :filter (nil) Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
|
68
|
+
# @option params [String] :limit (nil) Maximum number of notifications to return
|
69
|
+
# @option params [String] :without_grouping ('false') Whether notification index will include group members
|
70
|
+
# @option params [String] :with_group_members ('false') Whether notification index will include group members
|
71
|
+
# @option params [String] :reload ('true') Whether notification index will be reloaded
|
72
|
+
# @return [Response] JavaScript view for ajax request or redirects to back as default
|
74
73
|
def destroy
|
75
74
|
@notification.destroy
|
76
75
|
return_back_or_ajax
|
@@ -78,22 +77,20 @@ module ActivityNotification
|
|
78
77
|
|
79
78
|
# Opens a notification.
|
80
79
|
#
|
81
|
-
#
|
80
|
+
# PUT /:target_type/:target_id/notifications/:id/open
|
82
81
|
# @overload open(params)
|
83
82
|
# @param [Hash] params Request parameters
|
84
|
-
# @option params [String] :move
|
85
|
-
# @option params [String] :filter
|
86
|
-
# @option params [String] :limit
|
87
|
-
# @option params [String] :
|
88
|
-
# @option params [String] :
|
89
|
-
# @option params [String] :
|
90
|
-
# @return [
|
83
|
+
# @option params [String] :move ('false') Whether it redirects to notifiable_path after the notification is opened
|
84
|
+
# @option params [String] :filter (nil) Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
|
85
|
+
# @option params [String] :limit (nil) Maximum number of notifications to return
|
86
|
+
# @option params [String] :without_grouping ('false') Whether notification index will include group members
|
87
|
+
# @option params [String] :with_group_members ('false') Whether notification index will include group members
|
88
|
+
# @option params [String] :reload ('true') Whether notification index will be reloaded
|
89
|
+
# @return [Response] JavaScript view for ajax request or redirects to back as default
|
91
90
|
def open
|
92
91
|
with_members = !(params[:with_group_members].to_s.to_boolean(false) || params[:without_grouping].to_s.to_boolean(false))
|
93
|
-
@notification.open!(with_members: with_members)
|
94
|
-
params[:move].to_s.to_boolean(false) ?
|
95
|
-
move :
|
96
|
-
return_back_or_ajax
|
92
|
+
@opened_notifications_count = @notification.open!(with_members: with_members)
|
93
|
+
params[:move].to_s.to_boolean(false) ? move : return_back_or_ajax
|
97
94
|
end
|
98
95
|
|
99
96
|
# Moves to notifiable_path of the notification.
|
@@ -101,14 +98,17 @@ module ActivityNotification
|
|
101
98
|
# GET /:target_type/:target_id/notifications/:id/move
|
102
99
|
# @overload open(params)
|
103
100
|
# @param [Hash] params Request parameters
|
104
|
-
# @option params [String] :open
|
105
|
-
# @option params [String] :filter
|
106
|
-
# @option params [String] :limit
|
107
|
-
# @option params [String] :
|
108
|
-
# @
|
101
|
+
# @option params [String] :open ('false') Whether the notification will be opened
|
102
|
+
# @option params [String] :filter (nil) Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
|
103
|
+
# @option params [String] :limit (nil) Maximum number of notifications to return
|
104
|
+
# @option params [String] :without_grouping ('false') Whether notification index will include group members
|
105
|
+
# @option params [String] :with_group_members ('false') Whether notification index will include group members
|
106
|
+
# @option params [String] :reload ('true') Whether notification index will be reloaded
|
107
|
+
# @return [Response] JavaScript view for ajax request or redirects to back as default
|
109
108
|
def move
|
110
|
-
|
111
|
-
|
109
|
+
with_members = !(params[:with_group_members].to_s.to_boolean(false) || params[:without_grouping].to_s.to_boolean(false))
|
110
|
+
@opened_notifications_count = @notification.open!(with_members: with_members) if params[:open].to_s.to_boolean(false)
|
111
|
+
redirect_to_notifiable_path
|
112
112
|
end
|
113
113
|
|
114
114
|
# Returns path of the target view templates.
|
@@ -135,7 +135,7 @@ module ActivityNotification
|
|
135
135
|
params[:reverse].to_s.to_boolean(false) : nil
|
136
136
|
with_group_members = params[:with_group_members].present? || params[:without_grouping].present? ?
|
137
137
|
params[:with_group_members].to_s.to_boolean(false) || params[:without_grouping].to_s.to_boolean(false) : nil
|
138
|
-
@index_options = params.permit(:filter, :filtered_by_type, :filtered_by_group_type, :filtered_by_group_id, :filtered_by_key)
|
138
|
+
@index_options = params.permit(:filter, :filtered_by_type, :filtered_by_group_type, :filtered_by_group_id, :filtered_by_key, :later_than, :earlier_than, :routing_scope, :devise_default_routes)
|
139
139
|
.to_h.symbolize_keys
|
140
140
|
.merge(limit: limit, reverse: reverse, with_group_members: with_group_members)
|
141
141
|
end
|
@@ -155,8 +155,14 @@ module ActivityNotification
|
|
155
155
|
end
|
156
156
|
end
|
157
157
|
|
158
|
+
# Redirect to notifiable_path
|
159
|
+
# @api protected
|
160
|
+
def redirect_to_notifiable_path
|
161
|
+
redirect_to @notification.notifiable_path
|
162
|
+
end
|
163
|
+
|
158
164
|
# Returns controller path.
|
159
|
-
# This method is called from target_view_path method and can be
|
165
|
+
# This method is called from target_view_path method and can be overridden.
|
160
166
|
# @api protected
|
161
167
|
# @return [String] "activity_notification/notifications" as controller path
|
162
168
|
def controller_path
|