fastlane-plugin-slack_bot 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20831e77ecd2bd1e1417a5e87175deb52e3c50dfb06b29620dbf0d709ff9f5f6
-  data.tar.gz: 05dac64d7c171616d1751a8118400e584297afc85ff76c92c90f3c0427f87885
+  metadata.gz: 4f2aabbc8c122fde9ab66c2f19a43ee068eeb1905fe71676b58f3f97615df758
+  data.tar.gz: 2f14989f7e4afcf43fd873748b385bb9fb30c5e8b419d4c4ad35b5f910dedd8b
 SHA512:
-  metadata.gz: d07cf960466cdaa41f6a6a36bcb88cc25bb8befd531f519948c6a2416e72f7809d100b0c0706fbac4e1501b4b7f0fa9eb5156c3c8c06dc553d193450ca689902
-  data.tar.gz: 84bfcbf72612922233b819899443c64b9fbd00fda7decaec4f49e1a40c0bec695c3785efe797acda0f29261cfd10de008e5488cdbe5877597229d1ec0dde9279
+  metadata.gz: 4aa6547bd6c2d4b3f4275be0296027171e1e4f47e90540bd676e1adedc92840bc5945972e1462ada73f1a30eabf8ba7eeebaf9d46e76205d81053bc2595ceb3b
+  data.tar.gz: 15a515660c49d9ca4b7d9de700c4212692402c05d53feba5b039fadc82c00f7bf03fcd6255b8467c659ef8545028f823723ef3e30cde8efbd7144fc1b1e8ebfc

data/README.md

