noticed 1.5.3 → 1.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a91f0aa918496552c3b0f9153c1a4351a32f10910389780a71e8cb76d91df30
-  data.tar.gz: 653ebc0c8ba59639e405fe78dbc6a4ce0480baf8abe0824f0f46e09cf47137d7
+  metadata.gz: a428bc0978afe8b14abcb97a3d1044aa6b44acca00822f4f561eb2315392420d
+  data.tar.gz: 5dc07c6c18523c083e981f0440f1c4d273f36e1b83e78c04e31f0822ada927c1
 SHA512:
-  metadata.gz: f4bf8b33c4c68666e312451ee812ba5578d1eedb526108ef3e07f1c5f8a7eb57ed41cc2a077366d9c211ec72dd9fd9585c3297f0931dad6f80d23493fd98e96f
-  data.tar.gz: b043568083a5515b00d32936d7883cf617299965bcc1365eeff748c36faf52575a8bcc3fae0c20101b5e669691eaa5d5cebc381004fb7b2e993099041e552ce4
+  metadata.gz: 958fde4c959e18dfa7c569d4c5e3449b13332bd9a2161b1e0083b327f148edfb1ac454030576dc7f366d82c62ae7c6466f4a6d27fd44b97927d1b57e391498ca
+  data.tar.gz: 1a18f5937d945ecf386a74002ca5dc7b61b441d583b41dd9383f1cb171ca442dd82827ecf93febf2053441cf566f3739b5eddbe8da2c7ab0ec7ac8b647e27f5e

data/README.md

@@ -16,6 +16,7 @@ Currently, we support these notification delivery methods out of the box:
 * Twilio (SMS)
 * Vonage / Nexmo (SMS)
 * iOS Apple Push Notifications
+* Firebase Cloud Messaging (Android and more)
 
 And you can easily add new notification types for any other delivery methods.
 
@@ -190,6 +191,31 @@ Example:
 deliver_by :slack, debug: true
 ```
 
+## ✅ Best Practices
+
+A common use case is to trigger a notification when a record is created. For example,
+
+```ruby
+class Message < ApplicationRecord
+  belongs_to :recipient, class_name: "User"
+  
+  after_create_commit :notify_recipient
+  
+  private
+  
+  def notify_recipient
+    NewMessageNotification.with(message: self).deliver_later(recipient)
+  end
+```
+
+If you are creating the notification on a background job (i.e. via `#deliver_later`), make sure you use a `commit` hook such as `after_create_commit` or `after_commit`.
+
+Using `after_create` might cause the notification delivery methods to fail. This is because the job was enqueued while inside a database transaction, and the `Message` record might not yet be saved to the database.
+
+A common symptom of this problem is undelivered notifications and the following error in your logs.
+
+> `Discarded Noticed::DeliveryMethods::Email due to a ActiveJob::DeserializationError.`
+
 ## 🚛 Delivery Methods
 
 The delivery methods are designed to be modular so you can customize the way each type gets delivered.
@@ -205,6 +231,7 @@ For example, emails will require a subject, body, and email address while an SMS
 * [Test](docs/delivery_methods/test.md)
 * [Twilio](docs/delivery_methods/twilio.md)
 * [Vonage](docs/delivery_methods/vonage.md)
+* [Firebase Cloud Messaging](docs/delivery_methods/fcm.md)
 
 ### Fallback Notifications
 

data/lib/noticed/base.rb

@@ -81,6 +81,8 @@ module Noticed
     def run_delivery(recipient, enqueue: true)
       delivery_methods = self.class.delivery_methods.dup
 
+      self.recipient = recipient
+
       # Run database delivery inline first if it exists so other methods have access to the record
       if (index = delivery_methods.find_index { |m| m[:name] == :database })
         delivery_method = delivery_methods.delete_at(index)

data/lib/noticed/delivery_methods/base.rb

@@ -29,8 +29,8 @@ module Noticed
         end
       end
 
