noticed 1.2.16 → 1.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b37e7d17da790342493c2ffc575cc5d013ac156b7ac600fb0022c79bcb034de
-  data.tar.gz: 87fc46cbf6829e174b0dc6df1751187965e645f7461848469e48a2ea7bcb6a46
+  metadata.gz: 5dc2e5f50621a5b5da4f901c472621c2fce03d5f0f4db7c5a00a42de527e3128
+  data.tar.gz: 1e07d7ea3599b7999d9a252a062ab38641cf6553c8392bf54d70ec9fbc164050
 SHA512:
-  metadata.gz: b9b4db6825f88670f27d768f40724fbd22c2f8e92fc6ce5f3bc32650cc9e77475d3c6eecb51fd7f59b10d70e735f648c92ecdae6f6d4b8ff61ff4b5c39e501d3
-  data.tar.gz: f474ad70283d4faa9b33bd51346acb64b29a4076b9c9c0ffcff58e60f75d331bc54b162a8e3d77310153d39caf898ac2924b234389b1089b3262b35fa7b48ac3
+  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)
 
@@ -253,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.
@@ -440,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/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

@@ -106,7 +106,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/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

@@ -42,6 +42,10 @@ module Noticed
       update(read_at: Time.current)
     end
 
+    def mark_as_unread!
+      update(read_at: nil)
+    end
+
     def unread?
       !read?
     end

data/lib/noticed/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.16
+  version: 1.2.17
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,6 +104,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