noticed 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83635d722a21df622c90c4e8ded293206242be768b30b2139c41f13bc4d6712c
-  data.tar.gz: 707ff4e0e8d09ed4c1fa1b0a7228353de637b070e849e7eb234b58b6fb491e40
+  metadata.gz: b55f07f54d797f712ad06012dd4ab1ce6272d2c006e2f14fe7b78c59e88b7e14
+  data.tar.gz: 555dc41b72c2810780153a002f1a5f8365a4bc0e3df85cd0f9e098f0ca6bef75
 SHA512:
-  metadata.gz: 85ddb6e11858df2b21b4dc098096c78465f7ac3dcb7a804037f3cf1855735b954cccb1cb0ad3227d1ebd89cb98e2e6e5d0138af27e73e52d2feeb35ac85ccdec
-  data.tar.gz: 80d3485a086e8203397f83bf3269e057ec63c9da89b3016d29a8395499447419336d89e7d01daff911a838159b963423dd45f6161b80c0dfab608f2f4e11c662
+  metadata.gz: 376a54d888387481f8eb387f481c4b5c672ffdaf78dfb6ca9e61d7131afcbd5c5bd1e572f5630fc6d66de09d2c84bc1e0558130c14eb638c14369d4f1fa3508b
+  data.tar.gz: c9e917ab696531278bdbbb2cb5c2575b159d601cc4a21a4e4bb88ecda97d27cda680d7686cfe8268ab3b16f87ecd30babab8bda67ec9c7a3ee0ee48bd062b0a4

data/README.md

@@ -15,6 +15,7 @@ Currently, we support these notification delivery methods out of the box:
 * Microsoft Teams
 * Twilio (SMS)
 * Vonage / Nexmo (SMS)
+* iOS Apple Push Notifications
 
 And you can easily add new notification types for any other delivery methods.
 
@@ -159,6 +160,10 @@ For example:
 
  `t(".message")` looks up `en.notifications.new_comment.message`
 
