noticed 1.2.15 → 1.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69785568f3cfb7b464a3dfbb7ce8bd0813acbdcd3f96059122c2a9b24ade12d2
-  data.tar.gz: 3c9464383b48f2df3605b7aa1062519e867f2ebfae7dde21ccc25ac69afab258
+  metadata.gz: 3b37e7d17da790342493c2ffc575cc5d013ac156b7ac600fb0022c79bcb034de
+  data.tar.gz: 87fc46cbf6829e174b0dc6df1751187965e645f7461848469e48a2ea7bcb6a46
 SHA512:
-  metadata.gz: 539e60472bad43dd44239ecbcbd79ad9dff86cb8105d7923657e62ffa6b1fe9a3ef6ced17b823597e907645ec5837985aaee7cc7da8b2f89f7d85fa1b6b881bd
-  data.tar.gz: 34bb2249fafab5002d569ddd267a3944e43e03b51a793ed162c3166900699b658efdb8ace15a3a6dca29000aa68787046732d2d1df88b31468fc096ffd18641f
+  metadata.gz: b9b4db6825f88670f27d768f40724fbd22c2f8e92fc6ce5f3bc32650cc9e77475d3c6eecb51fd7f59b10d70e735f648c92ecdae6f6d4b8ff61ff4b5c39e501d3
+  data.tar.gz: f474ad70283d4faa9b33bd51346acb64b29a4076b9c9c0ffcff58e60f75d331bc54b162a8e3d77310153d39caf898ac2924b234389b1089b3262b35fa7b48ac3

data/README.md

@@ -86,6 +86,7 @@ class CommentNotification < Noticed::Base
   end
 
   # URL helpers are accessible in notifications
+  # Don't forget to set your default_url_options so Rails knows how to generate urls
   def url
     post_path(params[:post])
   end
@@ -113,6 +114,12 @@ You can define helper methods inside your Notification object to make it easier
 
 Rails url helpers are included in notification classes by default so you have full access to them just like you would in your controllers and views.
 
+Don't forget, you'll need to configure `default_url_options` in order for Rails to know what host and port to use when generating URLs.
+
+```ruby
+Rails.application.routes.default_url_options[:host] = 'localhost:3000'
+```
+
 **Callbacks**
 
 Like ActiveRecord, notifications have several different types of callbacks.
@@ -342,19 +349,24 @@ Delivery methods have access to the following methods and attributes:
 
 #### Validating options passed to Custom Delivery methods
 
-You can validate the options passed to the custom delivery method and raise validation errors. This is helpful for debugging to make sure valid and required options were passed in.
+The presence of the delivery method options is automatically validated if using the `option(s)` method.
 
-To do this, simply override the `self.validate!(options)` method from the `Noticed::DeliveryMethods::Base` class in your Custom Delivery method.
+If you want to validate that the passed options contain valid values, or to add any custom validations, override the `self.validate!(delivery_method_options)` method from the `Noticed::DeliveryMethods::Base` class.
 
 ```ruby
 class DeliveryMethods::Discord < Noticed::DeliveryMethods::Base
+  option :username # Requires the username option to be passed
+
   def deliver
     # Logic for sending a Discord notification
   end
 
-  def self.validate!(options)
-    unless options.key?(:sent_by)
-      raise Noticed::ValidationError, 'the `sent_by` option is missing'
+  def self.validate!(delivery_method_options)
+    super # Don't forget to call super, otherwise option presence won't be validated
+
+    # Custom validations
+    if delivery_method_options[:username].blank?
+      raise Noticed::ValidationError, 'the `username` option must be present'
     end
   end
 end
@@ -370,7 +382,7 @@ To fix the error, the argument has to be passed correctly. For example:
 
 ```ruby
 class CommentNotification < Noticed::Base
-  deliver_by :discord, class: 'DeliveryMethods::Discord', sent_by: User.admin.first
+  deliver_by :discord, class: 'DeliveryMethods::Discord', username: User.admin.username
 end
 ```
 
@@ -394,7 +406,7 @@ Rails 6.1+ can serialize Class and Module objects as arguments to ActiveJob. The
   deliver_by DeliveryMethods::Discord
 ```
 
-For Rails 6.0 and earlier, you must pass strings of the class names in the `deliver_by` options.
+For Rails 6.0, you must pass strings of the class names in the `deliver_by` options.
 
 ```ruby
   deliver_by :discord, class: "DeliveryMethods::Discord"

data/lib/generators/noticed/model_generator.rb

@@ -15,7 +15,7 @@ module Noticed
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
       def generate_notification
-        generate :model, name, "recipient:references{polymorphic}", "type", params_column, "read_at:datetime", *attributes
+        generate :model, name, "recipient:references{polymorphic}", "type", params_column, "read_at:datetime:index", *attributes
       end
 
       def add_noticed_model
@@ -43,7 +43,7 @@ module Noticed
 
       def params_column
         case ActiveRecord::Base.configurations.configs_for(spec_name: "primary").config["adapter"]
-        when "mysql"
+        when "mysql2"
           "params:json"
         when "postgresql"
           "params:jsonb"

data/lib/noticed/base.rb

@@ -32,7 +32,7 @@ module Noticed
       def params(*names)
         param_names.concat Array.wrap(names)
       end
-      alias param params
+      alias_method :param, :params
     end
 
     def initialize(params = {})

data/lib/noticed/delivery_methods/action_cable.rb

@@ -17,18 +17,18 @@ module Noticed
 
       def channel
         @channel ||= begin
-           value = options[:channel]
-           case value
-           when String
-             value.constantize
-           when Symbol
-             notification.send(value)
-           when Class
-             value
-           else
-             Noticed::NotificationChannel
-           end
-         end
+          value = options[:channel]
+          case value
+          when String
+            value.constantize
+          when Symbol
+            notification.send(value)
+          when Class
+            value
+          else
+            Noticed::NotificationChannel
+          end
+        end
       end
     end
   end

data/lib/noticed/delivery_methods/base.rb

@@ -4,8 +4,31 @@ module Noticed
       extend ActiveModel::Callbacks
       define_model_callbacks :deliver
 
+      class_attribute :option_names, instance_writer: false, default: []
+
       attr_reader :notification, :options, :params, :recipient, :record
 
+      class << self
+        # Copy option names from parent
+        def inherited(base) #:nodoc:
+          base.option_names = option_names.dup
+          super
+        end
+
+        def options(*names)
+          option_names.concat Array.wrap(names)
+        end
+        alias_method :option, :options
+
+        def validate!(delivery_method_options)
+          option_names.each do |option_name|
+            unless delivery_method_options.key? option_name
+              raise ValidationError, "option `#{option_name}` must be set for #{name}"
+            end
+          end
+        end
+      end
+
       def perform(args)
         @notification = args[:notification_class].constantize.new(args[:params])
         @options = args[:options]
@@ -26,11 +49,6 @@ module Noticed
         raise NotImplementedError, "Delivery methods must implement a deliver method"
       end
 
-      def self.validate!(options)
-        # Override this method in your custom DeliveryMethod class to validate the options
-        # and raise error, if invalid.
-      end
-
       private
 
       # Helper method for making POST requests from delivery methods

data/lib/noticed/delivery_methods/email.rb

@@ -1,16 +1,12 @@
 module Noticed
   module DeliveryMethods
     class Email < Base
+      option :mailer
+
       def deliver
         mailer.with(format).send(method.to_sym).deliver_later
       end
 
-      def self.validate!(options)
-        unless options.key?(:mailer)
-          raise ValidationError, "email delivery method requires a 'mailer' to be specified"
-        end
-      end
-
       private
 
       def mailer

data/lib/noticed/model.rb

@@ -32,10 +32,10 @@ module Noticed
     # Rehydrate the database notification into the Notification object for rendering
     def to_notification
       @_notification ||= begin
-                      instance = type.constantize.with(params)
-                      instance.record = self
-                      instance
-                    end
+        instance = type.constantize.with(params)
+        instance.record = self
+        instance
+      end
     end
 
     def mark_as_read!

data/lib/noticed/translation.rb

@@ -10,7 +10,7 @@ module Noticed
     def translate(key, **options)
       I18n.translate(scope_translation_key(key), **options)
     end
-    alias t translate
+    alias_method :t, :translate
 
     def scope_translation_key(key)
       if key.to_s.start_with?(".")

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.2.15"
+  VERSION = "1.2.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.15
+  version: 1.2.16
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -119,7 +119,7 @@ homepage: https://github.com/excid3/noticed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications
 test_files: []