slkecho 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60840e25954d5f27219da1751cc8afd0659d8fad0011d9801f392d73eff0fbdd
-  data.tar.gz: 01146cb293d39c8e1d7b01ff6748dbca25c3f6a35316b24ec5ef2ddb951d5f62
+  metadata.gz: a774fdb74395b1ee93dc0bd5571238c7acdbceea8b007c92b1986deac9fd439d
+  data.tar.gz: 40166736569c689cfe82c969f0806ebb7807a5732a230b7bface07b3a5501e3f
 SHA512:
-  metadata.gz: 6a61dc7880593a6cd2f4b53be89f5db6ec22431d086640e770092925751e6cb049f4fe852e061cc8524e69ee99c765134de4a178b31a343cb922aa6d5fcb9be1
-  data.tar.gz: fc30c5af4a5fca0defd1a3e87651ff4389e1a19767a5ab16915864d95341caa47abaa34a28d3afdfceb113fcc44f8767e24978565b9859934a41c2040b0221c1
+  metadata.gz: c4774fe9a783ab35bd7ef4297c3b8a5c5096ff0d8a5dd1cd6259f4339c3ecd8d00aeb25ec5eb3b2a0fa6de4d18140e44f15ba7421dcc67ddcd30d8a9a9b39523
+  data.tar.gz: 26175552d6ec35261a4a60be2ceb4ea4cc753aac66c0908322dd3098cdbfd265b6a706a207127b37be4db714d13d6a114cd382c3843dea72ade4860e747e619d

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [v2.0.0] - 2024-01-12
+
+- feat: Remove --subject option
+- feat: Rename --mention option to --mention-by-email option
+- feat: Rename errors
+  - `Slkecho::SlackApiRequestError` to `Slkecho::SlackApiHttpError`
+  - `Slkecho::SlackApiResponseErorr` to `Slkecho::SlackApiResultError`
+- feat: Improve error message of Slack API request
+- feat: Remove channel validation
+- chore: Update options description
+
 ## [v1.4.0] - 2024-01-09
 
 - feat: Add --icon-emoji option

data/README.md

@@ -23,36 +23,45 @@ More details: [Working with the RubyGems registry - GitHub Docs](https://docs.gi
 ## Usage
 
 ```
-slkecho -c <channel> -s <subject> -m <mention> message
+slkecho -c <channel> -m <mention> message
 ```
 
 or message from stdin:
 
 ```
-cat message.txt | slkecho -c <channel> -s <subject> -m <mention>
+cat message.txt | slkecho -c <channel> -m <mention>
 ```
 
 ### Options
 
 #### -c, --channel <channel> (required)
 
-Specify channel to post message. Channel name (starts `#`) or channel id (starts `C`).
+Slack channel to post message.
 
-#### -s, --subject <subject> (optional)
+See below: https://api.slack.com/methods/chat.postMessage#arg_channel
 
-Specify subject to post message.
+#### -m, --mention-by-email <mention> (optional)
 
-#### -m, --mention <mention> (optional)
-
-Specify mention to post message. user email or user id (starts `U`).
+Search for the target member by email address and adds a mentions to the message.
+Mention is only valid for members of the channel to which you are posting.
 
 #### --username <username> (optional)
 
-Specify the username for the published message.
+Set user name for message.
+
+See below: https://api.slack.com/methods/chat.postMessage#arg_username
+
+#### --icon-url <url> (optional)
+
+Set user icon image for message by URL.
+
+See below: https://api.slack.com/methods/chat.postMessage#arg_icon_url
 
 #### --icon-emoji <emoji> (optional)
 
-Specify an emoji for the speaker's icon. e.g.) `:smile:`
+Set user image for message by emoji.
+
+See below: https://api.slack.com/methods/chat.postMessage#arg_icon_emoji
 
 ## Contributing
 

data/exe/slkecho

@@ -15,8 +15,8 @@ rescue Slkecho::InvalidConfigurationError => e
   abort e.message
 rescue Slkecho::InvalidOptionError => e
   abort e.message
-rescue Slkecho::SlackRequestError => e
-  abort "Request failed: #{e.message}"
-rescue Slkecho::SlackResponseError => e
-  abort "Error responsed: #{e.message}"
+rescue Slkecho::SlackApiHttpError => e
+  abort "Slack API request failed: #{e.message}"
+rescue Slkecho::SlackApiResultError => e
+  abort "Slack API was responsed with error: #{e.message}"
 end

data/lib/slkecho/cli.rb

@@ -14,27 +14,20 @@ module Slkecho
 
       Slkecho.configuration.validate
 
-      user_id = mention_to_user_id(options.mention)
+      user_id = options.mention_by_email.nil? ? nil : email_to_user_id(options.mention_by_email)
 
       @slack_client.post_message(post_message_params_from(options, user_id))
     end
 
-    def mention_to_user_id(mention)
-      return nil if mention.nil?
-
-      return mention unless mention.include?("@")
-      return mention if mention.start_with?("U")
-
-      user = @slack_client.lookup_user_by_email(email: mention)
+    def email_to_user_id(email)
+      user = @slack_client.lookup_user_by_email(email: email)
       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,
+        message: user_id.nil? ? options.message : "<@#{user_id}> #{options.message}",
         username: options.username,
         icon_url: options.icon_url,
         icon_emoji: options.icon_emoji

data/lib/slkecho/option_parser.rb

@@ -2,17 +2,16 @@
 
 module Slkecho
   class OptionParser
-    def option_parser # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def option_parser # rubocop:disable Metrics/AbcSize
       @option_parser ||= ::OptionParser.new do |o|
         o.banner = "Usage: slkecho [options] message"
         o.program_name = "slkecho"
         o.version = Slkecho::VERSION
-        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", "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 }
+        o.on("-c", "--channel CHANNEL", "Slack channel to post message.") { @options.channel = _1 }
+        o.on("-m", "--mention-by-email EMAIL", "Mention to user by email.") { @options.mention_by_email = _1 }
+        o.on("--username USERNAME", "Set user name for message.") { @options.username = _1 }
+        o.on("--icon-url ICON_URL", "Set user icon image for message by URL.") { @options.icon_url = _1 }
+        o.on("--icon-emoji ICON_EMOJI", "Set user image for message by emoji.") { @options.icon_emoji = _1 }
       end
     end
 
@@ -38,11 +37,7 @@ module Slkecho
 
     def validate_options(options)
       # channel
-      channel = options.channel
-      raise Slkecho::InvalidOptionError, "channel is required." if channel.nil?
-      unless channel.start_with?("#") || channel.start_with?("C")
-        raise Slkecho::InvalidOptionError, "channel must start with # or C."
-      end
+      raise Slkecho::InvalidOptionError, "channel is required." if options.channel.nil?
 
       # message
       raise Slkecho::InvalidOptionError, "message is missing." if options.message.nil?

data/lib/slkecho/options.rb

@@ -2,6 +2,6 @@
 
 module Slkecho
   class Options
-    attr_accessor :channel, :subject, :mention, :message, :username, :icon_url, :icon_emoji
+    attr_accessor :channel, :mention_by_email, :message, :username, :icon_url, :icon_emoji
   end
 end

data/lib/slkecho/slack_request/lookup_user_by_email.rb

@@ -23,13 +23,13 @@ module Slkecho
         begin
           response = @http.get(uri_with_query(@uri, { email: email }), @headers)
         rescue StandardError => e
-          raise Slkecho::SlackRequestError, e.message
+          raise Slkecho::SlackApiHttpError, e.message
         end
-        raise Slkecho::SlackRequestError, response.body unless response.is_a?(Net::HTTPSuccess)
+        raise Slkecho::SlackApiHttpError, response.body unless response.is_a?(Net::HTTPSuccess)
 
         user_info = JSON.parse(response.body)
-        raise Slkecho::SlackResponseError, "user not found. (#{email})" if user_info["error"] == "users_not_found"
-        raise Slkecho::SlackResponseError, user_info["error"] unless user_info["ok"]
+        raise Slkecho::SlackApiResultError, "user not found. (#{email})" if user_info["error"] == "users_not_found"
+        raise Slkecho::SlackApiResultError, user_info["error"] unless user_info["ok"]
 
         user_info["user"]
       end

data/lib/slkecho/slack_request/post_message.rb

@@ -3,7 +3,7 @@
 module Slkecho
   module SlackRequest
     class PostMessage
-      Params = Struct.new(:channel, :message, :subject, :user_id, :username, :icon_url, :icon_emoji, keyword_init: true)
+      Params = Struct.new(:channel, :message, :username, :icon_url, :icon_emoji, keyword_init: true)
 
       def initialize(slack_api_token:)
         @slack_api_token = slack_api_token
@@ -23,47 +23,34 @@ module Slkecho
           request_body(params).to_json,
           @headers
         )
-        raise Slkecho::SlackRequestError, response.body unless response.is_a?(Net::HTTPSuccess)
+        raise Slkecho::SlackApiHttpError, "#{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
 
         result = JSON.parse(response.body)
-        raise Slkecho::SlackResponseError, result["error"] unless result["ok"]
+        raise Slkecho::SlackApiResultError, result["error"] unless result["ok"]
 
         true
       end
 
       def request_body(params)
-        body = {
+        {
           "channel" => params.channel,
-          "blocks" => [],
+          "blocks" => blocks_from(params.message),
           "username" => params.username,
           "icon_url" => params.icon_url,
           "icon_emoji" => params.icon_emoji
         }
-        body["blocks"] << header_block(params.subject) unless params.subject.nil?
-        body["blocks"] << section_block(params.message, user_id: params.user_id)
-
-        body
       end
 
-      def header_block(text)
-        {
-          "type" => "header",
-          "text" => {
-            "type" => "plain_text",
-            "text" => text,
-            "emoji" => true
+      def blocks_from(message)
+        [
+          {
+            "type" => "section",
+            "text" => {
+              "type" => "mrkdwn",
+              "text" => message
+            }
           }
-        }
-      end
-
-      def section_block(text, user_id: nil)
-        {
-          "type" => "section",
-          "text" => {
-            "type" => "mrkdwn",
-            "text" => user_id.nil? ? text : "<@#{user_id}> #{text}"
-          }
-        }
+        ]
       end
     end
   end

data/lib/slkecho/version.rb

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

data/lib/slkecho.rb

@@ -18,8 +18,8 @@ module Slkecho
   end
 
   class InvalidOptionError < StandardError; end
-  class SlackRequestError < StandardError; end
-  class SlackResponseError < StandardError; end
+  class SlackApiHttpError < StandardError; end
+  class SlackApiResultError < StandardError; end
 
   class << self
     def configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slkecho
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - okonomi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies: []
 description: Post message to Slack like echo command.
 email:
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Post message to Slack like echo command.