msteams_hermes 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 207fc7cd400e6d5acffe10bbb62b10b055ef3c26479901abbdcd582790484cc7
-  data.tar.gz: febe827ff6ce1a4e2c0984e0856fe8208b1548a1055fc81b9876ddebd8208d54
+  metadata.gz: 4b3cdc7a7dfce17ff21c71884f2e774845e1ba7fe89a2c9ead3445f88a40c544
+  data.tar.gz: c509e71637183ffa574dedb800be337f06f07c04869e8a0bfef61d5b7e20f2b6
 SHA512:
-  metadata.gz: 666bff112d33464b14e71fbc259b31a4a262d585fdb6038eeac34ccfe93e064755a3d43986844eb7bfa94db67a0b8555a2d080bd984e0d6799bd040996887561
-  data.tar.gz: 56436076d4550034a3e98acbe78c6c7bc45fce73efc9165f265fa66f815001e9f3128c9b54ec0b78ab5b4bf412a94e749315c6379f5ec8b6518de507f25fd182
+  metadata.gz: 6f2d422662a3846abd375126115db6ce6a008a67e811fb8563a4d6955d328e80df3591d3049e463fc65b29a0f41ccd4f66595a1cbaddab0811c40de40ecc9e82
+  data.tar.gz: e0c7a189f4a9be321c068efef20aaafe5244095f2b6617006940c92f10bc93ce1e4dcfe462aa7f6e1066ddee1398a611eaa66dbc971124928a8273c7a233b9bb

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changelog
 
+## [1.2.0] - 2024-12-20
+- Add support for MSTeams workflow based webhooks
+
 ## [1.1.1] - 2023-01-24
 - Prevent causing 413 response from microsoft teams webhook
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    msteams_hermes (1.1.1)
+    msteams_hermes (1.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -35,8 +35,8 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.4)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)

data/complex_example.rb

@@ -19,7 +19,7 @@ header = MsTeamsHermes::Components::Container.new(
       weight: MsTeamsHermes::Style::FontWeight::BOLDER
     ),
     MsTeamsHermes::Components::TextBlock.new(
-      text: "Saturday, 1 January 2022"
+      text: Time.now.strftime("%A, %d %B %Y %H:%M:%S").to_s
     )
   ]
 )

data/lib/msteams_hermes/message.rb

@@ -3,6 +3,15 @@
 require "net/http"
 require "json"
 
+##
+# Module to encapsulate the logic that decides whether a given response
+# is of type workflow or connector type webhook.
+# Both types must be considered differently to support both types of
+# MSTeams webhooks.
+##
+module MsTeamsWebhookType
+end
+
 module MsTeamsHermes
   ##
   # A class representing Microsoft's webhook message object
@@ -62,15 +71,12 @@ module MsTeamsHermes
 
         response = http.request(req)
 
-        # For details see:
-        # https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?tabs=cURL%2Ctext1#send-messages-using-curl-and-powershell
-        if response.body != "1"
-          raise MessageBodyTooLargeError, body_json.bytesize if response.body.include? MSTEAMS_MESSAGE_413_ERROR_TOKEN
+        return response if response_from_mst_workflow_webhook?(response) ||
+                           response_from_mst_connector_webhook?(response)
 
-          raise UnknownError, response.body
-        end
+        raise MessageBodyTooLargeError, body_json.bytesize if message_too_large?(response)
 
-        response
+        raise UnknownError, response.body
       end
     end
     # rubocop:enable Metrics/AbcSize
@@ -93,5 +99,21 @@ module MsTeamsHermes
         ]
       }.to_json
     end
+
+    private
+
+    def response_from_mst_workflow_webhook?(response)
+      response.code == "202" && response.body.empty?
+    end
+
+    def response_from_mst_connector_webhook?(response)
+      # For details see:
+      # https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?tabs=cURL%2Ctext1#send-messages-using-curl-and-powershell
+      response.code == "200" && response.body == "1"
+    end
+
+    def message_too_large?(response)
+      response.body.include? MSTEAMS_MESSAGE_413_ERROR_TOKEN
+    end
   end
 end

data/lib/msteams_hermes/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msteams_hermes
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Rafael Rocha
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Send messages to any Microsoft Teams' channel as easy as possible.