noticed 1.2.12 → 1.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fca882449d4696c1551badc82383f789610f19898dec345a64f33a225ca9f81
-  data.tar.gz: 8751afe5063970449573719d7bedb957d7c88e52f1efef96357d8754d48cec21
+  metadata.gz: 5dc2e5f50621a5b5da4f901c472621c2fce03d5f0f4db7c5a00a42de527e3128
+  data.tar.gz: 1e07d7ea3599b7999d9a252a062ab38641cf6553c8392bf54d70ec9fbc164050
 SHA512:
-  metadata.gz: 8ab4f29e4611ee0e5c3f548562e0265dc991ca45cb4789fbf7eb780430b21eddaef3407fbc7946f21bbff411149dd8e796197d9d0b334d85d8085aaea7beb54a
-  data.tar.gz: 7c6ce9b53092a182e405fc26274daae30e8ec6e2149c5f5794d3fa5c3728210f013f632c844dd00f9ad5f1d64cba12b09de6c311b9d367b580d91f899affb4c4
+  metadata.gz: 5f2dc0a1735bea8161241f7b384f722fd0a0d5bf1bac80424d63647d39cf9ef727839f3ba8320474c57da327e381daa46c533a788ca7d3ea1978c5eee10dcbfc
+  data.tar.gz: 44eb3c5472b947d416d6f14bb2fa1b6a6d9ed26e853eb5d5ca559c0467c0dea9b83634fb1aac72a691b8fbd7805103e3029562e0800d0f433d2ecd9ab5a4e4d1

data/README.md

@@ -12,6 +12,7 @@ Currently, we support these notification delivery methods out of the box:
 * Email
 * ActionCable channels
 * Slack
+* Microsoft Teams
 * Twilio (SMS)
 * Vonage / Nexmo (SMS)
 
@@ -78,7 +79,7 @@ To add delivery methods, simply `include` the module for the delivery methods yo
 class CommentNotification < Noticed::Base
   deliver_by :database
   deliver_by :action_cable
-  deliver_by :email, if: :email_notifications?
+  deliver_by :email, mailer: 'CommentMailer', if: :email_notifications?
 
   # I18n helpers
   def message
@@ -86,6 +87,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 +115,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.
@@ -120,7 +128,7 @@ Like ActiveRecord, notifications have several different types of callbacks.
 ```ruby
 class CommentNotification < Noticed::Base
   deliver_by :database
-  deliver_by :email
+  deliver_by :email, mailer: 'CommentMailer'
 
   # Callbacks for the entire delivery
   before_deliver :whatever
@@ -158,7 +166,7 @@ For example:
 
 ```ruby
 class CommentNotification < Noticed::Base
-  deliver_by :email, if: :email_notifications?
+  deliver_by :email, mailer: 'CommentMailer', if: :email_notifications?
 
   def email_notifications?
     recipient.email_notifications?
@@ -246,6 +254,42 @@ Sends a Slack notification via webhook.
 
   Defaults to `Rails.application.credentials.slack[:notification_url]`
 
+### 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 slack. 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.
@@ -340,6 +384,45 @@ Delivery methods have access to the following methods and attributes:
 * `recipient` - The object who should receive the notification. This is typically a User, Account, or other ActiveRecord model.
 * `params` - The params passed into the notification. This is details about the event that happened. For example, a user commenting on a post would have params of `{ user: User.first }`
 
+#### Validating options passed to Custom Delivery methods
+
+The presence of the delivery method options is automatically validated if using the `option(s)` 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!(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
+
+class CommentNotification < Noticed::Base
+  deliver_by :discord, class: 'DeliveryMethods::Discord'
+end
+```
+
+Now it will raise an error because a required argument is missing.
+
+To fix the error, the argument has to be passed correctly. For example:
+
+```ruby
+class CommentNotification < Noticed::Base
+  deliver_by :discord, class: 'DeliveryMethods::Discord', username: User.admin.username
+end
+```
+
 #### Callbacks
 
 Callbacks for delivery methods wrap the *actual* delivery of the notification. You can use `before_deliver`, `around_deliver` and `after_deliver` in your custom delivery methods.
@@ -360,7 +443,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"
@@ -394,10 +477,11 @@ Convert back into a Noticed notification object:
 @notification.to_notification
 ```
 
-Mark notification as read:
+Mark notification as read / unread:
 
 ```ruby
 @notification.mark_as_read!
+@notification.mark_as_unread!
 ```
 
 Check if read / unread:

data/lib/generators/noticed/model_generator.rb

@@ -15,13 +15,22 @@ 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
         inject_into_class model_path, class_name, "  include Noticed::Model\n"
       end
 
+      def add_not_nullable
+        migration_path = Dir.glob(Rails.root.join("db/migrate/*")).max_by { |f| File.mtime(f) }
+
+        # Force is required because null: false already exists in the file and Thor isn't smart enough to tell the difference
+        insert_into_file migration_path, after: "t.string :type", force: true do
+          ", null: false"
+        end
+      end
+
       def done
         readme "README" if behavior == :invoke
       end
@@ -34,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/generators/noticed/templates/delivery_method.rb.tt

@@ -2,4 +2,11 @@ class DeliveryMethods::<%= class_name %> < Noticed::DeliveryMethods::Base
   def deliver
     # Logic for sending the notification
   end
+
+  # You may override this method to validate options for the delivery method
+  # Invalid options should raise a ValidationError
+  #
+  # def self.validate!(options)
+  #   raise ValidationError, "required_option missing" unless options[:required_option]
+  # end
 end

data/lib/noticed.rb

@@ -8,6 +8,7 @@ module Noticed
   autoload :Model, "noticed/model"
   autoload :TextCoder, "noticed/text_coder"
   autoload :Translation, "noticed/translation"
+  autoload :NotificationChannel, "noticed/notification_channel"
 
   module DeliveryMethods
     autoload :Base, "noticed/delivery_methods/base"
@@ -15,6 +16,7 @@ module Noticed
     autoload :Database, "noticed/delivery_methods/database"
     autoload :Email, "noticed/delivery_methods/email"
     autoload :Slack, "noticed/delivery_methods/slack"
+    autoload :MicrosoftTeams, "noticed/delivery_methods/microsoft_teams"
     autoload :Test, "noticed/delivery_methods/test"
     autoload :Twilio, "noticed/delivery_methods/twilio"
     autoload :Vonage, "noticed/delivery_methods/vonage"

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 = {})
@@ -97,27 +97,38 @@ module Noticed
       }
 
       run_callbacks delivery_method[:name] do