+Or when notification class is in module:
+
+`t(".message") # in Admin::NewComment` looks up `en.notifications.admin.new_comment.message`
+
 ##### User Preferences
 
 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
 end
 ```
 
-## 🚛 Delivery Methods
-
-The delivery methods are designed to be modular so you can customize the way each type gets delivered.
-
-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.
-
-### Database
-
-Writes notification to the database.
-
-`deliver_by :database`
-
-**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.
-
-##### Options
-
-* `association` - *Optional*
-
-  The name of the database association to use. Defaults to `:notifications`
-
-* `format: :format_for_database` - *Optional*
-
-  Use a custom method to define the attributes saved to the database
-
-### Email
-
-Sends an email notification. Emails will always be sent with `deliver_later`
-
-`deliver_by :email, mailer: "UserMailer"`
-
-##### Options
-
-* `mailer` - **Required**
-
-  The mailer that should send the email
-
-* `method: :invoice_paid` - *Optional*
-
-  Used to customize the method on the mailer that is called
-
-* `format: :format_for_email` - *Optional*
-
-  Use a custom method to define the params sent to the mailer. `recipient` will be merged into the params.
-
-### ActionCable
-
-Sends a notification to the browser via websockets (ActionCable channel by default).
-
-`deliver_by :action_cable`
-
-##### Options
-
-* `format: :format_for_action_cable` - *Optional*
-
-  Use a custom method to define the Hash sent through ActionCable
-
-* `channel` - *Optional*
-
-  Override the ActionCable channel used to send notifications.
-
-  Defaults to `Noticed::NotificationChannel`
-
-### Slack
-
-Sends a Slack notification via webhook.
-
-`deliver_by :slack`
-
-##### Options
-
-* `format: :format_for_slack` - *Optional*
-
-  Use a custom method to define the payload sent to Slack. Method should return a Hash.
-
-* `url: :url_for_slack` - *Optional*
+## 🐞 Debugging
 
-  Use a custom method to retrieve the Slack Webhook URL. Method should return a String.
+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.
 
-  Defaults to `Rails.application.credentials.slack[:notification_url]`
+Example:
 
-### Microsoft Teams
-
-Sends a Teams notification via webhook.
-
-`deliver_by :microsoft_teams`
-
-#### Options
-
-* `format: :format_for_teams` - *Optional*
-
-  Use a custom method to define the payload sent to Microsoft Teams. Method should return a Hash.
-  Documentation for posting via Webhooks available at: https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook
-
-  ```ruby
-  {
-    title: "This is the title for the card",
-    text: "This is the body text for the card",
-    sections: [{activityTitle: "Section Title", activityText: "Section Text"}],
-    "potentialAction": [{
-      "@type": "OpenUri",
-      name: "Button Text",
-      targets: [{
-        os: "default",
-        uri: "https://example.com/foo/action"
-      }]
-    }]
-
-  }
-  ```
-
-* `url: :url_for_teams_channel`: - *Optional*
-
-  Use a custom method to retrieve the MS Teams Webhook URL. Method should return a string.
-
-  Defaults to `Rails.application.credentials.microsoft_teams[:notification_url]`
-
-### Twilio SMS
-
-Sends an SMS notification via Twilio.
-
-`deliver_by :twilio`
-
-##### Options
-
-* `credentials: :get_twilio_credentials` - *Optional*
-
-  Use a custom method to retrieve the credentials for Twilio. Method should return a Hash with `:account_sid`, `:auth_token` and `:phone_number` keys.
-
-  Defaults to `Rails.application.credentials.twilio[:account_sid]` and `Rails.application.credentials.twilio[:auth_token]`
-
-* `url: :get_twilio_url` - *Optional*
-
-  Use a custom method to retrieve the Twilio URL.  Method should return the Twilio API url as a string.
-
-  Defaults to `"https://api.twilio.com/2010-04-01/Accounts/#{twilio_credentials(recipient)[:account_sid]}/Messages.json"`
-
-* `format: :format_for_twilio` - *Optional*
-
-  Use a custom method to define the payload sent to Twilio. Method should return a Hash.
-
-  Defaults to:
-
-  ```ruby
-  {
-    Body: notification.params[:message],
-    From: twilio_credentials[:number],
-    To: recipient.phone_number
-  }
-  ```
-
-### Vonage SMS
-
-Sends an SMS notification via Vonage / Nexmo.
-
-`deliver_by :vonage`
-
-##### Options
-
-* `credentials: :get_credentials` - *Optional*
-
-  Use a custom method for retrieving credentials. Method should return a Hash with `:api_key` and `:api_secret` keys.
+```ruby
+deliver_by :slack, debug: true
+```
 
-  Defaults to `Rails.application.credentials.vonage[:api_key]` and `Rails.application.credentials.vonage[:api_secret]`
+## 🚛 Delivery Methods
 
-* `deliver_by :vonage, format: :format_for_vonage` - *Optional*
+The delivery methods are designed to be modular so you can customize the way each type gets delivered.
 
-  Use a custom method to generate the params sent to Vonage. Method should return a Hash. Defaults to:
+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.
 
-  ```ruby
-  {
-    api_key: vonage_credentials[:api_key],
-    api_secret: vonage_credentials[:api_secret],
-    from: notification.params[:from],
-    text: notification.params[:body],
-    to: notification.params[:to],
-    type: "unicode"
-  }
-  ```
+* [Database](docs/delivery_methods/database.md)
+* [Email](docs/delivery_methods/email.md)
+* [ActionCable](docs/delivery_methods/action_cable.md)
+* [iOS Apple Push Notifications](docs/delivery_methods/ios.md)
+* [Microsoft Teams](docs/delivery_methods/microsoft_teams.md)
+* [Slack](docs/delivery_methods/slack.md)
+* [Test](docs/delivery_methods/test.md)
+* [Twilio](docs/delivery_methods/twilio.md)
+* [Vonage](docs/delivery_methods/vonage.md)
 
 ### Fallback Notifications
 
@@ -371,16 +223,24 @@ You can also configure multiple fallback options:
 
 ```ruby
 class CriticalSystemNotification < Noticed::Base
+  deliver_by :database
   deliver_by :slack
-  deliver_by :email, mailer: 'CriticalSystemMailer', delay: 10.minutes, unless: :read?
-  deliver_by :twilio, delay: 20.minutes, unless: :read?
+  deliver_by :email, mailer: 'CriticalSystemMailer', delay: 10.minutes, if: :unread?
+  deliver_by :twilio, delay: 20.minutes, if: :unread?
 end
 ```
 
-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.
+In this scenario, you have created an escalating notification system that
+
+-  Immediately creates a record in the database (for display directly in the app)
+-  Immediately issues a ping in Slack.
+-  If the notification remains unread after 10 minutes, it emails the team.
+-  If the notification remains unread after 20 minutes, it sends an SMS to the on-call phone.
 
 You can mix and match the options and delivery methods to suit your application specific needs.
 
+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.
+
 ### 🚚 Custom Delivery Methods
 
 To generate a custom delivery method, simply run
@@ -471,13 +331,13 @@ Rails 6.1+ can serialize Class and Module objects as arguments to ActiveJob. The
   deliver_by DeliveryMethods::Discord
 ```
 
-For Rails 6.0, you must pass strings of the class names in the `deliver_by` options.
+For Rails 5.2 and 6.0, you must pass strings of the class names in the `deliver_by` options.
 
 ```ruby
   deliver_by :discord, class: "DeliveryMethods::Discord"
 ```
 
-We recommend the Rails 6.0 compatible options to prevent confusion.
+We recommend using a string in order to prevent confusion.
 
 ### 📦 Database Model
 
