noticent 0.0.1.pre.pre → 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fd327429401742c18e50a9ca5d13db9c34095f714ff89a6c8604a251272ede32
4
- data.tar.gz: 39e4437f0c0cddecb782477196fb92b7c511a8866c5d081425595341c547771b
3
+ metadata.gz: 07cca6155189647f0b1592d332c5fa40539ca4766674d9c03a669631bc8a5288
4
+ data.tar.gz: 2c6047f6305bb9f1cdf8da2f1c934e117a543ef89f27057e37647c72499533c6
5
5
  SHA512:
6
- metadata.gz: 4a871931c9e904b314e55e4ec820dacfed2d42b00c902b74e0b87913d3c19b5f85f46d8c330fb68e63c2513f0bbfdc4da6cd8bfbc574e408afc1b2ab53bedfac
7
- data.tar.gz: b42f22b75273b924a5f5d56f9d01891842018b63fc3a7e22326cc794d7d8f6833f255c136803ddbadc59009b7e269c8d0c0bd6fb88d24092430c2528ff771b6b
6
+ metadata.gz: e148c8b55623b7ea3dc0b57c2f26fa691a582a240f0f549918daae48bea744ec52e66ca04b10b8c2a37a87a825e53451043e5b71de09990426722ff43c22c870
7
+ data.tar.gz: af28e6396518b3d41b06b564e343765104b92ba98723163022ab07d863f1fa367d038fc599cc8ffd0dae13b16b0327d8bc4cd906d04ac8958abb533e2510e707
data/.gitignore CHANGED
@@ -49,3 +49,5 @@ build-iPhoneSimulator/
49
49
  # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
50
50
  .rvmrc
51
51
  /.idea
52
+ /.byebug_history
53
+ /spec/internal/db/combustion_test.sqlite
data/Gemfile.lock CHANGED
@@ -2,12 +2,23 @@ PATH
2
2
  remote: .
3
3
  specs:
4
4
  noticent (0.0.1.pre.pre)
5
+ actionpack (~> 5.2)
5
6
  activerecord (~> 5.2)
6
7
  activesupport (~> 5.2)
7
8
 
8
9
  GEM
9
10
  remote: https://rubygems.org/
10
11
  specs:
12
+ actioncable (5.2.3)
13
+ actionpack (= 5.2.3)
14
+ nio4r (~> 2.0)
15
+ websocket-driver (>= 0.6.1)
16
+ actionmailer (5.2.3)
17
+ actionpack (= 5.2.3)
18
+ actionview (= 5.2.3)
19
+ activejob (= 5.2.3)
20
+ mail (~> 2.5, >= 2.5.4)
21
+ rails-dom-testing (~> 2.0)
11
22
  actionpack (5.2.3)
12
23
  actionview (= 5.2.3)
13
24
  activesupport (= 5.2.3)
@@ -21,12 +32,19 @@ GEM
21
32
  erubi (~> 1.4)
22
33
  rails-dom-testing (~> 2.0)
23
34
  rails-html-sanitizer (~> 1.0, >= 1.0.3)
35
+ activejob (5.2.3)
36
+ activesupport (= 5.2.3)
37
+ globalid (>= 0.3.6)
24
38
  activemodel (5.2.3)
25
39
  activesupport (= 5.2.3)
26
40
  activerecord (5.2.3)
27
41
  activemodel (= 5.2.3)
28
42
  activesupport (= 5.2.3)
29
43
  arel (>= 9.0)
44
+ activestorage (5.2.3)
45
+ actionpack (= 5.2.3)
46
+ activerecord (= 5.2.3)
47
+ marcel (~> 0.3.1)
30
48
  activesupport (5.2.3)
31
49
  concurrent-ruby (~> 1.0, >= 1.0.2)
32
50
  i18n (>= 0.7, < 2)
@@ -35,6 +53,11 @@ GEM
35
53
  arel (9.0.0)
36
54
  ast (2.4.0)
37
55
  builder (3.2.3)
56
+ byebug (11.0.1)
57
+ combustion (1.1.0)
58
+ activesupport (>= 3.0.0)
59
+ railties (>= 3.0.0)
60
+ thor (>= 0.14.6)
38
61
  concurrent-ruby (1.1.5)
39
62
  crass (1.0.4)
40
63
  diff-lcs (1.3)
@@ -44,15 +67,24 @@ GEM
44
67
  generator_spec (0.9.4)
45
68
  activesupport (>= 3.0.0)
46
69
  railties (>= 3.0.0)
70
+ globalid (0.4.2)
71
+ activesupport (>= 4.2.0)
47
72
  i18n (1.6.0)
48
73
  concurrent-ruby (~> 1.0)
49
74
  jaro_winkler (1.5.2)
50
75
  loofah (2.2.3)
51
76
  crass (~> 1.0.2)
52
77
  nokogiri (>= 1.5.9)
78
+ mail (2.7.1)
79
+ mini_mime (>= 0.1.1)
80
+ marcel (0.3.3)
81
+ mimemagic (~> 0.3.2)
53
82
  method_source (0.9.2)
83
+ mimemagic (0.3.3)
84
+ mini_mime (1.0.2)
54
85
  mini_portile2 (2.4.0)
55
86
  minitest (5.11.3)
87
+ nio4r (2.4.0)
56
88
  nokogiri (1.10.3)
57
89
  mini_portile2 (~> 2.4.0)
58
90
  parallel (1.17.0)
@@ -61,6 +93,19 @@ GEM
61
93
  rack (2.0.7)
62
94
  rack-test (1.1.0)
63
95
  rack (>= 1.0, < 3)
96
+ rails (5.2.3)
97
+ actioncable (= 5.2.3)
98
+ actionmailer (= 5.2.3)
99
+ actionpack (= 5.2.3)
100
+ actionview (= 5.2.3)
101
+ activejob (= 5.2.3)
102
+ activemodel (= 5.2.3)
103
+ activerecord (= 5.2.3)
104
+ activestorage (= 5.2.3)
105
+ activesupport (= 5.2.3)
106
+ bundler (>= 1.3.0)
107
+ railties (= 5.2.3)
108
+ sprockets-rails (>= 2.0.0)
64
109
  rails-dom-testing (2.0.3)
65
110
  activesupport (>= 4.2.0)
66
111
  nokogiri (>= 1.6)
@@ -98,21 +143,34 @@ GEM
98
143
  rubocop (>= 0.68.0)
99
144
  ruby-progressbar (1.10.0)
100
145
  rufo (0.7.0)
146
+ sprockets (3.7.2)
147
+ concurrent-ruby (~> 1.0)
148
+ rack (> 1, < 3)
149
+ sprockets-rails (3.2.1)
150
+ actionpack (>= 4.0)
151
+ activesupport (>= 4.0)
152
+ sprockets (>= 3.0.0)
101
153
  sqlite3 (1.4.1)
102
154
  thor (0.20.3)
103
155
  thread_safe (0.3.6)
104
156
  tzinfo (1.2.5)
105
157
  thread_safe (~> 0.1)
106
158
  unicode-display_width (1.6.0)
159
+ websocket-driver (0.7.1)
160
+ websocket-extensions (>= 0.1.0)
161
+ websocket-extensions (0.1.4)
107
162
 
108
163
  PLATFORMS
109
164
  ruby
110
165
 
111
166
  DEPENDENCIES
112
167
  bundler (~> 2.0)
168
+ byebug (~> 11.0)
169
+ combustion (~> 1.1)
113
170
  factory_bot (~> 5.0)
114
171
  generator_spec (~> 0.9)
115
172
  noticent!
173
+ rails (~> 5.2)
116
174
  rake (~> 10.0)
117
175
  rspec (~> 3.8)
118
176
  rubocop (~> 0.69)
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ <img src="http://cdn2-cloud66-com.s3.amazonaws.com/images/oss-sponsorship.png" width=150/>
2
+
1
3
  # Noticent
2
4
 
3
5
  Noticent is a Ruby gem for user notification management. It is written to deliver a developer friendly way to managing application notifications in a typical web application. Many applications have user notification: sending emails when a task is done or support for webhooks or Slack upon certain events. Noticent makes it easy to write maintainable code for notification subscription and delivery in a typical web application.
@@ -93,12 +95,8 @@ Noticent.configure do
93
95
  channel :email
94
96
 
95
97
  scope :account do
96
- alert :new_signup do
97
- notify :owner
98
- end
99
- alert :new_team_member do
100
- notify :users
101
- end
98
+ alert(:new_signup){ notify :owner}
99
+ alert(:new_team_member) { notify :users }
102
100
  end
103
101
  end
104
102
  ```
@@ -195,20 +193,25 @@ Noticent.configure do
195
193
  product :product_buzz
196
194
  product :product_bar
197
195
 
198
- scope :account do
196
+ scope :account, check_constructor: false do
199
197
  alert :new_user do
200
198
  applies.to :product_foo
201
199
  notify :users
202
200
  notify(:staff).on(:internal)
203
201
  notify :owners
202
+
203
+ default true
204
204
  end
205
205
  end
206
206
 
207
207
  scope :comment do
208
- alert :new_comment do
208
+ alert :new_comment, constructor_name: :some_constructor do
209
209
  applies.not_to :product_buzz
210
210
  notify :commenter
211
- notify :auther
211
+ notify :author
212
+
213
+ default true
214
+ default(false) { on(:email) }
212
215
  end
213
216
  alert :comment_updated do
214
217
  notify :commenter
@@ -232,6 +235,11 @@ account_payload = AccountPayload.new(1, user.first)
232
235
  Noticent.notify(:new_user, account_payload)
233
236
  ```
234
237
 
238
+ While it is possible to define and use alert names as symbols, Noticent also creates a constant with the name of the alert under the `Noticent` namespace to help with the use of alert names.
239
+ By using the constants you can make sure alert names are free of typos.
240
+
241
+ For example, if you have an alert called `some_event` then after configuration there will be a constant called `Noticent::ALERT_SOME_EVENT` available to use with the value `:some_event`.
242
+
235
243
  ### Using Each Noticent Component
236
244
 
237
245
  #### Payload
@@ -250,6 +258,10 @@ end
250
258
 
251
259
  If specified, the type of the payload is checked against this class at runtime (when `Notify` is called).
252
260
 
261
+ To enforce development type consistency payload should have class method constructors that are named after the alert names. This can be turned off by setting `check_constructor` on scopes to `false`.
262
+ To share the same class method constructor for different alerts, you can use the `constructor_name` on alert to tell Noticent to look for a constructor that is not named after the alert itself.
263
+ This is a validation step only and doesn't affect the performance of Noticent.
264
+
253
265
  #### Channel
254
266
 
255
267
  Channels should be derived from `::Noticent::Channel` class and called the same as with the name of the channel with a `Channel` suffix: `email` would be `EmailChannel` and `slack` will be `SlackChannel`. Also, channels should have a method for each type of alert they are supposed to handle. Channel class can be changed using the `klass` argument during definition.
@@ -273,7 +285,22 @@ end
273
285
  ```
274
286
 
275
287
  In the example above, we are creating 2 flavors of the slack channel, one called `team_slack` but using the same class and configured differently. When `using` is used in a channel, any attribute passed into `using` will be called on the channel after creation with the given values.
276
- For example, in this example, the `Slack` class is instantiated and attribute `fuzz` is set to `:buzz` on it before the alert method is called.
288
+ For example, in this example, the `Slack` class is instantiated and attribute `fuzz` is set to `:buzz` on it before the alert method is called.
289
+
290
+ You can use `on` with a channel name instead of a channel group name instead:
291
+
292
+ ```ruby
293
+ Noticent.configure do
294
+ channel :email
295
+ channel :private_emails, group: :internal
296
+ channel :slack
297
+
298
+ alert :some_event do
299
+ notify(:users).on(:internal) # this is a group name
300
+ notify(:staff).on(:slack) # this is a channel name
301
+ end
302
+ end
303
+ ```
277
304
 
278
305
  You can use `render` in the channel code to render and return the view file and its front matter (if available). By default, channel will look for `html` and `erb` as the file content and format. You can change these both when calling `render` or at the top of the controller:
279
306
 
@@ -305,7 +332,7 @@ Views are like Rails views. Noticent supports rendering ERB files. You can also
305
332
  ```html
306
333
  This is at the top
307
334
 
308
- <%= yield %>
335
+ <%= @content %>
309
336
 
310
337
  This is at the bottom
311
338
  ```
@@ -327,6 +354,28 @@ Noticent uses a combination of channel, alert and scope to determine if a recipi
327
354
 
328
355
  Use `Noticent.configuration.opt_in_provider`'s `opt_in`, `opt_out` and `opted_in?` methods to change the opt-in state of each recipient.
329
356
 
357
+ ## Default Values
358
+
359
+ You can specify a default opt-in value for each alert. By default alerts have a default value of `false` (no opt-in) unless this is globally changed (see Customization section).
360
+
361
+ The default value for an alert can be set while this can also be changed per channel. For example:
362
+
363
+ ```ruby
364
+ Noticent.configure do
365
+ channel :email
366
+ channel :slack
367
+ channel :webhook
368
+
369
+ scope :post do
370
+ alert :foo do
371
+ notify :users
372
+ default(true) # sets the default value for all channels for this alert to true
373
+ default(false) { on(:slack) } # sets the default value for this alert to false for the slack channel only
374
+ end
375
+ end
376
+ end
377
+ ```
378
+
330
379
  ## Migration
331
380
 
332
381
  Noticent provides a method to add new alerts or remove deprecated alerts from the existing recipients. To add a new alert type, you can use `ActiveRecordOptInProvider.add_alert` method:
@@ -343,7 +392,17 @@ To remove any deprecated alert, use the `ActiveRecordOptInProvider.remove_alert`
343
392
  Noticent.opt_in_provider.remove_alert(scope: :foo, alert_name: :some_old_alert)
344
393
  ```
345
394
 
346
- This removes all instances of the old alert from the opt-ins.
395
+ This removes all instances of the old alert from the opt-ins.
396
+
397
+ ## New Recipient Sign up
398
+
399
+ When a new recipient signs up, you might want to make sure they have all the default alerts setup for them. You can achieve this by calling `Noticent.setup_recipient`:
400
+
401
+ ```ruby
402
+ Noticent.setup_recipient(recipient_id: 1, scope: :post, entity_ids: [2])
403
+ ```
404
+
405
+ This will adds the default opt-ins for recipient 1 on all channels that are applicable to it on scope `post` for entity 2.
347
406
 
348
407
  ## Validation
349
408
 
@@ -379,6 +438,12 @@ The following items can be customized:
379
438
 
380
439
  `halt_on_error`: Should notification fail after the first incident of an error during rendering. Default is `false`
381
440
 
441
+ `default_value`: Default value for all alerts unless explicitly specified. Default is `false`
442
+
443
+ `use_sub_modules`: If set to true, Noticent will look for Channel and Scope classes in sub modules under the `base_module_name`.
444
+ With `use_sub_modules` set to false, a channel named `:email` should be called `Noticent::Email` (if `base_module_name` is `Noticent`), while with `use_sub_modules` set to true, the same class should be `Noticent::Channels::Email`.
445
+ For Payloads, the sub module name will be `Payloads`.
446
+
382
447
 
383
448
  ## Development
384
449