@@ -1,11 +1,30 @@
 ## Fastlane `slack_bot` plugin
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-slack_bot) ![![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_)
-
-## About slack_bot
-
-A fastlane plugin to post slack message using bot api token. 🚀\
-Note: `Fastlane` comes with `slack` plugin by default, which uses slack webhook url, which can't send direct message & other webhook limitations.
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-slack_bot)
+![![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_)
+
+A fastlane plugin to customize your automation workflow(s) with a **Slack Bot** 🤖 using the [Slack APIs](https://api.slack.com/)
+
+- [About](#about)
+- [Getting Started](#getting-started)
+- [Features](#features)
+- [Post a message](#examples-post-a-message) examples
+- [Upload a file](#examples-upload-a-message) examples
+- [About Fastlane](#about-fastlane)
+
+## About
+
+A fastlane plugin to post slack message and much more using Slack bot api token. 🚀\
+**Note:** `Fastlane` comes with built-in `slack` action by default, which uses slack webhook url and have webhook limitations.  
+i.e Listing couple of slack **webhook url** limitations:
+- can't post a direct message to a slack user.
+- can’t post a message inside a slack thread.
+- can’t update a posted slack message.
+- can’t list and upload a file inside a slack channel.
+- much more, compare to a **Slack Bot** 🤖 using the [Slack APIs](https://api.slack.com/)
 
 ## Getting Started
 
@@ -23,41 +42,64 @@ fastlane add_plugin slack_bot
 ```
 If you are using fastlane using Gemfile in your project, add it to your project by running:
 ```bash
-bundle exec fastlane add_plugin slack_bot 
+bundle exec fastlane add_plugin slack_bot
 ```
 
-3. Add `slack_bot` to your lane in `Fastfile` whenever you want to post a slack message
+3. Use `slack_bot` features inside your lane in `Fastfile` whenever you want.
+
+## Features
+Using this `slack_bot` plugin, you can:
+
+- Post a message using [chat.postMessage](https://api.slack.com/methods/chat.postMessage) Slack API
+  - [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)
+
+- Update a message using [chat.update](https://api.slack.com/methods/chat.update) Slack API
+  - [x] update a message in a channel
+
+- List of files in a channel using [files.list](https://api.slack.com/methods/files.list) Slack API
+  - [x] A list of files in a channel, It can be filtered and sliced in various ways.
+
+- Upload a file using [files.upload](https://api.slack.com/methods/files.upload) Slack API
+  - [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
 
-## Examples
 
-In the following example lets send a message to the default slack bot channel.
+## Examples (Post a message)
+
+Let’s post a message to the default slack bot channel.
 
 ```ruby
 # share on Slack
-  post_to_slack(message: "App successfully released!")
+post_to_slack(message: "App successfully released!")
 ```
 
-In the following example lets send a direct message to a slack user that unit tests CI has been failed.
+Let’s post a direct message to a slack user that unit tests CI has been failed.
 
 ```ruby
 # share on Slack
-  post_to_slack(
-    message: "CI: Your unit tests on #{ENV['CI_COMMIT_REF_NAME']} failed",
-    channel: "@SlackUsername" # This can be Slack userID, instead of username i.e @UXXXXX
-  )
+post_to_slack(
+  message: "CI: Your unit tests on #{ENV['CI_COMMIT_REF_NAME']} failed",
+  channel: "@SlackUsername" # This can be Slack userID, instead of username i.e @UXXXXX
+)
 ```
 
-In the following example lets send slack message to `#ios-team` channel for test-flight build.
+Let’s post a slack message to the `#ios-team` channel about the new test-flight build.
 
 ```ruby
 lane :beta do
   gym # Build the app and create .ipa file
   pilot # Upload build to TestFlight
-  
+
   version_number = get_version_number # Get project version
   build_number = get_build_number # Get build number
   beta_release_name = "#{version_number}-#{build_number}-beta-release"
-  
+
   # share on Slack
   post_to_slack(
     message: "Hi team, we have a new test-flight beta build: #{beta_release_name}",
@@ -66,7 +108,7 @@ lane :beta do
 end
 ```
 
-In the following example lets send slack message with custom payload.
+Let’s post a slack message with custom payload.
 
 ```ruby
 # share on Slack
@@ -93,18 +135,104 @@ post_to_slack(
 )
 ```
 
-## Issues and Feedback
+Let’s post a slack message inside a slack thread 🧵
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+```ruby
+lane :release do
+  # Start the release with slack release thread
+  release_thread = post_to_slack(
+    message: "Good morning team, CI has started the AppStore release. You can find more information inside this thread 🧵",
+    channel: "#ios-team"
+  )
+
+  # Important: Save this slack thread timestamp for futher slack messages
+  release_thread_ts = release_thread[:json]["ts"]
+
+  gym # Build the app and create .ipa file
+
+  # Post an update in release thread
+  post_to_slack(
+    message: "App has been build successfully! 💪",
+    channel: "#ios-team",
+    thread_ts: release_thread_ts
+  )
 
-## Troubleshooting
+  deliver # Upload build to AppStore
+
+  # Post an update in release thread
+  post_to_slack(
+    message: "App has been uploaded to the AppStore and submitted for Apple's review! 🚀",
+    channel: "#ios-team",
+    thread_ts: release_thread_ts
+  )
+end
+```
 
-If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+## Examples (Upload a file)
 
-## Using _fastlane_ Plugins
+Let’s Upload a file to a slack channel that main branch unit tests has been failed, see scan logs.
 
-For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+```ruby
+# File upload on Slack
+file_upload_to_slack(
+  initial_comment: "CI: main-branch unit tests failed",
+  file_path: "scan.log",
+  channels: "#ios-team" # Comma-separated list of slack #channel names where the file will be shared
+)
+```
+
+Let’s Upload a file to a slack user that your branch unit tests has been failed, see scan logs.
+
+```ruby
+# File upload on Slack
+file_upload_to_slack(
+  initial_comment: "CI: Your unit tests on #{ENV['CI_COMMIT_REF_NAME']} failed",
+  file_path: "scan.log",
+  channels: "@SlackUsername" # This can be Slack userID, instead of username i.e @UXXXXX
+)
+```
+
+Let’s Upload a file inside a slack thread 🧵
+
+```ruby
+lane :release do
+  # Start the release with slack release thread
+  release_thread = post_to_slack(
+    message: "Good morning team, CI has started the AppStore release. You can find more information inside this thread 🧵",
+    channel: "#ios-team"
+  )
+
+  # Important: Save this slack thread timestamp for futher slack messages
+  release_thread_ts = release_thread[:json]["ts"]
+
+  gym # Build the app and create .ipa file
+
+  # Post an update in release thread
+  post_to_slack(
+    message: "App has been build successfully! 💪",
+    channel: "#ios-team",
+    thread_ts: release_thread_ts
+  )
+
+  deliver # Upload build to AppStore
+
+  # Post an update in release thread
+  post_to_slack(
+    message: "App has been uploaded to the AppStore and submitted for Apple's review! 🚀",
+    channel: "#ios-team",
+    thread_ts: release_thread_ts
+  )
+
+  # Spaceship logs file upload on Slack
+  file_upload_to_slack(
+    initial_comment: "Deliver:: Spaceship logs",
+    file_path: "spaceship.log",
+    channels: "#ios-team",
+    thread_ts: release_thread_ts
+  )
+end
+```
 
-## About _fastlane_
+## 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/slack_bot/actions/file_upload_to_slack.rb

@@ -0,0 +1,176 @@
+require 'fastlane/action'
+require_relative '../helper/slack_bot_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      FILE_UPLOAD_TO_SLACK_RESULT = :FILE_UPLOAD_TO_SLACK_RESULT
+    end
+
+    class FileUploadToSlackAction < Action
+      def self.run(params)
+        file_path = params[:file_path]
+
+        if params[:file_name].to_s.empty?
+          file_name = File.basename(file_path, ".*") # if file_path = "/path/file_name.jpeg" then will return "file_name"
+        else
+          file_name = params[:file_name]
+        end
+
+        if params[:file_type].to_s.empty?
+          file_type = File.extname(file_path)[1..-1] # if file_path = "/path/file_name.jpeg" then will return "jpeg"
+        else
+          file_type = params[:file_type]
+        end
+
+        begin
+          require 'faraday'
+
+          api_url = "https://slack.com/api/files.upload"
+          conn = Faraday.new(url: api_url) do |faraday|
+            faraday.request :multipart
+            faraday.request :url_encoded
+            faraday.adapter :net_http
+          end
+
+          payload = {
+            channels: params[:channels],
+            file: Faraday::FilePart.new(file_path, file_type),
+            filename: file_name,
+            filetype: file_type
+          }
+
+          payload[:title] = params[:title] unless params[:title].nil?
+          payload[:initial_comment] = params[:initial_comment] unless params[:initial_comment].nil?
+          payload[:thread_ts] = params[:thread_ts] unless params[:thread_ts].nil?
+
+          response = conn.post do |req|
+            req.headers['Authorization'] = "Bearer #{params[:api_token]}"
+            req.body = payload
+           end
+
+          result = self.formatted_result(response)
+        rescue => exception
+          UI.error("Exception: #{exception}")
+          return nil
+        else
+          UI.success("Successfully uploaded file to Slack! 🚀")
+          Actions.lane_context[SharedValues::FILE_UPLOAD_TO_SLACK_RESULT] = result
+          return result
+        end
+      end
+
+      def self.formatted_result(response)
+        result = {
+          status: response[:status],
+          body: response.body || "",
+          json: self.parse_json(response.body) || {}
+        }
+      end
+
+      def self.parse_json(value)
+        require 'json'
+
+        JSON.parse(value)
+      rescue JSON::ParserError
+        nil
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload a file to slack channel"
+      end
+
+      def self.details
+        "Upload a file to slack channel or DM to a slack user"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_BOT_TOKEN",
+                                       description: "Slack bot Token",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["SLACK_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :channels,
+                                       env_name: "FL_FETCH_FILES_SLACK_CHANNELS",
+                                       description: "Comma-separated list of slack #channel names where the file will be shared",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :file_path,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_FILE_PATH",
+                                       description: "relative file path which will upload to slack",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :file_name,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_FILE_NAME",
+                                       description: "This is optional filename of the file",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :file_type,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_FILE_TYPE",
+                                       description: "This is optional filetype of the file",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :title,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_TITLE",
+                                       description: "This is optional Title of file",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :initial_comment,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_INITIAL_COMMENT",
+                                       description: "This is optional message text introducing the file",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :thread_ts,
+                                       env_name: "FL_FILE_UPLOAD_TO_SLACK_THREAD_TS",
+                                       description: "Provide another message's ts value to make this message a reply",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.example_code
+        [
+          'file_upload_to_slack(
+            channels: "slack_channel_name",
+            file_path: "fastlane/test.png"
+          )',
+          'file_upload_to_slack(
+            title: "This is test title",
+            channels: "slack_channel_name1, slack_channel_name2",
+            file_path: "fastlane/report.xml"
+          )',
+          'file_upload_to_slack(
+            title: "This is test title",
+            initial_comment: "This is test initial comment",
+            channels: "slack_channel_name",
+            file_path: "fastlane/screenshots.zip"
+          )',
+          'file_upload_to_slack(
+            title: "This is test title", # Optional, uploading file title
+            initial_comment: "This is test initial comment",  # Optional, uploading file initial comment
+            channels: "slack_channel_name",
+            file_path: "fastlane/screenshots.zip",
+            thread_ts: thread_ts # Optional, Provide parent slack message `ts` value to upload this file as a reply.
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-slack_bot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manish Rathi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -146,6 +146,7 @@ files:
 - README.md
 - lib/fastlane/plugin/slack_bot.rb
 - lib/fastlane/plugin/slack_bot/actions/fetch_files_slack.rb
+- 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_helper.rb