slappd

command module
v0.0.0-...-ae47360 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2017 License: MIT Imports: 11 Imported by: 0

README

GoDoc Go Report Card

Deploy

If you are interested in donating public hosting for this application it would be very easy to let anyone on slack use this with the click of a button. Right now I am running it on a private host for only a couple slack teams.

Slappd (Slack Untappd)

A Slack (Application) for searching the Untappd Beer Search API for information about a given beer.

Slappd Preview GIF

Basic Usage

  1. Register for Untappd API Credentials
  2. Get the server running somewhere on a public host
  3. Configure a Slack Application. See Slack Docs.

TODO (03-13-2017): Add more details about Slack Application configuration.

The following environment variables must be set:

  • SLACK_TOKEN - The token assigned to the slash command integration (can contain multiple comma seperated tokens)
  • UNTAPPD_CLIENT_ID - Your Untappd API client ID
  • UNTAPPD_CLIENT_SECRET - Your Untappd API client secret token
Request

The server expects a POST request from Slack with the following form values:

  • token
  • user_name
  • text

These values should be present in the default slack POST in addition to other non-used values.

Response

The server will do a lookup on the Untappd API for the given text in the Slack POST. If no result is found an ephemeral (only displayed to requesting user) message will be returned stating that no results were found. If results are found an in_channel (displayed to anyone in the channel) message will be returned.

Interactions

A user will type /untappd Boulevard Wheat which will produce:

Slappd Search Response

a user then has the option to select the desired beer which will produce:

Slappd Select Response

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL