davidlarsketch / stuk Goto Github PK

Given

• Lambda function makes a POST request to /device

When

• The data is valid

Then

• It is stored & returns a 201 response

Unknown

Kind of storage

• DynamoDB
• RDS
• S3: JSON file

Given

• The user connects a new device to the Pi

When

• The device processes whether the device was successfully connected

Then

• The Pi makes a POST request with that device information, potentially to /device/new

Given

• The front-end site targets the correct API endpoints

When

• It makes a GET request for the user's profile data

Then

• That data is received in JSON format

Given

• A user is logged in
• A user has registered devices
• They perform an action on the "Devices" section

When

• They perform an action on a registered device

Then

• They see nice charts on stats such as:
  • Temp over duration of ferment
• They see stats such as:
  • Time until ferment end
  • Current temp
  • Time of recent reading
  • Avg temp
  • Highest temp
  • Lowest temp
  • Deviation

Given

• A user has a registered device
• They make a gesture on a device's "Reconfigure" or "New Schedule" button

When

• They fill out/edit the schedule information

Then

• The web app makes a request with that new information

Given

• A new device has been associated with a user
• The user confirms in a display that it is their device

When

• A PATCH request to /device/:id with the user data payload

Then

• The API updates the entry on the DB to associate the device with a user & sends back a status 200

Given

• There is a continuous integration pipeline setup (e.g., on CircleCI)

When

• Code is merged in to master

Then

• Integration test suites run
• Test results are recorded

Given

• A user is registered & logged in
• That device is recognized by the RaspberryPi

When

• They perform an action on the "Register" tab

Then

• They can enter the configuration settings for the new device, such as:
  • Minimum temp
  • Maximum temp
  • Fermentation end time
  • Type (what's being fermented)
  • Quantity (how much of it)
  • Location (where in one's house)

Given

• A temperature reading passes a certain condition for a schedule
• The user has a registered phone number
• Lambda formulates a message

When

• Lambda function publishes to a SNS topic

Then

• The user receives an SMS text message with the appropriate message

Given

• Chron wakes up the Pi & runs Python script

When

• It signals for a new reading

Then

• That reading is received & processed

Given

• A new device has been associated with a user

When

• The user confirms in a display that it is their device

Then

• The web app receives 200

Given

• A user is logged in

When

• The web app makes a GET request for all top-level data for devices associated with a user

Then

• The data is sent in JSON format with 200 status code

Given

• A new data point is sent to AWS

When

• AWS Lambda functions are triggered

Then

• Statistics are calculated such as:
  • Current temp
  • Time of recent reading
  • Avg temp
  • Highest temp
  • Lowest temp
  • Deviation
• Statistics are saved, associated with device

Given

• A user has registered devices and recorded data

When

• They make a gesture on a particular devices dashboard

Then

• They see terra.js-based, Conway's Game of Life style data visualizations

Given

• A user visits the site
• They perform an action on the "Login" button

When

• They enter valid login info

Then

• They are logged in & can view their sensors' data

Given

• The Pi makes a POST request for a new device

When

• The API handles the request by saving the new device data to the DB

Then

• A 201 code is logged

Posts with IP address of request made?
User registration requires saving that IP address, so that new device is understood to be connected with a particular user b/c of IP address?

1. vue assets build
2. Available at davidlarsket.ch/stuk
3. Served from CloudFront
4. Stored on S3

Given

• Code has been merged into master

When

• All tests pass

Then

• Running services are replaced with updated version

Given

• A check in to master occurs on the stuk web app
• Integration tests are written

When

• The tests pass

Then

• The image is deployed

Given

• A new temperature reading is received by the RaspberryPi

When

• Lambda functions process data results

Then

• It sends the data to a DB

Given

• Automated test pipeline exists

When

• They create an environment to run unit and integration tests in

Then

• The latest LTS version of Node is used

Use terraform create:

1. Route53
   • MX
   • TXT for domain verification
   • CNAME for DKIM verification
2. S3 for storage
3. SES
   • domain
   • email addresses
   • save email rule set

Given

• A user is logged in

When

• The web app makes a GET request for a device's data

Then

• That data is sent in JSON format with a 200 status code