noticed 1.4.1 → 1.5.3

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: 5b24f360d71aca5620ed10866864570642c49d36d21e5068d3e92e02b56538a5
4
- data.tar.gz: f22998f215bc9e75f14380bfabe5da7117476496395ecdb07da9f08952210bf6
3
+ metadata.gz: 3a91f0aa918496552c3b0f9153c1a4351a32f10910389780a71e8cb76d91df30
4
+ data.tar.gz: 653ebc0c8ba59639e405fe78dbc6a4ce0480baf8abe0824f0f46e09cf47137d7
5
5
  SHA512:
6
- metadata.gz: f1e02acbbcf4826441afa5ea04d30f949c528643e306fbc179320e76dfcf658c64b0db9c9f4ec8783aa624e49027ccc62108e5930fd003103378b4691215b87a
7
- data.tar.gz: df2b7c0ddf9e13a6e059352a065ea8b3ea2e5c881499ae5227b32ebe5b645087829fd64e2c5cd48390c649075e1f3fe26eaa7e50d0ccea72dd18bc6a2dbeb3ae
6
+ metadata.gz: f4bf8b33c4c68666e312451ee812ba5578d1eedb526108ef3e07f1c5f8a7eb57ed41cc2a077366d9c211ec72dd9fd9585c3297f0931dad6f80d23493fd98e96f
7
+ data.tar.gz: b043568083a5515b00d32936d7883cf617299965bcc1365eeff748c36faf52575a8bcc3fae0c20101b5e669691eaa5d5cebc381004fb7b2e993099041e552ce4
data/README.md CHANGED
@@ -15,6 +15,7 @@ Currently, we support these notification delivery methods out of the box:
15
15
  * Microsoft Teams
16
16
  * Twilio (SMS)
17
17
  * Vonage / Nexmo (SMS)
18
+ * iOS Apple Push Notifications
18
19
 
19
20
  And you can easily add new notification types for any other delivery methods.
20
21
 
@@ -159,6 +160,10 @@ For example:
159
160
 
160
161
  `t(".message")` looks up `en.notifications.new_comment.message`
161
162
 
163
+ Or when notification class is in module:
164
+
165
+ `t(".message") # in Admin::NewComment` looks up `en.notifications.admin.new_comment.message`
166
+
162
167
  ##### User Preferences
163
168
 
164
169
  You can use the `if:` and `unless: ` options on your delivery methods to check the user's preferences and skip processing if they have disabled that type of notification.
@@ -175,184 +180,31 @@ class CommentNotification < Noticed::Base
175
180
  end
176
181
  ```
177
182
 
178
- ## 🚛 Delivery Methods
179
-
180
- The delivery methods are designed to be modular so you can customize the way each type gets delivered.
181
-
182
- For example, emails will require a subject, body, and email address while an SMS requires a phone number and simple message. You can define the formats for each of these in your Notification and the delivery method will handle the processing of it.
183
-
184
- ### Database
185
-
186
- Writes notification to the database.
187
-
188
- `deliver_by :database`
189
-
190
- **Note:** Database notifications are special in that they will run before the other delivery methods. We do this so you can reference the database record ID in other delivery methods. For that same reason, the delivery can't be delayed (via the `delay` option) or an error will be raised.
191
-
192
- ##### Options
193
-
194
- * `association` - *Optional*
195
-
196
- The name of the database association to use. Defaults to `:notifications`
197
-
198
- * `format: :format_for_database` - *Optional*
199
-
200
- Use a custom method to define the attributes saved to the database
201
-
202
- ### Email
203
-
204
- Sends an email notification. Emails will always be sent with `deliver_later`
205
-
206
- `deliver_by :email, mailer: "UserMailer"`
207
-
208
- ##### Options
209
-
210
- * `mailer` - **Required**
211
-
212
- The mailer that should send the email
213
-
214
- * `method: :invoice_paid` - *Optional*
215
-
216
- Used to customize the method on the mailer that is called
217
-
218
- * `format: :format_for_email` - *Optional*
219
-
220
- Use a custom method to define the params sent to the mailer. `recipient` will be merged into the params.
221
-
222
- ### ActionCable
223
-
224
- Sends a notification to the browser via websockets (ActionCable channel by default).
225
-
226
- `deliver_by :action_cable`
227
-
228
- ##### Options
229
-
230
- * `format: :format_for_action_cable` - *Optional*
231
-
232
- Use a custom method to define the Hash sent through ActionCable
233
-
234
- * `channel` - *Optional*
235
-
236
- Override the ActionCable channel used to send notifications.
237
-
238
- Defaults to `Noticed::NotificationChannel`
239
-
240
- ### Slack
241
-
242
- Sends a Slack notification via webhook.
243
-
244
- `deliver_by :slack`
245
-
246
- ##### Options
247
-
248
- * `format: :format_for_slack` - *Optional*
183
+ ## 🐞 Debugging
249
184
 
250
- Use a custom method to define the payload sent to Slack. Method should return a Hash.
185
+ In order to figure out what's up when you run in to errors, you can set the `debug` parameter to `true` in your notification, which will give you a more detailed error message about what went wrong.
251
186
 
252
- * `url: :url_for_slack` - *Optional*
187
+ Example:
253
188
 
254
- Use a custom method to retrieve the Slack Webhook URL. Method should return a String.
255
-
256
- Defaults to `Rails.application.credentials.slack[:notification_url]`
257
-
258
- ### Microsoft Teams
259
-
260
- Sends a Teams notification via webhook.
261
-
262
- `deliver_by :microsoft_teams`
263
-
264
- #### Options
265
-
266
- * `format: :format_for_teams` - *Optional*
267
-
268
- Use a custom method to define the payload sent to Microsoft Teams. Method should return a Hash.
269
- Documentation for posting via Webhooks available at: https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook
270
-
271
- ```ruby
272
- {
273
- title: "This is the title for the card",
274
- text: "This is the body text for the card",
275
- sections: [{activityTitle: "Section Title", activityText: "Section Text"}],
276
- "potentialAction": [{
277
- "@type": "OpenUri",
278
- name: "Button Text",
279
- targets: [{
280
- os: "default",
281
- uri: "https://example.com/foo/action"
282
- }]
283
- }]
284
-
285
- }
286
- ```
287
-
288
- * `url: :url_for_teams_channel`: - *Optional*
289
-
290
- Use a custom method to retrieve the MS Teams Webhook URL. Method should return a string.
291
-
292
- Defaults to `Rails.application.credentials.microsoft_teams[:notification_url]`
293
-
294
- ### Twilio SMS
295
-
296
- Sends an SMS notification via Twilio.
297
-
298
- `deliver_by :twilio`
299
-
300
- ##### Options
301
-
302
- * `credentials: :get_twilio_credentials` - *Optional*
303
-
304
- Use a custom method to retrieve the credentials for Twilio. Method should return a Hash with `:account_sid`, `:auth_token` and `:phone_number` keys.
305
-
306
- Defaults to `Rails.application.credentials.twilio[:account_sid]` and `Rails.application.credentials.twilio[:auth_token]`
307
-
308
- * `url: :get_twilio_url` - *Optional*
309
-
310
- Use a custom method to retrieve the Twilio URL. Method should return the Twilio API url as a string.
311
-
312
- Defaults to `"https://api.twilio.com/2010-04-01/Accounts/#{twilio_credentials(recipient)[:account_sid]}/Messages.json"`
313
-
314
- * `format: :format_for_twilio` - *Optional*
315
-
316
- Use a custom method to define the payload sent to Twilio. Method should return a Hash.
317
-
318
- Defaults to:
319
-
320
- ```ruby
321
- {
322
- Body: notification.params[:message],
323
- From: twilio_credentials[:number],
324
- To: recipient.phone_number
325
- }
326
- ```
327
-
328
- ### Vonage SMS
329
-
330
- Sends an SMS notification via Vonage / Nexmo.
331
-
332
- `deliver_by :vonage`
333
-
334
- ##### Options
335
-
336
- * `credentials: :get_credentials` - *Optional*
337
-
338
- Use a custom method for retrieving credentials. Method should return a Hash with `:api_key` and `:api_secret` keys.
189
+ ```ruby
190
+ deliver_by :slack, debug: true
191
+ ```
339
192
 
340
- Defaults to `Rails.application.credentials.vonage[:api_key]` and `Rails.application.credentials.vonage[:api_secret]`
193
+ ## 🚛 Delivery Methods
341
194
 
342
- * `deliver_by :vonage, format: :format_for_vonage` - *Optional*
195
+ The delivery methods are designed to be modular so you can customize the way each type gets delivered.
343
196
 
344
- Use a custom method to generate the params sent to Vonage. Method should return a Hash. Defaults to:
197
+ For example, emails will require a subject, body, and email address while an SMS requires a phone number and simple message. You can define the formats for each of these in your Notification and the delivery method will handle the processing of it.
345
198
 
346
- ```ruby
347
- {
348
- api_key: vonage_credentials[:api_key],
349
- api_secret: vonage_credentials[:api_secret],
350
- from: notification.params[:from],
351
- text: notification.params[:body],
352
- to: notification.params[:to],
353
- type: "unicode"
354
- }
355
- ```
199
+ * [Database](docs/delivery_methods/database.md)
200
+ * [Email](docs/delivery_methods/email.md)
201
+ * [ActionCable](docs/delivery_methods/action_cable.md)
202
+ * [iOS Apple Push Notifications](docs/delivery_methods/ios.md)
203
+ * [Microsoft Teams](docs/delivery_methods/microsoft_teams.md)
204
+ * [Slack](docs/delivery_methods/slack.md)
205
+ * [Test](docs/delivery_methods/test.md)
206
+ * [Twilio](docs/delivery_methods/twilio.md)
207
+ * [Vonage](docs/delivery_methods/vonage.md)
356
208
 
357
209
  ### Fallback Notifications
358
210
 
@@ -371,16 +223,24 @@ You can also configure multiple fallback options:
371
223
 
372
224
  ```ruby
373
225
  class CriticalSystemNotification < Noticed::Base
226
+ deliver_by :database
374
227
  deliver_by :slack
375
- deliver_by :email, mailer: 'CriticalSystemMailer', delay: 10.minutes, unless: :read?
376
- deliver_by :twilio, delay: 20.minutes, unless: :read?
228
+ deliver_by :email, mailer: 'CriticalSystemMailer', delay: 10.minutes, if: :unread?
229
+ deliver_by :twilio, delay: 20.minutes, if: :unread?
377
230
  end
378
231
  ```
379
232
 
380
- In this scenario, you can create an escalating notification that starts with a ping in Slack, then emails the team, and then finally sends an SMS to the on-call phone.
233
+ In this scenario, you have created an escalating notification system that
234
+
235
+ - Immediately creates a record in the database (for display directly in the app)
236
+ - Immediately issues a ping in Slack.
237
+ - If the notification remains unread after 10 minutes, it emails the team.
238
+ - If the notification remains unread after 20 minutes, it sends an SMS to the on-call phone.
381
239
 
382
240
  You can mix and match the options and delivery methods to suit your application specific needs.
383
241
 
242
+ Please note that to implement this pattern, it is essential `deliver_by :database` is one among the different delivery methods specified. Without this, a database record of the notification will not be created.
243
+
384
244
  ### 🚚 Custom Delivery Methods
385
245
 
386
246
  To generate a custom delivery method, simply run
@@ -550,7 +410,7 @@ class Post < ApplicationRecord
550
410
  has_noticed_notifications
551
411
 
552
412
  # You can override the param_name, the notification model name, or disable the before_destroy callback
553
- has_noticed_notifications param_name: :parent, destroy: false, model: "Notification"
413
+ has_noticed_notifications param_name: :parent, destroy: false, model_name: "Notification"
554
414
  end
555
415
 
556
416
  # Create a CommentNotification with a post param
@@ -564,7 +424,7 @@ CommentNotification.with(parent: @post).deliver(user)
564
424
 
565
425
  #### Handling Deleted Records
566
426
 
567
- If you create a notification but delete the associated record and forgot `has_noticed_notifications` on the model, the jobs for sending the notification will not be able to find the record when ActiveJob deserializes. You can discord the job on these errors by adding the following to `ApplicationJob`:
427
+ If you create a notification but delete the associated record and forgot `has_noticed_notifications` on the model, the jobs for sending the notification will not be able to find the record when ActiveJob deserializes. You can discard the job on these errors by adding the following to `ApplicationJob`:
568
428
 
569
429
  ```ruby
570
430
  class ApplicationJob < ActiveJob::Base
@@ -43,7 +43,7 @@ module Noticed
43
43
 
44
44
  def params_column
45
45
  case current_adapter
46
- when "postgresql"
46
+ when "postgresql", "postgis"
47
47
  "params:jsonb"
48
48
  else
49
49
  # MySQL and SQLite both support json
data/lib/noticed/base.rb CHANGED
@@ -9,7 +9,7 @@ module Noticed
9
9
  class_attribute :delivery_methods, instance_writer: false, default: []
10
10
  class_attribute :param_names, instance_writer: false, default: []
11
11
 
12
- # Gives notifications access to the record and recipient when formatting for delivery
12
+ # Gives notifications access to the record and recipient during delivery
13
13
  attr_accessor :record, :recipient
14
14
 
15
15
  delegate :read?, :unread?, to: :record
@@ -21,7 +21,7 @@ module Noticed
21
21
  end
22
22
 
23
23
  # Copy delivery methods from parent
24
- def inherited(base) #:nodoc:
24
+ def inherited(base) # :nodoc:
25
25
  base.delivery_methods = delivery_methods.dup
26
26
  base.param_names = param_names.dup
27
27
  super
@@ -31,6 +31,16 @@ module Noticed
31
31
  new(params)
32
32
  end
33
33
 
34
+ # Shortcut for delivering without params
35
+ def deliver(recipients)
36
+ new.deliver(recipients)
37
+ end
38
+
39
+ # Shortcut for delivering later without params
40
+ def deliver_later(recipients)
41
+ new.deliver_later(recipients)
42
+ end
43
+
34
44
  def params(*names)
35
45
  param_names.concat Array.wrap(names)
36
46
  end
@@ -71,22 +81,19 @@ module Noticed
71
81
  def run_delivery(recipient, enqueue: true)
72
82
  delivery_methods = self.class.delivery_methods.dup
73
83
 
74
- # Set recipient to instance var so it is available to Notification class
75
- @recipient = recipient
76
-
77
84
  # Run database delivery inline first if it exists so other methods have access to the record
78
85
  if (index = delivery_methods.find_index { |m| m[:name] == :database })
79
86
  delivery_method = delivery_methods.delete_at(index)
80
- @record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false)
87
+ self.record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false, record: nil)
81
88
  end
82
89
 
83
90
  delivery_methods.each do |delivery_method|
84
- run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue)
91
+ run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue, record: record)
85
92
  end
86
93
  end
87
94
 
88
95
  # Actually runs an individual delivery
89
- def run_delivery_method(delivery_method, recipient:, enqueue:)
96
+ def run_delivery_method(delivery_method, recipient:, enqueue:, record:)
90
97
  args = {
91
98
  notification_class: self.class.name,
92
99
  options: delivery_method[:options],
@@ -2,7 +2,7 @@ module Noticed
2
2
  module DeliveryMethods
3
3
  class ActionCable < Base
4
4
  def deliver
5
- channel.broadcast_to recipient, format
5
+ channel.broadcast_to stream, format
6
6
  end
7
7
 
8
8
  private
@@ -30,6 +30,18 @@ module Noticed
30
30
  end
31
31
  end
32
32
  end
33
+
34
+ def stream
35
+ value = options[:stream]
36
+ case value
37
+ when String
38
+ value
39
+ when Symbol
40
+ notification.send(value)
41
+ else
42
+ recipient
43
+ end
44
+ end
33
45
  end
34
46
  end
35
47
  end
@@ -10,7 +10,7 @@ module Noticed
10
10
 
11
11
  class << self
12
12
  # Copy option names from parent
13
- def inherited(base) #:nodoc:
13
+ def inherited(base) # :nodoc:
14
14
  base.option_names = option_names.dup
15
15
  super
16
16
  end
@@ -31,7 +31,7 @@ module Noticed
31
31
 
32
32
  def perform(args)
33
33
  @notification = args[:notification_class].constantize.new(args[:params])
34
- @options = args[:options]
34
+ @options = args[:options] || {}
35
35
  @params = args[:params]
36
36
  @recipient = args[:recipient]
37
37
  @record = args[:record]
@@ -4,17 +4,42 @@ module Noticed
4
4
  option :mailer
5
5
 
6
6
  def deliver
7
- mailer.with(format).send(method.to_sym).deliver_now
7
+ if options[:enqueue]
8
+ mailer.with(format).send(method.to_sym).deliver_later
9
+ else
10
+ mailer.with(format).send(method.to_sym).deliver_now
11
+ end
8
12
  end
9
13
 
10
14
  private
11
15
 
16
+ # mailer: "UserMailer"
17
+ # mailer: UserMailer
18
+ # mailer: :my_method - `my_method` should return Class
12
19
  def mailer
13
- options.fetch(:mailer).constantize
20
+ option = options.fetch(:mailer)
21
+ case option
22
+ when String
23
+ option.constantize
24
+ when Symbol
25
+ notification.send(option)
26
+ else
27
+ option
28
+ end
14
29
  end
15
30
 
31
+ # Method should be a symbol
32
+ #
33
+ # If notification responds to symbol, call that method and use return value
34
+ # If notification does not respond to symbol, use the symbol for the mailer method
35
+ # Otherwise, use the underscored notification class name as the mailer method
16
36
  def method
17
- options[:method] || notification.class.name.underscore
37
+ method_name = options[:method]&.to_sym
38
+ if method_name.present?
39
+ notification.respond_to?(method_name) ? notification.send(method_name) : method_name
40
+ else
41
+ notification.class.name.underscore
42
+ end
18
43
  end
19
44
 
20
45
  def format
@@ -0,0 +1,162 @@
1
+ require "apnotic"
2
+
3
+ module Noticed
4
+ module DeliveryMethods
5
+ class Ios < Base
6
+ cattr_accessor :connection_pool
7
+
8
+ def deliver
9
+ raise ArgumentError, "bundle_identifier is missing" if bundle_identifier.blank?
10
+ raise ArgumentError, "key_id is missing" if key_id.blank?
11
+ raise ArgumentError, "team_id is missing" if team_id.blank?
12
+ raise ArgumentError, "Could not find APN cert at '#{cert_path}'" unless File.exist?(cert_path)
13
+
14
+ device_tokens.each do |device_token|
15
+ connection_pool.with do |connection|
16
+ apn = Apnotic::Notification.new(device_token)
17
+ format_notification(apn)
18
+
19
+ response = connection.push(apn)
20
+ raise "Timeout sending iOS push notification" unless response
21
+
22
+ if bad_token?(response)
23
+ # Allow notification to cleanup invalid iOS device tokens
24
+ cleanup_invalid_token(device_token)
25
+ elsif !response.ok?
26
+ raise "Request failed #{response.body}"
27
+ end
28
+ end
29
+ end
30
+ end
31
+
32
+ private
33
+
34
+ def format_notification(apn)
35
+ apn.topic = bundle_identifier
36
+
37
+ if (method = options[:format])
38
+ notification.send(method, apn)
39
+ elsif params[:message].present?
40
+ apn.alert = params[:message]
41
+ else
42
+ raise ArgumentError, "No message for iOS delivery. Either include message in params or add the 'format' option in 'deliver_by :ios'."
43
+ end
44
+ end
45
+
46
+ def device_tokens
47
+ if notification.respond_to?(:ios_device_tokens)
48
+ Array.wrap(notification.ios_device_tokens(recipient))
49
+ else
50
+ raise NoMethodError, <<~MESSAGE
51
+ You must implement `ios_device_tokens` to send iOS notifications
52
+
53
+ # This must return an Array of iOS device tokens
54
+ def ios_device_tokens(user)
55
+ user.ios_device_tokens.pluck(:token)
56
+ end
57
+ MESSAGE
58
+ end
59
+ end
60
+
61
+ def bad_token?(response)
62
+ response.status == "410" || (response.status == "400" && response.body["reason"] == "BadDeviceToken")
63
+ end
64
+
65
+ def cleanup_invalid_token(token)
66
+ return unless notification.respond_to?(:cleanup_device_token)
67
+ notification.send(:cleanup_device_token, token: token, platform: "iOS")
68
+ end
69
+
70
+ def connection_pool
71
+ self.class.connection_pool ||= new_connection_pool
72
+ end
73
+
74
+ def new_connection_pool
75
+ handler = proc do |connection|
76
+ connection.on(:error) do |exception|
77
+ Rails.logger.info "Apnotic exception raised: #{exception}"
78
+ end
79
+ end
80
+
81
+ if development?
82
+ Apnotic::ConnectionPool.development(connection_pool_options, pool_options, &handler)
83
+ else
84
+ Apnotic::ConnectionPool.new(connection_pool_options, pool_options, &handler)
85
+ end
86
+ end
87
+
88
+ def connection_pool_options
89
+ {
90
+ auth_method: :token,
91
+ cert_path: cert_path,
92
+ key_id: key_id,
93
+ team_id: team_id
94
+ }
95
+ end
96
+
97
+ def bundle_identifier
98
+ option = options[:bundle_identifier]
99
+ case option
100
+ when String
101
+ option
102
+ when Symbol
103
+ notification.send(option)
104
+ else
105
+ Rails.application.credentials.dig(:ios, :bundle_identifier)
106
+ end
107
+ end
108
+
109
+ def cert_path
110
+ option = options[:cert_path]
111
+ case option
112
+ when String
113
+ option
114
+ when Symbol
115
+ notification.send(option)
116
+ else
117
+ Rails.root.join("config/certs/ios/apns.p8")
118
+ end
119
+ end
120
+
121
+ def key_id
122
+ option = options[:key_id]
123
+ case option
124
+ when String
125
+ option
126
+ when Symbol
127
+ notification.send(option)
128
+ else
129
+ Rails.application.credentials.dig(:ios, :key_id)
130
+ end
131
+ end
132
+
133
+ def team_id
134
+ option = options[:team_id]
135
+ case option
136
+ when String
137
+ option
138
+ when Symbol
139
+ notification.send(option)
140
+ else
141
+ Rails.application.credentials.dig(:ios, :team_id)
142
+ end
143
+ end
144
+
145
+ def development?
146
+ option = options[:development]
147
+ case option
148
+ when Symbol
149
+ !!notification.send(option)
150
+ else
151
+ !!option
152
+ end
153
+ end
154
+
155
+ def pool_options
156
+ {
157
+ size: options.fetch(:pool_size, 5)
158
+ }
159
+ end
160
+ end
161
+ end
162
+ end
@@ -1,6 +1,6 @@
1
1
  module Noticed
2
2
  module HasNotifications
3
- # Defines a method for the association and a before_destory callback to remove notifications
3
+ # Defines a method for the association and a before_destroy callback to remove notifications
4
4
  # where this record is a param
5
5
  #
6
6
  # class User < ApplicationRecord
@@ -18,7 +18,7 @@ module Noticed
18
18
  define_method "notifications_as_#{param_name}" do
19
19
  model = options.fetch(:model_name, "Notification").constantize
20
20
  case current_adapter
21
- when "postgresql"
21
+ when "postgresql", "postgis"
22
22
  model.where("params @> ?", Noticed::Coder.dump(param_name.to_sym => self).to_json)
23
23
  when "mysql2"
24
24
  model.where("JSON_CONTAINS(params, ?)", Noticed::Coder.dump(param_name.to_sym => self).to_json)
data/lib/noticed/model.rb CHANGED
@@ -1,5 +1,13 @@
1
1
  module Noticed
2
2
  module Model
3
+ DATABASE_ERROR_CLASS_NAMES = lambda {
4
+ classes = [ActiveRecord::NoDatabaseError]
5
+ classes << ActiveRecord::ConnectionNotEstablished
6
+ classes << Mysql2::Error if defined?(::Mysql2)
7
+ classes << PG::ConnectionBad if defined?(::PG)
8
+ classes
9
+ }.call.freeze
10
+
3
11
  extend ActiveSupport::Concern
4
12
 
5
13
  included do
@@ -32,7 +40,9 @@ module Noticed
32
40
  else
33
41
  Noticed::TextCoder
34
42
  end
35
- rescue ActiveRecord::NoDatabaseError
43
+ rescue *DATABASE_ERROR_CLASS_NAMES => _error
44
+ warn("Noticed was unable to bootstrap correctly as the database is unavailable.")
45
+
36
46
  Noticed::TextCoder
37
47
  end
38
48
  end
@@ -42,6 +52,7 @@ module Noticed
42
52
  @_notification ||= begin
43
53
  instance = type.constantize.with(params)
44
54
  instance.record = self
55
+ instance.recipient = recipient
45
56
  instance
46
57
  end
47
58
  end
@@ -7,6 +7,10 @@ module Noticed
7
7
  :notifications
8
8
  end
9
9
 
10
+ def class_scope
11
+ self.class.name.underscore.tr("/", ".")
12
+ end
13
+
10
14
  def translate(key, **options)
11
15
  I18n.translate(scope_translation_key(key), **options)
12
16
  end
@@ -14,7 +18,7 @@ module Noticed
14
18
 
15
19
  def scope_translation_key(key)
16
20
  if key.to_s.start_with?(".")
17
- "#{i18n_scope}.#{self.class.name.underscore}#{key}"
21
+ "#{i18n_scope}.#{class_scope}#{key}"
18
22
  else
19
23
  key
20
24
  end
@@ -1,3 +1,3 @@
1
1
  module Noticed
2
- VERSION = "1.4.1"
2
+ VERSION = "1.5.3"
3
3
  end
data/lib/noticed.rb CHANGED
@@ -12,12 +12,13 @@ module Noticed
12
12
  autoload :NotificationChannel, "noticed/notification_channel"
13
13
 
14
14
  module DeliveryMethods
15
- autoload :Base, "noticed/delivery_methods/base"
16
15
  autoload :ActionCable, "noticed/delivery_methods/action_cable"
16
+ autoload :Base, "noticed/delivery_methods/base"
17
17
  autoload :Database, "noticed/delivery_methods/database"
18
18
  autoload :Email, "noticed/delivery_methods/email"
19
- autoload :Slack, "noticed/delivery_methods/slack"
19
+ autoload :Ios, "noticed/delivery_methods/ios"
20
20
  autoload :MicrosoftTeams, "noticed/delivery_methods/microsoft_teams"
21
+ autoload :Slack, "noticed/delivery_methods/slack"
21
22
  autoload :Test, "noticed/delivery_methods/test"
22
23
  autoload :Twilio, "noticed/delivery_methods/twilio"
23
24
  autoload :Vonage, "noticed/delivery_methods/vonage"
@@ -54,7 +54,7 @@ module ActionCable
54
54
  serialize_broadcasting([channel_name, model])
55
55
  end
56
56
 
57
- def serialize_broadcasting(object) #:nodoc:
57
+ def serialize_broadcasting(object) # :nodoc:
58
58
  case # standard:disable Style/EmptyCaseCondition
59
59
  when object.is_a?(Array)
60
60
  object.map { |m| serialize_broadcasting(m) }.join(":")
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: noticed
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
4
+ version: 1.5.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chris Oliver
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-05-04 00:00:00.000000000 Z
11
+ date: 2021-11-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rails
@@ -132,6 +132,7 @@ files:
132
132
  - lib/noticed/delivery_methods/base.rb
133
133
  - lib/noticed/delivery_methods/database.rb
134
134
  - lib/noticed/delivery_methods/email.rb
135
+ - lib/noticed/delivery_methods/ios.rb
135
136
  - lib/noticed/delivery_methods/microsoft_teams.rb
136
137
  - lib/noticed/delivery_methods/slack.rb
137
138
  - lib/noticed/delivery_methods/test.rb
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
168
169
  - !ruby/object:Gem::Version
169
170
  version: '0'
170
171
  requirements: []
171
- rubygems_version: 3.1.4
172
+ rubygems_version: 3.2.22
172
173
  signing_key:
173
174
  specification_version: 4
174
175
  summary: Notifications for Ruby on Rails applications