fastlane-plugin-discord_notifier 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3001a33edbdf017d3f5c0e0b27042bad5faed8b868c9d411f062a92f5a93937b
-  data.tar.gz: 484b513d6f1da18ca2564d20587fc632b40551ab7e307125a44ae4fca57c7e3e
+  metadata.gz: df02d5432c8eb9b837f56d41a5dcfacb0024acdc8f1a983df5dfd7767afc8333
+  data.tar.gz: 6e0b0dff9b4edbad76724402b4cbe47de7fb6dbdc8a2b334c84c07b18a2486aa
 SHA512:
-  metadata.gz: ff1a4850e14eb14761965adbcc50b89342e62f7e6fd0d5d6261556e06bd110064340e418cee9d5020ff481c1b4edd69fa93387dbc308b6ff24325c8fa2080ed0
-  data.tar.gz: ab56eadd8fca161bef9914b8668949b428b08710e7c3c7a14c5e2bb640f9d358f7a781eae42bd9eabfff91eed2c3d8da11cc7adf6d4ab0e3ae8ff935caba77b0
+  metadata.gz: 05b8709efcc84b6047898fd05219ea97a4a0bffc1e77cef6a27e26197839ea092547b649c3c60176197749d219b96e18be9201bb64d1759192bf599f4ba51bc6
+  data.tar.gz: dc7304c5f2a4deb38a1b0b851b66415f23147ba2a78bb89a019ef37cdc510c7d22fb3ae4ff7fbd94ed849e68a2622ff3098014d55b6ed63aabdefbbb1a0086e1

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2020 Nikos Theodosis <n.theodosis@stoiximan.gr>
+Copyright (c) 2020 Nikos Theodosis
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -14,14 +14,44 @@ fastlane add_plugin discord_notifier
 
 Discord Notifier
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+`discord_notifier` posts a message in a discord channel defined by a webhook created for your discord server.
+
+## Usage
+
+To get started, first, create a webhook in your Discord server. You can find detailed instructions [here](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks). You will need the webhook url in each call to successfully post a message in your channel.
+
+```ruby
+discord_notifier(
+    webhook_url:"<discord webhook url>",
+    title: "<a title>",
+    description: "<a description>",
+    success: "<true/false>", # Optional - Default is true
+    color: "FFFFF", # Optional
+    thumbnail_url:"<thumbnail url>", # Optional
+    image_url:"<image url>" # Optional 
+  )
+```
+
+## Keys
+
+| Key | Description | Optional
+| --- | --- | ---|
+| webhook_url | Discord webhook url | false
+| title | Message title | false
+| description | Message description | false
+| thumbnail_url | Thumbnail url | true
+| image_url | Message image url | true
+| success | Show file differences that haven't been staged | true
+| color | The color defined will be attributed to the message sidebar. The sidebar by default uses #4BB543 if `success` is set to true and #CC0000 if set to false. If color is set, it overrides the default color described before. | true
+| gravatar_email | If set, then the author's image will be replaced by the resolved gravatar. If not and the next 3 keys are set, the author's image will be set as the user's discord avatar  | true
+| bot_token | Token of bot assigned to discord server | true
+| client_id | Client id retrieved upon bot creation | true
+| discord_user_id | User id of the discord user | true
 
 ## Example
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
-
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/discord_notifier/actions/discord_notifier_action.rb

@@ -2,6 +2,7 @@ require 'fastlane/action'
 require_relative '../helper/discord_notifier_helper'
 require 'discordrb/webhooks'
 
+
 module Fastlane
   module Actions
     class DiscordNotifierAction < Action
@@ -14,6 +15,22 @@ module Fastlane
         unless params[:color].nil? || params[:color] == 0
           color = params[:color]
         end
+        
+        begin
+          user = Helper::DiscordUserHelper.findUser(params[:bot_token], params[:client_id], params[:discord_user_id])
+          discord_avatar = user.avatar_url
+        rescue => ex
+          UI.important('Fetching user data failed. Continuing anyway...')
+        end
+
+        author_name = ENV['USER']
+        unless user.nil?
+          author_name = user.name
+        end
+
+        unless params[:gravatar_email].nil? || params[:gravatar_email].empty?
+          discord_avatar = Helper::DiscordUserHelper.gravatarImageUrl(params[:gravatar_email])
+        end
        
         client = Discordrb::Webhooks::Client.new(url: params[:webhook_url])
         client.execute do |builder|
@@ -27,7 +44,8 @@ module Fastlane
               url: params[:image_url]
             )
             embed.author = Discordrb::Webhooks::EmbedAuthor.new(
-              name: params[:author]
+              name: author_name,
+              icon_url: discord_avatar
             )
             embed.colour = color
             embed.timestamp = Time.now
@@ -81,11 +99,6 @@ module Fastlane
             optional: true,
             type: String
           ),
-          FastlaneCore::ConfigItem.new(
-            key: :author,
-            optional: true,
-            type: String
-          ),
           FastlaneCore::ConfigItem.new(
             key: :success,
             optional: true,
@@ -96,6 +109,29 @@ module Fastlane
             key: :color,
             optional: true,
             type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :gravatar_email,
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :bot_token,
+            env_name: "DISCORD_BOT_TOKEN",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :client_id,
+            env_name: "DISCORD_CLIENT_ID",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :discord_user_id,
+            env_name: "DISCORD_USER_ID",
+            optional: true,
+            type: String
           )
         ]
       end

data/lib/fastlane/plugin/discord_notifier/helper/discord_notifier_helper.rb

@@ -1,4 +1,6 @@
 require 'fastlane_core/ui/ui'
+require 'digest/md5'
+require 'discordrb'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
@@ -12,5 +14,28 @@ module Fastlane
         UI.message("Hello from the discord_notifier plugin helper!")
       end
     end
+
+    class DiscordUserHelper
+
+      def self.gravatarImageUrl(email)
+        email_address = ENV["FASTLANE_USER"].downcase
+        # create the md5 hash
+        hash = Digest::MD5.hexdigest(email)
+        # compile URL which can be used in <img src="RIGHT_HERE"...
+        image_src = "https://www.gravatar.com/avatar/#{hash}"
+        
+        return image_src
+      end
+
+      def self.findUser(bot_token, client_id, user_id)
+        bot = Discordrb::Bot.new(
+          token: bot_token,
+          client_id: client_id
+        )
+        user = bot.user(user)
+      
+        return user
+      end
+    end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module DiscordNotifier
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-discord_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nikos Theodosis
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.145.0
 description: 
-email: n.theodosis@stoiximan.gr
+email: nikolas.theodosis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []