slkecho 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b531f04eb873f7fa6e28b2bc17560e49b0f0a2cd87885cc00e7bcc566f637fbd
-  data.tar.gz: 6203249d51a01d0280ddced3801263f0f78efd92206f01a7bd5d4f82e0974f23
+  metadata.gz: 60840e25954d5f27219da1751cc8afd0659d8fad0011d9801f392d73eff0fbdd
+  data.tar.gz: 01146cb293d39c8e1d7b01ff6748dbca25c3f6a35316b24ec5ef2ddb951d5f62
 SHA512:
-  metadata.gz: 2f2ad0611bb599758005d228228396326649a6fb625d42880dc1c375a2a5bea487c88f30ea203677de215a362273711129e06cb3329911b0cdc5f58f28d254b7
-  data.tar.gz: ad3c3eac4b13c6f7585f88f86c3f81476a6892e433d2a0433368fe23598860de3caa86be00b7cb0f9371febab40e8ada5775f27eb9b32add219847f9bb0c8e20
+  metadata.gz: 6a61dc7880593a6cd2f4b53be89f5db6ec22431d086640e770092925751e6cb049f4fe852e061cc8524e69ee99c765134de4a178b31a343cb922aa6d5fcb9be1
+  data.tar.gz: fc30c5af4a5fca0defd1a3e87651ff4389e1a19767a5ab16915864d95341caa47abaa34a28d3afdfceb113fcc44f8767e24978565b9859934a41c2040b0221c1

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [v1.4.0] - 2024-01-09
+
+- feat: Add --icon-emoji option
+
+## [v1.3.0] - 2024-01-08
+
+- chore: Improved description of username option
+- feat: Add --icon-url option
+- refactor: Remove `Slkecho::Options` initialize method
+- refactor: Summarize arguments of `Slkecho::SlackRequest::PostMessage#request` to params
+- refactor: Summarize arguments of `Slkecho::SlackClient#post_message` to params
+
 ## [v1.2.1] - 2024-01-08
 
 - fix: Not implemented to username specified

data/README.md

@@ -50,6 +50,10 @@ Specify mention to post message. user email or user id (starts `U`).
 
 Specify the username for the published message.
 
+#### --icon-emoji <emoji> (optional)
+
+Specify an emoji for the speaker's icon. e.g.) `:smile:`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/okonomi/slkecho.

data/lib/slkecho/cli.rb

@@ -16,13 +16,7 @@ module Slkecho
 
       user_id = mention_to_user_id(options.mention)
 
-      @slack_client.post_message(
-        channel: options.channel,
-        message: options.message,
-        subject: options.subject,
-        user_id: user_id,
-        username: options.username
-      )
+      @slack_client.post_message(post_message_params_from(options, user_id))
     end
 
     def mention_to_user_id(mention)
@@ -35,6 +29,18 @@ module Slkecho
       user["id"]
     end
 
+    def post_message_params_from(options, user_id)
+      Slkecho::SlackClient::PostMessageParams.new(
+        channel: options.channel,
+        message: options.message,
+        subject: options.subject,
+        user_id: user_id,
+        username: options.username,
+        icon_url: options.icon_url,
+        icon_emoji: options.icon_emoji
+      )
+    end
+
     def self.run(argv)
       cli = new(
         option_parser: Slkecho::OptionParser.new,

data/lib/slkecho/option_parser.rb

@@ -2,7 +2,7 @@
 
 module Slkecho
   class OptionParser
-    def option_parser
+    def option_parser # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       @option_parser ||= ::OptionParser.new do |o|
         o.banner = "Usage: slkecho [options] message"
         o.program_name = "slkecho"
@@ -10,7 +10,9 @@ module Slkecho
         o.on("-c", "--channel CHANNEL", "Slack channel to post the message") { @options.channel = _1 }
         o.on("-s", "--subject SUBJECT", "Subject of message") { @options.subject = _1 }
         o.on("-m", "--mention EMAIL", "Mention to user by email") { @options.mention = _1 }
-        o.on("--username USERNAME", "Username to post the message") { @options.username = _1 }
+        o.on("--username USERNAME", "Set your bot's user name") { @options.username = _1 }
+        o.on("--icon-url ICON_URL", "URL to an image to use as the icon for this message") { @options.icon_url = _1 }
+        o.on("--icon-emoji ICON_EMOJI", "Emoji to use as the icon for this message") { @options.icon_emoji = _1 }
       end
     end
 

data/lib/slkecho/options.rb

@@ -2,14 +2,6 @@
 
 module Slkecho
   class Options
-    attr_accessor :channel, :subject, :mention, :message, :username
-
-    def initialize(channel: nil, subject: nil, mention: nil, message: nil, username: nil)
-      @channel = channel
-      @subject = subject
-      @mention = mention
-      @message = message
-      @username = username
-    end
+    attr_accessor :channel, :subject, :mention, :message, :username, :icon_url, :icon_emoji
   end
 end

data/lib/slkecho/slack_client.rb

@@ -9,6 +9,8 @@ require_relative "slack_request/post_message"
 
 module Slkecho
   class SlackClient
+    PostMessageParams = Slkecho::SlackRequest::PostMessage::Params
+
     def initialize(slack_api_token:)
       @slack_api_token = slack_api_token
 
@@ -26,10 +28,9 @@ module Slkecho
                                               .request(email: email)
     end
 
-    def post_message(channel:, message:, subject: nil, user_id: nil, username: nil)
+    def post_message(params)
       Slkecho::SlackRequest::PostMessage.new(slack_api_token: @slack_api_token)
-                                        .request(channel: channel, message: message, subject: subject, user_id: user_id,
-                                                 username: username)
+                                        .request(params)
     end
   end
 end

data/lib/slkecho/slack_request/post_message.rb

@@ -3,6 +3,8 @@
 module Slkecho
   module SlackRequest
     class PostMessage
+      Params = Struct.new(:channel, :message, :subject, :user_id, :username, :icon_url, :icon_emoji, keyword_init: true)
+
       def initialize(slack_api_token:)
         @slack_api_token = slack_api_token
 
@@ -15,11 +17,10 @@ module Slkecho
         }
       end
 
-      def request(channel:, message:, subject: nil, user_id: nil, username: nil)
+      def request(params)
         response = @http.post(
           @uri.path,
-          request_body(channel: channel, message: message, subject: subject, user_id: user_id,
-                       username: username).to_json,
+          request_body(params).to_json,
           @headers
         )
         raise Slkecho::SlackRequestError, response.body unless response.is_a?(Net::HTTPSuccess)
@@ -30,14 +31,16 @@ module Slkecho
         true
       end
 
-      def request_body(channel:, message:, subject: nil, user_id: nil, username: nil)
+      def request_body(params)
         body = {
-          "channel" => channel,
+          "channel" => params.channel,
           "blocks" => [],
-          "username" => username
+          "username" => params.username,
+          "icon_url" => params.icon_url,
+          "icon_emoji" => params.icon_emoji
         }
-        body["blocks"] << header_block(subject) unless subject.nil?
-        body["blocks"] << section_block(message, user_id: user_id)
+        body["blocks"] << header_block(params.subject) unless params.subject.nil?
+        body["blocks"] << section_block(params.message, user_id: params.user_id)
 
         body
       end

data/lib/slkecho/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slkecho
-  VERSION = "1.2.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slkecho
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - okonomi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies: []
 description: Post message to Slack like echo command.
 email: