msteams_hermes 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b669c1e292e83f5cd4ade218b5746fd43d510992f5a5b2ef8db6c0fa50d8799
-  data.tar.gz: a188b10e541fc0c5d471b872c20c2cc15a0852c95bea444da8d0bd2b179c2dc1
+  metadata.gz: 4b3cdc7a7dfce17ff21c71884f2e774845e1ba7fe89a2c9ead3445f88a40c544
+  data.tar.gz: c509e71637183ffa574dedb800be337f06f07c04869e8a0bfef61d5b7e20f2b6
 SHA512:
-  metadata.gz: d320bd149716475e1be084bede6a3443a53263cfb77df1a8f163f8257465f9422d71ca7149447a769bf1860efe3ceb95f38e5b2a0a3ac3b993565d7abfa7e9b9
-  data.tar.gz: 5d68eea1cdb86d0c2383881f4a334c8952650513c51aa883e06f2290fd366a9758fae12503d270350b40390102e3009b8c878b1d15150f1585663c178508dd01
+  metadata.gz: 6f2d422662a3846abd375126115db6ce6a008a67e811fb8563a4d6955d328e80df3591d3049e463fc65b29a0f41ccd4f66595a1cbaddab0811c40de40ecc9e82
+  data.tar.gz: e0c7a189f4a9be321c068efef20aaafe5244095f2b6617006940c92f10bc93ce1e4dcfe462aa7f6e1066ddee1398a611eaa66dbc971124928a8273c7a233b9bb

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [ "2.7", "3.0", "3.1.2" ]
+        ruby-version: [ "3.1", "3.2", "3.3" ]
     steps:
     - uses: actions/checkout@v2
 

data/.rubocop.yml

@@ -1,9 +1,10 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
 
 Metrics/BlockLength:
   Exclude:
-    - 'spec/**/*'
+    - msteams_hermes.gemspec
+    - spec/**/*
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## 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
+
 ## [1.1.0] - 2023-01-24
 - Add support for @mentions
 

data/Gemfile

@@ -4,7 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in msteams_hermes.gemspec
 gemspec
-
-gem "rake"
-gem "rspec"
-gem "rubocop"

data/Gemfile.lock

@@ -1,59 +1,86 @@
 PATH
   remote: .
   specs:
-    msteams_hermes (1.1.0)
+    msteams_hermes (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    diff-lcs (1.5.0)
-    json (2.6.2)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    bigdecimal (3.1.8)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    hashdiff (1.1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.5)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.4)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.36.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.2.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
-  x86_64-darwin-20
-  x86_64-darwin-21
 
 DEPENDENCIES
   msteams_hermes!
+  pry-byebug
   rake
   rspec
   rubocop
+  webmock (~> 3.23)
 
 BUNDLED WITH
-   2.2.15
+   2.5.10

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
     )
   ]
 )
@@ -72,4 +72,4 @@ content = MsTeamsHermes::Components::AdaptiveCard.new(
   ]
 )
 
-MsTeamsHermes::Message.new(webhook_url: YOUR_WEBHOOK_URL, content: content).deliver
+MsTeamsHermes::Message.new(webhook_url: YOUR_WEBHOOK_URL, content:).deliver

data/lib/msteams_hermes/actions/open_url.rb

@@ -20,9 +20,9 @@ module MsTeamsHermes
       def to_hash
         {
           type: "Action.OpenUrl",
-          url: url,
-          title: title,
-          tooltip: tooltip
+          url:,
+          title:,
+          tooltip:
         }
       end
     end

data/lib/msteams_hermes/components/adaptive_card.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
 require "msteams_hermes/components/base"
+require "msteams_hermes/style"
 
 module MsTeamsHermes
   ##
   # Module containing Microsoft's components representations
   ##
   module Components
+    include MsTeamsHermes::Style
     ##
     # A class representing Microsoft's AdaptiveCard object
     # https://adaptivecards.io/explorer/AdaptiveCard.html
     ##
     class AdaptiveCard < Base
-      attr_reader :body, :actions, :entities
+      attr_reader :body, :actions, :entities, :width
 
-      def initialize(body:, actions: nil, entities: [])
+      def initialize(body:, actions: nil, entities: [], width: Style::Width::DEFAULT)
         @body = body
         raise "AdaptiveCard `body` must be an Array" unless @body.is_a? Array
 
@@ -23,6 +25,9 @@ module MsTeamsHermes
 
         @entities = entities
         raise "AdaptiveCard `entities` must be an Array" unless @entities.nil? || @entities.is_a?(Array)
+
+        @width = width
+        raise "AdaptiveCard `width` must be one of the available Width options" unless Style::Width.all.include?(width)
       end
 
       def to_hash
@@ -31,7 +36,10 @@ module MsTeamsHermes
           version: "1.5",
           body: body.map(&:to_hash),
           actions: actions&.map(&:to_hash),
-          msteams: { entities: entities.map(&:to_hash) }
+          msteams: {
+            entities: entities.map(&:to_hash),
+            width:
+          }
         }
       end
     end

data/lib/msteams_hermes/components/column.rb

@@ -25,7 +25,7 @@ module MsTeamsHermes
       def to_hash
         {
           type: "Column",
-          width: width,
+          width:,
           items: items.map(&:to_hash)
         }
       end

