fastlane-plugin-slack_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16e39b2fce849554b6c4885cffaa8927490484da4a1a1f0999bfec1a8ccc78e4
+  data.tar.gz: ceea881ae3a883a66b086d38b29ae50aaa2ff4fd5b099edd08204b799a0908d9
+SHA512:
+  metadata.gz: 6e529ea68942f05f0c4d46942679cea2089d29eb21b89acf1388fb35c46128507aadbdd324863154dc01fadb4fc50d7f22f76f64cf6fc06718e103d07eb736ef
+  data.tar.gz: ff5a0a712d16ac057c0960463bd4eeac9d808c5dece2e9d39e39564b474cd107cc6bb3842c9374fad778277ccbfeb043d6ba14620945da1bb640404b328b249a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Manish Rathi <m.rathi@catawiki.nl>
+
+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,65 @@
+## 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)
+
+## 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 limitations.
+
+## Getting Started
+
+1. Generate `Slack token` for `Fastlane` bot
+    - From your Slack organization page, go to `Manage` -> `Custom Integrations`
+    - Open `Bots`
+    - Add Configuration
+    - Choose a name for your bot, e.g. `"fastlane"`
+    - Save `API Token`
+
+2. Add plugin in your project
+
+```bash
+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 
+```
+
+3. Add `slack_bot` to your lane in `Fastfile` whenever you want to post a slack message
+
+In the following example lets send slack message to `#ios-team` channel for 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(
+    api_token: "xyz", # Preferably configure as ENV['SLACK_API_TOKEN']
+    message: "Hi team, we have a new test-flight beta build: #{beta_release_name}",
+    channel: "#ios-team"
+  )
+end
+```
+
+## 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/slack_bot.rb

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

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

@@ -0,0 +1,127 @@
+require 'fastlane/action'
+require_relative '../helper/slack_bot_helper'
+
+module Fastlane
+  module Actions
+    class PostToSlackAction < Action
+      def self.run(params)
+        require 'slack-notifier'
+
+        options[:message] = (options[:message].to_s || '').gsub('\n', "\n")
+        options[:message] = Slack::Notifier::Util::LinkFormatter.format(options[:message])
+
+        options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
+
+        if options[:channel].to_s.length > 0
+          slack_channel = options[:channel]
+          slack_channel = ('#' + options[:channel]) unless ['#', '@'].include?(slack_channel[0]) # send message to channel by default
+        end
+
+        slack_attachment = SlackAction.generate_slack_attachments(options)
+
+        begin
+          require 'excon'
+
+          api_url = "https://slack.com/api/chat.postMessage"
+          headers = { "Content-Type": "application/json", "Authorization": "Bearer #{options[:api_token]}" }
+          payload = { channel: slack_channel, attachments: [slack_attachment] }.to_json
+
+          Excon.post(api_url, headers: headers, body: payload)
+        rescue => exception
+          UI.error("Exception: #{exception}")
+        else
+          UI.success("Successfully sent Slack notification")
+        end
+      end
+
+      def self.description
+        "Post a slack message"
+      end
+
+      def self.details
+        "Post a slack message to any #channel/@user using Slack bot chat postMessage api."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "FL_POST_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: :channel,
+                                       env_name: "FL_POST_TO_SLACK_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: true),
+          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",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_POST_TO_SLACK_MESSAGE",
+                                       description: "The message that should be displayed on Slack",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :payload,
+                                       env_name: "FL_POST_TO_SLACK_PAYLOAD",
+                                       description: "Add additional information to this post. payload must be a hash containing any key with any value",
+                                       default_value: {},
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :default_payloads,
+                                       env_name: "FL_POST_TO_SLACK_DEFAULT_PAYLOADS",
+                                       description: "Remove some of the default payloads. More information about the available payloads on GitHub",
+                                       optional: true,
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :attachment_properties,
+                                       env_name: "FL_POST_TO_SLACK_ATTACHMENT_PROPERTIES",
+                                       description: "Merge additional properties in the slack attachment, see https://api.slack.com/docs/attachments",
+                                       default_value: {},
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :success,
+                                       env_name: "FL_POST_TO_SLACK_SUCCESS",
+                                       description: "Was this successful? (true/false)",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false)
+        ]
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.example_code
+        [
+          'post_to_slack(message: "App successfully released!")',
+          'post_to_slack(
+            message: "App successfully released!",
+            channel: "#channel",  # Optional, by default will post to the default channel configured for the POST URL.
+            success: true,        # Optional, defaults to true.
+            payload: {            # Optional, lets you specify any number of your own Slack attachments.
+              "Build Date" => Time.new.to_s,
+              "Built by" => "Jenkins",
+            },
+            default_payloads: [:git_branch, :git_author], # Optional, lets you specify a whitelist of default payloads to include. Pass an empty array to suppress all the default payloads.
+                                                          # Don\'t add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit`, `last_git_commit_hash`.
+            attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
+                                     # This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
+              thumb_url: "http://example.com/path/to/thumb.png",
+              fields: [{
+                title: "My Field",
+                value: "My Value",
+                short: true
+              }]
+            }
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/slack_bot/helper/slack_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 SlackBotHelper
+      # class methods that you define here become available in your action
+      # as `Helper::SlackBotHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the slack_bot plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-slack_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manish Rathi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-27 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.148.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.148.1
+description: 
+email: manishrathi19902013@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/slack_bot.rb
+- lib/fastlane/plugin/slack_bot/actions/post_to_slack.rb
+- lib/fastlane/plugin/slack_bot/helper/slack_bot_helper.rb
+- lib/fastlane/plugin/slack_bot/version.rb
+homepage: https://github.com/crazymanish/fastlane-plugin-slack_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: "A fastlane plugin to post slack message using bot api token. \U0001F680"
+test_files: []