-      def perform(args)
-        @notification = args[:notification_class].constantize.new(args[:params])
+      def assign_args(args)
+        @notification = args.fetch(:notification_class).constantize.new(args[:params])
         @options = args[:options] || {}
         @params = args[:params]
         @recipient = args[:recipient]
@@ -39,6 +39,11 @@ module Noticed
         # Make notification aware of database record and recipient during delivery
         @notification.record = args[:record]
         @notification.recipient = args[:recipient]
+        self
+      end
+
+      def perform(args)
+        assign_args(args)
 
         return if (condition = @options[:if]) && !@notification.send(condition)
         return if (condition = @options[:unless]) && @notification.send(condition)
@@ -57,16 +62,16 @@ module Noticed
       # Helper method for making POST requests from delivery methods
       #
       # Usage:
-      #   post("http://example.com", basic_auth: {user:, pass:}, json: {}, form: {})
+      #   post("http://example.com", basic_auth: {user:, pass:}, headers: {}, json: {}, form: {})
       #
       def post(url, args = {})
+        options ||= {}
         basic_auth = args.delete(:basic_auth)
+        headers = args.delete(:headers)
 
-        request = if basic_auth
-          HTTP.basic_auth(user: basic_auth[:user], pass: basic_auth[:pass])
-        else
-          HTTP
-        end
+        request = HTTP
+        request = request.basic_auth(user: basic_auth[:user], pass: basic_auth[:pass]) if basic_auth
+        request = request.headers(headers) if headers
 
         response = request.post(url, args)
 
@@ -76,6 +81,8 @@ module Noticed
         end
 
         if !options[:ignore_failure] && !response.status.success?
+          puts response.status
+          puts response.body
           raise ResponseUnsuccessful.new(response)
         end
 

data/lib/noticed/delivery_methods/fcm.rb

@@ -0,0 +1,96 @@
+require "googleauth"
+
+# class CommentNotifier
+#  deliver_by :fcm, credentials: Rails.root.join("config/certs/fcm.json"), format: :format_notification
+#
+#  deliver_by :fcm, credentials: :fcm_credentials
+#   def fcm_credentials
+#     { project_id: "api-12345" }
+#   end
+# end
+
+module Noticed
+  module DeliveryMethods
+    class Fcm < Base
+      BASE_URI = "https://fcm.googleapis.com/v1/projects/"
+
+      option :format
+
+      def deliver
+        device_tokens.each do |device_token|
+          post("#{BASE_URI}#{project_id}/messages:send", headers: {authorization: "Bearer #{access_token}"}, json: {message: format(device_token)})
+        rescue ResponseUnsuccessful => exception
+          if exception.code == 404
+            cleanup_invalid_token(device_token)
+          else
+            raise
+          end
+        end
+      end
+
+      def cleanup_invalid_token(device_token)
+        return unless notification.respond_to?(:cleanup_device_token)
+        notification.send(:cleanup_device_token, token: device_token, platform: "fcm")
+      end
+
+      def credentials
+        @credentials ||= begin
+          option = options[:credentials]
+          credentials_hash = case option
+          when Hash
+            option
+          when Pathname
+            load_json(option)
+          when String
+            load_json(Rails.root.join(option))
+          when Symbol
+            notification.send(option)
+          else
+            Rails.application.credentials.fcm
+          end
+
+          credentials_hash.symbolize_keys
+        end
+      end
+
+      def load_json(path)
+        JSON.parse(File.read(path))
+      end
+
+      def project_id
+        credentials[:project_id]
+      end
+
+      def access_token
+        token = authorizer.fetch_access_token!
+        token["access_token"]
+      end
+
+      def authorizer
+        @authorizer ||= options.fetch(:authorizer, Google::Auth::ServiceAccountCredentials).make_creds(
+          json_key_io: StringIO.new(credentials.to_json),
+          scope: "https://www.googleapis.com/auth/firebase.messaging"
+        )
+      end
+
+      def format(device_token)
+        notification.send(options[:format], device_token)
+      end
+
+      def device_tokens
+        if notification.respond_to?(:fcm_device_tokens)
+          Array.wrap(notification.fcm_device_tokens(recipient))
+        else
+          raise NoMethodError, <<~MESSAGE
+            You must implement `fcm_device_tokens` to send Firebase Cloud Messaging notifications
+
+            # This must return an Array of FCM device tokens
+            def fcm_device_tokens(recipient)
+              recipient.fcm_device_tokens.pluck(:token)
+            end
+          MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/noticed/delivery_methods/ios.rb

@@ -9,7 +9,7 @@ module Noticed
         raise ArgumentError, "bundle_identifier is missing" if bundle_identifier.blank?
         raise ArgumentError, "key_id is missing" if key_id.blank?
         raise ArgumentError, "team_id is missing" if team_id.blank?
-        raise ArgumentError, "Could not find APN cert at '#{cert_path}'" unless File.exist?(cert_path)
+        raise ArgumentError, "Could not find APN cert at '#{cert_path}'" unless valid_cert_path?
 
         device_tokens.each do |device_token|
           connection_pool.with do |connection|
@@ -51,8 +51,8 @@ module Noticed
             You must implement `ios_device_tokens` to send iOS notifications
 
             # This must return an Array of iOS device tokens
-            def ios_device_tokens(user)
-              user.ios_device_tokens.pluck(:token)
+            def ios_device_tokens(recipient)
+              recipient.ios_device_tokens.pluck(:token)
             end
           MESSAGE
         end
@@ -152,6 +152,15 @@ module Noticed
         end
       end
 
+      def valid_cert_path?
+        case cert_path
+        when File, StringIO
+          cert_path.size > 0
+        else
+          File.exist?(cert_path)
+        end
+      end
+
       def pool_options
         {
           size: options.fetch(:pool_size, 5)

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.5.3"
+  VERSION = "1.5.7"
 end

data/lib/noticed.rb

@@ -22,6 +22,7 @@ module Noticed
     autoload :Test, "noticed/delivery_methods/test"
     autoload :Twilio, "noticed/delivery_methods/twilio"
     autoload :Vonage, "noticed/delivery_methods/vonage"
+    autoload :Fcm, "noticed/delivery_methods/fcm"
   end
 
   def self.notify(recipients:, notification:)

data/lib/rails_6_polyfills/base.rb

@@ -1,11 +1,11 @@
 # The following implements polyfills for Rails < 6.0
 module ActionCable
   # If the Rails 6.0 ActionCable::TestHelper is missing then allow it to autoload
-  unless ActionCable.const_defined? "TestHelper"
+  unless ActionCable.const_defined? :TestHelper
     autoload :TestHelper, "rails_6_polyfills/actioncable/test_helper.rb"
   end
   # If the Rails 6.0 test SubscriptionAdapter is missing then allow it to autoload
-  unless ActionCable.const_defined? "SubscriptionAdapter::Test"
+  unless ActionCable::SubscriptionAdapter.const_defined? :Test
     module SubscriptionAdapter
       autoload :Test, "rails_6_polyfills/actioncable/test_adapter.rb"
     end
@@ -13,6 +13,6 @@ module ActionCable
 end
 
 # If the Rails 6.0 ActionJob Serializers are missing then load support for them
-unless Object.const_defined?("ActiveJob::Serializers")
+unless ActiveJob.const_defined?(:Serializers)
   require "rails_6_polyfills/activejob/serializers"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.7
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -132,6 +132,7 @@ files:
 - lib/noticed/delivery_methods/base.rb
 - lib/noticed/delivery_methods/database.rb
 - lib/noticed/delivery_methods/email.rb
+- lib/noticed/delivery_methods/fcm.rb
 - lib/noticed/delivery_methods/ios.rb
 - lib/noticed/delivery_methods/microsoft_teams.rb
 - lib/noticed/delivery_methods/slack.rb
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications