jasonnor / annoying-doge-bot

🐕 A Rocket.Chat bot that randomly reads conversations to send annoying memes.

Annoying Doge Bot

A Rocket.Chat bot that randomly reads conversations to send annoying memes.

Getting Started

Configuration

Edit config/setting.yaml to configure project.

Required

• rocket_chat
  • url - URL of your Rocket Chat site
  • user_name - Username of bot to send messages, could be a normal user
  • password - Password of above user
• chat_bot
  • display_name - Name of chatbot display in Rocket Chat
  • avatar_url - Avatar image URL of chatbot display in Rocket Chat
  • target_channels - List of channels name to monitor and send messages
• google_search
  • url - URL of Google Custom Search JSON API, would be one of the following:
    • https://www.googleapis.com/customsearch/v1 for normal API
    • https://www.googleapis.com/customsearch/v1/siterestrict for restricted API
  • cx - Programmable Search Engine ID, see document here for more information
  • api_key - API key of application, see document here for more information

Optional

• chat_bot
  • alternative_rules - Replace messages to alternative value to search meme if messages contain key
  • pattern_matching - Reply message value to target if messages contain pattern key
• watch_dog
  • time_interval_sec - Interval time of monitoring channel messages
  • time_limit_sec - Service life, end service if reach time limit

Starting service

go build cmd/annoying-doge/main.go

# Linux or macOS
./main

# Windows
main.exe

Features

WIP

annoying-doge-bot's Issues

Support image response in pattern matching rules

Update config trigger by command

Trigger by #8

Write test code and create GitHub action for CI

User statistics and send special message to top rank user

Inspire by William

Support English meme search

Add CHANGELOG in docs for better version record

Find an alternative to Google Custom Search API

Due to the limit of 100 times per day
https://github.com/search?o=desc&q=google+search&s=stars&type=Repositories

Skip message if contains some emoji or message

Dislike meme to delete message of poor doge

To delete bad meme

Trigger something by keyword mode

Debug mode to send log messenger to rocket.chat

Daemon process like cron or watchdog to auto send memes

Watchdog may be better, because doge is a dog too. 🐶

Message cache to avoid trying to search empty meme result

Or if we solve #6, it won't be a problem 😉

Add Go Report Card badge in README.md

https://goreportcard.com/report/github.com/Jasonnor/annoying-doge-bot

Refactor all HTTP request to `go-resty` client

https://github.com/go-resty/resty

Logger instead of print

e.g., https://github.com/Sirupsen/logrus

Should not send meaningless meme while get no text message, e.g., pure image

Check image URL availability before send message

To avoid sending a dead image 💀

Store persistent maps to disk for variables such as blacklist

Support messenger API

Add docker images for CI and production environments

Error while can't get any memes about message

Should add a simple length check before reply

Write document of repo, with usage and installation

Rule base config to treat something as something

e.g., bad doge to sorry