Merge branch 'main' of github.com:excid3/noticed

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+  workflow_call:
 
 jobs:
   sqlite:

.github/workflows/publish_gem.yml

@@ -8,7 +8,11 @@ on:
         type: string
 
 jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
   push:
+    needs: test
     runs-on: ubuntu-latest
 
     permissions:
@@ -27,7 +31,7 @@ jobs:
       - name: Update version
         run: |
           sed -i 's/".*"/"${{ inputs.version }}"/' lib/noticed/version.rb
-          bundle config set frozen false
+          bundle config set --local deployment 'false'
           bundle
           bundle exec appraisal
           git config user.name 'GitHub Actions'

README.md

@@ -645,7 +645,7 @@ class DeliveryMethods::WhatsApp < Noticed::DeliveryMethod
   def deliver
     # ...
     config.day #=> #<Proc:0x000f7c8 (lambda)>
-    evaluate_option(config.day) #=> "Tuesday"
+    evaluate_option(:day) #=> "Tuesday"
   end
 end
 ```

app/models/concerns/noticed/deliverable.rb

@@ -70,8 +70,12 @@ def param(*names)
       end
 
       def with(params)
-        record = params.delete(:record)
-        new(params: params, record: record)
+        if self < Ephemeral
+          new(params: params)
+        else
+          record = params.delete(:record)
+          new(params: params, record: record)
+        end
       end
 
       def deliver(recipients = nil, **options)

docs/delivery_methods/fcm.md

@@ -50,7 +50,7 @@ Customize the Firebase Cloud Messaging notification object. This can be a Lambda
 
 The callable object will be given the device token as an argument.
 
-There are lots of options of now to structure a FCM notification message. See https://firebase.google.com/docs/cloud-messaging/concept-options for more details.
+There are lots of options of how to structure a FCM notification message. See https://firebase.google.com/docs/cloud-messaging/concept-options for more details.
 
 ### `credentials`
 The location of your Firebase Cloud Messaging credentials.

docs/delivery_methods/ios.md

@@ -74,7 +74,7 @@ Here, the recipient `has_many :notification_tokens` with columns `platform` and
 
 ```ruby
 deliver_by :ios do |config|
-  config.device_tokens = ->(recipient) { recipient.notification_tokens.where(platform: :iOS).pluck(:token) }
+  config.device_tokens = -> { recipient.notification_tokens.where(platform: :iOS).pluck(:token) }
 end
 ```
 

docs/delivery_methods/twilio_messaging.md

@@ -38,6 +38,25 @@ deliver_by :twilio_messaging do |config|
 end
 ```
 
+## Error Handling
+
+Twilio provides a full list of error codes that can be handled as needed. See https://www.twilio.com/docs/api/errors
+
+```ruby
+deliver_by :twilio_messaging do |config|
+  config.error_handler = lambda do |twilio_error_response|
+    error_hash = JSON.parse(twilio_error_response.body)
+    case error_hash["code"]
+    when 21211
+      # The 'To' number is not a valid phone number.
+      # Write your error handling code
+    else
+      raise "Unhandled Twilio error: #{error_hash}"
+    end
+  end
+end
+```
+
 ## Options
 
 * `json` - *Optional*

lib/noticed/delivery_methods/twilio_messaging.rb

@@ -3,6 +3,12 @@ module DeliveryMethods
     class TwilioMessaging < DeliveryMethod
       def deliver
         post_request url, basic_auth: {user: account_sid, pass: auth_token}, form: json.stringify_keys
+      rescue Noticed::ResponseUnsuccessful => exception
+        if exception.response.code.start_with?("4") && config[:error_handler]
+          notification.instance_exec(exception.response, &config[:error_handler])
+        else
+          raise
+        end
       end
 
       def json

test/delivery_methods/twilio_messaging_test.rb

@@ -3,7 +3,7 @@
 class TwilioMessagingTest < ActiveSupport::TestCase
   setup do
     @delivery_method = Noticed::DeliveryMethods::TwilioMessaging.new
-    set_config(
+    @config = {
       account_sid: "acct_1234",
       auth_token: "token",
       json: -> {
@@ -13,7 +13,8 @@ class TwilioMessagingTest < ActiveSupport::TestCase
           Body: "Hello world"
         }
       }
-    )
+    }
+    set_config(@config)
   end
 
   test "sends sms" do
@@ -38,6 +39,26 @@ class TwilioMessagingTest < ActiveSupport::TestCase
     end
   end
 
+  test "passes error to notification instance if error_handler is configured" do
+    @delivery_method = Noticed::DeliveryMethods::TwilioMessaging.new(
+      "delivery_method_name",
+      noticed_notifications(:one)
+    )
+
+    error_handler_called = false
+    @config[:error_handler] = lambda do |twilio_error_message|
+      error_handler_called = true
+    end
+    set_config(@config)
+
+    stub_request(:post, "https://api.twilio.com/2010-04-01/Accounts/acct_1234/Messages.json").to_return(status: 422)
+    assert_nothing_raised do
+      @delivery_method.deliver
+    end
+
+    assert(error_handler_called, "Handler is called if status is 4xx")
+  end
+
   private
 
   def set_config(config)

test/ephemeral_notifier_test.rb

@@ -13,4 +13,8 @@ class EphemeralNotifierTest < ActiveSupport::TestCase
       perform_enqueued_jobs
     end
   end
+
+  test "ephemeral has record shortcut" do
+    assert_equal :foo, EphemeralNotifier.with(record: :foo).record
+  end
 end