fastlane-plugin-teams_card 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c45da79cee6983b8b2a4c7ab3bbf9263ac8a8b00071c9919e2226d035d35ad18
+  data.tar.gz: 878329a865a503a026a233fa2d6bfddc69bee8bb063cbe3de24f96753e442014
+SHA512:
+  metadata.gz: 4ed16d47c6d852f46c6c792bf90f2a3fd5ac31893c114f5070e305bed8f8c6be763753dc6cb17a96393665d4c822de5cff3b2af5db6016ed42003c2cdaa50c2a
+  data.tar.gz: fe69ef1add0f62c4ab7d94eec7633d4b0bd9b2449c7208b8a467f6dccc8cf8f9ad3ee5eeaa6c35ecd688c15b2bf3635bb830790fc70f3d256f3bb5b556a6252a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kondamon
+
+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,101 @@
+# teams_card plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-teams_card)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-teams_card`, add it to your project by running:
+
+```bash
+fastlane add_plugin teams_card
+```
+
+## About teams_card
+
+With this plugin you will be able to send a message on a microsoft teams channel, group chat or chat.
+
+Beforehand you must Set up an incoming webhook workflow from a template in Microsoft Teams channel of your choice. You can follow this documentation to help you do this: [Incoming Webhook](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498)
+
+`teams_card` allows you to send a fully custom message to a specific incoming webhook.
+
+## Usage
+
+```ruby
+teams_card(
+    workflow_url: 'https://your.logic.azure.com:443/workflows/1234567890',
+    text: 'A new release is ready for testing!',
+    image: 'https://raw.githubusercontent.com/fastlane/boarding/master/app/assets/images/fastlane.png',
+    image_title: 'Fastlane',
+    ]
+  )
+```
+
+or
+
+```ruby
+teams_card(
+    workflow_url: 'https://your.logic.azure.com:443/workflows/1234567890',
+    title: 'Notification Title',
+    text: 'A new release is ready for testing!',
+    image: 'https://raw.githubusercontent.com/fastlane/boarding/master/app/assets/images/fastlane.png',
+    image_title: 'Fastlane',
+    open_url: 'https://beta.itunes.apple.com/v1/app/_YOUR_APP_ID_',
+    facts: [
+      {
+        'title' => 'Environment',
+        'value' => 'Staging'
+      },
+      {
+        'title' => 'Release',
+        'value' => '1.0.3'
+      }
+    ]
+  )
+```
+
+This code give the following message:
+
+<img src="screenshots/1.png">
+
+### Help
+
+Once installed, information and help for an action can be printed out with this command:
+
+```bash
+fastlane action teams_card
+```
+
+### `teams_card`
+
+| Key         | Description                                        | Env Var(s)                | Default |
+|-------------|----------------------------------------------------|---------------------------|---------|
+| `title`     | The title that should be displayed on Teams         | `TEAMS_MESSAGE_TITLE`     |         |
+| `image`     | Displays an image on your activity (project logo, company logo, etc.) | `TEAMS_MESSAGE_IMAGE` |         |
+| `image_title` | Displays a title next to your image               | `TEAMS_MESSAGE_IMAGE_TITLE` |       |
+| `text`      | The message you want to display                     | `TEAMS_MESSAGE_TEXT`      |         |
+| `facts`     | Optional facts (assigned to, due date, status, branch, environment, etc.) | `TEAMS_MESSAGE_FACTS` | `[]`    |
+| `open_url`  | Optional URL for a button at the bottom of the card | `TEAMS_MESSAGE_OPEN_URL`  |         |
+| `workflow_url` | The URL of the incoming Webhook you created in Workflows app | `TEAMS_MESSAGE_WORKFLOW_URL` | |
+
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/teams_card/actions/teams_card_action.rb