@@ -550,7 +410,7 @@ class Post < ApplicationRecord
   has_noticed_notifications
 
   # You can override the param_name, the notification model name, or disable the before_destroy callback
-  has_noticed_notifications param_name: :parent, destroy: false, model: "Notification"
+  has_noticed_notifications param_name: :parent, destroy: false, model_name: "Notification"
 end
 
 # Create a CommentNotification with a post param
@@ -564,7 +424,7 @@ CommentNotification.with(parent: @post).deliver(user)
 
 #### Handling Deleted Records
 
-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`:
+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`:
 
 ```ruby
 class ApplicationJob < ActiveJob::Base
@@ -576,5 +436,13 @@ end
 
 This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `standardrb` before submitting pull requests.
 
+Running tests against multiple databases locally:
+
+```
+DATABASE_URL=sqlite3:noticed_test rails test
+DATABASE_URL=mysql2://root:@127.0.0.1/noticed_test rails test
+DATABASE_URL=postgres://127.0.0.1/noticed_test rails test
+```
+
 ## 📝 License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/noticed/model_generator.rb

@@ -42,14 +42,22 @@ module Noticed
       end
 
       def params_column
-        case ActiveRecord::Base.configurations.configs_for(spec_name: "primary").config["adapter"]
-        when "postgresql"
+        case current_adapter
+        when "postgresql", "postgis"
           "params:jsonb"
         else
           # MySQL and SQLite both support json
           "params:json"
         end
       end
+
+      def current_adapter
+        if ActiveRecord::Base.respond_to?(:connection_db_config)
+          ActiveRecord::Base.connection_db_config.adapter
+        else
+          ActiveRecord::Base.connection_config[:adapter]
+        end
+      end
     end
   end
 end

data/lib/noticed/base.rb

@@ -9,7 +9,7 @@ module Noticed
     class_attribute :delivery_methods, instance_writer: false, default: []
     class_attribute :param_names, instance_writer: false, default: []
 
-    # Gives notifications access to the record and recipient when formatting for delivery
+    # Gives notifications access to the record and recipient during delivery
     attr_accessor :record, :recipient
 
     delegate :read?, :unread?, to: :record
@@ -21,7 +21,7 @@ module Noticed
       end
 
       # Copy delivery methods from parent
-      def inherited(base) #:nodoc:
+      def inherited(base) # :nodoc:
         base.delivery_methods = delivery_methods.dup
         base.param_names = param_names.dup
         super
@@ -31,6 +31,16 @@ module Noticed
         new(params)
       end
 
+      # Shortcut for delivering without params
+      def deliver(recipients)
+        new.deliver(recipients)
+      end
+
+      # Shortcut for delivering later without params
+      def deliver_later(recipients)
+        new.deliver_later(recipients)
+      end
+
       def params(*names)
         param_names.concat Array.wrap(names)
       end
@@ -71,22 +81,19 @@ module Noticed
     def run_delivery(recipient, enqueue: true)
       delivery_methods = self.class.delivery_methods.dup
 
-      # Set recipient to instance var so it is available to Notification class
-      @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)
-        @record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false)
+        record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false, record: nil)
       end
 
       delivery_methods.each do |delivery_method|
-        run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue)
+        run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue, record: record)
       end
     end
 
     # Actually runs an individual delivery
-    def run_delivery_method(delivery_method, recipient:, enqueue:)
+    def run_delivery_method(delivery_method, recipient:, enqueue:, record:)
       args = {
         notification_class: self.class.name,
         options: delivery_method[:options],
@@ -98,11 +105,14 @@ module Noticed
       run_callbacks delivery_method[:name] do
         method = delivery_method_for(delivery_method[:name], delivery_method[:options])
 
+        # If the queue is `nil`, ActiveJob will use a default queue name.
+        queue = delivery_method.dig(:options, :queue)
+
         # Always perfrom later if a delay is present
         if (delay = delivery_method.dig(:options, :delay))
-          method.set(wait: delay).perform_later(args)
+          method.set(wait: delay, queue: queue).perform_later(args)
         elsif enqueue
-          method.perform_later(args)
+          method.set(queue: queue).perform_later(args)
         else
           method.perform_now(args)
         end

data/lib/noticed/delivery_methods/action_cable.rb

@@ -2,7 +2,7 @@ module Noticed
   module DeliveryMethods
     class ActionCable < Base
       def deliver
-        channel.broadcast_to recipient, format
+        channel.broadcast_to stream, format
       end
 
       private
@@ -30,6 +30,18 @@ module Noticed
           end
         end
       end
+
+      def stream
+        value = options[:stream]
+        case value
+        when String
+          value
+        when Symbol
+          notification.send(value)
+        else
+          recipient
+        end
+      end
     end
   end
 end

data/lib/noticed/delivery_methods/base.rb

@@ -10,7 +10,7 @@ module Noticed
 
       class << self
         # Copy option names from parent
-        def inherited(base) #:nodoc:
+        def inherited(base) # :nodoc:
           base.option_names = option_names.dup
           super
         end
@@ -31,7 +31,7 @@ module Noticed
 
       def perform(args)
         @notification = args[:notification_class].constantize.new(args[:params])
-        @options = args[:options]
+        @options = args[:options] || {}
         @params = args[:params]
         @recipient = args[:recipient]
         @record = args[:record]

data/lib/noticed/delivery_methods/email.rb

@@ -4,17 +4,42 @@ module Noticed
       option :mailer
 
       def deliver
-        mailer.with(format).send(method.to_sym).deliver_now
+        if options[:enqueue]
+          mailer.with(format).send(method.to_sym).deliver_later
+        else
+          mailer.with(format).send(method.to_sym).deliver_now
+        end
       end
 
       private
 
+      # mailer: "UserMailer"
+      # mailer: UserMailer
+      # mailer: :my_method - `my_method` should return Class
       def mailer
-        options.fetch(:mailer).constantize
+        option = options.fetch(:mailer)
+        case option
+        when String
+          option.constantize
+        when Symbol
+          notification.send(option)
+        else
+          option
+        end
       end
 
+      # Method should be a symbol
+      #
+      # If notification responds to symbol, call that method and use return value
+      # If notification does not respond to symbol, use the symbol for the mailer method
+      # Otherwise, use the underscored notification class name as the mailer method
       def method
-        options[:method] || notification.class.name.underscore
+        method_name = options[:method]&.to_sym
+        if method_name.present?
+          notification.respond_to?(method_name) ? notification.send(method_name) : method_name
+        else
+          notification.class.name.underscore
+        end
       end
 
       def format

data/lib/noticed/delivery_methods/ios.rb

@@ -0,0 +1,152 @@
+require "apnotic"
+
+module Noticed
+  module DeliveryMethods
+    class Ios < Base
+      cattr_accessor :connection_pool
+
+      def deliver
+        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)
+
+        device_tokens.each do |device_token|
+          connection_pool.with do |connection|
+            apn = Apnotic::Notification.new(device_token)
+            format_notification(apn)
+
+            response = connection.push(apn)
+            raise "Timeout sending iOS push notification" unless response
+
+            if bad_token?(response)
+              # Allow notification to cleanup invalid iOS device tokens
+              cleanup_invalid_token(device_token)
+            elsif !response.ok?
+              raise "Request failed #{response.body}"
+            end
+          end
+        end
+      end
+
+      private
+
+      def format_notification(apn)
+        apn.topic = bundle_identifier
+
+        if (method = options[:format])
+          notification.send(method, apn)
+        elsif params[:message].present?
+          apn.alert = params[:message]
+        else
+          raise ArgumentError, "No message for iOS delivery. Either include message in params or add the 'format' option in 'deliver_by :ios'."
+        end
+      end
+
+      def device_tokens
+        if notification.respond_to?(:ios_device_tokens)
+          Array.wrap(notification.ios_device_tokens(recipient))
+        else
+          raise NoMethodError, <<~MESSAGE
+            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)
+            end
+          MESSAGE
+        end
+      end
+
+      def bad_token?(response)
+        response.status == "410" || (response.status == "400" && response.body["reason"] == "BadDeviceToken")
+      end
+
+      def cleanup_invalid_token(token)
+        return unless notification.respond_to?(:cleanup_device_token)
+        notification.send(:cleanup_device_token, token: token, platform: "iOS")
+      end
+
+      def connection_pool
+        self.class.connection_pool ||= new_connection_pool
+      end
+
+      def new_connection_pool
+        handler = proc do |connection|
+          connection.on(:error) do |exception|
+            Rails.logger.info "Apnotic exception raised: #{exception}"
+          end
+        end
+
+        if options[:development]
+          Apnotic::ConnectionPool.development(connection_pool_options, pool_options, &handler)
+        else
+          Apnotic::ConnectionPool.new(connection_pool_options, pool_options, &handler)
+        end
+      end
+
+      def connection_pool_options
+        {
+          auth_method: :token,
+          cert_path: cert_path,
+          key_id: key_id,
+          team_id: team_id
+        }
+      end
+
+      def bundle_identifier
+        option = options[:bundle_identifier]
+        case option
+        when String
+          option
+        when Symbol
+          notification.send(option)
+        else
+          Rails.application.credentials.dig(:ios, :bundle_identifier)
+        end
+      end
+
+      def cert_path
+        option = options[:cert_path]
+        case option
+        when String
+          option
+        when Symbol
+          notification.send(option)
+        else
+          Rails.root.join("config/certs/ios/apns.p8")
+        end
+      end
+
+      def key_id
+        option = options[:key_id]
+        case option
+        when String
+          option
+        when Symbol
+          notification.send(option)
+        else
+          Rails.application.credentials.dig(:ios, :key_id)
+        end
+      end
+
+      def team_id
+        option = options[:team_id]
+        case option
+        when String
+          option
+        when Symbol
+          notification.send(option)
+        else
+          Rails.application.credentials.dig(:ios, :team_id)
+        end
+      end
+
+      def pool_options
+        {
+          size: options.fetch(:pool_size, 5)
+        }
+      end
+    end
+  end
+end

data/lib/noticed/engine.rb

@@ -5,5 +5,9 @@ module Noticed
         include Noticed::HasNotifications
       end
     end
+
+    initializer "noticed.rails_5_2_support" do
+      require "rails_6_polyfills/base" if Rails::VERSION::MAJOR < 6
+    end
   end
 end

data/lib/noticed/has_notifications.rb

@@ -1,6 +1,6 @@
 module Noticed
   module HasNotifications
-    # Defines a method for the association and a before_destory callback to remove notifications
+    # Defines a method for the association and a before_destroy callback to remove notifications
     # where this record is a param
     #
     #    class User < ApplicationRecord
@@ -15,10 +15,19 @@ module Noticed
 
     class_methods do
       def has_noticed_notifications(param_name: model_name.singular, **options)
-        model = options.fetch(:model_name, "Notification").constantize
-
         define_method "notifications_as_#{param_name}" do
-          model.where(params: {param_name.to_sym => self})
+          model = options.fetch(:model_name, "Notification").constantize
+          case current_adapter
+          when "postgresql", "postgis"
+            model.where("params @> ?", Noticed::Coder.dump(param_name.to_sym => self).to_json)
+          when "mysql2"
+            model.where("JSON_CONTAINS(params, ?)", Noticed::Coder.dump(param_name.to_sym => self).to_json)
+          when "sqlite3"
+            model.where("json_extract(params, ?) = ?", "$.#{param_name}", Noticed::Coder.dump(self).to_json)
+          else
+            # This will perform an exact match which isn't ideal
+            model.where(params: {param_name.to_sym => self})
+          end
         end
 
         if options.fetch(:destroy, true)
@@ -28,5 +37,13 @@ module Noticed
         end
       end
     end
+
+    def current_adapter
+      if ActiveRecord::Base.respond_to?(:connection_db_config)
+        ActiveRecord::Base.connection_db_config.adapter
+      else
+        ActiveRecord::Base.connection_config[:adapter]
+      end
+    end
   end
 end

data/lib/noticed/model.rb

@@ -24,12 +24,16 @@ module Noticed
       end
 
       def noticed_coder
+        return Noticed::TextCoder unless table_exists?
+
         case attribute_types["params"].type
         when :json, :jsonb
           Noticed::Coder
         else
           Noticed::TextCoder
         end
+      rescue ActiveRecord::NoDatabaseError
+        Noticed::TextCoder
       end
     end
 
@@ -38,6 +42,7 @@ module Noticed
       @_notification ||= begin
         instance = type.constantize.with(params)
         instance.record = self
+        instance.recipient = recipient
         instance
       end
     end

data/lib/noticed/translation.rb

@@ -7,6 +7,10 @@ module Noticed
       :notifications
     end
 
+    def class_scope
+      self.class.name.underscore.tr("/", ".")
+    end
+
     def translate(key, **options)
       I18n.translate(scope_translation_key(key), **options)
     end
@@ -14,7 +18,7 @@ module Noticed
 
     def scope_translation_key(key)
       if key.to_s.start_with?(".")
-        "#{i18n_scope}.#{self.class.name.underscore}#{key}"
+        "#{i18n_scope}.#{class_scope}#{key}"
       else
         key
       end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.3.0"
+  VERSION = "1.5.0"
 end

data/lib/noticed.rb

@@ -12,12 +12,13 @@ module Noticed
   autoload :NotificationChannel, "noticed/notification_channel"
 
   module DeliveryMethods
-    autoload :Base, "noticed/delivery_methods/base"
     autoload :ActionCable, "noticed/delivery_methods/action_cable"
+    autoload :Base, "noticed/delivery_methods/base"
     autoload :Database, "noticed/delivery_methods/database"
     autoload :Email, "noticed/delivery_methods/email"
-    autoload :Slack, "noticed/delivery_methods/slack"
+    autoload :Ios, "noticed/delivery_methods/ios"
     autoload :MicrosoftTeams, "noticed/delivery_methods/microsoft_teams"
+    autoload :Slack, "noticed/delivery_methods/slack"
     autoload :Test, "noticed/delivery_methods/test"
     autoload :Twilio, "noticed/delivery_methods/twilio"
     autoload :Vonage, "noticed/delivery_methods/vonage"

data/lib/rails_6_polyfills/actioncable/test_adapter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "action_cable/subscription_adapter/base"
+require "action_cable/subscription_adapter/subscriber_map"
+require "action_cable/subscription_adapter/async"
+
+module ActionCable
+  module SubscriptionAdapter
+    # == Test adapter for Action Cable
+    #
+    # The test adapter should be used only in testing. Along with
+    # <tt>ActionCable::TestHelper</tt> it makes a great tool to test your Rails application.
+    #
+    # To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file.
+    #
+    # NOTE: Test adapter extends the <tt>ActionCable::SubscriptionsAdapter::Async</tt> adapter,
+    # so it could be used in system tests too.
+    class Test < Async
+      def broadcast(channel, payload)
+        broadcasts(channel) << payload
+        super
+      end
+
+      def broadcasts(channel)
+        channels_data[channel] ||= []
+      end
+
+      def clear_messages(channel)
+        channels_data[channel] = []
+      end
+
+      def clear
+        @channels_data = nil
+      end
+
+      private
+
+      def channels_data
+        @channels_data ||= {}
+      end
+    end
+  end
+
+  # Update how broadcast_for determines the channel name so it's consistent with the Rails 6 way
+  module Channel
+    module Broadcasting
+      delegate :broadcast_to, to: :class
+      module ClassMethods
+        def broadcast_to(model, message)
+          ActionCable.server.broadcast(broadcasting_for(model), message)
+        end
+
+        def broadcasting_for(model)
+          serialize_broadcasting([channel_name, model])
+        end
+
+        def serialize_broadcasting(object) # :nodoc:
+          case # standard:disable Style/EmptyCaseCondition
+          when object.is_a?(Array)
+            object.map { |m| serialize_broadcasting(m) }.join(":")
+          when object.respond_to?(:to_gid_param)
+            object.to_gid_param
+          else
+            object.to_param
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_6_polyfills/actioncable/test_helper.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module ActionCable
+  # Have ActionCable pick its Test SubscriptionAdapter when it's called for in cable.yml
+  module Server
+    class Configuration
+      def pubsub_adapter
+        cable["adapter"] == "test" ? ActionCable::SubscriptionAdapter::Test : super
+      end
+    end
+  end
+
+  # Provides helper methods for testing Action Cable broadcasting
+  module TestHelper
+    def before_setup # :nodoc:
+      server = ActionCable.server
+      test_adapter = ActionCable::SubscriptionAdapter::Test.new(server)
+
+      @old_pubsub_adapter = server.pubsub
+
+      server.instance_variable_set(:@pubsub, test_adapter)
+      super
+    end
+
+    def after_teardown # :nodoc:
+      super
+      ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
+    end
+
+    # Asserts that the number of broadcasted messages to the stream matches the given number.
+    #
+    #   def test_broadcasts
+    #     assert_broadcasts 'messages', 0
+    #     ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #     assert_broadcasts 'messages', 1
+    #     ActionCable.server.broadcast 'messages', { text: 'world' }
+    #     assert_broadcasts 'messages', 2
+    #   end
+    #
+    # If a block is passed, that block should cause the specified number of
+    # messages to be broadcasted.
+    #
+    #   def test_broadcasts_again
+    #     assert_broadcasts('messages', 1) do
+    #       ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #     end
+    #
+    #     assert_broadcasts('messages', 2) do
+    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #       ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #     end
+    #   end
+    #
+    def assert_broadcasts(stream, number)
+      if block_given?
+        original_count = broadcasts_size(stream)
+        yield
+        new_count = broadcasts_size(stream)
+        actual_count = new_count - original_count
+      else
+        actual_count = broadcasts_size(stream)
+      end
+
+      assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
+    end
+
+    # Asserts that no messages have been sent to the stream.
+    #
+    #   def test_no_broadcasts
+    #     assert_no_broadcasts 'messages'
+    #     ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #     assert_broadcasts 'messages', 1
+    #   end
+    #
+    # If a block is passed, that block should not cause any message to be sent.
+    #
+    #   def test_broadcasts_again
+    #     assert_no_broadcasts 'messages' do
+    #       # No job messages should be sent from this block
+    #     end
+    #   end
+    #
+    # Note: This assertion is simply a shortcut for:
+    #
+    #   assert_broadcasts 'messages', 0, &block
+    #
+    def assert_no_broadcasts(stream, &block)
+      assert_broadcasts stream, 0, &block
+    end
+
+    # Asserts that the specified message has been sent to the stream.
+    #
+    #   def test_assert_transmitted_message
+    #     ActionCable.server.broadcast 'messages', text: 'hello'
+    #     assert_broadcast_on('messages', text: 'hello')
+    #   end
+    #
+    # If a block is passed, that block should cause a message with the specified data to be sent.
+    #
+    #   def test_assert_broadcast_on_again
+    #     assert_broadcast_on('messages', text: 'hello') do
+    #       ActionCable.server.broadcast 'messages', text: 'hello'
+    #     end
+    #   end
+    #
+    def assert_broadcast_on(stream, data)
+      # Encode to JSON and back–we want to use this value to compare
+      # with decoded JSON.
+      # Comparing JSON strings doesn't work due to the order of the keys.
+      serialized_msg =
+        ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
+
+      new_messages = broadcasts(stream)
+      if block_given?
+        old_messages = new_messages
+        clear_messages(stream)
+
+        yield
+        new_messages = broadcasts(stream)
+        clear_messages(stream)
+
+        # Restore all sent messages
+        (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
+      end
+
+      message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
+
+      assert message, "No messages sent with #{data} to #{stream}"
+    end
+
+    def pubsub_adapter # :nodoc:
+      ActionCable.server.pubsub
+    end
+
+    delegate :broadcasts, :clear_messages, to: :pubsub_adapter
+
+    private
+
+    def broadcasts_size(channel)
+      broadcasts(channel).size
+    end
+  end
+end

data/lib/rails_6_polyfills/activejob/serializers.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+# First add Rails 6.0 ActiveJob Serializers support, and then the
+# DurationSerializer and SymbolSerializer.
+module ActiveJob
+  module Arguments
+    # :nodoc:
+    OBJECT_SERIALIZER_KEY = "_aj_serialized"
+
+    def serialize_argument(argument)
+      case argument
+      when *TYPE_WHITELIST
+        argument
+      when GlobalID::Identification
+        convert_to_global_id_hash(argument)
+      when Array
+        argument.map { |arg| serialize_argument(arg) }
+      when ActiveSupport::HashWithIndifferentAccess
+        serialize_indifferent_hash(argument)
+      when Hash
+        symbol_keys = argument.each_key.grep(Symbol).map(&:to_s)
+        result = serialize_hash(argument)
+        result[SYMBOL_KEYS_KEY] = symbol_keys
+        result
+      when ->(arg) { arg.respond_to?(:permitted?) }
+        serialize_indifferent_hash(argument.to_h)
+      else # Add Rails 6 support for Serializers
+        Serializers.serialize(argument)
+      end
+    end
+
+    def deserialize_argument(argument)
+      case argument
+      when String
+        argument
+      when *TYPE_WHITELIST
+        argument
+      when Array
+        argument.map { |arg| deserialize_argument(arg) }
+      when Hash
+        if serialized_global_id?(argument)
+          deserialize_global_id argument
+        elsif custom_serialized?(argument)
+          Serializers.deserialize(argument)
+        else
+          deserialize_hash(argument)
+        end
+      else
+        raise ArgumentError, "Can only deserialize primitive arguments: #{argument.inspect}"
+      end
+    end
+
+    def custom_serialized?(hash)
+      hash.key?(OBJECT_SERIALIZER_KEY)
+    end
+  end
+
+  # The <tt>ActiveJob::Serializers</tt> module is used to store a list of known serializers
+  # and to add new ones. It also has helpers to serialize/deserialize objects.
+  module Serializers # :nodoc:
+    # Base class for serializing and deserializing custom objects.
+    #
+    # Example:
+    #
+    #   class MoneySerializer < ActiveJob::Serializers::ObjectSerializer
+    #     def serialize(money)
+    #       super("amount" => money.amount, "currency" => money.currency)
+    #     end
+    #
+    #     def deserialize(hash)
+    #       Money.new(hash["amount"], hash["currency"])
+    #     end
+    #
+    #     private
+    #
+    #       def klass
+    #         Money
+    #       end
+    #   end
+    class ObjectSerializer
+      include Singleton
+
+      class << self
+        delegate :serialize?, :serialize, :deserialize, to: :instance
+      end
+
+      # Determines if an argument should be serialized by a serializer.
+      def serialize?(argument)
+        argument.is_a?(klass)
+      end
+
+      # Serializes an argument to a JSON primitive type.
+      def serialize(hash)
+        {Arguments::OBJECT_SERIALIZER_KEY => self.class.name}.merge!(hash)
+      end
+
+      # Deserializes an argument from a JSON primitive type.
+      def deserialize(_argument)
+        raise NotImplementedError
+      end
+
+      private
+
+      # The class of the object that will be serialized.
+      def klass
+        raise NotImplementedError
+      end
+    end
+
+    class DurationSerializer < ObjectSerializer # :nodoc:
+      def serialize(duration)
+        super("value" => duration.value, "parts" => Arguments.serialize(duration.parts.each_with_object({}) { |v, s| s[v.first.to_s] = v.last }))
+      end
+
+      def deserialize(hash)
+        value = hash["value"]
+        parts = Arguments.deserialize(hash["parts"])
+
+        klass.new(value, parts)
+      end
+
+      private
+
+      def klass
+        ActiveSupport::Duration
+      end
+    end
+
+    class SymbolSerializer < ObjectSerializer # :nodoc:
+      def serialize(argument)
+        super("value" => argument.to_s)
+      end
+
+      def deserialize(argument)
+        argument["value"].to_sym
+      end
+
+      private
+
+      def klass
+        Symbol
+      end
+    end
+
+    # -----------------------------
+
+    mattr_accessor :_additional_serializers
+    self._additional_serializers = Set.new
+
+    class << self
+      # Returns serialized representative of the passed object.
+      # Will look up through all known serializers.
+      # Raises <tt>ActiveJob::SerializationError</tt> if it can't find a proper serializer.
+      def serialize(argument)
+        serializer = serializers.detect { |s| s.serialize?(argument) }
+        raise SerializationError.new("Unsupported argument type: #{argument.class.name}") unless serializer
+        serializer.serialize(argument)
+      end
+
+      # Returns deserialized object.
+      # Will look up through all known serializers.
+      # If no serializer found will raise <tt>ArgumentError</tt>.
+      def deserialize(argument)
+        serializer_name = argument[Arguments::OBJECT_SERIALIZER_KEY]
+        raise ArgumentError, "Serializer name is not present in the argument: #{argument.inspect}" unless serializer_name
+
+        serializer = serializer_name.safe_constantize
+        raise ArgumentError, "Serializer #{serializer_name} is not known" unless serializer
+
+        serializer.deserialize(argument)
+      end
+
+      # Returns list of known serializers.
+      def serializers
+        self._additional_serializers # standard:disable Style/RedundantSelf
+      end
+
+      # Adds new serializers to a list of known serializers.
+      def add_serializers(*new_serializers)
+        self._additional_serializers += new_serializers.flatten
+      end
+    end
+
+    add_serializers DurationSerializer,
+      SymbolSerializer
+    # The full set of 6 serializers that Rails 6.0 normally adds here -- feel free to include any others if you wish:
+    # SymbolSerializer,
+    # DurationSerializer, # (The one that we've added above in order to support testing)
+    # DateTimeSerializer,
+    # DateSerializer,
+    # TimeWithZoneSerializer,
+    # TimeSerializer
+  end
+
+  # Is the updated version of perform_enqueued_jobs from Rails 6.0 missing from ActionJob's TestHelper?
+  unless TestHelper.private_instance_methods.include?(:flush_enqueued_jobs)
+    module TestHelper
+      def perform_enqueued_jobs(only: nil, except: nil, queue: nil)
+        return flush_enqueued_jobs(only: only, except: except, queue: queue) unless block_given?
+
+        super
+      end
+
+      private
+
+      def jobs_with(jobs, only: nil, except: nil, queue: nil)
+        validate_option(only: only, except: except)
+
+        jobs.count do |job|
+          job_class = job.fetch(:job)
+
+          if only
+            next false unless filter_as_proc(only).call(job)
+          elsif except
+            next false if filter_as_proc(except).call(job)
+          end
+
+          if queue
+            next false unless queue.to_s == job.fetch(:queue, job_class.queue_name)
+          end
+
+          yield job if block_given?
+
+          true
+        end
+      end
+
+      def enqueued_jobs_with(only: nil, except: nil, queue: nil, &block)
+        jobs_with(enqueued_jobs, only: only, except: except, queue: queue, &block)
+      end
+
+      def flush_enqueued_jobs(only: nil, except: nil, queue: nil)
+        enqueued_jobs_with(only: only, except: except, queue: queue) do |payload|
+          instantiate_job(payload).perform_now
+          queue_adapter.performed_jobs << payload
+        end
+      end
+    end
+  end
+end

data/lib/rails_6_polyfills/base.rb

@@ -0,0 +1,18 @@
+# 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"
+    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"
+    module SubscriptionAdapter
+      autoload :Test, "rails_6_polyfills/actioncable/test_adapter.rb"
+    end
+  end
+end
+
+# If the Rails 6.0 ActionJob Serializers are missing then load support for them
+unless Object.const_defined?("ActiveJob::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.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -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/ios.rb
 - lib/noticed/delivery_methods/microsoft_teams.rb
 - lib/noticed/delivery_methods/slack.rb
 - lib/noticed/delivery_methods/test.rb
@@ -144,6 +145,10 @@ files:
 - lib/noticed/text_coder.rb
 - lib/noticed/translation.rb
 - lib/noticed/version.rb
+- lib/rails_6_polyfills/actioncable/test_adapter.rb
+- lib/rails_6_polyfills/actioncable/test_helper.rb
+- lib/rails_6_polyfills/activejob/serializers.rb
+- lib/rails_6_polyfills/base.rb
 - lib/tasks/noticed_tasks.rake
 homepage: https://github.com/excid3/noticed
 licenses:
@@ -164,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications