slkecho 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e644caea3b2e9401cfc58f37814cbf04d94d74292f4b150eb12f108d63022e7
-  data.tar.gz: '081186fc14c84b7311f710a7d14f7f8c962ca69e9165857cd03aa38ebb9f65fc'
+  metadata.gz: 4316f376c8717965ab2c3518c054be6d983bc005d343803305bdb90f2bc0b963
+  data.tar.gz: 11cf2ec4be6b49b6a4d4d566ac9c767036ae91871c3ebe39e4a760198f13e367
 SHA512:
-  metadata.gz: 79303c561c911bf9c9e46f2f7ccc7f23baa76738fde53219e071eccb17ca9764ef5a9fb1c5091136e75291ee2336a9a2ee340c93945dcba2c5e66ac25b016629
-  data.tar.gz: e372eeb64e03fe3a1275365ee64f815dd55454a10414a0c896644d33e7a5731bbcdfe5aae21f833480cfaf582f9f4ee6f5196231a9cd9987cb79aa52535ae7cc
+  metadata.gz: 25a8acf5fd4f84c7d76b91ac9a44e99e780e398c0b878dac33352e621e5139dc09d9d13b041eaec04227b20c7996596799656b5cf367195d65aeb10b959507e2
+  data.tar.gz: da7a9a3a06f06910e7660f5408c0a9c9a3b1d0f057c02ad88b5c9bc10ba96f559141b956659a6993b6b04c611a6fde5f0b26a06998c39ad9651270ad21d877f0

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [v2.1.1] - 2024-02-12
+
+- chore: Add ruby-lsp gem
+- refactor: Parse JSON with symbolize names
+- refactor: Make request body with symbolize keys
+- refactor: Make blocks with symbolize keys
+- refactor: Extract http response checking
+- test: Introduce saharspec gem
+
+## [v2.1.0] - 2024-01-19
+
+- feat: Add --message-as-blocks option
+- fix: Require libraries
+- style: Enable RuboCop new cops and fix offenses
+- style: Add rubocop-performance and fix offenses
+
 ## [v2.0.1] - 2024-01-17
 
 - feat: Add Dockerfile

data/README.md

@@ -1,5 +1,7 @@
 # Slkecho
 
+[![Gem Version](https://badge.fury.io/rb/slkecho.svg)](https://badge.fury.io/rb/slkecho)
+
 Slkecho is a CLI tool to post message to Slack like echo command.
 
 ## Installation
@@ -63,6 +65,12 @@ Set user image for message by emoji.
 
 See below: https://api.slack.com/methods/chat.postMessage#arg_icon_emoji
 
+### --message-as-blocks (optional)
+
+Post message as blocks.
+
+See below: https://api.slack.com/methods/chat.postMessage#arg_blocks
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/okonomi/slkecho.

data/exe/slkecho

@@ -4,7 +4,7 @@
 require_relative "../lib/slkecho"
 
 Slkecho.configure do |config|
-  config.slack_api_token = ENV["SLACK_API_TOKEN"]
+  config.slack_api_token = ENV.fetch("SLACK_API_TOKEN", nil)
 end
 
 begin

data/lib/slkecho/blocks_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Slkecho
+  class BlocksBuilder
+    def build_from_message(message, user_id = nil)
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: user_id.nil? ? message : "<@#{user_id}> #{message}"
+          }
+        }
+      ]
+    end
+
+    def build_from_json(json, user_id = nil)
+      JSON.parse(json.gsub("<mention>", "<@#{user_id}>"))
+    end
+  end
+end

data/lib/slkecho/cli.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require "optparse"
-
 module Slkecho
   class CLI
-    def initialize(option_parser:, slack_client:)
+    def initialize(option_parser:, slack_client:, blocks_builder:)
       @option_parser = option_parser
       @slack_client = slack_client
+      @blocks_builder = blocks_builder
     end
 
     def run(argv)
@@ -27,17 +26,26 @@ module Slkecho
     def post_message_params_from(options, user_id)
       Slkecho::SlackClient::PostMessageParams.new(
         channel: options.channel,
-        message: user_id.nil? ? options.message : "<@#{user_id}> #{options.message}",
+        blocks: blocks_from(options.message, user_id, options.message_as_blocks),
         username: options.username,
         icon_url: options.icon_url,
         icon_emoji: options.icon_emoji
       )
     end
 
+    def blocks_from(message, user_id, message_as_blocks)
+      if message_as_blocks
+        @blocks_builder.build_from_json(message, user_id)
+      else
+        @blocks_builder.build_from_message(message, user_id)
+      end
+    end
+
     def self.run(argv)
       cli = new(
         option_parser: Slkecho::OptionParser.new,
-        slack_client: Slkecho::SlackClient.new(slack_api_token: Slkecho.configuration.slack_api_token)
+        slack_client: Slkecho::SlackClient.new(slack_api_token: Slkecho.configuration.slack_api_token),
+        blocks_builder: Slkecho::BlocksBuilder.new
       )
       cli.run(argv)
     end

data/lib/slkecho/option_parser.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "optparse"
+
 module Slkecho
   class OptionParser
-    def option_parser # rubocop:disable Metrics/AbcSize
+    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"
@@ -12,6 +14,7 @@ module Slkecho
         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 }
+        o.on("--message-as-blocks", "Post message as blocks.") { @options.message_as_blocks = true }
       end
     end
 

data/lib/slkecho/options.rb

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

data/lib/slkecho/slack_client.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "net/http"
-require "uri"
-require "json"
-
 require_relative "slack_request/lookup_user_by_email"
 require_relative "slack_request/post_message"
 
@@ -13,14 +9,6 @@ module Slkecho
 
     def initialize(slack_api_token:)
       @slack_api_token = slack_api_token
