slkecho 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77afa5c20a94b0e30aa7aa41e5a2849a235d4fc2a60fe4437db1401b655cc784
-  data.tar.gz: 7bd371392c450668e17d39f9e97e5a37490cded751b0a046c924ba063da5394f
+  metadata.gz: 27a5c0b65463136318cabb237d686c66d5e116a957e54cad2a3e96b5bacd4b26
+  data.tar.gz: a83950809a7c4ef56219a732409a257c3d9c9e70255cca266b385c0917ac7334
 SHA512:
-  metadata.gz: 7e4b16802556b7e67e0d12c3ab51c272d423bc57ca3a9066e82a31d697535c8ff2254e012dca963aa2e5fb99d23d6ce1a7ab6e40dcdcc3751dbe722ac33ab4f1
-  data.tar.gz: 0ee38f3cf91680f85ebaa03c328d89b8aae3e8793ecf03e9b63ed5e9b5f5c147733e66911c179403dc879044d782a7bc80f22886a2fe53856152e79dd5129477
+  metadata.gz: 74cb2097a07867294dce7e3563737a10c08c1138fc24a0d5a67b202849c71194a4e32473152e13c1e7115d6520b66e82b38cec7891ff10b3ea170ec215bd9dd8
+  data.tar.gz: c74fda6c554796a2ed28fa600d18f891d8b25ef6e2a3c94bd471b591fa8a2d073e5532e8dafec93199687250172de69dbad5f947c9409c4b16fea400d6d85069

data/CHANGELOG.md

@@ -1,14 +1,24 @@
 ## [Unreleased]
 
-- feat: Start type signature implementation
+## [v2.2.0] - 2025-01-10
+
+- feat: add `--configure` option (to be implemented)
+- feat: add `--token` option
+- test: use `its_block` in rspec
+
+## [v2.1.6] - 2025-01-05
+
+- refactor: options building
+- refactor: slack request
 
 ## [v2.1.5] - 2025-01-04
 
-- Only update dependencies
+- feat: Start type signature implementation
+- chore: update dependencies
 
 ## [v2.1.4] - 2024-08-31
 
-- Only update dependencies
+- chore: update dependencies
 
 ## [v2.1.3] - 2024-03-15
 

data/README.md

@@ -71,6 +71,10 @@ Post message as blocks.
 
 See below: https://api.slack.com/methods/chat.postMessage#arg_blocks
 
+### --token <token> (optional)
+
+Pass a token to authenticate with Slack.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/okonomi/slkecho.

data/exe/slkecho

@@ -9,10 +9,6 @@ end
 
 begin
   Slkecho::CLI.run(ARGV)
-  puts "Message sent successfully."
-rescue Slkecho::InvalidConfigurationError => e
-  abort "#{e.message} Please set SLACK_API_TOKEN environment variable." if e.item == :slack_api_token
-  abort e.message
 rescue Slkecho::InvalidOptionError => e
   abort e.message
 rescue Slkecho::SlackApiHttpError => e

data/lib/slkecho/cli.rb

@@ -2,24 +2,27 @@
 
 module Slkecho
   class CLI
-    def initialize(option_parser:, slack_client:, blocks_builder:)
+    def initialize(option_parser:, blocks_builder:)
       @option_parser = option_parser
-      @slack_client = slack_client
       @blocks_builder = blocks_builder
     end
 
     def run(argv)
       options = @option_parser.parse(argv)
 
-      Slkecho.configuration.validate
-
-      user_id = options.mention_by_email.nil? ? nil : email_to_user_id(options.mention_by_email)
+      if options.configure
+        puts "Slkecho configuration"
+      else
+        slack_client = Slkecho::SlackClient.new(slack_api_token: options.token)
+        user_id = options.mention_by_email.nil? ? nil : email_to_user_id(slack_client, options.mention_by_email)
+        slack_client.post_message(post_message_params_from(options, user_id))
 
-      @slack_client.post_message(post_message_params_from(options, user_id))
+        puts "Message sent successfully."
+      end
     end
 
-    def email_to_user_id(email)
-      user = @slack_client.lookup_user_by_email(email: email)
+    def email_to_user_id(slack_client, email)
+      user = slack_client.lookup_user_by_email(email: email)
       user[:id]
     end
 
@@ -44,7 +47,6 @@ module Slkecho
     def self.run(argv)
       cli = new(
         option_parser: Slkecho::OptionParser.new,
-        slack_client: Slkecho::SlackClient.new(slack_api_token: Slkecho.configuration.slack_api_token),
         blocks_builder: Slkecho::BlocksBuilder.new
       )
       cli.run(argv)

