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
@@ -0,0 +1,209 @@
|
|
1
|
+
module ActivityNotification
|
2
|
+
module Swagger::NotificationSchema #:nodoc:
|
3
|
+
extend ActiveSupport::Concern
|
4
|
+
include ::Swagger::Blocks
|
5
|
+
|
6
|
+
included do
|
7
|
+
swagger_component do
|
8
|
+
schema :NotificationAttributes do
|
9
|
+
key :type, :object
|
10
|
+
property :id do
|
11
|
+
key :oneOf, [
|
12
|
+
{ type: :integer },
|
13
|
+
{ type: :string }
|
14
|
+
]
|
15
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
16
|
+
key :example, 123
|
17
|
+
end
|
18
|
+
property :target_type do
|
19
|
+
key :type, :string
|
20
|
+
key :example, "User"
|
21
|
+
end
|
22
|
+
property :target_id do
|
23
|
+
key :oneOf, [
|
24
|
+
{ type: :integer },
|
25
|
+
{ type: :string }
|
26
|
+
]
|
27
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
28
|
+
key :example, 1
|
29
|
+
end
|
30
|
+
property :notifiable_type do
|
31
|
+
key :type, :string
|
32
|
+
key :example, "Comment"
|
33
|
+
end
|
34
|
+
property :notifiable_id do
|
35
|
+
key :oneOf, [
|
36
|
+
{ type: :integer },
|
37
|
+
{ type: :string }
|
38
|
+
]
|
39
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
40
|
+
key :example, 22
|
41
|
+
end
|
42
|
+
property :key do
|
43
|
+
key :type, :string
|
44
|
+
key :example, "comment.default"
|
45
|
+
end
|
46
|
+
property :group_type do
|
47
|
+
key :type, :string
|
48
|
+
key :nullable, true
|
49
|
+
key :example, "Article"
|
50
|
+
end
|
51
|
+
property :group_id do
|
52
|
+
# key :oneOf, [
|
53
|
+
# { type: :integer },
|
54
|
+
# { type: :string },
|
55
|
+
# { nullable: true }
|
56
|
+
# ]
|
57
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
58
|
+
key :nullable, true
|
59
|
+
key :example, 11
|
60
|
+
end
|
61
|
+
property :group_owner_id do
|
62
|
+
# key :oneOf, [
|
63
|
+
# { type: :integer },
|
64
|
+
# { type: :string },
|
65
|
+
# { type: :object },
|
66
|
+
# { nullable: true }
|
67
|
+
# ]
|
68
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string or object including $oid with Mongoid or Dynamoid ORMs."
|
69
|
+
key :nullable, true
|
70
|
+
key :example, 123
|
71
|
+
end
|
72
|
+
property :notifier_type do
|
73
|
+
key :type, :string
|
74
|
+
key :nullable, true
|
75
|
+
key :example, "User"
|
76
|
+
end
|
77
|
+
property :notifier_id do
|
78
|
+
# key :oneOf, [
|
79
|
+
# { type: :integer },
|
80
|
+
# { type: :string },
|
81
|
+
# { nullable: true }
|
82
|
+
# ]
|
83
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
84
|
+
key :nullable, true
|
85
|
+
key :example, 2
|
86
|
+
end
|
87
|
+
property :parameters do
|
88
|
+
key :type, :object
|
89
|
+
key :additionalProperties, {
|
90
|
+
type: :string
|
91
|
+
}
|
92
|
+
key :example, {
|
93
|
+
test_default_param: "1"
|
94
|
+
}
|
95
|
+
end
|
96
|
+
property :opened_at do
|
97
|
+
key :type, :string
|
98
|
+
key :format, :'date-time'
|
99
|
+
key :nullable, true
|
100
|
+
end
|
101
|
+
property :created_at do
|
102
|
+
key :type, :string
|
103
|
+
key :format, :'date-time'
|
104
|
+
end
|
105
|
+
property :updated_at do
|
106
|
+
key :type, :string
|
107
|
+
key :format, :'date-time'
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
schema :Notification do
|
112
|
+
key :type, :object
|
113
|
+
key :required, [ :id, :target_type, :target_id, :notifiable_type, :notifiable_id, :key, :created_at, :updated_at, :target, :notifiable ]
|
114
|
+
allOf do
|
115
|
+
schema do
|
116
|
+
key :'$ref', :NotificationAttributes
|
117
|
+
end
|
118
|
+
schema do
|
119
|
+
key :type, :object
|
120
|
+
property :notifiable_path do
|
121
|
+
key :type, :string
|
122
|
+
key :format, :uri
|
123
|
+
key :example, "/articles/11"
|
124
|
+
end
|
125
|
+
property :printable_notifiable_name do
|
126
|
+
key :type, :string
|
127
|
+
key :format, :uri
|
128
|
+
key :example, "comment \"This is the first Stephen's comment to Ichiro's article.\""
|
129
|
+
end
|
130
|
+
property :group_member_notifier_count do
|
131
|
+
key :type, :integer
|
132
|
+
key :example, 1
|
133
|
+
end
|
134
|
+
property :group_notification_count do
|
135
|
+
key :type, :integer
|
136
|
+
key :example, 2
|
137
|
+
end
|
138
|
+
property :target do
|
139
|
+
key :type, :object
|
140
|
+
key :description, "Associated target model in your application"
|
141
|
+
key :example, {
|
142
|
+
id: 1,
|
143
|
+
email: "ichiro@example.com",
|
144
|
+
name: "Ichiro",
|
145
|
+
created_at: Time.current,
|
146
|
+
updated_at: Time.current,
|
147
|
+
provider: "email",
|
148
|
+
uid: "",
|
149
|
+
printable_type: "User",
|
150
|
+
printable_target_name: "Ichiro"
|
151
|
+
}
|
152
|
+
end
|
153
|
+
property :notifiable do
|
154
|
+
key :type, :object
|
155
|
+
key :description, "Associated notifiable model in your application"
|
156
|
+
key :example, {
|
157
|
+
id: 22,
|
158
|
+
user_id: 2,
|
159
|
+
article_id: 11,
|
160
|
+
body: "This is the first Stephen's comment to Ichiro's article.",
|
161
|
+
created_at: Time.current,
|
162
|
+
updated_at: Time.current,
|
163
|
+
printable_type: "Comment"
|
164
|
+
}
|
165
|
+
end
|
166
|
+
property :group do
|
167
|
+
key :type, :object
|
168
|
+
key :description, "Associated group model in your application"
|
169
|
+
key :nullable, true
|
170
|
+
key :example, {
|
171
|
+
id: 11,
|
172
|
+
user_id: 4,
|
173
|
+
title: "Ichiro's great article",
|
174
|
+
body: "This is Ichiro's great article. Please read it!",
|
175
|
+
created_at: Time.current,
|
176
|
+
updated_at: Time.current,
|
177
|
+
printable_type: "Article",
|
178
|
+
printable_group_name: "article \"Ichiro's great article\""
|
179
|
+
}
|
180
|
+
end
|
181
|
+
property :notifier do
|
182
|
+
key :type, :object
|
183
|
+
key :description, "Associated notifier model in your application"
|
184
|
+
key :nullable, true
|
185
|
+
key :example, {
|
186
|
+
id: 2,
|
187
|
+
email: "stephen@example.com",
|
188
|
+
name: "Stephen",
|
189
|
+
created_at: Time.current,
|
190
|
+
updated_at: Time.current,
|
191
|
+
provider: "email",
|
192
|
+
uid: "",
|
193
|
+
printable_type: "User",
|
194
|
+
printable_notifier_name: "Stephen"
|
195
|
+
}
|
196
|
+
end
|
197
|
+
property :group_members do
|
198
|
+
key :type, :array
|
199
|
+
items do
|
200
|
+
key :'$ref', :NotificationAttributes
|
201
|
+
end
|
202
|
+
end
|
203
|
+
end
|
204
|
+
end
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
end
|
@@ -0,0 +1,162 @@
|
|
1
|
+
module ActivityNotification
|
2
|
+
module Swagger::SubscriptionSchema #:nodoc:
|
3
|
+
extend ActiveSupport::Concern
|
4
|
+
include ::Swagger::Blocks
|
5
|
+
|
6
|
+
included do
|
7
|
+
swagger_component do
|
8
|
+
schema :SubscriptionAttributes do
|
9
|
+
key :type, :object
|
10
|
+
property :key do
|
11
|
+
key :type, :string
|
12
|
+
key :example, "comment.default"
|
13
|
+
end
|
14
|
+
property :subscribing do
|
15
|
+
key :type, :boolean
|
16
|
+
key :default, true
|
17
|
+
key :example, true
|
18
|
+
end
|
19
|
+
property :subscribing_to_email do
|
20
|
+
key :type, :boolean
|
21
|
+
key :default, true
|
22
|
+
key :example, true
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
schema :Subscription do
|
27
|
+
key :type, :object
|
28
|
+
key :required, [ :id, :target_type, :target_id, :key, :subscribing, :subscribing_to_email, :created_at, :updated_at, :target ]
|
29
|
+
allOf do
|
30
|
+
schema do
|
31
|
+
key :type, :object
|
32
|
+
property :id do
|
33
|
+
key :oneOf, [
|
34
|
+
{ type: :integer },
|
35
|
+
{ type: :string }
|
36
|
+
]
|
37
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
38
|
+
key :example, 321
|
39
|
+
end
|
40
|
+
property :target_type do
|
41
|
+
key :type, :string
|
42
|
+
key :example, "User"
|
43
|
+
end
|
44
|
+
property :target_id do
|
45
|
+
key :oneOf, [
|
46
|
+
{ type: :integer },
|
47
|
+
{ type: :string }
|
48
|
+
]
|
49
|
+
key :description, "This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
|
50
|
+
key :example, 1
|
51
|
+
end
|
52
|
+
end
|
53
|
+
schema do
|
54
|
+
key :'$ref', :SubscriptionAttributes
|
55
|
+
end
|
56
|
+
schema do
|
57
|
+
key :type, :object
|
58
|
+
property :subscribed_at do
|
59
|
+
key :type, :string
|
60
|
+
key :format, :'date-time'
|
61
|
+
key :nullable, true
|
62
|
+
end
|
63
|
+
property :unsubscribed_at do
|
64
|
+
key :type, :string
|
65
|
+
key :format, :'date-time'
|
66
|
+
key :nullable, true
|
67
|
+
end
|
68
|
+
property :subscribed_to_email_at do
|
69
|
+
key :type, :string
|
70
|
+
key :format, :'date-time'
|
71
|
+
key :nullable, true
|
72
|
+
end
|
73
|
+
property :unsubscribed_to_email_at do
|
74
|
+
key :type, :string
|
75
|
+
key :format, :'date-time'
|
76
|
+
key :nullable, true
|
77
|
+
end
|
78
|
+
property :optional_targets do
|
79
|
+
key :type, :object
|
80
|
+
key :additionalProperties, {
|
81
|
+
type: "object",
|
82
|
+
properties: {
|
83
|
+
subscribing: {
|
84
|
+
type: "boolean"
|
85
|
+
},
|
86
|
+
subscribed_at: {
|
87
|
+
type: "string",
|
88
|
+
format: "date-time"
|
89
|
+
}
|
90
|
+
}
|
91
|
+
}
|
92
|
+
key :example, {
|
93
|
+
action_cable_channel: {
|
94
|
+
subscribing: true,
|
95
|
+
subscribed_at: Time.current,
|
96
|
+
unsubscribed_at: nil
|
97
|
+
},
|
98
|
+
slack: {
|
99
|
+
subscribing: false,
|
100
|
+
subscribed_at: nil,
|
101
|
+
unsubscribed_at: Time.current
|
102
|
+
}
|
103
|
+
}
|
104
|
+
end
|
105
|
+
property :created_at do
|
106
|
+
key :type, :string
|
107
|
+
key :format, :'date-time'
|
108
|
+
end
|
109
|
+
property :updated_at do
|
110
|
+
key :type, :string
|
111
|
+
key :format, :'date-time'
|
112
|
+
end
|
113
|
+
property :target do
|
114
|
+
key :type, :object
|
115
|
+
key :description, "Associated target model in your application"
|
116
|
+
key :example, {
|
117
|
+
id: 1,
|
118
|
+
email: "ichiro@example.com",
|
119
|
+
name: "Ichiro",
|
120
|
+
created_at: Time.current,
|
121
|
+
updated_at: Time.current
|
122
|
+
}
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
schema :SubscriptionInput do
|
129
|
+
key :type, :object
|
130
|
+
key :required, [ :key ]
|
131
|
+
allOf do
|
132
|
+
schema do
|
133
|
+
key :'$ref', :SubscriptionAttributes
|
134
|
+
end
|
135
|
+
schema do
|
136
|
+
key :type, :object
|
137
|
+
property :optional_targets do
|
138
|
+
key :type, :object
|
139
|
+
key :additionalProperties, {
|
140
|
+
type: "object",
|
141
|
+
properties: {
|
142
|
+
subscribing: {
|
143
|
+
type: "boolean"
|
144
|
+
}
|
145
|
+
}
|
146
|
+
}
|
147
|
+
key :example, {
|
148
|
+
action_cable_channel: {
|
149
|
+
subscribing: true
|
150
|
+
},
|
151
|
+
slack: {
|
152
|
+
subscribing: false
|
153
|
+
}
|
154
|
+
}
|
155
|
+
end
|
156
|
+
end
|
157
|
+
end
|
158
|
+
end
|
159
|
+
end
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|