@@ -0,0 +1,205 @@
+require 'fastlane/action'
+require 'fastlane_core'
+require_relative '../helper/teams_card_helper'
+
+module Fastlane
+  module Actions
+    class TeamsCardAction < Action
+      def self.run(params)
+        payload = {
+          "type" => "message",
+          "attachments" => [{
+            "contentType" => "application/vnd.microsoft.card.adaptive",
+            "contentUrl" => nil,
+            "content" => {
+              "type" => "AdaptiveCard",
+              "body" => [
+                {
+                  "type" => "TextBlock",
+                  "text" => params[:text],
+                  "wrap" => true
+                },
+                {
+                  "type" => "FactSet",
+                  "facts" => params[:facts]
+                }
+              ],
+              "$schema" => "http://adaptivecards.io/schemas/adaptive-card.json",
+              "version" => "1.2"
+            }
+          }]
+        }
+
+        if params[:image] || params[:image_title]
+          payload["attachments"][0]["content"]["body"].unshift(
+            {
+              "type" => "ColumnSet",
+              "columns" => [
+                {
+                  "type" => "Column",
+                  "items" => [
+                    {
+                      "type" => "Image",
+                      "style" => "Person",
+                      "url" => params[:image],
+                      "size" => "Small"
+                    }
+                  ],
+                  "width" => "auto"
+                },
+                {
+                  "type" => "Column",
+                  "items" => [
+                    {
+                      "type" => "TextBlock",
+                      "weight" => "Bolder",
+                      "text" => params[:image_title],
+                      "wrap" => true
+                    }
+                  ],
+                  "width" => "stretch",
+                  "horizontalAlignment" => "Left",
+                  "verticalContentAlignment" => "Center"
+                }
+              ]
+            }
+          )
+        end
+
+        if params[:title]
+          payload["attachments"][0]["content"]["body"].unshift(
+            {
+              "type" => "TextBlock",
+              "size" => "large",
+              "weight" => "bolder",
+              "text" => params[:title],
+              "wrap" => true
+            }
+          )
+        end
+
+        if params[:open_url]
+          payload["attachments"][0]["content"]["actions"] = [
+            {
+              "type" => "Action.OpenUrl",
+              "title" => "Open",
+              "url" => params[:open_url]
+            }
+          ]
+        end
+
+        send_message(params[:workflow_url], payload)
+      end
+
+      def self.send_message(url, payload)
+        require 'net/http'
+        require 'uri'
+        json_headers = { 'Content-Type' => 'application/json' }
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request = Net::HTTP::Post.new(uri.request_uri, json_headers)
+        request.body = payload.to_json
+        response = http.request(request)
+        is_message_success(response)
+      end
+
+      def self.is_message_success(response)
+        if response.code.to_i == 202
+          UI.message("🔔 The card was posted successfully.")
+          true
+        else
+          UI.user_error!("⚠️ An error occurred: #{response.body}")
+        end
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :title,
+                                       env_name: "TEAMS_MESSAGE_TITLE",
+                                       optional: true,
+                                       description: "The title that should be displayed on Teams"),
+
+          FastlaneCore::ConfigItem.new(key: :image,
+                                       env_name: "TEAMS_MESSAGE_IMAGE",
+                                       sensitive: true,
+                                       optional: true,
+                                       description: "Displays an image on your activity (project logo, company logo, ...)"),
+
+          FastlaneCore::ConfigItem.new(key: :image_title,
+                                       env_name: "TEAMS_MESSAGE_IMAGE_TITLE",
+                                       optional: true,
+                                       description: "Displays a title next to your image"),
+
+          FastlaneCore::ConfigItem.new(key: :text,
+                                       env_name: "TEAMS_MESSAGE_TEXT",
+                                       description: "The message you want to display",
+                                       optional: false),
+
+          FastlaneCore::ConfigItem.new(key: :facts,
+                                       type: Array,
+                                       env_name: "TEAMS_MESSAGE_FACTS",
+                                       description: "Optional facts (assigned to, due date, status, branch, environment, ...)",
+                                       default_value: []),
+
+          FastlaneCore::ConfigItem.new(key: :open_url,
+                                       env_name: "TEAMS_MESSAGE_OPEN_URL",
+                                       description: "Optional url for a button at bottom of card",
+                                       optional: true),
+
+          FastlaneCore::ConfigItem.new(key: :workflow_url,
+                                       env_name: "TEAMS_MESSAGE_TEAMS_URL",
+                                       sensitive: true,
+                                       optional: false,
+                                       description: "The URL of the incoming Webhook you created on your Microsoft Teams channel",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid URL, must start with https://") unless value.start_with?("https://")
+                                       end)
+        ]
+      end
+
+      def self.example_code
+        [
+          'teams_card(
+            workflow_url: "https://your.logic.azure.com:443/workflows/1234567890",
+            title: "Notification Title",
+            text: "A new release is ready for testing!",
+            image: "https://raw.githubusercontent.com/fastlane/boarding/master/app/assets/images/fastlane.png",
+            image_title: "Fastlane",
+            open_url: "https://beta.itunes.apple.com/v1/app/_YOUR_APP_ID_",
+            facts: [
+              {
+                "title" => "Environment",
+                "value" => "Staging"
+              },
+              {
+                "title" => "Release",
+                "value" => "1.0.3"
+              }
+            ]
+          )'
+        ]
+      end
+
+      def self.description
+        "Easily send a message to a Microsoft Teams channel or group chat through the Power Automate Webhook connector"
+      end
+
+      def self.details
+        "Send a message to a specific channel, group chat or chat on your Microsoft Teams organization via a Workflow of Power Automate"
+      end
+
+      def self.authors
+        ["Kondamon"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/teams_card/helper/teams_card_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class TeamsCardHelper
+      # class methods that you define here become available in your action
+      # as `Helper::TeamsCardHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the teams_card plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/teams_card/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module TeamsCard
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/teams_card.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/teams_card/version'
+
+module Fastlane
+  module TeamsCard
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::TeamsCard.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-teams_card
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kondamon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-31 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/teams_card.rb
+- lib/fastlane/plugin/teams_card/actions/teams_card_action.rb
+- lib/fastlane/plugin/teams_card/helper/teams_card_helper.rb
+- lib/fastlane/plugin/teams_card/version.rb
+homepage: https://github.com/Kondamon/fastlane-plugin-teams_card
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+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: Easily alert a Microsoft Teams channel, group chat or chat via Workflows
+test_files: []