fastlane-plugin-discord_webhook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c623e59ee75e6ee3443dbf34fda73c834a831bc2a90ff0a0bb6cb0a86924146
+  data.tar.gz: e726c49563e2df88536facd4cc9492d6bbc8a15d01b131dbf147cb6fbeff1d8d
+SHA512:
+  metadata.gz: b493ed928ef47e68b470d13da492a5b150dc4365511bf16f4aad30ffbd4fdabc193df426fe18ba67a93e406d033ed212dbd4c765c5a6622a15e3baec682f3875
+  data.tar.gz: b2bf0e922d25b2660ab0a38d2c68c7b8c8242a9fc5fb651d5a84a70f031609a111540890685e955b5811dd1fcac40457fdae8d6ef7e8a99851ae4a0da843e6c6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Takuma Homma <nagomimatcha@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,73 @@
+# discord_webhook plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-discord_webhook)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-discord_webhook`, add it to your project by running:
+
+```bash
+fastlane add_plugin discord_webhook
+```
+
+## About discord_webhook
+
+Send a message using Discord Webhook
+
+## Usage
+
+| Key | Description |
+| :--: | :--: |
+| `webhook_url` | Discord Webhook URL. |
+| `username` | [Optional] Username. It will override webhook's username if specified. |
+| `message`  | The message you want to send. |
+| `attachment_file_path` | [Optional] File path to upload. See details for supported types: https://discord.com/developers/docs/reference#uploading-files |
+| `embed_payload` | [Optional] Embed Object. You can specify one object. See details: https://discord.com/developers/docs/resources/message#embed-object |
+
+## Example
+
+```ruby
+lane :discord_message do
+  discord_webhook(
+    webhook_url: 'https://yourDiscordWebhookUrl',
+    message: 'hello'
+  )
+end
+```
+
+```ruby
+lane :discord_message_with_file do
+  discord_webhook(
+    webhook_url: 'https://yourDiscordWebhookUrl',
+    message: 'hello',
+    attachment_file_path: '/home/mataku/screenshot.png',
+    # Be careful to use relative path.
+    # Fastfile is into fastlane/, but fastlane tries to load from working directory.
+  )
+end
+```
+
+```ruby
+lane :discord_message_with_embed do
+  discord_webhook(
+    webhook_url: 'https://yourDiscordWebhookUrl',
+    message: 'hello',
+    embed_payload: {
+      title: 'embed_title',
+      description: 'embed_description',
+      url: 'https://github.com/mataku',
+      thumbnail: {
+        url: 'https://github.com/mataku.png'
+      }
+    }
+  )
+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.

data/lib/fastlane/plugin/discord_webhook/actions/discord_webhook_action.rb

@@ -0,0 +1,119 @@
+require 'fastlane/action'
+require 'json'
+require 'net/http'
+require_relative '../helper/discord_webhook_helper'
+require_relative '../discord_client'
+
+module Fastlane
+  module Actions
+    class DiscordWebhookAction < Action
+      def self.run(params)
+        webhook_url = params[:webhook_url]
+        if webhook_url.nil? || webhook_url.empty?
+          UI.user_error!('`webhook_url:` parameter is invalid. Please provide a valid URL.')
+        end
+
+        message = params[:message]
+        username = params[:username]
+        file_path = params[:attachment_file_path]
+        embed_payload = params[:embed_payload]
+
+        client = DiscordWebhook::DiscordClient.new(webhook_url)
+        begin
+          response = client.send_message(
+            username: username,
+            content: message,
+            file_path: file_path,
+            embed_payload: embed_payload
+          )
+          handle_response(response)
+        rescue StandardError => e
+          UI.user_error!(e.message)
+        end
+      end
+
+      def self.description
+        "Send a message using Discord Webhook"
+      end
+
+      def self.authors
+        ["Takuma Homma"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "Send a message using Discord Webhook"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :webhook_url,
+            env_name: "FL_DISCORD_WEBHOOK_URL",
+            description: "Discord Webhook URL",
+            optional: false,
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!('`webhook_url:` parameter is invalid. Please provide a valid URL.') if value.nil? || value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :message,
+            env_name: "FL_DISCORD_WEBHOOK_MESSAGE",
+            description: "The message you want to send",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :username,
+            env_name: "FL_DISCORD_WEBHOOK_USERNAME",
+            description: "[Optional] Username",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :attachment_file_path,
+            env_name: "FL_DISCORD_WEBHOOK_ATTACHMENT_FILE_PATH",
+            description: "[Optional] File path to upload",
+            optional: true,
+            type: String,
+            verify_block: proc do |value|
+              if value
+                UI.user_error!("#{value} not found! Specify correct file path.") unless File.exist?(value)
+              end
+            end
+          ),
+          # See: https://discord.com/developers/docs/resources/message#embed-object
+          FastlaneCore::ConfigItem.new(
+            key: :embed_payload,
+            env_name: "FL_DISCORD_WEBHOOK_EMBED_PAYLOAD",
+            description: "[Optional] Embed Object. You can specify one object. See details: https://discord.com/developers/docs/resources/message#embed-object",
+            optional: true,
+            type: Hash
+          )
+          # TODO: multiple file and embed contents if needed
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.handle_response(response)
+        if response.kind_of?(Net::HTTPSuccess)
+          UI.success('Successfully sent a message to Discord')
+        else
+          error_body = begin
+            JSON.parse(response.body)['message']
+          rescue StandardError
+            ''
+          end
+          UI.user_error!("Failed to send a message to Discord: #{error_body}")
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/discord_webhook/discord_client.rb

@@ -0,0 +1,98 @@
+require 'json'
+require 'net/http'
+
+module Fastlane
+  module DiscordWebhook
+    class DiscordClient
+      attr_accessor :webhook_url
+
+      # @param webhook_url [String]
+      def initialize(webhook_url)
+        @webhook_url = webhook_url
+      end
+
+      # @param username [String]
+      # @param content [String]
+      # @param file_path [String]
+      # @param embed_payload [Hash]
+      # @param debug [Boolean]
+      def send_message(username:, content:, file_path:, embed_payload:, debug: false)
+        if file_path.nil? || file_path.empty?
+          send_message_with_embed(username: username, content: content, embed_payload: embed_payload, debug: debug)
+        else
+          send_message_with_file(username: username, content: content, file_path: file_path, embed_payload: embed_payload, debug: debug)
+        end
+      end
+
+      private
+
+      # @param username [String]
+      # @param content  [String]
+      # @param file_path  [String]
+      # @param embed_payload [Hash]
+      # @param debug    [Boolean]
+      def send_message_with_file(username:, content:, file_path:, embed_payload:, debug: false)
+        uri = URI.parse(@webhook_url)
+        request = Net::HTTP::Post.new(uri)
+        embed_payload_content = if embed_payload.nil? || embed_payload.empty?
+                                  []
+                                else
+                                  [embed_payload]
+                                end
+        payload_json = if !username.nil? && !username.empty?
+                         { username: username, content: content, embeds: embed_payload_content }
+                       else
+                         { content: content, embeds: embed_payload_content }
+                       end
+        request.set_form(
+          [
+            [
+              'payload_json',
+              payload_json.to_json
+            ],
+            [
+              'file1',
+              File.open(file_path)
+            ]
+          ],
+          'multipart/form-data'
+        )
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = true
+        http.set_debug_output($stderr) if debug
+        http.start do |h|
+          h.request(request)
+        end
+      end
+
+      # @param username [String]
+      # @param content  [String]
+      # @param embed_payload [Hash]
+      # @param debug    [Boolean]
+      def send_message_with_embed(username:, content:, embed_payload:, debug: false)
+        uri = URI.parse(@webhook_url)
+        request = Net::HTTP::Post.new(uri)
+        request.content_type = 'application/json'
+        embed_payload_content = if embed_payload.nil? || embed_payload.empty?
+                                  []
+                                else
+                                  [embed_payload]
+                                end
+
+        body = {
+          content: content,
+          embeds: embed_payload_content
+        }
+        body[:username] = username if !username.nil? && !username.empty?
+        request.body = body.to_json
+
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = true
+        http.set_debug_output($stderr) if debug
+        http.start do |h|
+          h.request(request)
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/discord_webhook/helper/discord_webhook_helper.rb

@@ -0,0 +1,86 @@
+require 'fastlane_core/ui/ui'
+require 'json'
+require 'net/http'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class DiscordWebhookHelper
+      # class methods that you define here become available in your action
+      # as `Helper::DiscordWebhookHelper.your_method`
+
+      def self.send_message_with_file(webhook_url:, username:, content:, file_path:, embed_title:, embed_description:, embed_url:, embed_icon_url:, debug: false)
+        uri = URI.parse(webhook_url)
+        request = Net::HTTP::Post.new(uri)
+        payload_json = if !username.nil? && !username.empty?
+                         { username: username, content: content }
+                       else
+                         { content: content }
+                       end
+        request.set_form(
+          [
+            [
+              'payload_json',
+              payload_json.to_json
+            ],
+            [
+              'file1',
+              File.open(file_path)
+            ]
+          ],
+          'multipart/form-data'
+        )
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = true
+        http.set_debug_output($stderr) if debug
+        response = http.start do |h|
+          h.request(request)
+        end
+        handle_response(response)
+      end
+
+      def self.send_message_with_embed(webhook_url:, username:, content:, embed_title:, embed_description:, embed_url:, embed_thumbnail_url:, debug: false)
+        uri = URI.parse(webhook_url)
+        request = Net::HTTP::Post.new(uri)
+        request.content_type = 'application/json'
+        embed = {
+          type: 'link',
+          title: embed_title,
+          description: embed_description,
+          url: embed_url
+        }
+        if !embed_icon_url.nil? && !embed_icon_url.empty?
+          embed[:thumbnail] = {
+            url: embed_thumbnail_url
+          }
+        end
+
+        body = {
+          content: content,
+          embeds: [embed]
+        }
+        body[:username] = username if !username.nil? && !username.empty?
+        request.body = body.to_json
+
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = true
+        http.set_debug_output($stderr) if debug
+        response = http.start do |h|
+          h.request(request)
+        end
+
+        handle_response(response)
+      end
+
+      def self.handle_response(response)
+        if response.kind_of?(Net::HTTPSuccess)
+          UI.success('Successfully sent a message to Discord')
+        else
+          error_body = JSON.parse(response.body)
+          UI.user_error!("Failed to send a message to Discord: #{error_body}")
+        end
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/discord_webhook.rb

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

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-discord_webhook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuma Homma
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies: []
+description:
+email: nagomimatcha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/discord_webhook.rb
+- lib/fastlane/plugin/discord_webhook/actions/discord_webhook_action.rb
+- lib/fastlane/plugin/discord_webhook/discord_client.rb
+- lib/fastlane/plugin/discord_webhook/helper/discord_webhook_helper.rb
+- lib/fastlane/plugin/discord_webhook/version.rb
+homepage: https://github.com/mataku/fastlane-plugin-discord_webhook
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A fastlane plugin to send a message via Discord Webhook
+test_files: []