fastlane-plugin-slack_bot 0.4.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f2aabbc8c122fde9ab66c2f19a43ee068eeb1905fe71676b58f3f97615df758
-  data.tar.gz: 2f14989f7e4afcf43fd873748b385bb9fb30c5e8b419d4c4ad35b5f910dedd8b
+  metadata.gz: d41be99af2fa9df13b2a8b613f0afc6ca95ec7e78abe90c07231b2564e9d6431
+  data.tar.gz: f5b92143896f6a54b893b06daf6a2e4f6b464fba24473851b98f70c16995a15e
 SHA512:
-  metadata.gz: 4aa6547bd6c2d4b3f4275be0296027171e1e4f47e90540bd676e1adedc92840bc5945972e1462ada73f1a30eabf8ba7eeebaf9d46e76205d81053bc2595ceb3b
-  data.tar.gz: 15a515660c49d9ca4b7d9de700c4212692402c05d53feba5b039fadc82c00f7bf03fcd6255b8467c659ef8545028f823723ef3e30cde8efbd7144fc1b1e8ebfc
+  metadata.gz: 40e353d5df69d1822acceb88aaced1b4eb79f5c56d615bf36abb82b56c593311e0e50bbe82362a662e63c9c5a343eae50a0a2fe666b3e48e044090da5d557c77
+  data.tar.gz: 34fb53d69b3fa99084615db23e2ab03c862928af864b6c28239004af7b7ab4e747f91c756dabe6e855008ed58706802618a1c8becfbfc2cc26c80f8810524f35

data/README.md