-
-      @uri = URI.parse("https://slack.com/api/chat.postMessage")
-      @http = Net::HTTP.new(@uri.host, @uri.port)
-      @http.use_ssl = true
-      @headers = {
-        "Content-Type" => "application/json; charset=utf-8",
-        "Authorization" => "Bearer #{slack_api_token}"
-      }
     end
 
     def lookup_user_by_email(email:)

data/lib/slkecho/slack_request/lookup_user_by_email.rb

@@ -4,6 +4,8 @@ require "net/http"
 require "uri"
 require "json"
 
+require_relative "../slack_request"
+
 module Slkecho
   module SlackRequest
     class LookupUserByEmail
@@ -20,18 +22,18 @@ module Slkecho
       end
 
       def request(email:)
-        begin
-          response = @http.get(uri_with_query(@uri, { email: email }), @headers)
-        rescue StandardError => e
-          raise Slkecho::SlackApiHttpError, e.message
+        user_info = Slkecho::SlackRequest.send_request do
+          @http.get(uri_with_query(@uri, { email: email }), @headers)
         end
-        raise Slkecho::SlackApiHttpError, response.body unless response.is_a?(Net::HTTPSuccess)
 
-        user_info = JSON.parse(response.body)
-        raise Slkecho::SlackApiResultError, "user not found. (#{email})" if user_info["error"] == "users_not_found"
-        raise Slkecho::SlackApiResultError, user_info["error"] unless user_info["ok"]
+        case user_info
+        in { ok: true, user: user }
+          user
+        in { ok: false, error: error }
+          raise Slkecho::SlackApiResultError, "user not found. (#{email})" if error == "users_not_found"
 
-        user_info["user"]
+          raise Slkecho::SlackApiResultError, error
+        end
       end
 
       def uri_with_query(uri, params)

data/lib/slkecho/slack_request/post_message.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
+require "net/http"
+require "uri"
+require "json"
+
+require_relative "../slack_request"
+
 module Slkecho
   module SlackRequest
     class PostMessage
-      Params = Struct.new(:channel, :message, :username, :icon_url, :icon_emoji, keyword_init: true)
+      Params = Struct.new(:channel, :blocks, :username, :icon_url, :icon_emoji, keyword_init: true)
 
       def initialize(slack_api_token:)
         @slack_api_token = slack_api_token
@@ -18,40 +24,28 @@ module Slkecho
       end
 
       def request(params)
-        response = @http.post(
-          @uri.path,
-          request_body(params).to_json,
-          @headers
-        )
-        raise Slkecho::SlackApiHttpError, "#{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+        result = Slkecho::SlackRequest.send_request do
+          @http.post(
+            @uri.path,
+            request_body(params).to_json,
+            @headers
+          )
+        end
 
-        result = JSON.parse(response.body)
-        raise Slkecho::SlackApiResultError, result["error"] unless result["ok"]
+        raise Slkecho::SlackApiResultError, result[:error] unless result[:ok]
 
         true
       end
 
       def request_body(params)
         {
-          "channel" => params.channel,
-          "blocks" => blocks_from(params.message),
-          "username" => params.username,
-          "icon_url" => params.icon_url,
-          "icon_emoji" => params.icon_emoji
+          channel: params.channel,
+          blocks: params.blocks,
+          username: params.username,
+          icon_url: params.icon_url,
+          icon_emoji: params.icon_emoji
         }
       end
-
-      def blocks_from(message)
-        [
-          {
-            "type" => "section",
-            "text" => {
-              "type" => "mrkdwn",
-              "text" => message
-            }
-          }
-        ]
-      end
     end
   end
 end

data/lib/slkecho/slack_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Slkecho
+  module SlackRequest
+    def self.send_request
+      return unless block_given?
+
+      response = yield
+      raise Slkecho::SlackApiError, "API Response could not be retrieved." unless response.is_a?(Net::HTTPResponse)
+      raise Slkecho::SlackApiHttpError, "#{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+      begin
+        JSON.parse(response.body, symbolize_names: true)
+      rescue JSON::ParserError
+        raise Slkecho::SlackApiError, "API Response is not JSON."
+      end
+    end
+  end
+end

data/lib/slkecho/version.rb

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

data/lib/slkecho.rb

@@ -6,6 +6,7 @@ require_relative "slkecho/cli"
 require_relative "slkecho/options"
 require_relative "slkecho/option_parser"
 require_relative "slkecho/slack_client"
+require_relative "slkecho/blocks_builder"
 
 module Slkecho
   class InvalidConfigurationError < StandardError
@@ -18,6 +19,7 @@ module Slkecho
   end
 
   class InvalidOptionError < StandardError; end
+  class SlackApiError < StandardError; end
   class SlackApiHttpError < StandardError; end
   class SlackApiResultError < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slkecho
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - okonomi
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-17 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies: []
 description: Post message to Slack like echo command.
 email:
@@ -23,11 +23,13 @@ files:
 - README.md
 - exe/slkecho
 - lib/slkecho.rb
+- lib/slkecho/blocks_builder.rb
 - lib/slkecho/cli.rb
 - lib/slkecho/configuration.rb
 - lib/slkecho/option_parser.rb
 - lib/slkecho/options.rb
 - lib/slkecho/slack_client.rb
+- lib/slkecho/slack_request.rb
 - lib/slkecho/slack_request/lookup_user_by_email.rb
 - lib/slkecho/slack_request/post_message.rb
 - lib/slkecho/version.rb
@@ -40,7 +42,8 @@ metadata:
   source_code_uri: https://github.com/okonomi/slkecho
   changelog_uri: https://github.com/okonomi/slkecho/blob/main/CHANGELOG.md
   github_repo: https://github.com/okonomi/slkecho
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -56,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Post message to Slack like echo command.
 test_files: []