msteams_hermes 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cf0e67a3baf8adb2febaabec358bc95bdbb4bd05b22a9cd3f73f2b3438690ab
-  data.tar.gz: 28004b92b73f486f1f7a4cdc9a182989bb6b89ee0cb440d88b9cf972e35c82f5
+  metadata.gz: 9b669c1e292e83f5cd4ade218b5746fd43d510992f5a5b2ef8db6c0fa50d8799
+  data.tar.gz: a188b10e541fc0c5d471b872c20c2cc15a0852c95bea444da8d0bd2b179c2dc1
 SHA512:
-  metadata.gz: f175e08b3de73132ac2b5893ae66e7f6e2312e76fa1018a0ea5a319f65f3a707ed9e8d01169e71e40eca42d5e1d5bcf52610c522cb905be631536924027b8e9c
-  data.tar.gz: 8d41d5c53012d6e3aff9d830283026762e30e81d87b289e559fde21377660090108ae1c14a84fa59d544fced6a8729aab01f1f6b4670668bcd13e3855d9f681c
+  metadata.gz: d320bd149716475e1be084bede6a3443a53263cfb77df1a8f163f8257465f9422d71ca7149447a769bf1860efe3ceb95f38e5b2a0a3ac3b993565d7abfa7e9b9
+  data.tar.gz: 5d68eea1cdb86d0c2383881f4a334c8952650513c51aa883e06f2290fd366a9758fae12503d270350b40390102e3009b8c878b1d15150f1585663c178508dd01

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changelog
 
+## [1.1.0] - 2023-01-24
+- Add support for @mentions
+
 ## [1.0.0] - 2022-09-02
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    msteams_hermes (1.0.0)
+    msteams_hermes (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/complex_example.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require "msteams_hermes/actions/open_url"

data/lib/msteams_hermes/components/adaptive_card.rb

@@ -12,14 +12,17 @@ module MsTeamsHermes
     # https://adaptivecards.io/explorer/AdaptiveCard.html
     ##
     class AdaptiveCard < Base
-      attr_reader :body, :actions
+      attr_reader :body, :actions, :entities
 
-      def initialize(body:, actions: nil)
+      def initialize(body:, actions: nil, entities: [])
         @body = body
         raise "AdaptiveCard `body` must be an Array" unless @body.is_a? Array
 
         @actions = actions
         raise "AdaptiveCard `actions` must be an Array" unless @actions.nil? || @actions.is_a?(Array)
+
+        @entities = entities
+        raise "AdaptiveCard `entities` must be an Array" unless @entities.nil? || @entities.is_a?(Array)
       end
 
       def to_hash
@@ -27,7 +30,8 @@ module MsTeamsHermes
           type: "AdaptiveCard",
           version: "1.5",
           body: body.map(&:to_hash),
-          actions: actions&.map(&:to_hash)
+          actions: actions&.map(&:to_hash),
+          msteams: { entities: entities.map(&:to_hash) }
         }
       end
     end

data/lib/msteams_hermes/components/base.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "msteams_hermes/components/base"
-
 module MsTeamsHermes
   ##
   # Module containing Microsoft's components representations

data/lib/msteams_hermes/msteams/entities/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  module MsTeams
+    module Entities
+      # Super class for entities to enforce overridding the `to_hash` method
+      class Base
+        def to_hash
+          raise "Should be implemented on the subclass"
+        end
+      end
+    end
+  end
+end

data/lib/msteams_hermes/msteams/entities/mention.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/msteams/entities/base"
+
+module MsTeamsHermes
+  module MsTeams
+    module Entities
+      ##
+      # A class representing Microsoft's Msteams.Mention object
+      # https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format?tabs=adaptive-md%2Cdesktop%2Cconnector-html#user-mention-in-incoming-webhook-with-adaptive-cards
+      ##
+      class Mention < Base
+        attr_reader :mention_reference, :mention_string, :user_id
+
+        def initialize(text:, name:, id:)
+          raise "`text` must be a string" unless text.is_a? String
+          raise "`text` must contain <at>...</at>" unless text.include?("<at>") && text.include?("</at>")
+          raise "`id` must be a string" unless text.is_a? String
+
+          @mention_reference = text # String surrounded by <at>string</at> that marks the mention section in a text
+          @mention_string = name # allows for overriding the mention_reference
+          @user_id = id
+        end
+
+        def to_hash
+          {
+            type: "mention",
+            text: mention_reference,
+            mentioned: {
+              id: user_id,
+              name: mention_string
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/msteams_hermes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MsTeamsHermes
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msteams_hermes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rafael Rocha
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies: []
 description: This gem helps you sending messages to your Microsoft Teams channels.
   With autonomy to create your own layouts, like UI kits such as React, Flutter, SwiftUI
@@ -45,6 +45,8 @@ files:
 - lib/msteams_hermes/components/fact_set.rb
 - lib/msteams_hermes/components/text_block.rb
 - lib/msteams_hermes/message.rb
+- lib/msteams_hermes/msteams/entities/base.rb
+- lib/msteams_hermes/msteams/entities/mention.rb
 - lib/msteams_hermes/style.rb
 - lib/msteams_hermes/style/colors.rb
 - lib/msteams_hermes/style/container_style.rb
@@ -75,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Send messages to any Microsoft Teams' channel as easy as possible.