kneerunjun / botmincock

telegram bot backend for accounts maintenance, patching the payment gateway, monthly book keeping

botmincock

telegram bot backend for accounts maintenance, patching the payment gateway, monthly book keeping

docker-compose --env-file dev.env up mongostore

docker-compose --env-file dev.env up botmincock docker-compose --env-file dev.env build

docker exec -it ctn_store /bin/bash -c mongo

dev-btmnck b07m1nc0ck

botmincock's Issues

when adding expenses the tally should be added to the balance collection as well

Over elevation should be flagged as error

/allexpenses command

This lets you check all the expenses for the team

when adding expenses the tally should be added to the balance collection as well

circular package reference bot/core <--> bot/updt

The updates channel on the bot can be shifted out

elevating users to higher roles

While you can register users with /regiserme , this should be able to elevate user

not picking up updates from when the server was down and rebooted

Ideally when the bot server is down and back up it should get updates from where it last left off ! That isnt the case here. The bot tends to miss all the updates in the conversation while the server was down

/deregisterme - deregistering self from botmincock accounts

just the opposite of /registerme

registering a new user account

This helps in registering a new user with botmincock database. A user can self register in the database - incentive to register in the database should be given by the system admin. User issues a command in the group and the bot then can save the details against unique ids.

• user issues a command in group chat @psa_badmintonbot /registerme [email protected]

• bot identifies the command

  • command if not identified bot throws error
  • exits the task
  • waits for new command

• bot validates the email

  • email not valid, bot throws error
  • exits the task
  • waits for new command

• bot registers the user with unique chat id to the database

  • Error registering the account, bot throws error
  • exits the task
  • waits for a new command

• bot responds with success

MarkPlayday - daily GM messages parsed to debits onto accounts

This function

• Eyeball all the err paths, and fix user messages
• Test when total play days ==0, no one has answered polls, or everyone has opted out of play
• Test when player hasn't answered polls , or has opted out of play
• BUG: when player opts to play, the player share has to be recalculated given the changed estimates
• Player shares, total play days, expenses, recoveries till now shouldnt be the responsibility of MarkPlayday
• Testing AttendanceBotCmd.Execute( ) for all possible scenarios
• Enabling user messages for MarkPlayDay
• biz package needs offloading of the responsibilities
• Testing AdjustDayDebit
• Testing AdjustPlayDebitBotCmd.Execute

editing existing account for email id

While account being registered is with an email id, there has to be a provision to change the same later

/myinfo - getting your account info

Cron job for Playday debit adjustment

• Cron job enabled in from Docker container
• Shell script as a trigger
• HTTP endpoint, handler that a trigger can call
• container entrypoint from entry.sh , entry.sh will enable cron deamon

getting user info - ids

All the commands following /registerme require the user ids to reference the user. We need a command that can help get the user info for the same

/listusers and the bot shall come back with

UserID UserName Elevation

/help to enlist the commands of the bot

Refactor package design

In what turns out to be a good learning experience - we have encountered a spot where it can be observed that change in the design will greatly clean up the code. But since the packages end having circular references this design activity can lead to a dead end.
Here is some guidance on how to get rid of the circular references yet still keep your package design intact.

calculate player contribution ratio from estimates poll

When user not registered - /myinfo

When users aren't registered /myinfo should reveal the telegram ID and the message that he can register using /register me

When account is not found "GetOne" - check for mgo.ErrNotFound

No error message when no expenses are recorded

I happened to delete all the expenses and then issued /allexpenses was expecting an error message, but what I got was no response from the bot

`GetOne` on the dbadp should be able to strong type the result

No error message when no expenses are recorded

I happened to delete all the expenses and then issued /allexpenses was expecting an error message, but what I got was no response from the bot

run.sh script for containers

while one can directly run containers from the shell and so can systemctl , run.sh is cleaner and less brutal on the containers

tok.secret missing from the build lineup - now that we are using code spaces

refactor based on business logic

biz.RecordExpense - adding a new expense

bot be able to bucket / neglect the relevant /irrelevant messages

command : /findme <emailid>

given the email the bot should be able to discover the user information