msteams_hermes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cf0e67a3baf8adb2febaabec358bc95bdbb4bd05b22a9cd3f73f2b3438690ab
+  data.tar.gz: 28004b92b73f486f1f7a4cdc9a182989bb6b89ee0cb440d88b9cf972e35c82f5
+SHA512:
+  metadata.gz: f175e08b3de73132ac2b5893ae66e7f6e2312e76fa1018a0ea5a319f65f3a707ed9e8d01169e71e40eca42d5e1d5bcf52610c522cb905be631536924027b8e9c
+  data.tar.gz: 8d41d5c53012d6e3aff9d830283026762e30e81d87b289e559fde21377660090108ae1c14a84fa59d544fced6a8729aab01f1f6b4670668bcd13e3855d9f681c

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ "2.7", "3.0", "3.1.2" ]
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run rubocop
+      run: bundle exec rubocop
+
+    - name: Run rspec
+      run: bundle exec rspec spec/

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/.idea/
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Changelog
+
+## [1.0.0] - 2022-09-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rafael.rocha@xing.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in msteams_hermes.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    msteams_hermes (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      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)
+      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)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+  x86_64-darwin-21
+
+DEPENDENCIES
+  msteams_hermes!
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Rafael Rocha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# MsTeamsHermes
+
+Like Hermes, the messenger of the greek gods, 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 of [Microsoft's adaptive cards](https://adaptivecards.io/explorer/). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'msteams_hermes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install msteams_hermes
+
+## Usage
+
+First of all, you need a Webhook URL, which is responsible to identify which channel should receive the messages we are about to send. To generate one, follow [Microsoft's instructions](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
+
+### Your first message
+
+A default _Hello World!_ message could be sent by simply:
+
+```ruby
+require "msteams_hermes/components/adaptive_card"
+require "msteams_hermes/components/text_block"
+require "msteams_hermes/message"
+
+content = MsTeamsHermes::Components::AdaptiveCard.new(
+  body: [
+    MsTeamsHermes::Components::TextBlock.new(
+      text: "Hello World!",
+    )
+  ]
+)
+
+MsTeamsHermes::Message.new(webhook_url: <YOUR_WEBHOOK_URL>, content: content).deliver
+```
+
+- You can provide the `webhook_url` by either sending it as a param or setting it as an environment variable, but it must not be nil.
+- `content` must always be an `AdaptiveCard`, which is the top component for Microsoft's webhook messages.
+
+Each component, each style, each action is a 1:1 representation from [Microsoft's adaptive cards](https://adaptivecards.io/explorer/).
+
+If you want a more elaborated example on how to create message with complex layouts, check out this [example](https://github.com/xing/msteams_hermes/blob/main/complex_example.rb).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xing/msteams_hermes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/xing/msteams_hermes/blob/main/CODE_OF_CONDUCT.md).
+
+### Adding new components, styles and actions
+
+Every new component, style or action must implement the `to_hash` method, which serializes the object into a hash object to be sent to the `webhook_url`. When implementing the `to_hash` method, pay attention to the JSON structure of the given object, usually described on the _Example_ section of its documentation on [adaptivecards.io](https://adaptivecards.io/explorer/).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MsTeamsHermes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/xing/msteams_hermes/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "msteams_hermes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/complex_example.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require "msteams_hermes/actions/open_url"
+require "msteams_hermes/components/adaptive_card"
+require "msteams_hermes/components/text_block"
+require "msteams_hermes/components/container"
+require "msteams_hermes/components/fact_set"
+require "msteams_hermes/message"
+
+YOUR_WEBHOOK_URL = "YOUR_WEBHOOK_URL"
+
+header = MsTeamsHermes::Components::Container.new(
+  style: MsTeamsHermes::Style::ContainerStyle::WARNING,
+  items: [
+    MsTeamsHermes::Components::TextBlock.new(
+      text: "John Cena",
+      size: MsTeamsHermes::Style::FontSize::LARGE,
+      weight: MsTeamsHermes::Style::FontWeight::BOLDER
+    ),
+    MsTeamsHermes::Components::TextBlock.new(
+      text: "Saturday, 1 January 2022"
+    )
+  ]
+)
+
+description = MsTeamsHermes::Components::TextBlock.new(
+  text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et " \
+        "dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip " \
+        "ex ea commodo consequat.",
+  wrap: true
+)
+
+facts = MsTeamsHermes::Components::FactSet.new(
+  facts: [
+    {
+      "title": "Board:",
+      "value": "Adaptive Card"
+    },
+    {
+      "title": "List:",
+      "value": "Backlog"
+    },
+    {
+      "title": "Assigned to:",
+      "value": "John Cena"
+    },
+    {
+      "title": "Due date:",
+      "value": "Not set"
+    }
+  ]
+)
+
+action = MsTeamsHermes::Actions::OpenUrl.new(
+  title: "View Website",
+  url: "https://adaptivecards.io"
+)
+
+content = MsTeamsHermes::Components::AdaptiveCard.new(
+  body: [
+    header,
+    MsTeamsHermes::Components::Container.new(
+      items: [
+        description,
+        facts
+      ]
+    )
+  ],
+  actions: [
+    action
+  ]
+)
+
+MsTeamsHermes::Message.new(webhook_url: YOUR_WEBHOOK_URL, content: content).deliver

data/lib/msteams_hermes/actions/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+
+module MsTeamsHermes
+  module Actions
+    ##
+    # Base class of Actions representations
+    ##
+    class Base
+      def to_hash
+        raise "Should be implemented on the subclass"
+      end
+    end
+  end
+end

data/lib/msteams_hermes/actions/open_url.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/actions/base"
+
+module MsTeamsHermes
+  module Actions
+    ##
+    # A class representing Microsoft's Action.OpenUrl object
+    # https://adaptivecards.io/explorer/Action.OpenUrl.html
+    ##
+    class OpenUrl < Base
+      attr_reader :url, :title, :tooltip
+
+      def initialize(url:, title: nil, tooltip: nil)
+        @url = url
+        @title = title
+        @tooltip = tooltip
+      end
+
+      def to_hash
+        {
+          type: "Action.OpenUrl",
+          url: url,
+          title: title,
+          tooltip: tooltip
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/action_set.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+require "msteams_hermes/style"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's components representations
+  ##
+  module Components
+    ##
+    # A class representing Microsoft's ActionSet object
+    # https://adaptivecards.io/explorer/ActionSet.html
+    ##
+    class ActionSet < Base
+      attr_reader :actions
+
+      def initialize(actions:)
+        @actions = actions
+        raise "ActionSet `actions` must be an Array" unless @actions.is_a? Array
+      end
+
+      def to_hash
+        {
+          type: "ActionSet",
+          actions: actions.map(&:to_hash)
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/adaptive_card.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's components representations
+  ##
+  module Components
+    ##
+    # A class representing Microsoft's AdaptiveCard object
+    # https://adaptivecards.io/explorer/AdaptiveCard.html
+    ##
+    class AdaptiveCard < Base
+      attr_reader :body, :actions
+
+      def initialize(body:, actions: nil)
+        @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)
+      end
+
+      def to_hash
+        {
+          type: "AdaptiveCard",
+          version: "1.5",
+          body: body.map(&:to_hash),
+          actions: actions&.map(&:to_hash)
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's components representations
+  ##
+  module Components
+    ##
+    # Base class of Components representations
+    ##
+    class Base
+      def to_hash
+        raise "Should be implemented on the subclass"
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/column.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+require "msteams_hermes/style"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's components representations
+  ##
+  module Components
+    ##
+    # A class representing Microsoft's Column object
+    # https://adaptivecards.io/explorer/Column.html
+    ##
+    class Column < Base
+      attr_reader :items, :width
+
+      def initialize(items:, width: "auto")
+        @items = items
+        raise "Column `items` must be an Array" unless @items.is_a? Array
+
+        @width = width
+      end
+
+      def to_hash
+        {
+          type: "Column",
+          width: width,
+          items: items.map(&:to_hash)
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/column_set.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+require "msteams_hermes/style"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's components representations
+  ##
+  module Components
+    ##
+    # A class representing Microsoft's ColumnSet object
+    # https://adaptivecards.io/explorer/ColumnSet.html
+    ##
+    class ColumnSet < Base
+      attr_reader :columns
+
+      def initialize(columns:)
+        @columns = columns
+        raise "ColumnSet `columns` must be an Array" unless @columns.is_a? Array
+      end
+
+      def to_hash
+        {
+          type: "ColumnSet",
+          columns: columns.map(&:to_hash)
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/container.rb

@@ -0,0 +1,37 @@
+# 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 Container object
+    # https://adaptivecards.io/explorer/Container.html
+    ##
+    class Container < Base
+      attr_reader :items, :style, :select_action
+
+      def initialize(items:, style: Style::ContainerStyle::DEFAULT, select_action: nil)
+        @items = items
+        raise "Container `items` must be an Array" unless @items.is_a? Array
+
+        @style = style
+        @select_action = select_action
+      end
+
+      def to_hash
+        {
+          type: "Container",
+          style: style,
+          selectAction: select_action&.to_hash,
+          items: items.map(&:to_hash)
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/fact_set.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/components/base"
+require "msteams_hermes/style"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's components representations
+  ##
+  module Components
+    ##
+    # A class representing Microsoft's FactSet object
+    # https://adaptivecards.io/explorer/FactSet.html
+    ##
+    class FactSet < Base
+      attr_reader :facts
+
+      def initialize(facts:)
+        @facts = facts
+        raise "FactSet `facts` must be an Array of hashes containing title and value keys" unless valid_facts?
+      end
+
+      def to_hash
+        {
+          type: "FactSet",
+          facts: facts
+        }
+      end
+
+      private
+
+      def valid_facts?
+        facts.is_a?(Array) && facts.all? do |fact|
+          extra_keys = %i[title value] - fact.keys
+          fact.is_a?(Hash) && extra_keys.empty?
+        end
+      end
+    end
+  end
+end

data/lib/msteams_hermes/components/text_block.rb

@@ -0,0 +1,51 @@
+# 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 TextBlock object
+    # https://adaptivecards.io/explorer/TextBlock.html
+    ##
+    class TextBlock < Base
+      attr_reader :text, :wrap, :color, :size, :font_type, :weight, :is_subtle
+
+      def initialize(text:,
+                     wrap: false,
+                     color: Style::Colors::DEFAULT,
+                     size: Style::FontSize::DEFAULT,
+                     font_type: Style::FontType::DEFAULT,
+                     weight: Style::FontWeight::DEFAULT,
+                     is_subtle: false)
+        @text = text
+        raise "TextBlock `text` must be a String" unless @text.is_a? String
+
+        @wrap = wrap
+        @color = color
+        @size = size
+        @font_type = font_type
+        @weight = weight
+        @is_subtle = is_subtle
+      end
+
+      def to_hash
+        {
+          type: "TextBlock",
+          text: text,
+          color: color,
+          size: size,
+          font_type: font_type,
+          weight: weight,
+          wrap: wrap,
+          is_subtle: is_subtle
+        }
+      end
+    end
+  end
+end

data/lib/msteams_hermes/message.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+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
+    attr_reader :webhook_url, :content
+
+    def initialize(content:, webhook_url: ENV["WEBHOOK_URL"])
+      @webhook_url = webhook_url
+      @content = content
+
+      raise "Message `webhook_url` cannot be empty" if @webhook_url.nil?
+      raise "Message `content` must be an AdaptiveCard" unless @content.is_a? Components::AdaptiveCard
+    end
+
+    ##
+    # Sends a HTTP request to the webhook URL specified via
+    # either environment variable or when initializing the class
+    #
+    # @return a Net::HTTP response object
+    ##
+    def deliver
+      uri = URI.parse(webhook_url)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
+        req = Net::HTTP::Post.new(uri)
+        req.body = body_json
+        req["Content-Type"] = "application/json"
+        http.request(req)
+      end
+    end
+
+    ##
+    # Formats the JSON object to be set on the HTTP request
+    #
+    # @return a JSON object
+    ##
+    def body_json
+      {
+        type: "message",
+        attachments: [
+          {
+            contentType: "application/vnd.microsoft.card.adaptive",
+            contentUrl: nil,
+            content: content.to_hash
+          }
+        ]
+      }.to_json
+    end
+  end
+end

data/lib/msteams_hermes/style/colors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    ##
+    # Module containing Microsoft's Colors representation
+    # See `Colors` in https://adaptivecards.io/explorer/TextBlock.html
+    ##
+    module Colors
+      DEFAULT = "default"
+      ACCENT = "accent"
+      GOOD = "good"
+      WARNING = "warning"
+      ATTENTION = "attention"
+      LIGHT = "light"
+      DARK = "dark"
+    end
+  end
+end

data/lib/msteams_hermes/style/container_style.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    ##
+    # Module containing Microsoft's ContainerStyle representation
+    # See `ContainerStyle` in https://adaptivecards.io/explorer/Container.html
+    ##
+    module ContainerStyle
+      DEFAULT = "default"
+      ACCENT = "accent"
+      GOOD = "good"
+      WARNING = "warning"
+      ATTENTION = "attention"
+      EMPHASIS = "emphasis"
+    end
+  end
+end

data/lib/msteams_hermes/style/font_size.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    ##
+    # Module containing Microsoft's FontSize representation
+    # See `FontSize` in https://adaptivecards.io/explorer/TextBlock.html
+    ##
+    module FontSize
+      DEFAULT = "default"
+      SMALL = "small"
+      MEDIUM = "medium"
+      LARGE = "large"
+      EXTRA_LARGE = "extraLarge"
+    end
+  end
+end

data/lib/msteams_hermes/style/font_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    ##
+    # Module containing Microsoft's FontType representation
+    # See `FontType` in https://adaptivecards.io/explorer/TextBlock.html
+    ##
+    module FontType
+      DEFAULT = "default"
+      MONOSPACE = "monospace"
+    end
+  end
+end

data/lib/msteams_hermes/style/font_weight.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    ##
+    # Module containing Microsoft's FontWeight representation
+    # See `FontWeight` in https://adaptivecards.io/explorer/TextBlock.html
+    ##
+    module FontWeight
+      DEFAULT = "default"
+      LIGHTER = "lighter"
+      BOLDER = "bolder"
+    end
+  end
+end

data/lib/msteams_hermes/style.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "msteams_hermes/style/colors"
+require "msteams_hermes/style/container_style"
+require "msteams_hermes/style/font_size"
+require "msteams_hermes/style/font_type"
+require "msteams_hermes/style/font_weight"
+
+module MsTeamsHermes
+  ##
+  # Module containing Microsoft's style representations
+  ##
+  module Style
+    include MsTeamsHermes::Style::Colors
+    include MsTeamsHermes::Style::ContainerStyle
+    include MsTeamsHermes::Style::FontSize
+    include MsTeamsHermes::Style::FontType
+    include MsTeamsHermes::Style::FontWeight
+  end
+end

data/lib/msteams_hermes/version.rb

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

data/lib/msteams_hermes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "msteams_hermes/version"
+require_relative "msteams_hermes/message"
+
+##
+# MsTeamsHermes module
+##
+module MsTeamsHermes; end

data/msteams_hermes.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/msteams_hermes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "msteams_hermes"
+  spec.version       = MsTeamsHermes::VERSION
+  spec.authors       = ["Rafael Rocha"]
+  spec.email         = "opensource@xing.com"
+  spec.date          = Time.now.strftime("%Y-%m-%d")
+
+  spec.summary       = "Send messages to any Microsoft Teams' channel as easy as possible."
+  spec.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 of " \
+                       "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"
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # 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
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: msteams_hermes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rafael Rocha
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-01 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
+  (and some others), you will be able to customize it with the objects representations
+  of Microsoft's adaptive cards.
+email: opensource@xing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- complex_example.rb
+- lib/msteams_hermes.rb
+- lib/msteams_hermes/actions/base.rb
+- lib/msteams_hermes/actions/open_url.rb
+- lib/msteams_hermes/components/action_set.rb
+- lib/msteams_hermes/components/adaptive_card.rb
+- lib/msteams_hermes/components/base.rb
+- lib/msteams_hermes/components/column.rb
+- lib/msteams_hermes/components/column_set.rb
+- lib/msteams_hermes/components/container.rb
+- lib/msteams_hermes/components/fact_set.rb
+- lib/msteams_hermes/components/text_block.rb
+- lib/msteams_hermes/message.rb
+- lib/msteams_hermes/style.rb
+- lib/msteams_hermes/style/colors.rb
+- lib/msteams_hermes/style/container_style.rb
+- lib/msteams_hermes/style/font_size.rb
+- lib/msteams_hermes/style/font_type.rb
+- lib/msteams_hermes/style/font_weight.rb
+- lib/msteams_hermes/version.rb
+- msteams_hermes.gemspec
+homepage: https://github.com/xing/msteams_hermes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xing/msteams_hermes
+  source_code_uri: https://github.com/xing/msteams_hermes
+  changelog_uri: https://github.com/xing/msteams_hermes/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Send messages to any Microsoft Teams' channel as easy as possible.
+test_files: []