data/lib/slkecho/http.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module Slkecho
+  class HTTP
+    class << self
+      def get(uri, headers: nil)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http.get(uri, headers)
+      end
+
+      def post(uri, headers: nil, body: nil)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http.post(uri, body, headers)
+      end
+    end
+  end
+end

data/lib/slkecho/option_parser.rb

@@ -4,46 +4,50 @@ require "optparse"
 
 module Slkecho
   class OptionParser
-    def option_parser # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def option_parser # rubocop:disable Metrics/MethodLength
       @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 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 }
-        o.on("--message-as-blocks", "Post message as blocks.") { @options.message_as_blocks = true }
+        o.on("--configure", "Configure Slack API token.")
+        o.on("-c", "--channel CHANNEL", "Slack channel to post message.")
+        o.on("-m", "--mention-by-email EMAIL", "Mention to user by email.")
+        o.on("--username USERNAME", "Set user name for message.")
+        o.on("--icon-url ICON_URL", "Set user icon image for message by URL.")
+        o.on("--icon-emoji ICON_EMOJI", "Set user image for message by emoji.")
+        o.on("--message-as-blocks", "Post message as blocks.")
+        o.on("--token TOKEN", "Slack API token.")
       end
     end
 
     def parse(argv)
-      options = parse_options(argv)
+      options = build_options(argv)
       validate_options(options)
 
       options
     end
 
-    def parse_options(argv)
-      @options = Slkecho::Options.new
-      argv = option_parser.parse(argv)
+    def build_options(argv)
+      option_values = {}
+      argv = option_parser.parse(argv, into: option_values)
+      option_values = option_values.transform_keys { _1.to_s.tr("-", "_").to_sym }
+      option_values[:token] ||= ENV.fetch("SLACK_API_TOKEN", nil)
 
-      @options.message = if !argv.empty?
-                           argv.first
-                         elsif !$stdin.tty?
-                           $stdin.read.then { _1.empty? ? nil : _1 }
-                         end
+      Slkecho::Options.new(option_values).tap do |opt|
+        opt.message = fetch_message(argv)
+      end
+    end
 
-      @options.dup
+    def fetch_message(argv)
+      if !argv.empty?
+        argv.first
+      elsif !$stdin.tty?
+        $stdin.read.then { _1.empty? ? nil : _1 }
+      end
     end
 
     def validate_options(options)
-      # channel
-      raise Slkecho::InvalidOptionError, "channel is required." if options.channel.nil?
-
-      # message
-      raise Slkecho::InvalidOptionError, "message is missing." if options.message.nil?
+      raise Slkecho::InvalidOptionError, options.error_message unless options.valid?
 
       true
     end

data/lib/slkecho/options.rb

@@ -1,7 +1,28 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 module Slkecho
   class Options
-    attr_accessor :channel, :mention_by_email, :message, :username, :icon_url, :icon_emoji, :message_as_blocks
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
+    attribute :configure, :boolean
+    attribute :channel, :string
+    attribute :mention_by_email, :string
+    attribute :message, :string
+    attribute :username, :string
+    attribute :icon_url, :string
+    attribute :icon_emoji, :string
+    attribute :message_as_blocks, :boolean
+    attribute :token, :string
+
+    validates :channel, presence: { message: "is required." }, unless: -> { configure }
+    validates :message, presence: { message: "is missing." }, unless: -> { configure || !message.nil? }
+    validates :token, presence: { message: "is required." }, unless: -> { configure }
+
+    def error_message
+      errors.full_messages.join(" ").downcase
+    end
   end
 end

data/lib/slkecho/slack_request/lookup_user_by_email.rb

@@ -5,28 +5,17 @@ require "uri"
 require "json"
 
 require_relative "../slack_request"
+require_relative "../http"
 
 module Slkecho
   module SlackRequest
     class LookupUserByEmail
       def initialize(slack_api_token:)
         @slack_api_token = slack_api_token
-
-        @uri = URI.parse("https://slack.com/api/users.lookupByEmail")
-        host = @uri.host
-        @http = Net::HTTP.new(host, @uri.port) unless host.nil?
-        @http.use_ssl = true
-        @headers = {
-          "Authorization" => "Bearer #{slack_api_token}",
-          "Content-Type" => "application/x-www-form-urlencoded"
-        }
       end
 
       def request(email:)
-        user_info = Slkecho::SlackRequest.send_request do
-          @http.get(uri_with_query(@uri, { email: email }), @headers)
-        end
-
+        user_info = send_request(email, @slack_api_token)
         case user_info
         in { ok: true, user: user }
           user
@@ -37,8 +26,21 @@ module Slkecho
         end
       end
 
+      private
+
+      def send_request(email, token)
+        Slkecho::SlackRequest.send_request do
+          uri = uri_with_query("https://slack.com/api/users.lookupByEmail", { email: email })
+          headers = {
+            "Authorization" => "Bearer #{token}",
+            "Content-Type" => "application/x-www-form-urlencoded"
+          }
+          Slkecho::HTTP.get(uri, headers: headers)
+        end
+      end
+
       def uri_with_query(uri, params)
-        uri.dup.tap { _1.query = URI.encode_www_form(params) }
+        URI(uri).tap { _1.query = URI.encode_www_form(params) }
       end
     end
   end

data/lib/slkecho/slack_request/post_message.rb

@@ -4,30 +4,30 @@ require "net/http"
 require "uri"
 require "json"
 
+require_relative "../http"
 require_relative "../slack_request"
 
 module Slkecho
   module SlackRequest
     class PostMessage
-      Params = Struct.new(:channel, :blocks, :username, :icon_url, :icon_emoji, keyword_init: true)
+      Params = Struct.new(:channel, :blocks, :username, :icon_url, :icon_emoji, keyword_init: true) do
+        def to_request_body
+          JSON.dump({
+                      channel: channel,
+                      blocks: blocks,
+                      username: username,
+                      icon_url: icon_url,
+                      icon_emoji: icon_emoji
+                    })
+        end
+      end
 
       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 request(params)
-        result = Slkecho::SlackRequest.send_request do
-          @http.post(@uri.path, request_body(params).to_json, @headers)
-        end
-
+        result = send_request(@slack_api_token, params)
         case result
         in { ok: true }
           true
@@ -36,14 +36,19 @@ module Slkecho
         end
       end
 
-      def request_body(params)
-        {
-          channel: params.channel,
-          blocks: params.blocks,
-          username: params.username,
-          icon_url: params.icon_url,
-          icon_emoji: params.icon_emoji
-        }
+      private
+
+      def send_request(token, params)
+        Slkecho::SlackRequest.send_request do
+          uri = URI("https://slack.com/api/chat.postMessage")
+          headers = {
+            "Content-Type" => "application/json; charset=utf-8",
+            "Authorization" => "Bearer #{token}"
+          }
+          body = params.to_request_body
+
+          Slkecho::HTTP.post(uri, headers: headers, body: body)
+        end
       end
     end
   end

data/lib/slkecho/version.rb

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

data/sig/slkecho/http.rbs

@@ -0,0 +1,5 @@
+module Slkecho
+  class HTTP
+    def self.get: (URI::Generic, headers: Hash[String, String]) -> void
+  end
+end

data/sig/slkecho/slack_request/lookup_user_by_email.rbs

@@ -2,12 +2,10 @@ module Slkecho
   module SlackRequest
     class LookupUserByEmail
       @slack_api_token: String
-      @uri: URI::Generic
-      @http: Net::HTTP
-      @headers: Hash[String, String]
 
       def initialize: (slack_api_token: String) -> void
-      def uri_with_query: (URI::Generic, untyped) -> untyped
+      def send_request: (String, String) -> untyped
+      def uri_with_query: (String, untyped) -> untyped
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: slkecho
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.2.0
 platform: ruby
 authors:
 - okonomi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
-dependencies: []
+date: 2025-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Post message to Slack like echo command.
 email:
 - okonomi@oknm.jp
@@ -27,6 +41,7 @@ files:
 - lib/slkecho/blocks_builder.rb
 - lib/slkecho/cli.rb
 - lib/slkecho/configuration.rb
+- lib/slkecho/http.rb
 - lib/slkecho/option_parser.rb
 - lib/slkecho/options.rb
 - lib/slkecho/slack_client.rb
@@ -35,6 +50,7 @@ files:
 - lib/slkecho/slack_request/post_message.rb
 - lib/slkecho/version.rb
 - sig/slkecho.rbs
+- sig/slkecho/http.rbs
 - sig/slkecho/slack_request.rbs
 - sig/slkecho/slack_request/lookup_user_by_email.rbs
 homepage: https://github.com/okonomi/slkecho