fastlane-plugin-slack_bot 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e0d95cdc34c99e1608ec3d1e30ff2f0b538516bd370fd166bc09c97d61e5781
-  data.tar.gz: cc8eb032bfc0b3e3022a2a390981120cdf9245812ef46c7fbe9ff0dd2808a0f5
+  metadata.gz: 289a56616a3791c91d4aa9033fe725da23f086ba112f63f383617de611824aa9
+  data.tar.gz: 406ed9f6c5809ed39b6ea2024f9c998409bcb11711616006714fdfef28063441
 SHA512:
-  metadata.gz: 9d76ae4594ce67f876db6d0fe4673503f05088e64cad0bf6faf5bd5f0fcaaa5d972f2c146454aa425e6a1de980436297533e5881eb8438547e78878783dc6706
-  data.tar.gz: d0abe8adad2c616a9feb9521bf29a2cda9f49cbab0f4895379bbb97fd2ed2791d354f9b1bdafdb59430e0773ecf0baa9888d0aa0ecefd6e448974f866dda0556
+  metadata.gz: 821fbff8025635a8c8728e40ceccc52f54db653fc2aaa4ddeed6d7bb5aaec10d78798b19a88282c44ba8168fb0342da8804030bbbf715299827e0b38aca60f9e
+  data.tar.gz: d9bd6cc8c9aa8d0dd1704ddd583735f3400a38d2ac440b0a61ff63aa586b079d3b93b75d5f5770f28e523ef097abeaf4142b56ceaefaf77e1f08d0e99e959b2c

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/)
 
@@ -175,7 +175,7 @@ Let’s post a message with custom slack bot username and icon
 # share on Slack
 post_to_slack(
   message: "App successfully released!",
-  username: "Release Bot", # Overrides the bot's image
+  username: "Release Bot", # Overrides the bot's username
   icon_url: "https://fastlane.tools/assets/img/fastlane_icon.png" # Overrides the bot's icon
 )
 ```

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]
 

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, formats: %i[html markdown]
+          @formats = formats
+          @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.1"
+    VERSION = "1.0.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.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Manish Rathi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-04-18 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: