meerkat

README

Meerkat

Usecases

Usage flow

Interaction flow with Slack

Feature

• CreateQueastionnaire
  • Questions
    • Reuse existing questions
  • Schedule
    • WeekdayAndTimeSchedule
  • ScheduleException
    • YearMonthDayScheduleException
  • PostTarget
• EditQuestionnaire
• DisableQuestionnaire
• CreateAnswerer
• RemoveAnswerer
• Authorization
• Ask Answers (Notify)
  • deploy
  • execute every 1 minutes
• PostAnswer
• list (search) questionnaires
• list (search) answers
• list (search) answerers
• Inmemory persistence
• DynamoDB persistence
  • InitializeTable
• HTTP Server For Slack interface
• Lambda Server (with API Gateway) For Slack interface

Slack commands

Use AppMentionEvent

• @meerkat createQuestionnaire
• @meerkat editQuestionnaire {questionnaireID}
• @meerkat createAnswerer
• @meerkat addAnswerer

Usage

Lambda with API Gateway

1. create slack apps https://api.slack.com/apps?new_app=1
   • allow scope ( chat:write:bot, bot )
2. initialize conf yaml
   • make init
   • edit yamls ./gitignored/deployconfg/
3. deploy by ./deploytool/lambda/deploy.go
   • make deploy
4. setup API Gateway
   • setup path for ./adapter/slack/cmd/meerkat-slackapigatewayhandlerbylambda
     • /slack/suggestion
     • /slack/event
     • /slack/interactive
   • deploy and get public URL
5. config slack apps
   • Interactive Component
     • Interactivity
     • Message Menus
   • Event Subscriptions
     • Subscribe to Bot Events app_mention
   • Bot Users
6. create DynamoDB Tables
   • ./adapter/cmd/create_dynamodb_table
7. setup NotificationService execution with ./adapter/cmd/ask_all_if_needed
   • https://docs.aws.amazon.com/lambda/latest/dg/tutorial-scheduled-events-schedule-expressions.html