noticed 1.2.15 → 1.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69785568f3cfb7b464a3dfbb7ce8bd0813acbdcd3f96059122c2a9b24ade12d2
-  data.tar.gz: 3c9464383b48f2df3605b7aa1062519e867f2ebfae7dde21ccc25ac69afab258
+  metadata.gz: e5b998072ed72c9844842d8610a9ffcea75cf16f958296aa3d53e1a3c050b6db
+  data.tar.gz: 589f43985b3dc7740977730d10917d0b111706fe56c4daafedbacc08e7f2ce84
 SHA512:
-  metadata.gz: 539e60472bad43dd44239ecbcbd79ad9dff86cb8105d7923657e62ffa6b1fe9a3ef6ced17b823597e907645ec5837985aaee7cc7da8b2f89f7d85fa1b6b881bd
-  data.tar.gz: 34bb2249fafab5002d569ddd267a3944e43e03b51a793ed162c3166900699b658efdb8ace15a3a6dca29000aa68787046732d2d1df88b31468fc096ffd18641f
+  metadata.gz: 9f4a336ed688008a5abc3f91099a5ecc4128361beffd216e0e2e0bc0a1670286e607577d2f4ce13f1e36c2fb2fff3d93fbab9a10914d0321a2d1e0c2449ea715
+  data.tar.gz: b4a67b79dcf34892dcd11b56ad83e2c393a2da49c3eb38e3e911411164b4150ec27a836e53d1d7875ea40141276a398878e8c23304c326287299b26bafebacba

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)
 
@@ -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
@@ -104,6 +106,7 @@ end
 
 * `if: :method_name`  - Calls `method_name`and cancels delivery method if `false` is returned
 * `unless: :method_name`  - Calls `method_name`and cancels delivery method if `true` is returned
+* `delay: ActiveSupport::Duration` - Delays the delivery for the given duration of time
 
 ##### Helper Methods
 
@@ -113,6 +116,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.
@@ -178,7 +187,7 @@ 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.
+**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
 
@@ -246,6 +255,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.
@@ -342,19 +387,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 +420,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 +444,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"
@@ -414,10 +464,19 @@ Sorting notifications by newest first:
 user.notifications.newest_first
 ```
 
-Marking all notifications as read:
+Query for read or unread notifications:
+
+```ruby
+user.notifications.read
+user.notifications.unread
+```
+
+
+Marking all notifications as read or unread:
 
 ```ruby
 user.notifications.mark_as_read!
+user.notifications.mark_as_unread!
 ```
 
 #### Instance methods
@@ -428,10 +487,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:
@@ -471,7 +531,7 @@ class Post < ApplicationRecord
 end
 ```
 
-##### Polymorphic Assocation
+##### Polymorphic Association
 
 If your notification is only associated with one model or you're using a `text` column for your params column , then a polymorphic association is what you'll want to use.
 

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.rb

@@ -16,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 = {})
@@ -85,9 +85,6 @@ module Noticed
 
     # Actually runs an individual delivery
     def run_delivery_method(delivery_method, recipient:, enqueue:)
-      return if (delivery_method_name = delivery_method.dig(:options, :if)) && !send(delivery_method_name)
-      return if (delivery_method_name = delivery_method.dig(:options, :unless)) && send(delivery_method_name)
-
       args = {
         notification_class: self.class.name,
         options: delivery_method[:options],
@@ -98,7 +95,15 @@ module Noticed
 
       run_callbacks delivery_method[:name] do
         method = delivery_method_for(delivery_method[:name], delivery_method[:options])
-        enqueue ? method.perform_later(args) : method.perform_now(args)
+
+        # Always perfrom later if a delay is present
+        if (delay = delivery_method.dig(:options, :delay))
+          method.set(wait: delay).perform_later(args)
+        elsif enqueue
+          method.perform_later(args)
+        else
+          method.perform_now(args)
+        end
       end
     end
 
@@ -106,7 +111,7 @@ module Noticed
       if options[:class]
         options[:class].constantize
       else
-        "Noticed::DeliveryMethods::#{name.to_s.classify}".constantize
+        "Noticed::DeliveryMethods::#{name.to_s.camelize}".constantize
       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,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]
@@ -17,6 +40,9 @@ module Noticed
         @notification.record = args[:record]
         @notification.recipient = args[:recipient]
 
+        return if (condition = @options[:if]) && !@notification.send(condition)
+        return if (condition = @options[:unless]) && @notification.send(condition)
+
         run_callbacks :deliver do
           deliver
         end
@@ -26,11 +52,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/database.rb

@@ -6,6 +6,13 @@ module Noticed
         recipient.send(association_name).create!(attributes)
       end
 
+      def self.validate!(options)
+        super
+
+        # Must be executed right away so the other deliveries can access the db record
+        raise ArgumentError, "database delivery cannot be delayed" if options.key?(:delay)
+      end
+
       private
 
       def association_name

data/lib/noticed/delivery_methods/email.rb

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

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/delivery_methods/vonage.rb

@@ -7,6 +7,8 @@ module Noticed
         if !options[:ignore_failure] && status != "0"
           raise ResponseUnsuccessful.new(response)
         end
+
+        response
       end
 
       private

data/lib/noticed/model.rb

@@ -14,11 +14,15 @@ module Noticed
       scope :read, -> { where.not(read_at: nil) }
     end
 
-    module ClassMethods
+    class_methods do
       def mark_as_read!
         update_all(read_at: Time.current, updated_at: Time.current)
       end
 
+      def mark_as_unread!
+        update_all(read_at: nil, updated_at: Time.current)
+      end
+
       def noticed_coder
         case attribute_types["params"].type
         when :json, :jsonb
@@ -32,16 +36,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.15"
+  VERSION = "1.2.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.15
+  version: 1.2.20
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -104,6 +118,7 @@ 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
@@ -119,7 +134,7 @@ homepage: https://github.com/excid3/noticed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +149,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: []