-        klass = get_class(delivery_method[:name], delivery_method[:options])
-        enqueue ? klass.perform_later(args) : klass.perform_now(args)
+        method = delivery_method_for(delivery_method[:name], delivery_method[:options])
+        enqueue ? method.perform_later(args) : method.perform_now(args)
       end
     end
 
-    # Retrieves the correct class for a delivery method
-    def get_class(name, options)
+    def delivery_method_for(name, options)
       if options[:class]
         options[:class].constantize
       else
-        "Noticed::DeliveryMethods::#{name.to_s.classify}".constantize
+        "Noticed::DeliveryMethods::#{name.to_s.camelize}".constantize
       end
     end
 
-    # Validates that all params are present
     def validate!
+      validate_params_present!
+      validate_options_of_delivery_methods!
+    end
+
+    # Validates that all params are present
+    def validate_params_present!
       self.class.param_names.each do |param_name|
         if params[param_name].nil?
           raise ValidationError, "#{param_name} is missing."
         end
       end
     end
+
+    def validate_options_of_delivery_methods!
+      delivery_methods.each do |delivery_method|
+        method = delivery_method_for(delivery_method[:name], delivery_method[:options])
+        method.validate!(delivery_method[:options])
+      end
+    end
   end
 end

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,11 +4,35 @@ module Noticed
       extend ActiveModel::Callbacks
       define_model_callbacks :deliver
 
-      attr_reader :notification, :options, :recipient, :record
+      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]
+        @params = args[:params]
         @recipient = args[:recipient]
         @record = args[:record]
 

data/lib/noticed/delivery_methods/email.rb

@@ -1,6 +1,8 @@
 module Noticed
   module DeliveryMethods
     class Email < Base
+      option :mailer
+
       def deliver
         mailer.with(format).send(method.to_sym).deliver_later
       end

data/lib/noticed/delivery_methods/microsoft_teams.rb

@@ -0,0 +1,32 @@
+module Noticed
+  module DeliveryMethods
+    class MicrosoftTeams < Base
+      def deliver
+        post(url, json: format)
+      end
+
+      private
+
+      def format
+        if (method = options[:format])
+          notification.send(method)
+        else
+          {
+            title: notification.params[:title],
+            text: notification.params[:text],
+            sections: notification.params[:sections],
+            potentialAction: notification.params[:notification_action]
+          }
+        end
+      end
+
+      def url
+        if (method = options[:url])
+          notification.send(method)
+        else
+          Rails.application.credentials.microsoft_teams[:notification_url]
+        end
+      end
+    end
+  end
+end

data/lib/noticed/model.rb

@@ -32,16 +32,20 @@ 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!
       update(read_at: Time.current)
     end
 
+    def mark_as_unread!
+      update(read_at: nil)
+    end
+
     def unread?
       !read?
     end

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.12"
+  VERSION = "1.2.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.12
+  version: 1.2.17
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,7 +91,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/channels/noticed/notification_channel.rb
 - lib/generators/noticed/delivery_method_generator.rb
 - lib/generators/noticed/model_generator.rb
 - lib/generators/noticed/notification_generator.rb
@@ -105,12 +104,14 @@ files:
 - lib/noticed/delivery_methods/base.rb
 - lib/noticed/delivery_methods/database.rb
 - lib/noticed/delivery_methods/email.rb
+- lib/noticed/delivery_methods/microsoft_teams.rb
 - lib/noticed/delivery_methods/slack.rb
 - lib/noticed/delivery_methods/test.rb
 - lib/noticed/delivery_methods/twilio.rb
 - lib/noticed/delivery_methods/vonage.rb
 - lib/noticed/engine.rb
 - lib/noticed/model.rb
+- lib/noticed/notification_channel.rb
 - lib/noticed/text_coder.rb
 - lib/noticed/translation.rb
 - lib/noticed/version.rb
@@ -119,7 +120,7 @@ homepage: https://github.com/excid3/noticed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +135,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: []