agileventures / asyncvoter-slack-bot Goto Github PK

JavaScript 76.93% Gherkin 23.07%

asyncvoter-slack-bot's Introduction

Asynchronous Voting Bot (SPIKE)

A slack bot to handle asynchronous planning poker

Setup

Set an environment variable equal to ASYNC_VOTER_SLACK_BOT_TOKEN to be your custom bot token. Set in your .bashrc or prefix the bot command with ASYNC_VOTER_SLACK_BOT_TOKEN=<your-token>

Running

Edit the code to manually set the vote topic, start the bot up with:

$ node server.js

and then say to the bot in a channel (or in DM if you want to just test it):

@<bot-name> start new vote

and the bot will say:


Async VoterBOT	[11:02 AM]  
@channel NEW ASYNC VOTE on "Project Page Redesign" https://github.com/AgileVentures/WebsiteOne/issues/797 Please DM me with: `vote 1` (Simple), `vote 2` (Medium) or `vote 3` (Hard) - Discussion in ticket or here as you prefer. :slightly_smiling_face:

now anyone wishing to vote can DM the bot like so:

vote 1

and the vote will be stored and the channel notified of the update like so:

@here ASYNC VOTE UPDATE 1 vote so far [@tansaku ] on "Project Page Redesign" https://github.com/AgileVentures/WebsiteOne/issues/797 Please DM me with: `vote 1` (Simple), `vote 2` (Medium) or `vote 3` (Hard) - Discussion in ticket or here as you prefer. :slightly_smiling_face:

finally say to the bot:

@<bot-name> result

to get the results posted to the channel where the vote was started:

votes so far:

@edmilsonefs voted: 2
@arreche voted: 2
@tansaku voted: 2

asyncvoter-slack-bot's People

Contributors

Watchers

asyncvoter-slack-bot's Issues

add cucumber testing

We've got a yada outline in place, but needs some work to hook it out and help make the high level stories nice and clear

failure on server

When @mtc2013 was testing we got this failure:

ubuntu@ip-172-31-35-239:~/async_slack_bot$ { type: 'message',
  channel: 'D35B4MGCU',
  user: 'U02B6JMJ6',
  text: 'vote results',
  ts: '1481754694.000008',
  team: 'T0285CSTT',
  event: 'direct_message',
  match: [ 'vote', index: 0, input: 'vote results' ] }

/home/ubuntu/async_slack_bot/server.js:57
  vote = message.text.match(/\d+/)[0]
                                  ^
TypeError: Cannot read property '0' of null
    at Object.controller.hears.response (/home/ubuntu/async_slack_bot/server.js:57:35)
    at Object.<anonymous> (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:852:28)
    at Object.Botkit.botkit.trigger (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:879:49)
    at Object.<anonymous> (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/SlackBot.js:720:34)
    at Object.Botkit.botkit.trigger (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:879:49)
    at /home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:983:32
    at Object.bot.findConversation (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/Slackbot_worker.js:678:9)
    at /home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:979:21
    at next (/home/ubuntu/async_slack_bot/node_modules/botkit/node_modules/ware/lib/index.js:82:27)
    at Ware.run (/home/ubuntu/async_slack_bot/node_modules/botkit/node_modules/ware/lib/index.js:88:3)

hosted on drie push votes were stored, but we didn't get channel prompts

more details here: drie/push-issues#2

make existing cukes more aware of channels the bot and user is in

probably want to use the newly forked npm module for botkit on av

throttling the messages and instructions

it would be nice if the bot avoided reposted the instructions etc. if they had been posted recently

replace botkit-mock

support multiple parallel votes

arguably we need the existing functionality wrapped in tests first ...!

bug: name not found

{ type: 'message',
  channel: 'D33U268KG',
  user: 'U0292M7AC',
  text: 'vote 3',
  ts: '1480511500.000046',
  team: 'T0285CSTT',
  event: 'direct_message',
  match: [ 'vote', index: 0, input: 'vote 3' ] }
info: ** API CALL: https://slack.com/api/chat.postMessage
info: ** API CALL: https://slack.com/api/chat.postMessage
info: ** API CALL: https://slack.com/api/chat.postMessage
info: ** API CALL: https://slack.com/api/chat.postMessage
start new vote "API - create user"  <https://www.pivotaltracker.com/story/show/134581147>

/home/ubuntu/async_slack_bot/server.js:50
  story.name = match[1]
                    ^
TypeError: Cannot read property '1' of null
    at Object.controller.hears.vote (/home/ubuntu/async_slack_bot/server.js:50:21)
    at Object.<anonymous> (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:852:28)
    at Object.Botkit.botkit.trigger (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:879:49)
    at Object.<anonymous> (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/SlackBot.js:739:38)
    at Object.Botkit.botkit.trigger (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:879:49)
    at /home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:983:32
    at Object.bot.findConversation (/home/ubuntu/async_slack_bot/node_modules/botkit/lib/Slackbot_worker.js:678:9)
    at /home/ubuntu/async_slack_bot/node_modules/botkit/lib/CoreBot.js:979:21
    at next (/home/ubuntu/async_slack_bot/node_modules/botkit/node_modules/ware/lib/index.js:82:27)
    at Ware.run (/home/ubuntu/async_slack_bot/node_modules/botkit/node_modules/ware/lib/index.js:88:3)

full feature user stories at the top of each cuke

I think the key addition now is the full feature user stories at the top of each cuke, and a gradual polishing to more declarative cukes:

http://itsadeliverything.com/declarative-vs-imperative-gherkin-scenarios-for-cucumber

also pulling in a bigger set of other stories

restart slack bot after crash

at the moment a regex mismatch will bring down the bot ... :-(

get a test harness in place for slack bot

need to test this code - what we have so far is a spike

would like the URL to be hyperlinked

should be relatively easy with the slack syntax

persist the vote info

As an admin or user
So that we don't lose critical vote information
I would like the vote information to be persisted

Could be sent to RESTful endpoint

add error handling

@chaiwa-berian makes a great point that we should have some general error handling when instructions fail, so the bot can respond with some helpful instructions when there's a fail

prompt vote after inactivity

maybe after 12 hours with no votes - should prompt in channel