slkecho 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d32f248314a8ecc59325cf6cb2092a53ef4bfed9e9866ad46c0ad09076e79d2
+  data.tar.gz: 377be48a2826d3a0df573127cb06add79bb25a0a31fb4c152a7eb709faee127c
+SHA512:
+  metadata.gz: 3aa071ad29e150bcb983f3c674ba6aaccda853fc8ff65fe93395a92e86e7e4190e39f5dcfcad9f88019b74986ccd2bba41556ee5a5b5f8a3d720686e072f12bb
+  data.tar.gz: 6293abc9ec4d005d50fa5fdc1672e6e981713957ee3a9548ef86d9c2c0a4d2a9c4c8a1f2da06d19738ddad31613f9345159321df5dd59088cd65c3d17eb056cf

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/NamedSubject:
+  Enabled: false

data/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "dotenv.dotenv-vscode",
+        "shopify.ruby-extensions-pack"
+    ]
+}

data/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    // IntelliSense を使用して利用可能な属性を学べます。
+    // 既存の属性の説明をホバーして表示します。
+    // 詳細情報は次を確認してください: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "rdbg",
+            "name": "Debug current file with rdbg",
+            "request": "launch",
+            "script": "${file}",
+            "args": [],
+            "askParameters": true
+        },
+        {
+            "type": "rdbg",
+            "name": "Attach with rdbg",
+            "request": "attach"
+        }
+    ]
+}

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+## [Unreleased]
+
+## [v1.2.0] - 2024-01-08
+
+- feat: Add --username option
+
+## [v1.1.0] - 2024-01-08
+
+- test: reset SLACK_API_TOKEN env var
+- feat: Message can be set from stdin
+
+## [v1.0.1] - 2024-01-08
+
+- fix: Delay validation of configuration
+- fix: Error messages are now output to stderr
+
+## [v1.0.0] - 2024-01-06
+
+- docs: Update installation section
+- feat: Improve error message
+- style: Align line wrapping
+
+## [v0.3.0] - 2024-01-06
+
+- Allow channel id
+- Allow user id
+- Update README
+
+## [v0.2.1] - 2024-01-06
+
+- Fix error handling
+
+## [v0.2.0] - 2024-01-06
+
+- chore: add dotenv extension
+- Add --mention option
+- Improve error handling
+- Command line options
+
+## [v0.1.0] - 2024-01-03
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 okonomi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Slkecho
+
+Slkecho is a CLI tool to post message to Slack like echo command.
+
+## Installation
+
+Install it yourself as:
+
+```
+gem install slkecho
+```
+
+or add this line to your application's Gemfile:
+
+```
+source "https://rubygems.pkg.github.com/okonomi" do
+  gem "slkecho"
+end
+```
+
+More details: [Working with the RubyGems registry - GitHub Docs](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry#installing-a-package)
+
+## Usage
+
+```
+slkecho -c <channel> -s <subject> -m <mention> message
+```
+
+or message from stdin:
+
+```
+cat message.txt | slkecho -c <channel> -s <subject> -m <mention>
+```
+
+### Options
+
+#### -c, --channel <channel> (required)
+
+Specify channel to post message. Channel name (starts `#`) or channel id (starts `C`).
+
+#### -s, --subject <subject> (optional)
+
+Specify subject to post message.
+
+#### -m, --mention <mention> (optional)
+
+Specify mention to post message. user email or user id (starts `U`).
+
+#### --username <username> (optional)
+
+Specify the username for the published message.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/okonomi/slkecho.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/slkecho

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/slkecho"
+
+Slkecho.configure do |config|
+  config.slack_api_token = ENV["SLACK_API_TOKEN"]
+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::SlackRequestError => e
+  abort "Request failed: #{e.message}"
+rescue Slkecho::SlackResponseError => e
+  abort "Error responsed: #{e.message}"
+end

data/lib/slkecho/cli.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Slkecho
+  class CLI
+    def initialize(option_parser:, slack_client:)
+      @option_parser = option_parser
+      @slack_client = slack_client
+    end
+
+    def run(argv)
+      options = @option_parser.parse(argv)
+
+      Slkecho.configuration.validate
+
+      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
+      )
+    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)
+      user["id"]
+    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)
+      )
+      cli.run(argv)
+    end
+  end
+end

data/lib/slkecho/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Slkecho
+  class Configuration
+    attr_accessor :slack_api_token
+
+    def validate
+      if slack_api_token.nil?
+        raise Slkecho::InvalidConfigurationError.new("slack_api_token is required.", :slack_api_token)
+      end
+
+      true
+    end
+  end
+end

data/lib/slkecho/option_parser.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Slkecho
+  class OptionParser
+    def option_parser
+      @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", "Username to post the message") { @options.username = _1 }
+      end
+    end
+
+    def parse(argv)
+      options = parse_options(argv)
+      validate_options(options)
+
+      options
+    end
+
+    def parse_options(argv)
+      @options = Slkecho::Options.new
+      argv = option_parser.parse(argv)
+
+      @options.message = if !argv.empty?
+                           argv.first
+                         elsif !$stdin.tty?
+                           $stdin.read.then { _1.empty? ? nil : _1 }
+                         end
+
+      @options.dup
+    end
+
+    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
+
+      # message
+      raise Slkecho::InvalidOptionError, "message is missing." if options.message.nil?
+
+      true
+    end
+  end
+end

data/lib/slkecho/options.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/slkecho/slack_client.rb

@@ -0,0 +1,34 @@
+# 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"
+
+module Slkecho
+  class SlackClient
+    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:)
+      Slkecho::SlackRequest::LookupUserByEmail.new(slack_api_token: @slack_api_token)
+                                              .request(email: email)
+    end
+
+    def post_message(channel:, message:, subject: nil, user_id: nil)
+      Slkecho::SlackRequest::PostMessage.new(slack_api_token: @slack_api_token)
+                                        .request(channel: channel, message: message, subject: subject, user_id: user_id)
+    end
+  end
+end

data/lib/slkecho/slack_request/lookup_user_by_email.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+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")
+        @http = Net::HTTP.new(@uri.host, @uri.port)
+        @http.use_ssl = true
+        @headers = {
+          "Authorization" => "Bearer #{slack_api_token}",
+          "Content-Type" => "application/x-www-form-urlencoded"
+        }
+      end
+
+      def request(email:)
+        begin
+          response = @http.get(uri_with_query(@uri, { email: email }), @headers)
+        rescue StandardError => e
+          raise Slkecho::SlackRequestError, e.message
+        end
+        raise Slkecho::SlackRequestError, 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"]
+
+        user_info["user"]
+      end
+
+      def uri_with_query(uri, params)
+        uri.dup.tap { _1.query = URI.encode_www_form(params) }
+      end
+    end
+  end
+end

data/lib/slkecho/slack_request/post_message.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Slkecho
+  module SlackRequest
+    class PostMessage
+      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(channel:, message:, subject: nil, user_id: nil)
+        response = @http.post(
+          @uri.path,
+          request_body(channel: channel, message: message, subject: subject, user_id: user_id).to_json,
+          @headers
+        )
+        raise Slkecho::SlackRequestError, response.body unless response.is_a?(Net::HTTPSuccess)
+
+        result = JSON.parse(response.body)
+        raise Slkecho::SlackResponseError, result["error"] unless result["ok"]
+
+        true
+      end
+
+      def request_body(channel:, message:, subject: nil, user_id: nil, username: nil)
+        body = {
+          "channel" => channel,
+          "blocks" => [],
+          "username" => username
+        }
+        body["blocks"] << header_block(subject) unless subject.nil?
+        body["blocks"] << section_block(message, user_id: user_id)
+
+        body
+      end
+
+      def header_block(text)
+        {
+          "type" => "header",
+          "text" => {
+            "type" => "plain_text",
+            "text" => text,
+            "emoji" => true
+          }
+        }
+      end
+
+      def section_block(text, user_id: nil)
+        {
+          "type" => "section",
+          "text" => {
+            "type" => "mrkdwn",
+            "text" => user_id.nil? ? text : "<@#{user_id}> #{text}"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/slkecho/version.rb

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

data/lib/slkecho.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "slkecho/version"
+require_relative "slkecho/configuration"
+require_relative "slkecho/cli"
+require_relative "slkecho/options"
+require_relative "slkecho/option_parser"
+require_relative "slkecho/slack_client"
+
+module Slkecho
+  class InvalidConfigurationError < StandardError
+    attr_reader :item
+
+    def initialize(message, item = nil)
+      @item = item
+      super(message)
+    end
+  end
+
+  class InvalidOptionError < StandardError; end
+  class SlackRequestError < StandardError; end
+  class SlackResponseError < StandardError; end
+
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/sig/slkecho.rbs

@@ -0,0 +1,4 @@
+module Slkecho
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: slkecho
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- okonomi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-08 00:00:00.000000000 Z
+dependencies: []
+description: Post message to Slack like echo command.
+email:
+- okonomi@oknm.jp
+executables:
+- slkecho
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/extensions.json"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/slkecho
+- lib/slkecho.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/lookup_user_by_email.rb
+- lib/slkecho/slack_request/post_message.rb
+- lib/slkecho/version.rb
+- sig/slkecho.rbs
+homepage: https://github.com/okonomi/slkecho
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/okonomi/slkecho
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Post message to Slack like echo command.
+test_files: []