1년 정도 Ruby를 만져 왔지만, 「그렇게 CLITool 만든 적 없어」라고 생각해, 간단하게 만들어 보았다.

출력

CLI 기반으로 Slack에게 인증 테스트, 메시지 전송 및 채널 목록을 얻을 수있는 것을 만들 수 있습니다.

htps : // 기주 b. 코 m / 토즈 00 / s ぁ ck_ 후 fy_c ぃ

어디 까지나 CLItool을 만드는 방법을 배우십시오

개발 환경

OS : macOS Mojave

rbenv: 1.1.2

Ruby: 2.6.2

rubygems: 3.0.3

절차

이번에는 slack_notify_cli라는 gem을 만듭니다.

1. bundler 설치

설치되지 않은 경우에만.

$ gem install bundler 

2. 젬의 병아리 만들기

이번에는 테스트도 쓸 예정이므로 -t 옵션을 지정한다.

$ bundle gem slack_notify_cli -t rspec

3. gemspec 수정

기본적으로 TODO 부분을 편집하면 좋다.

slack_notify_cli.gemspec

Gem::Specification.new do |spec|
  spec.name          = "slack_notify_cli"
  spec.version       = SlackNotifyCli::VERSION
+   spec.authors       = "tozu00"
-   spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}↲
-   spec.description   = %q{TODO: Write a longer description or delete this line.}↲
-   spec.homepage      = "TODO: Put your gem's website or public repo URL here."↲
+  spec.summary       = %q{slack notification command line interface. }
+  spec.description   = %q{slack notification command line interface. ex.) get channel list, check auth, send message}
+  spec.homepage      = "https://github.com/tozu00/slack_notify_cli"

rubygems에 등록하는 경우에는 다음 설정이 있으면 안됩니다.

외부에 gem을 게시하지 않으려는 경우에만 이 설정이 필요합니다. 그래서 삭제합니다.

slack_notify_cli.gemspec

-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-    spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end

필요한 gem 추가

slack_notify_cli.gemspec

  spec.add_development_dependency "aruba"

  spec.add_dependency "thor"
  spec.add_dependency "slack-ruby-client"

아루바 : 테스트 프레임 워크. CLI 테스트가 쉬워집니다.

thor : CLItool을 작성합니다.

slack-ruby-client : slack의 통지 기능을 실현한다.

4. 명령이 실행되는 클래스 작성

slack-ruby-client의 다음 기능을 구현해보십시오.

test-auth

send-messages

list-channels

lib/slack_notify_cli/command.rb

require 'thor'
require 'slack-ruby-client'

Slack.configure do |config|
  config.token = ENV['SLACK_API_TOKEN']
  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
end

module SlackNotifyCli
  class Command < Thor
    desc "slack_notify_cli auth_check", "auth check"
    def auth_check
      client = Slack::Web::Client.new
      puts client.auth_test['ok'] ? "Authentication successed" : "Authentication failed"
    end

    desc "slack_notify_cli channel_list", "get channel list"
    def channel_list
      client = Slack::Web::Client.new
      channels = client.channels_list.channels
      puts channels.map { |c| "##{c.name} #{c.purpose.value}"}
    end

    desc "slack_cli send str:{channel} str:{message}", "send message ex.) slack_cli send \"#general\" \"Hello World\""
    def send(channel, message)
      client = Slack::Web::Client.new
      client.chat_postMessage(channel: channel, text: message, as_user: true)
    end
  end
end

만든 클래스 로드

lib/slack_notify_cli.rb

require "slack_notify_cli/version"
+ require "slack_notify_cli/command"

module SlackNotifyCli
  class Error < StandardError; end
end

5. 실행 파일 만들기

SlackNotifyCli::Command.start에서 CLI를 시작합니다.

exe/slack_notify_cli

#!/usr/bin/env ruby

require "slack_notify_cli"

SlackNotifyCli::Command.start

6. bundle install

gem의 설치를 디렉토리의 범위에 한정하고 싶기 때문에, --path 옵션을 붙여, 인스톨 한다.

$ bundle install --path .bundle

7. 명령 실행

환경 변수에 token을 설정하고 명령을 실행합니다.

$ export SLACK_API_TOKEN=xo...
$ bundle exec exe/slack_notify_cli
Commands:
  slack_notify_cli help [COMMAND]                              # Describe available commands or one specific command
  slack_notify_cli slack_cli send str:{channel} str:{message}  # send message ex.) slack_cli send "#general" "Hello World"![スクリーンショット 2019-05-04 23.59.51.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/236702/fdc9373d-0d54-bdbb-534c-ea5737285d5a.jpeg)

  slack_notify_cli slack_notify_cli auth_check                 # auth check
  slack_notify_cli slack_notify_cli channel_list               # get channel list

인수를 지정하지 않으면 도움말을 내주는 것 같습니다.

메시지 보내기

$ bundle exec exe/slack_notify_cli send "#test" "Hello World"

굉장히 간단하지 않을까!

소감

생각보다 쉬워졌습니다

젬을 만들어 공개 할 때까지 시도

CItool과 함께 가자

참고 기사

Ruby에서 CLI 도구를 만드는 단계 요약

RubyGems를 만드는 방법

Slack API의 Token 취득 및 위치

rubygems에 등록 할 때는 spec.metadata [ 'allowed_push_host'] 근처를 지우자.

Aruba gem으로 CLI 테스트 지원