fastlane-plugin-teams_bot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 306b339e7deb7f7ca9e5d31e6d06de5dce760238f8267c9aa122e80e0e7265f4
+  data.tar.gz: a6b017fe71fec2dc099c245ca8ebf9f769f88eec7361f65fc9fda20208e4f4a3
+SHA512:
+  metadata.gz: 430f928d5f9cd537fda95dcfa785707f33b696abde7edb9257b223eacd2d5729a7266122571ac111d3ece6a641b7af88a6e310f8a680e22b5602ddd88105f720
+  data.tar.gz: 591da19c004cbf8399ead3fc88caddd1d0d426c1cbc95a422fde9267f8718b60f6d622f52a5263bc124f73fcb96d8c1842c8c863a6e0b9ae8455cef1d54de34f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Hugo EXTRAT <extrat.h@gmail.com>
+
+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,104 @@
+# Microsoft Teams Bot `fastlane` plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-teams_bot)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-teams_bot.svg)](https://badge.fury.io/rb/fastlane-plugin-teams_bot)
+
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-teams_bot`, add it to your project by running:
+
+```bash
+fastlane add_plugin teams_bot
+```
+
+## About teams_bot
+
+With this plugin you will be able to send a message on a microsoft teams channel.
+
+Beforehand you must create a new incoming webhook on the Microsoft Teams channel of your choice, you can follow this documentation to help you do this: [Incoming Webhook](https://docs.microsoft.com/en-US/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook#add-an-incoming-webhook-to-a-teams-channel)
+
+`teams_bot` allows you to send a fully custom message to a specific incoming webhook.
+
+## Usage
+
+```ruby
+teams_bot(
+    teams_url: "<incoming webhook URL",
+    title: "Welcome from Fastlane",
+    text: "Hi there !! I am [Teams Bot](https://github.com/huextrat/fastlane-plugin-teams_bot). I can send messages on Microsoft Teams very easily from Fastlane.",
+    activity_title: "Hey",
+    activity_image: "https://seeklogo.com/images/F/fastlane-logo-6CA0B0B428-seeklogo.com.png"
+)
+```
+
+or
+
+```ruby
+teams_bot(
+    teams_url: "<incoming webhook URL",
+    title: "Welcome from Fastlane",
+    text: "Hi there !! I am [Teams Bot](https://github.com/huextrat/fastlane-plugin-teams_bot). I can send messages on Microsoft Teams very easily from Fastlane.",
+    activity_title: "Hey",
+    activity_image: "https://seeklogo.com/images/F/fastlane-logo-6CA0B0B428-seeklogo.com.png",
+    facts: [
+        {
+            "name" => "Environment",
+            "value" => "Staging"
+        },
+        {
+            "name" => "Branch",
+            "value" => "Develop"
+        }
+    ],
+    theme_color: "321244", # A custom RGB color
+    use_markdown: true # Using markdown allowing you to add URL in your text
+)
+```
+
+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_bot
+```
+
+### `teams_bot`
+
+| Key               | Description                | Env Var                    | Default |
+|-------------------|----------------------------|----------------------------|---------|
+| theme_color       | Theme color of the message card | TEAMS_MESSAGE_THEME_COLOR  | 321244  |
+| title             | The title that should be displayed on Teams | TEAMS_MESSAGE_TITLE        |         |
+| summary           | The summary that should be displayed on Teams | TEAMS_MESSAGE_SUMMARY      | summary |
+| activity_title    | A summary of your message  | TEAMS_MESSAGE_ACTIVITY_TITLE  |         |
+| activity_subtitle | A quick subtitle for your activity (date, project name, branch, ...)  | TEAMS_MESSAGE_ACTIVITY_SUBTITLE  | ''      |
+| activity_image    | Display an image on your activity (project logo, company logo, ...)  | TEAMS_MESSAGE_ACTIVITY_IMAGE  |         |
+| text              | The message you want to display    | TEAMS_MESSAGE_TEXT         |         |
+| use_markdown      | Define to use or not markdown       | TEAMS_MESSAGE_USE_MARKDOWN  | true    |
+| facts             | Optional facts (assigned to, due date, status, branch, environment, ...)   | TEAMS_MESSAGE_FACTS        | []      |
+| teams_url         | The URL of the incoming Webhook you created on your Microsoft Teams channel   | TEAMS_MESSAGE_TEAMS_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`.
+
+## 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_bot.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/teams_bot/version'
+
+module Fastlane
+  module TeamsBot
+    # 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::TeamsBot.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/teams_bot/actions/teams_bot_action.rb

@@ -0,0 +1,162 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class TeamsBotAction < Action
+      def self.run(params)
+        payload = {
+          "@type" => "MessageCard",
+          "@context" => "http://schema.org/extensions",
+          "themeColor" => params[:theme_color],
+          "title" => params[:title],
+          "summary" => params[:summary],
+          "sections": [{
+              "activityTitle": params[:activity_title],
+              "activitySubtitle": params[:activity_subtitle],
+              "activityImage": params[:activity_image],
+              "text" => params[:text],
+              "facts": params[:facts],
+              "markdown": params[:use_markdown]
+          }]
+        }
+
+        send_message(params[:teams_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
+        response = http.post(uri.path, payload.to_json, json_headers)
+        is_message_success(response)
+      end
+
+      def self.is_message_success(response)
+        if response.code.to_i == 200 && response.body.to_i == 1
+          UI.message("🍾 The message was sent successfully")
+          true
+        else
+          UI.user_error!("⚠️ An error occurred: #{response.body}")
+        end
+      end
+
+      def self.available_options
+        [
+          # Card configuration
+          FastlaneCore::ConfigItem.new(key: :theme_color,
+                                       env_name: "TEAMS_MESSAGE_THEME_COLOR",
+                                       description: "Theme color of the message card",
+                                       optional: true,
+                                       default_value: "321244"),
+
+          FastlaneCore::ConfigItem.new(key: :title,
+                                       env_name: "TEAMS_MESSAGE_TITLE",
+                                       optional: false,
+                                       description: "The title that should be displayed on Teams"),
+
+          FastlaneCore::ConfigItem.new(key: :summary,
+                                       env_name: "TEAMS_MESSAGE_SUMMARY",
+                                       description: "The summary that should be displayed on Teams",
+                                       optional: true,
+                                       default_value: "summary"),
+
+          # Activity Configuration
+          FastlaneCore::ConfigItem.new(key: :activity_title,
+                                       env_name: "TEAMS_MESSAGE_ACTIVITY_TITLE",
+                                       optional: false,
+                                       description: "A summary of your message"),
+
+          FastlaneCore::ConfigItem.new(key: :activity_subtitle,
+                                       env_name: "TEAMS_MESSAGE_ACTIVITY_SUBTITLE",
+                                       optional: true,
+                                       description: "A quick subtitle for your activity (date, project name, branch, ...)",
+                                       default_value: ""),
+
+          FastlaneCore::ConfigItem.new(key: :activity_image,
+                                       env_name: "TEAMS_MESSAGE_ACTIVITY_IMAGE",
+                                       sensitive: true,
+                                       optional: true,
+                                       description: "Display an image on your activity (project logo, company logo, ...)"),
+
+          FastlaneCore::ConfigItem.new(key: :text,
+                                       env_name: "TEAMS_MESSAGE_TEXT",
+                                       description: "The message you want to display",
+                                       optional: false),
+
+          FastlaneCore::ConfigItem.new(key: :use_markdown,
+                                       type: Boolean,
+                                       env_name: "TEAMS_MESSAGE_USE_MARKDOWN",
+                                       optional: true,
+                                       description: "Define to use or not markdown",
+                                       default_value: true),
+
+          FastlaneCore::ConfigItem.new(key: :facts,
+                                       type: Array,
+                                       env_name: "TEAMS_MESSAGE_FACTS",
+                                       description: "Optional facts (assigned to, due date, status, branch, environment, ...)",
+                                       default_value: []),
+
+          # Core Configuration
+          FastlaneCore::ConfigItem.new(key: :teams_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_bot(
+            teams_url: "https://outlook.office.com/webhook/...",
+            title: "Welcome from Fastlane",
+            summary: "Integration is a success",
+            text: "Hi there !! I am [Teams Bot](https://github.com/huextrat/fastlane-plugin-teams_bot). I can send messages on Microsoft Teams very easily from Fastlane.",
+            activity_title: "Hey",
+            activity_subtitle: "Working on Fastlane",
+            activity_image: "https://seeklogo.com/images/F/fastlane-logo-6CA0B0B428-seeklogo.com.png",
+            facts: [
+              {
+                "name" => "Environment",
+                "value" => "Staging"
+              },
+              {
+                "name" => "Branch",
+                "value" => "Develop"
+              }
+            ],
+            theme_color: "321244",
+            use_markdown: true
+          )'
+        ]
+      end
+
+      def self.description
+        "Easily send a message to a Microsoft Teams channel through the Webhook connector"
+      end
+
+      def self.details
+        # Optional:
+        "Send a message to a specific channel on your Microsoft Teams organization"
+      end
+
+      def self.authors
+        ["Hugo EXTRAT"]
+      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_bot/helper/teams_bot_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module TeamsBot
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-teams_bot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hugo EXTRAT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: bundler
+  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: rspec_junit_formatter
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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: simplecov
+  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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.171.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.171.0
+description: 
+email: extrat.h@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/teams_bot.rb
+- lib/fastlane/plugin/teams_bot/actions/teams_bot_action.rb
+- lib/fastlane/plugin/teams_bot/helper/teams_bot_helper.rb
+- lib/fastlane/plugin/teams_bot/version.rb
+homepage: https://github.com/huextrat/fastlane-plugin-teams_bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Easily alert a Microsoft Teams channel
+test_files: []