groupbot

README

GroupBot

Overview

GroupBot is a bot that allows you to share information about yourself with the team. It was initially created to share information for ordering tshirts. It currently stores data in a Google Sheet.

Configuration

Set the following environment variables:

Variable	Type	Required	Notes
GROUPBOT_ENGINE	string	y	aws or nethttp
GROUPBOT_PORT	integer	n	local port number for net/http
GROUPBOT_REQUEST_FUZZY_AT_MENTION_MATCH	boolean	n	Match non-completed at mentions.
GROUPBOT_RESPONSE_AUTO_AT_MENTION	boolean	n
GROUPBOT_POST_SUFFIX	string	n
GOOGLE_SERVICE_ACCOUNT_JWT	JSON string	y
GOOGLE_SPREADSHEET_ID	string	y	ID as in URL
GOOGLE_SHEET_TITLE_RECORDS	string	y	sheet title for data records, e.g. Records
GOOGLE_SHEET_TITLE_METADATA	string	y	sheet title for metadata, e.g. Metadata
RINGCENTRAL_BOT_ID	string	y	bot personId in Glip
RINGCENTRAL_BOT_NAME	string	y	bot name in Glip for fuzzy at matching
RINGCENTRAL_SERVER_URL	string	y	Base API URL, e.g. https://platform.ringcentral.com
RINGCENTRAL_TOKEN_JSON	JSON string	y	JSON token as returned by /oauth/token endpoint

Using the AWS Engine

To use the AWS Lambda engine, you need an AWS account. If you don't hae one, the free trial account includes 1 million free Lambda requests per month forever and 1 million free API Gateway requests per month for the first year.

Installation via AWS Lambda

See the AWS docs for deployment:

https://docs.aws.amazon.com/lambda/latest/dg/lambda-go-how-to-create-deployment-package.html

Using the aws-cli you can use the following approach:

$ cd ./apps/server
$ GOOS=linux go build main.go
$ zip main.zip ./main
# --handler is the path to the executable inside the .zip
$ aws lambda create-function --region us-east-1 --function-name Databot --memory 128 --role arn:aws:iam::account-id:role/execution_role --runtime go1.x --zip-file fileb://main.zip --handler main

Keepalive

In production, there are are reasons why a RingCentral webhook may fail and become blacklisted. These should be tracked down an eliminated. If there are reasons to reenable the webhook, you can deploy the [rchooks] RingCentral Lambda keepalive function:

• rchooks/apps/keepalive_lambda

Documentation

Index

• Constants
• func GetGoogleApiClient(appConfig AppConfig) (*http.Client, error)
• func GetRingCentralApiClient(appConfig AppConfig) (*rc.APIClient, error)
• func GetSheetsMap(googClient *http.Client, spreadsheetId string, sheetTitle string) (sheetsmap.SheetsMap, error)
• func HandleAwsLambda(req events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)
• func ServeAwsLambda(intentRouter IntentRouter)
• func ServeNetHttp(intentRouter IntentRouter)
• type AppConfig
  • func (ac *AppConfig) AppendPostSuffix(s string) string
  • func (ac *AppConfig) Quote(s string) string
• type GlipPostEventInfo
• type Groupbot
  • func (bot *Groupbot) HandleAwsLambda(req events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)
  • func (bot *Groupbot) HandleNetHTTP(res http.ResponseWriter, req *http.Request)
  • func (bot *Groupbot) Initialize() (hum.ResponseInfo, error)
  • func (bot *Groupbot) ProcessEvent(reqBodyBytes []byte) (*hum.ResponseInfo, error)
  • func (bot *Groupbot) SendGlipPost(glipPostEventInfo *GlipPostEventInfo, reqBody rc.GlipCreatePost) (*hum.ResponseInfo, error)
• type Intent
• type IntentRouter
  • func NewIntentRouter() IntentRouter
  • func (ir *IntentRouter) ProcessRequest(bot *Groupbot, glipPostEventInfo *GlipPostEventInfo) (*hum.ResponseInfo, error)
  • func (ir *IntentRouter) ProcessRequestSingle(bot *Groupbot, textNoBotMention string, glipPostEventInfo *GlipPostEventInfo) (*hum.ResponseInfo, error)
• type IntentType

Constants

const (
	CharQuoteLeft  = "“"
	CharQuoteRight = "”"
)

const ValidationTokenHeader = "Validation-Token"

Functions

func GetGoogleApiClient

func GetGoogleApiClient(appConfig AppConfig) (*http.Client, error)

func GetRingCentralApiClient

func GetRingCentralApiClient(appConfig AppConfig) (*rc.APIClient, error)

func GetSheetsMap

func GetSheetsMap(googClient *http.Client, spreadsheetId string, sheetTitle string) (sheetsmap.SheetsMap, error)

func HandleAwsLambda

func HandleAwsLambda(req events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)

func ServeAwsLambda

func ServeAwsLambda(intentRouter IntentRouter)

func ServeNetHttp

func ServeNetHttp(intentRouter IntentRouter)

Types

type AppConfig

type AppConfig struct {
	Port                               int64  `env:"GROUPBOT_PORT"`
	GroupbotRequestFuzzyAtMentionMatch bool   `env:"GROUPBOT_REQUEST_FUZZY_AT_MENTION_MATCH"`
	GroupbotResponseAutoAtMention      bool   `env:"GROUPBOT_RESPONSE_AUTO_AT_MENTION"`
	GroupbotPostSuffix                 string `env:"GROUPBOT_POST_SUFFIX"`
	GroupbotCharQuoteLeft              string `env:"GROUPBOT_CHAR_QUOTE_LEFT"`
	GroupbotCharQuoteRight             string `env:"GROUPBOT_CHAR_QUOTE_RIGHT"`
	RingCentralTokenJSON               string `env:"RINGCENTRAL_TOKEN_JSON"`
	RingCentralServerURL               string `env:"RINGCENTRAL_SERVER_URL"`
	RingCentralWebhookURL              string `env:"RINGCENTRAL_WEBHOOK_URL"`
	RingCentralBotId                   string `env:"RINGCENTRAL_BOT_ID"`
	RingCentralBotName                 string `env:"RINGCENTRAL_BOT_NAME"`
	GoogleSvcAccountJWT                string `env:"GOOGLE_SERVICE_ACCOUNT_JWT"`
	GoogleSpreadsheetId                string `env:"GOOGLE_SPREADSHEET_ID"`
	GoogleSheetTitleRecords            string `env:"GOOGLE_SHEET_TITLE_RECORDS"`
	GoogleSheetTitleMetadata           string `env:"GOOGLE_SHEET_TITLE_METADATA"`
}

func (*AppConfig) AppendPostSuffix

func (ac *AppConfig) AppendPostSuffix(s string) string

func (*AppConfig) Quote

func (ac *AppConfig) Quote(s string) string

type GlipPostEventInfo

type GlipPostEventInfo struct {
	PostEvent        *rc.GlipPostEvent
	GroupMemberCount int64
	CreatorInfo      *rc.GlipPersonInfo
	TryCommandsLc    []string
}

type Groupbot

type Groupbot struct {
	AppConfig         AppConfig
	RingCentralClient *rc.APIClient
	GoogleClient      *http.Client
	SheetsMap         sheetsmap.SheetsMap
	SheetsMapMeta     sheetsmap.SheetsMap
	IntentRouter      IntentRouter
}

func (*Groupbot) HandleAwsLambda

func (bot *Groupbot) HandleAwsLambda(req events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)

func (*Groupbot) HandleNetHTTP

func (bot *Groupbot) HandleNetHTTP(res http.ResponseWriter, req *http.Request)

func (*Groupbot) Initialize

func (bot *Groupbot) Initialize() (hum.ResponseInfo, error)

func (*Groupbot) ProcessEvent

func (bot *Groupbot) ProcessEvent(reqBodyBytes []byte) (*hum.ResponseInfo, error)

func (*Groupbot) SendGlipPost

func (bot *Groupbot) SendGlipPost(glipPostEventInfo *GlipPostEventInfo, reqBody rc.GlipCreatePost) (*hum.ResponseInfo, error)

type Intent

type Intent struct {
	Type         IntentType
	Strings      []string
	Regexps      []*regexp.Regexp
	HandleIntent func(bot *Groupbot, glipPostEventInfo *GlipPostEventInfo) (*hum.ResponseInfo, error)
}

type IntentRouter

type IntentRouter struct {
	Intents []Intent
}

type EventResponse struct {
	StatusCode int               `json:"statusCode,omitempty"`
	Headers    map[string]string `json:"headers,omitempty"`
	Message    string            `json:"message,omitempty"`
}

func (er *EventResponse) ToJson() []byte {
	if len(er.Message) == 0 {
		er.Message = ""
	}
	msgJson, err := json.Marshal(er)
	if err != nil {
		return []byte(`{"statusCode":500,"message":"Cannot Marshal to JSON"}`)
	}
	return msgJson
}

func NewIntentRouter

func NewIntentRouter() IntentRouter

func (*IntentRouter) ProcessRequest

func (ir *IntentRouter) ProcessRequest(bot *Groupbot, glipPostEventInfo *GlipPostEventInfo) (*hum.ResponseInfo, error)

func (*IntentRouter) ProcessRequestSingle

func (ir *IntentRouter) ProcessRequestSingle(bot *Groupbot, textNoBotMention string, glipPostEventInfo *GlipPostEventInfo) (*hum.ResponseInfo, error)

type IntentType

type IntentType int

const (
	MatchString IntentType = iota
	MatchStringLowerCase
	MatchRegexp
	MatchAny
)