@@ -4,7 +4,7 @@
 ![![License]](https://img.shields.io/badge/license-MIT-green.svg?style=flat)
 [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-slack_bot.svg)](https://badge.fury.io/rb/fastlane-plugin-slack_bot)
 ![![RubyGem Download Badge]](https://ruby-gem-downloads-badge.herokuapp.com/fastlane-plugin-slack_bot?type=total)
-[![Twitter: @manish](https://img.shields.io/badge/contact-@manish-blue.svg?style=flat)](https://twitter.com/manish_rathi_)
+[![Twitter: @manish](https://img.shields.io/badge/contact-@manish-blue.svg?style=flat)](https://twitter.com/iammanishrathi)
 
 A fastlane plugin to customize your automation workflow(s) with a **Slack Bot** 🤖 using the [Slack APIs](https://api.slack.com/)
 
@@ -29,9 +29,7 @@ i.e Listing couple of slack **webhook url** limitations:
 ## Getting Started
 
 1. [Generate `Slack token` for `Fastlane` bot](https://slack.com/intl/en-nl/help/articles/115005265703-Create-a-bot-for-your-workspace)
-    - From your Slack organization page, go to `Manage` -> `Custom Integrations`
-    - Open `Bots`
-    - Add Configuration
+    - Add a slack `Bot` user
     - Choose a name for your bot, e.g. `"fastlane"`
     - Save `API Token`
 
@@ -54,7 +52,8 @@ Using this `slack_bot` plugin, you can:
   - [x] Post a message to a _public_ channel
   - [x] Post a message to a _private_ channel
   - [x] Post a message to a _slack user_ (DM)
-  - [x] Post a message inside a _slack thread_ 🧵  (DM)
+  - [x] Post a message inside a _slack thread_ 🧵
+  - [x] Post a message with _custom Bot username and icon_
 
 - Update a message using [chat.update](https://api.slack.com/methods/chat.update) Slack API
   - [x] update a message in a channel
@@ -66,8 +65,8 @@ Using this `slack_bot` plugin, you can:
   - [x] Upload a file to a _public_ channel
   - [x] Upload a file to a _private_ channel
   - [x] Upload a file to a _slack user_ (DM)
-  - [x] Upload a file inside a _slack thread_ 🧵  (DM)
-  - [x] Upload a file with multiple channels/users
+  - [x] Upload a file inside a _slack thread_ 🧵
+  - [x] Upload a file with _multiple channels/users_
 
 
 ## Examples (Post a message)
@@ -168,6 +167,17 @@ lane :release do
 end
 ```
 
+Let’s post a message with custom slack bot username and icon
+
+```ruby
+# share on Slack
+post_to_slack(
+  message: "App successfully released!",
+  username: "Release Bot", # Overrides the bot's username
+  icon_url: "https://fastlane.tools/assets/img/fastlane_icon.png" # Overrides the bot's icon
+)
+```
+
 ## Examples (Upload a file)
 
 Let’s Upload a file to a slack channel that main branch unit tests has been failed, see scan logs.

data/lib/fastlane/plugin/slack_bot/actions/post_to_slack.rb

@@ -1,5 +1,7 @@
 require 'fastlane/action'
 require_relative '../helper/slack_bot_helper'
+require_relative '../helper/slack_bot_attachments_helper'
+require_relative '../helper/slack_bot_link_formatter_helper'
 
 module Fastlane
   module Actions
@@ -9,10 +11,8 @@ module Fastlane
 
     class PostToSlackAction < Action
       def self.run(options)
-        require 'slack-notifier'
-
         options[:message] = (options[:message].to_s || '').gsub('\n', "\n")
-        options[:message] = Slack::Notifier::Util::LinkFormatter.format(options[:message])
+        options[:message] = Helper::SlackBotLinkFormatterHelper.format(options[:message])
         options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
 
         if options[:channel].to_s.length > 0
@@ -20,7 +20,7 @@ module Fastlane
           slack_channel = ('#' + options[:channel]) unless ['#', 'C', '@'].include?(slack_channel[0]) # Add prefix(#) by default, if needed
         end
 
-        slack_attachment = SlackAction.generate_slack_attachments(options)
+        slack_attachment = Helper::SlackBotAttachmentsHelper.generate_slack_attachments(options)
         bot_username = options[:username]
         bot_icon_url = options[:icon_url]
 
@@ -38,10 +38,11 @@ module Fastlane
             icon_url: bot_icon_url,
             attachments: [slack_attachment]
           }
+          payload[:as_user] = options[:as_user] if options[:as_user] # default is false
           payload[:thread_ts] = options[:thread_ts] unless options[:thread_ts].nil?
           payload = payload.to_json
 
-          response = Excon.post(api_url, headers: headers, body: payload)
+          response = Excon.post(api_url, headers: headers, body: payload, omit_default_port: true)
           result = self.formatted_result(response)
         rescue => exception
           UI.error("Exception: #{exception}")
@@ -104,6 +105,12 @@ module Fastlane
                                        default_value: "https://fastlane.tools/assets/img/fastlane_icon.png",
                                        is_string: true,
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :as_user,
+                                       env_name: "FL_POST_TO_SLACK_AS_USER",
+                                       description: "Pass true to post the message as the authed user. Defaults to false",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
           FastlaneCore::ConfigItem.new(key: :pretext,
                                        env_name: "FL_POST_TO_SLACK_PRETEXT",
                                        description: "This is optional text that appears above the message attachment block. This supports the standard Slack markup language",

data/lib/fastlane/plugin/slack_bot/actions/update_slack_message.rb

@@ -1,5 +1,7 @@
 require 'fastlane/action'
 require_relative '../helper/slack_bot_helper'
+require_relative '../helper/slack_bot_attachments_helper'
+require_relative '../helper/slack_bot_link_formatter_helper'
 
 module Fastlane
   module Actions
@@ -8,12 +10,10 @@ module Fastlane
     end
     class UpdateSlackMessageAction < Action
       def self.run(options)
-        require 'slack-notifier'
-
         options[:message] = (options[:message].to_s || '').gsub('\n', "\n")
-        options[:message] = Slack::Notifier::Util::LinkFormatter.format(options[:message])
+        options[:message] = Helper::SlackBotLinkFormatterHelper.format(options[:message])
         options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
-        slack_attachment = SlackAction.generate_slack_attachments(options)
+        slack_attachment = Helper::SlackBotAttachmentsHelper.generate_slack_attachments(options)
 
         begin
           require 'excon'

data/lib/fastlane/plugin/slack_bot/helper/slack_bot_attachments_helper.rb

@@ -0,0 +1,113 @@
+require 'fastlane_core/ui/ui'
+require 'fastlane_core/env'
+require_relative 'slack_bot_link_formatter_helper'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class SlackBotAttachmentsHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SlackBotAttachmentsHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the slack_bot plugin attachments helper!")
+      end
+
+      def self.generate_slack_attachments(options)
+        color = (options[:success] ? 'good' : 'danger')
+        should_add_payload = ->(payload_name) { options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
+
+        slack_attachment = {
+          fallback: options[:message],
+          text: options[:message],
+          pretext: options[:pretext],
+          color: color,
+          mrkdwn_in: ["pretext", "text", "fields", "message"],
+          fields: []
+        }
+
+        # custom user payloads
+        slack_attachment[:fields] += options[:payload].map do |k, v|
+          {
+            title: k.to_s,
+            value: SlackBotLinkFormatterHelper.format(v.to_s),
+            short: false
+          }
+        end
+
+        # Add the lane to the Slack message
+        # This might be nil, if slack is called as "one-off" action
+        if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
+          slack_attachment[:fields] << {
+            title: 'Lane',
+            value: Actions.lane_context[Actions::SharedValues::LANE_NAME],
+            short: true
+          }
+        end
+
+        # test_result
+        if should_add_payload[:test_result]
+          slack_attachment[:fields] << {
+            title: 'Result',
+            value: (options[:success] ? 'Success' : 'Error'),
+            short: true
+          }
+        end
+
+        # git branch
+        if Actions.git_branch && should_add_payload[:git_branch]
+          slack_attachment[:fields] << {
+            title: 'Git Branch',
+            value: Actions.git_branch,
+            short: true
+          }
+        end
+
+        # git_author
+        if Actions.git_author_email && should_add_payload[:git_author]
+          if FastlaneCore::Env.truthy?('FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS') && options[:success]
+            # We only show the git author if the build failed
+          else
+            slack_attachment[:fields] << {
+              title: 'Git Author',
+              value: Actions.git_author_email,
+              short: true
+            }
+          end
+        end
+
+        # last_git_commit
+        if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
+          slack_attachment[:fields] << {
+            title: 'Git Commit',
+            value: Actions.last_git_commit_message,
+            short: false
+          }
+        end
+
+        # last_git_commit_hash
+        if Actions.last_git_commit_hash(true) && should_add_payload[:last_git_commit_hash]
+          slack_attachment[:fields] << {
+            title: 'Git Commit Hash',
+            value: Actions.last_git_commit_hash(short: true),
+            short: false
+          }
+        end
+
+        # merge additional properties
+        deep_merge(slack_attachment, options[:attachment_properties])
+      end
+
+      # Adapted from https://stackoverflow.com/a/30225093/158525
+      def self.deep_merge(a, b)
+        merger = proc do |key, v1, v2|
+          Hash === v1 && Hash === v2 ?
+                 v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
+                   v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
+        end
+        a.merge(b, &merger)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/slack_bot/helper/slack_bot_link_formatter_helper.rb

@@ -0,0 +1,82 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    # Fastlane is moving away 'slack-notifier' gem, https://github.com/fastlane/fastlane/pull/18512
+    # Duplicate of: https://github.com/stevenosloan/slack-notifier/blob/master/lib/slack-notifier/util/link_formatter.rb
+    class SlackBotLinkFormatterHelper
+        # http://rubular.com/r/19cNXW5qbH
+        HTML_PATTERN = %r{
+          <a
+          (?:.*?)
+          href=['"](.+?)['"]
+          (?:.*?)>
+          (.+?)
+          </a>
+        }x
+
+        # the path portion of a url can contain these characters
+        VALID_PATH_CHARS = '\w\-\.\~\/\?\#\='
+
+        # Attempt at only matching pairs of parens per
+        # the markdown spec http://spec.commonmark.org/0.27/#links
+        #
+        # http://rubular.com/r/y107aevxqT
+        MARKDOWN_PATTERN = %r{
+            \[ ([^\[\]]*?) \]
+            \( ((https?://.*?) | (mailto:.*?)) \)
+            (?! [#{VALID_PATH_CHARS}]* \) )
+        }x
+
+        class << self
+          def format string, opts={}
+            SlackBotLinkFormatterHelper.new(string, **opts).formatted
+          end
+        end
+
+        attr_reader :formats
+
+        def initialize string, opts = {}
+          @formats = opts[:formats] || %i[html markdown]
+          @orig    = string.respond_to?(:scrub) ? string.scrub : string
+        end
+
+        # rubocop:disable Lint/RescueWithoutErrorClass
+        def formatted
+          return @orig unless @orig.respond_to?(:gsub)
+
+          sub_markdown_links(sub_html_links(@orig))
+        rescue => e
+          raise e unless RUBY_VERSION < "2.1" && e.message.include?("invalid byte sequence")
+          raise e, "#{e.message}. Consider including the 'string-scrub' gem to strip invalid characters"
+        end
+        # rubocop:enable Lint/RescueWithoutErrorClass
+
+        private
+
+          def sub_html_links string
+            return string unless formats.include?(:html)
+
+            string.gsub(HTML_PATTERN) do
+              slack_link Regexp.last_match[1], Regexp.last_match[2]
+            end
+          end
+
+          def sub_markdown_links string
+            return string unless formats.include?(:markdown)
+
+            string.gsub(MARKDOWN_PATTERN) do
+              slack_link Regexp.last_match[2], Regexp.last_match[1]
+            end
+          end
+
+          def slack_link link, text=nil
+            "<#{link}" \
+            "#{text && !text.empty? ? "|#{text}" : ''}" \
+            ">"
+          end
+      end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module SlackBot
-    VERSION = "0.4.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-slack_bot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Manish Rathi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -149,7 +149,9 @@ files:
 - lib/fastlane/plugin/slack_bot/actions/file_upload_to_slack.rb
 - lib/fastlane/plugin/slack_bot/actions/post_to_slack.rb
 - lib/fastlane/plugin/slack_bot/actions/update_slack_message.rb
+- lib/fastlane/plugin/slack_bot/helper/slack_bot_attachments_helper.rb
 - lib/fastlane/plugin/slack_bot/helper/slack_bot_helper.rb
+- lib/fastlane/plugin/slack_bot/helper/slack_bot_link_formatter_helper.rb
 - lib/fastlane/plugin/slack_bot/version.rb
 homepage: https://github.com/crazymanish/fastlane-plugin-slack_bot
 licenses: