saba-webhook-gateway 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b360d216c14fa19ecc9e6fb814f26bf0a9d8b0f2c07e98073bd74ff27e665cec
+  data.tar.gz: b381d002fb7a4c526ce4a00e3026aae881c50c7656f2da73a170cf5d0b7c5b5f
+SHA512:
+  metadata.gz: 485b0ba83cdd8b7cc51bff9bd1120ad59212ee46dc55611f0c5cf1fb5dbe341792c814a2be3413d9934619249434cfeb05fec7291e100bb8c5a0fcfc354b48b3
+  data.tar.gz: 0eb0f2ac4b7ef20316400481b12c79fa2d3199651d39f98df7460d254787acb7e75a7eb6b5ffea52c488fd99b844ea0922e48bf420fc276ee5a7c72da30ab4b9

data/.rubocop.yml

@@ -0,0 +1,306 @@
+AllCops:
+  Exclude:
+    - samples/**/*
+    - vendor/**/*
+  DisplayCopNames: true
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+
+#### Lint
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'test/*'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/ErbNewArguments:
+  Enabled: false
+
+# make it enable when supporting only Ruby 3.0 and higher.
+Lint/RedundantDirGlobSort:
+  Enabled: false
+
+#### Performance
+
+Performance/DeletePrefix:
+  Enabled: false
+
+Performance/StringInclude:
+  Enabled: false
+
+Performance/CollectionLiteralInLoop:
+  Enabled: false
+
+Performance/MapCompact:
+  Enabled: false
+
+#### Style
+
+Style/AsciiComments:
+  Enabled: false
+
+# Use alias_method instead of alias.
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+  Enabled: true
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+  Enabled: true
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+  Enabled: true
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+  Enabled: true
+
+Style/TernaryParentheses:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+  Enabled: true
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+  Enabled: true
+
+Style/LineEndConcatenation:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  AllowedPatterns:
+    - 'require'
+    - 'include'
+    - 'file'
+    - 'task'
+    - 'desc'
+    - 'info'
+    - 'gem'
+    - 'exit'
+    - 'print'
+    - 'puts'
+    - 'write'
+    - 'warn'
+    - 'error'
+    - 'error!'
+    - 'app_error'
+    - 'raise'
+    - 'yield'
+    - 'source'
+    - 'assert'
+    - 'assert_equal'
+    - 'assert_raise'
+    - 'assert_raises'
+    - 'assert_nothing_raised'
+    - 'sh'
+    - 'mv'
+    - 'rm_rf'
+  Enabled: true
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/PercentQLiterals:
+  EnforcedStyle: upper_case_q
+  Enabled: true
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StderrPuts:
+  Enabled: false
+
+Style/WordArray:
+  MinSize: 10
+
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/CombinableLoops:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+### Layout
+
+Layout/BlockAlignment:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Layout/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+  Enabled: true
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+  AllowInHeredoc: true
+
+Layout/LineLength:
+  Max: 256
+  Exclude:
+    - "test/**/*"
+
+#### Metrics
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 28
+
+Metrics/ClassLength:
+  Max: 1500
+  Exclude:
+    - 'test/*.rb'
+
+### should be < 50
+Metrics/MethodLength:
+  Max: 100
+  Exclude:
+    - "bin/review-*"
+    - "bin/review2*"
+    - "test/**/*"
+
+### should be < 20
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+### should be < 60
+Metrics/AbcSize:
+  Max: 120
+  Exclude:
+    - "bin/review-*"
+    - "test/**/*"
+
+### shoud be < 25
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Max: 62
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+
+## Naming
+
+Naming/FileName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: normalcase
+  Enabled: true
+  Exclude:
+    - test/*
+
+#### Security
+
+#### Gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile-lambda

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'faraday'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kenshi Muto
+
+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,144 @@
+# Saba Webhook Gateway
+
+![](./saba-webhook-gateway.png)
+
+[![Gem Version](https://badge.fury.io/rb/saba-webhook-gateway.svg)](https://rubygems.org/gems/saba-webhook-gateway)
+
+Saba Webhook Gatewayは、監視サービス[Mackerel](https://ja.mackerel.io)のWebhookを受け取り、ほかの形式のWebhookに変換して引き渡すゲートウェイのライブラリです。
+
+以下のMackerelのWebhook通知に対応します。
+
+- サンプル（Mackerelの「テスト」で送出されるもの）
+- アラート通知
+- アラートグループ通知
+- ホストステータス変更
+- ホスト登録
+- ホスト退役
+- 監視ルールの操作（追加・変更・削除）
+
+## Google Chatでの実行
+
+実装のリファレンスとして、Google Chat Webhook変換を用意しています。各通知をGoogle Chatに送信できます（ただし、現時点でGoogle ChatのWebhookは有償プランのみでしか使えません）。
+
+![Google Chatでの通知表示](./googlechat.png)
+
+### Sinatraを使う場合
+
+以下のようにGoogle ChatスペースのWebhook URLを指定した`.env`ファイルを用意し、本Gitリポジトリを展開しているフォルダに配置します。
+
+```
+GOOGLECHAT_WEBHOOK=https://chat.googleapis.com/v1/spaces/…
+```
+
+Sinatra gemをインストールします。
+
+```
+$ gem install sinatra
+```
+
+Sinatraのサーバーを起動します。
+
+```
+$ exe/webhook-handler-googlechat.rb
+```
+
+デフォルトでは全IPアドレスにバインドした状態でTCPポート4567、パス`/`で待ち受けます。変更したいときには`.env`ファイルで`SERVER_BIND`・`SERVER_PORT`・`SERVER_PATH`を指定してください。
+
+用意したこのサーバーに対してMackerelから送信するようチャンネルを設定します。インターネット経由でアクセスできる必要があるため、ngrokやWebサーバーのプロキシを使ってアクセスできるようにしておきましょう。
+
+Mackerelの通知チャンネルの追加で「Webhook」を選び、URLにインターネット経由でアクセスされるURLを指定します。作成されたWebhookチャンネルで「テスト」をクリックすると、サンプルの通知がGoogle Chatに飛びます。
+
+### AWS Lambdaでの実行
+
+AWS LambdaのRubyランタイムと関数URLを使ってサーバーレスで実行することもできます。
+
+まず、アップロードするsaba-webhook-gateway-googlechat.zipファイルを作成します。
+
+```
+$ ./make-lambda-zip.sh
+```
+
+この作成シェルスクリプトはDebian bookworm用に作っており、Ruby 3.1で用意されるフォルダ名をLambdaのRuby 3.2用に変更しています。ほかのOSやバージョンの場合は適宜変更してください。
+
+AWSでLambdaを用意します。
+
+- 一から作成
+- 関数名: 任意
+- ランタイム: 「Ruby 3.2」
+- アーキテクチャ: 任意
+- デフォルトの実行ロールの変更: 環境に応じて
+- 詳細設定の 関数URLを有効化: チェック
+- 認証タイプ: NONE（※パブリックなエンドポイントになることに注意）
+- 呼び出しモード: BUFFERED（デフォルト）
+- オリジン間リソース共有（CORS）を設定: 任意
+
+「コード」タブの「コードソース」の「アップロード元」からsaba-webhook-gateway-googlechat.zipファイルをアップロードします。
+
+下にスクロールして「ランタイム設定」に進み、「編集」をクリックしてハンドラを以下のとおり変更します。
+
+```
+exe/lambda-handler-googlechat.lambda_handler
+```
+
+次に「コード」に戻り、「設定」タブをクリックして、「環境変数」を選びます。「環境変数の追加」をクリックし、キーに `GOOGLECHAT_WEBHOOK` 、値にGoogle ChatスペースのWebhook URLを指定します。
+
+さらに「暗号化の設定」を選び、「転送時の暗号化に使用するヘルパーの有効化」にチェックします。値の右に「転送時の暗号化」というボタンができるので、これをクリックし、KMSキーを選びます。
+
+「実行ロールポリシー」に復号のためにLambdaの実行IAMロールに追加する必要のあるポリシーが示されるので、これをIAMロールに付加してください。
+
+「関数の概要」にWebhookエンドポイントとなる「関数URL」が表示されているので、Mackerelの通知チャンネルの追加で「Webhook」を選び、URLにその関数URLを指定します。作成されたWebhookチャンネルで「テスト」をクリックすると、サンプルの通知がGoogle Chatに飛びます。
+
+### カスタマイズ
+
+メッセージを変更したいときには、`lib/saba-webhook-gateway/googlechat.rb`を直接書き換える方法もありますが、一部だけであればメソッドをオーバーライドするのが簡単です。
+
+```
+# Saba Webhook Gateway Override
+module GoogleChatOverride
+  # SabaWebhookGateway::GoogleChat の一部のメソッドの挙動(カード出力など)を変えたいときにはここでメソッドを上書きする
+  # sampleメソッドを上書きする例
+  def sample(h)
+    header = { title: '通知のテスト' }
+    widget1 = [{ textParagraph: { text: h[:message] } }]
+    sections = [{ widgets: widget1 }]
+    googlechat_card(header, sections)
+  end
+end
+
+module SabaWebhookGateway
+  class GoogleChat
+    prepend GoogleChatOverride
+  end
+end
+```
+
+## MackerelのWebhook JSONスキーマについて
+
+webhooksフォルダに、参考としてMackerelのWebhook JSONのスキーマファイルを入れています。
+
+内部仕様ではなく、出力から導出したものなので、正確性の保証はないことに注意してください。また、スキーマ内部で本来分岐が必要なもの（監視ルールの設定など）についても対応はしていません。
+
+## ライセンス
+```
+MIT License
+
+Copyright (c) 2023 Kenshi Muto
+
+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/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'fileutils'
+
+desc 'Check with rubocop'
+task :rubocop do
+  begin
+    require 'rubocop/rake_task'
+    RuboCop::RakeTask.new
+  rescue LoadError
+    $stderr.puts 'rubocop not found'
+  end
+end
+
+task default: %i[rubocop]

data/exe/lambda-handler-googlechat.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/saba-webhook-gateway'
+require 'aws-sdk-kms'
+require 'base64'
+
+ENCRYPTED = ENV['GOOGLECHAT_WEBHOOK']
+# Decrypt code should run once and variables stored outside of the function
+# handler so that these are decrypted once per container
+DECRYPTED = Aws::KMS::Client.new.decrypt({
+                                           ciphertext_blob: Base64.decode64(ENCRYPTED),
+                                           encryption_context: { 'LambdaFunctionName' => ENV['AWS_LAMBDA_FUNCTION_NAME'] }
+                                         }).plaintext
+ENV['GOOGLECHAT_WEBHOOK'] = DECRYPTED
+
+# rubocop:disable Lint/UnusedMethodArgument
+def lambda_handler(event:, context:)
+  m = SabaWebhookGateway::GoogleChat.new
+  h = m.parse(JSON.generate(event))
+  if h[:body]
+    m.run(m.parse(h[:body]))
+  elsif h[:event]
+    m.run(h)
+  end
+
+  { statusCode: 200, body: JSON.generate('received on Lambda') }
+end
+# rubocop:enable Lint/UnusedMethodArgument

data/exe/webhook-handler-googlechat.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# Saba Webhook Gateway Handler for Google Chat on Sinatra
+#
+# Copyright 2023 Kenshi Muto <kmuto@kmuto.jp>
+require 'dotenv'
+require 'sinatra'
+
+require 'pathname'
+bindir = Pathname.new(__FILE__).realpath.dirname
+$LOAD_PATH.unshift((bindir + '../lib').realpath)
+
+require 'saba-webhook-gateway'
+
+Dotenv.load
+@bind = ENV['SERVER_BIND'] || '0.0.0.0'
+@port = ENV['SERVER_PORT'] || 4567
+@path = ENV['SERVER_PATH'] || '/'
+
+set :bind, @bind
+set :port, @port
+
+post @path do
+  status 204
+  request.body.rewind
+  request_json = request.body.read
+
+  m = SabaWebhookGateway::GoogleChat.new
+  h = m.parse(request_json)
+  m.run(h) if h
+end