data/lib/msteams_hermes/components/container.rb

@@ -27,7 +27,7 @@ module MsTeamsHermes
       def to_hash
         {
           type: "Container",
-          style: style,
+          style:,
           selectAction: select_action&.to_hash,
           items: items.map(&:to_hash)
         }

data/lib/msteams_hermes/components/fact_set.rb

@@ -23,7 +23,7 @@ module MsTeamsHermes
       def to_hash
         {
           type: "FactSet",
-          facts: facts
+          facts:
         }
       end
 

data/lib/msteams_hermes/components/text_block.rb

@@ -37,13 +37,13 @@ module MsTeamsHermes
       def to_hash
         {
           type: "TextBlock",
-          text: text,
-          color: color,
-          size: size,
-          font_type: font_type,
-          weight: weight,
-          wrap: wrap,
-          is_subtle: is_subtle
+          text:,
+          color:,
+          size:,
+          font_type:,
+          weight:,
+          wrap:,
+          is_subtle:
         }
       end
     end

data/lib/msteams_hermes/message.rb

@@ -3,12 +3,47 @@
 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
   # https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?tabs=cURL#send-adaptive-cards-using-an-incoming-webhook
   ##
   class Message
+    ##
+    # Raises when the message is larger than the latest known maximum size of a microsoft teams message
+    ##
+    class MessageBodyTooLargeError < StandardError
+      def initialize(current_size)
+        super "Microsoft Teams Webhook answered with a 413 due to content size limitations" \
+              " (last check it was about #{MSTEAMS_MESSAGE_SIZE_LIMIT} bytes)." \
+              "\nYour message results in a size of about #{current_size} bytes which is too much."
+      end
+    end
+
+    ##
+    # Raises when the response message changes from the successful response
+    ##
+    class UnknownError < StandardError
+      def initialize(error)
+        super "Microsoft Teams Webhook had an unexpected response body:\n#{error}"
+      end
+    end
+
+    # Docu says: 'The message size limit is 28 KB',
+    # but testing aligned with 21KB.
+    # See: https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook
+    MSTEAMS_MESSAGE_SIZE_LIMIT = 21_000
+    MSTEAMS_MESSAGE_413_ERROR_TOKEN = "returned HTTP error 413"
+
     attr_reader :webhook_url, :content
 
     def initialize(content:, webhook_url: ENV["WEBHOOK_URL"])
@@ -19,6 +54,8 @@ module MsTeamsHermes
       raise "Message `content` must be an AdaptiveCard" unless @content.is_a? Components::AdaptiveCard
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     ##
     # Sends a HTTP request to the webhook URL specified via
     # either environment variable or when initializing the class
@@ -31,9 +68,19 @@ module MsTeamsHermes
         req = Net::HTTP::Post.new(uri)
         req.body = body_json
         req["Content-Type"] = "application/json"
-        http.request(req)
+
+        response = http.request(req)
+
+        return response if response_from_mst_workflow_webhook?(response) ||
+                           response_from_mst_connector_webhook?(response)
+
+        raise MessageBodyTooLargeError, body_json.bytesize if message_too_large?(response)
+
+        raise UnknownError, response.body
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     ##
     # Formats the JSON object to be set on the HTTP request
@@ -52,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/style/width.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    ##
+    # Module containing available width options for the AdaptiveCard component
+    ##
+    module Width
+      DEFAULT = "default"
+      FULL = "full"
+
+      def self.all
+        [DEFAULT, FULL]
+      end
+    end
+  end
+end

data/lib/msteams_hermes/style.rb

@@ -5,6 +5,7 @@ require "msteams_hermes/style/container_style"
 require "msteams_hermes/style/font_size"
 require "msteams_hermes/style/font_type"
 require "msteams_hermes/style/font_weight"
+require "msteams_hermes/style/width"
 
 module MsTeamsHermes
   ##
@@ -16,5 +17,6 @@ module MsTeamsHermes
     include MsTeamsHermes::Style::FontSize
     include MsTeamsHermes::Style::FontType
     include MsTeamsHermes::Style::FontWeight
+    include MsTeamsHermes::Style::Width
   end
 end

data/lib/msteams_hermes/version.rb

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

data/msteams_hermes.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |spec|
                        "Microsoft's adaptive cards."
   spec.homepage      = "https://github.com/xing/msteams_hermes"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/xing/msteams_hermes"
   spec.metadata["changelog_uri"] = "https://github.com/xing/msteams_hermes/CHANGELOG.md"
 
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1")
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -34,6 +35,9 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock", "~> 3.23"
 end

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: msteams_hermes
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rafael Rocha
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
-dependencies: []
+date: 2024-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  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: rspec
+  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: rubocop
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
 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
   (and some others), you will be able to customize it with the objects representations
@@ -53,6 +123,7 @@ files:
 - lib/msteams_hermes/style/font_size.rb
 - lib/msteams_hermes/style/font_type.rb
 - lib/msteams_hermes/style/font_weight.rb
+- lib/msteams_hermes/style/width.rb
 - lib/msteams_hermes/version.rb
 - msteams_hermes.gemspec
 homepage: https://github.com/xing/msteams_hermes
@@ -70,14 +141,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Send messages to any Microsoft Teams' channel as easy as possible.