martinpeck / bedlam-slack Goto Github PK

At present, the code builds slack responses inline.

Given that responses all have the same structure and, often, share common properties it would be better to have a single place in the code where responses are generated (or, at least, template responses are generated).

When slash commands are POSTed to the app there are two POST form values that can be used to validate that the request came from a recognised Slack instance:

• token (contains a value generated when the slash command is added to Slack)
• team_id (contains the team ID for the Slack instance)

We should be validating these incoming values with those stored in the environment variables SLACK_TOKEN and SLACK_TEAM (defined in .env, or defined in Heroku)

See https://api.slack.com/slash-commands#how_do_commands_work for details

https://github.com/martinpeck/bedlam-slack/blob/master/CODE_OF_CONDUCT.md

Probably don't want to email the atom folks.

/ud [word]

• should look up word and return definition from UrbanDictionary.com

Add CI (suggest Travis) to run tests on check in to master.
Once in place, update Heroku to only deploy on a green build.

Build a SPA that:

• allows the user to enter one of the slack commands
• create HTTP POST to mimick Slack
• displays the request body
• displays the response body

Add a Postman Collection somewhere so that it's easier to poke/test the API from a test client.

For example, this slack command:

/ud beans & cheese

Requests to UD should be properly generated with something like requests to avoid this.

Need come to...

• parse the incoming slack slash command POST key/value pairs
• expose these to the rest of the code

Add some tests so that we can validate things are working prior to deployment

E.g. http://www.etymonline.com/index.php?allowed_in_frame=0&search=octopus

Suggest copy and paste the urban dictionary command. Better still refactor this to allow similar functions to be created more easily by specifying a "root" URL and a search term.

It appears that the cat gifs are being duplicated. I think this is because the current implementation is returning this URL to Slack...

http://thecatapi.com/api/images/get?format=src&type=gif

... which returns a random gif, but because it's the same URL each time Slack is caching the image and re-showing a previously returned gif.

Instead, we should be calling the cat gif API directly, getting the URL for an image, and returning the URL.

In order to make things testable and easier to add stuff I want to restructure the entire folder structure of this app as per http://learnpythonthehardway.org/book/ex46.html

The Idea

Allow a user to create a vote in a channel.

• votes are attached to a channel and a user
• any number of draft votes can exist
• only one can be active in the channel
• multi choice options are supplied
• voting starts when the owner says so
• entire channel gets to vote
• voting stops when the owner of the vote closes the polls
• once closed, a summary of the results is shown
• once closed, other votes can be started

Commands:

/vote start
/vote option [option]
/vote option list
/vote start
/vote [option]
/vote close
/vote list
/vote result [vote id]

How it might work:

/vote create When shall we meet for beers?

(ephemeral message)

what are the options? Use \vote options [option text] to create them, then \vote start to start voting in this channel or \vote quit to abort

/vote option Monday (enter)

(ephemeral message)

you've added the option "Monday"

/vote option Wednesday (enter)

(ephemeral message)

you've added the option "Wednesday"

/vote option Monday (enter)

(ephemeral message)

you've already added this option. Please make your options unique. Friday` (enter)

/vote option Friday (enter)

(ephemeral message)

you've added the option "Friday"

/vote start (enter)

@martinpeck wants you to vote on something!
@martinpeck asks "When shall we meet for beers?"
Your options are:
/vote 1 for Monday
/vote 2 for Tuesday
/vote 3 for Friday

/vote options will remind you of the options

To end voting, @martinpeck can use /vote close and I'll show you the results

/vote start
(ephemeral message)

There is already a vote taking place in this channel

/vote 1
(ephemeral message)

Thanks! Your vote has been counted! Any previous votes will be ignored.

/vote 1
(ephemeral message)

Thanks! Your vote has been counted! Any previous votes will be ignored.

/vote close

Voting has closed on Martin's vote "When shall we meet for beers?"
Here are the results:

Monday: 1 vote
Wednesday: 0 votes
Friday: 0 votes

It looks like the option "Monday" has won!