tdmalone/coffee-shop-message

A little AWS Lambda function I've got hooked up to a Flic button at our fave coffee shop. Includes Terraform config for all necessary AWS resources.

Coffee Shop Message

This is a little AWS Lambda function I've got hooked up to a Flic button at my work's fave coffee shop.

Like all good cafes they open early, and sometimes close early - particularly when they've sold out of salads, or it's a quiet afternoon. So the Flic sits on their wall, and when they're about to close they tap it... a few doors down our office gets a Slack message and we know to come get our last coffees of the day!

Setup

To install locally:

$ yarn

As input is required to run the function, the easiest way to see it in action is to run the integration tests documented below.

Then, to install on AWS using Terraform, see infrastructure/. You can then configure a Flic button to send POST requests to your new API whenever it is pressed!

Tests

To run all tests at once:

$ yarn test

Unit Tests

To run:

$ yarn unit-tests

Note that unit tests are yet to be written, and will currently just pass!!

Integration Tests

To run:

$ yarn docker-tests

Integration tests require Docker. They run in lambci/lambda:nodejs6.10 (GitHub | Docker Hub).

The following environment variables must be defined on your system:

• SLACK_HOOK_DEV
• SNS_TOPIC_DEV
• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_DEFAULT_REGION
• CI - optional

The final CI variable above is optional, but recommended. If set (which it is by default on Travis CI, for instance), it will cause errors to be thrown rather than returned as an API Gateway style response. If not set, tests will still 'pass', as errors will be mapped to a HTTP status code rather than thrown.

License

MIT.

coffee-shop-message's Issues

Add basic unit tests

The refactor to external Lambda response library breaks the response

Re fd2d625:

This isn't in prod/master yet, but in dev it is triggering a 'Malformed Lambda proxy response' error at API Gateway, likely because the body isn't sent as a JSON string:

{"isBase64Encoded":false,"headers":{},"statusCode":200,"body":[{"ResponseMetadata":{"RequestId":"27f2cb59-34d0-5450-a437-9811e2ee48d5"},"MessageId":"d3ecba33-56c2-59f7-b570-e97b80fca572"},"ok"]}

The other issue here though, is we lost the custom 'Message sent, thanks guys!' that goes back to the coffee shop.

It might either be worth reverting fd2d625 before merging dev into master, or looking into a way to resolve this issue while still using the external dependency to build the proxy response.

Upgrade to Node 8, now available with Lambda

Can also use async/await now.

Come up with an easy way for the shop or customers themselves to subscribe e-mails and mobile numbers to the SNS topic

Lambda func with static frontend?

Add Terraform configuration for managing infrastructure

Adding this will make it easier to transfer from my AWS account to @daviddeejjames's AWS account!