joe

joeボット？

Hubot からインスピレーションを得た、Go で書かれた汎用ボット ライブラリです。

---

joe Go プログラミング言語でチャット ボットを作成するために使用されるライブラリです。これは、Github の人々によって開発された素晴らしい Hubot フレームワークから多大な影響を受けており、Go を使用してチャット ボットを実装したい人々にそのパワーをもたらします。

はじめる

joe Go モジュールとしてパッケージ化されたソフトウェア ライブラリです。次の方法で入手できます。

joe ">

 go get github.com/go- joe / joe

使用例

すべてのコード例、詳細な説明、完全なレシピは https://joe-bot.net で見つけることができます。

各ボットは、チャットアダプター(例: Slack と統合するため)、キーと値のデータを記憶するためのメモリ実装 (例: Redis を使用)、および新しいメッセージまたはカスタム イベント (例: HTTP 呼び出しの受信) を対応する登録済みのユーザーにルーティングするBrainで構成されます。ハンドラー関数。

デフォルトでは、 joe .New(…)は、ボットが stdin からメッセージを読み取り、stdout で応答するようにする CLI アダプターを使用します。さらに、ボットはキー値データをメモリ内に保存します。つまり、ボットが再起動されると、ユーザーが指示した内容はすべて忘れられます。このデフォルト設定は、依存関係のないローカル開発には便利ですが、すぐに他のモジュールを追加してボットの機能を拡張したくなるでしょう。

次の例では、ボットを Slack ワークスペースに接続し、キーと値のデータを Redis に保存します。メッセージ ハンドラーがメモリにアクセスできるようにするために、メッセージ ハンドラーをjoe .Botを埋め込むカスタムExampleBotタイプの関数として定義します。

joe " "github.com/go- joe /redis-memory" "github.com/go- joe /slack-adapter/v2" ) type ExampleBot struct { * joe .Bot } func main() { b := &ExampleBot{ Bot: joe .New("example", redis.Memory("localhost:6379"), slack.Adapter("xoxb-1452345…"), ), } b.Respond("remember (.+) is (.+)", b.Remember) b.Respond("what is (.+)", b.WhatIs) err := b.Run() if err != nil { b.Logger.Fatal(err.Error()) } } func (b *ExampleBot) Remember(msg joe .Message) error { key, value := msg.Matches[0], msg.Matches[1] msg.Respond("OK, I'll remember %s is %s", key, value) return b.Store.Set(key, value) } func (b *ExampleBot) WhatIs(msg joe .Message) error { key := msg.Matches[0] var value string ok, err := b.Store.Get(key, &value) if err != nil { return fmt.Errorf("failed to retrieve key %q from brain: %w", key, err) } if ok { msg.Respond("%s is %s", key, value) } else { msg.Respond("I do not remember %q", key) } return nil }">

 package main

import (
	"fmt"

	"github.com/go- joe / joe "
	"github.com/go- joe /redis-memory"
	"github.com/go- joe /slack-adapter/v2"
)

type ExampleBot struct {
	* joe . Bot
}

func main () {
	b := & ExampleBot {
		Bot : joe . New ( "example" ,
			redis . Memory ( "localhost:6379" ),
			slack . Adapter ( "xoxb-1452345…" ),
		),
	}

	b . Respond ( "remember (.+) is (.+)" , b . Remember )
	b . Respond ( "what is (.+)" , b . WhatIs )

	err := b . Run ()
	if err != nil {
		b . Logger . Fatal ( err . Error ())
	}
}

func ( b * ExampleBot ) Remember ( msg joe . Message ) error {
	key , value := msg . Matches [ 0 ], msg . Matches [ 1 ]
	msg . Respond ( "OK, I'll remember %s is %s" , key , value )
	return b . Store . Set ( key , value )
}

func ( b * ExampleBot ) WhatIs ( msg joe . Message ) error {
	key := msg . Matches [ 0 ]
	var value string
	ok , err := b . Store . Get ( key , & value )
	if err != nil {
		return fmt . Errorf ( "failed to retrieve key %q from brain: %w" , key , err )
	}

	if ok {
		msg . Respond ( "%s is %s" , key , value )
	} else {
		msg . Respond ( "I do not remember %q" , key )
	}

	return nil
}

利用可能なモジュール

joe実際に必要以上の依存関係が取り込まれないようにするため、Redis 統合などのサードパーティ モジュールは同梱されていません。ただし、自分であまり多くのコードを記述しなくても、ボットの機能を拡張するために直接使用できるモジュールがすでにいくつかあります。

モジュールを作成し、それを共有したい場合は、それをこのリストに追加し、プル リクエストを開いてください。

チャットアダプター

• Slack アダプター: https://github.com/go-joe/slack-adapter
• Rocket.Chat アダプター: https://github.com/dwmunster/rocket-adapter
• テレグラムアダプター: https://github.com/robertgzr/joe-telegram-adapter
• IRC アダプター: https://github.com/akrennmair/joe-irc-adapter
• Mattermost アダプター: https://github.com/dwmunster/joe-mattermost-adapter
• VK アダプター: https://github.com/tdakkota/joe-vk-adapter

メモリモジュール

• Redis メモリ: https://github.com/go-joe/redis-memory
• ファイルメモリ: https://github.com/go-joe/file-memory
• ボルトメモリ: https://github.com/robertgzr/joe-bolt-memory
• Sqlite メモリ: https://github.com/warmans/sqlite-memory

その他のモジュール

• HTTP サーバー: https://github.com/go-joe/http-server
• Cron ジョブ: https://github.com/go-joe/cron

で構築

• zap - Go での超高速で構造化された平準化されたロギング
• multierr - パッケージ multierr では 1 つ以上のエラーを結合できます
• testify - シンプルな単体テスト ライブラリ

貢献する

私たちの行動規範とこのリポジトリにプル リクエストを送信するプロセスの詳細については、CONTRIBUTING.md をお読みください。

バージョン管理

このソフトウェアはまだアルファ版であり、API の安定性についてはまだ保証されていません。

すべての重要な (破壊的な) 変更は CHANGELOG.md に文書化されています。

v1.0 リリース後は、バージョン管理に SemVer を使用する予定です。利用可能なバージョンについては、このリポジトリのタグを参照してください。

著者

• フリードリヒ・グローセ-初期作品- fgrosse

このプロジェクトに参加した貢献者のリストもご覧ください。

ライセンス

このプロジェクトは、BSD-3-Clause License に基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。

謝辞

• Hubot とインスピレーションをもたらす素晴らしいコミュニティ
• embedmd は、マークダウン ファイルにソース コードを埋め込むための優れたツールです