Welcome to PowerDale

PowerDale is a small town with around 100 residents. Most houses have a smart meter installed that can save and send information about how much energy a house has used.

There are three major providers of energy in town that charge different amounts for the power they supply.

• Dr Evil's Dark Energy
• The Green Eco
• Power for Everyone

Introducing JOI Energy

JOI Energy is a new start-up in the energy industry. Rather than selling energy they want to differentiate themselves from the market by recording their customers' energy usage from their smart meters and recommending the best supplier to meet their needs.

You have been placed into their development team, whose current goal is to produce an API which their customers and smart meters will interact with.

Unfortunately, two members of the team are on annual leave, and another one has called in sick! You are left with another ThoughtWorker to progress with the current user stories on the story wall. This is your chance to make an impact on the business, improve the code base and deliver value.

Story Wall

At JOI energy the development team use a story wall or Kanban board to keep track of features or "stories" as they are worked on.

The wall you will be working from today has 7 columns:

• Backlog
• Ready for Dev
• In Dev
• Ready for Testing
• In Testing
• Ready for sign off
• Done

Examples can be found here https://leankit.com/learn/kanban/kanban-board/

Users

To trial the new JOI software 5 people from the JOI accounts team have agreed to test the service and share their energy data.

User	Smart Meter ID	Power Supplier
Sarah	smart-meter-0	Dr Evil's Dark Energy
Peter	smart-meter-1	The Green Eco
Charlie	smart-meter-2	Dr Evil's Dark Energy
Andrea	smart-meter-3	Power for Everyone
Alex	smart-meter-4	The Green Eco

These values are used in the code and in the following examples too.

Overview

JOI Energy is a new energy company that uses data to ensure customers are able to be on the best price plan for their energy consumption.

API

Below is a list of API endpoints with their respective input and output. Please note that the application needs to be running. For more information about how to run the application, please refer to run the application section below.

Store Readings

Endpoint

POST /readings/store

Example of body

{
    "smartMeterId": <smartMeterId>,
    "electricityReadings": [
        { "time": <time>, "reading": <reading> },
        { "time": <time>, "reading": <reading> },
        ...
    ]
}

Parameters

Parameter	Description
smartMeterId	One of the smart meters' id listed above
time	The time when the delta is measured
reading	The delta reading since the last reading

Example readings

Date (GMT)	Reading (kW)
2020-11-11T08:00:00.0000000+00:00	0.0503
2020-11-12T08:00:00.0000000+00:00	0.0213

In the above example, 0.0213 kW where consumed between 2020-11-11 8:00 and 2020-11-12 8:00.

Posting readings using CURL

$ curl \
  -X POST \
  -H "Content-Type: application/json" \
  "http://localhost:8000/readings/store" \
  -d '{"smartMeterId":"smart-meter-0","electricityReadings":[{"time":"2020-11-11T08:00:00.0000000+00:00","reading":0.0503},{"time":"2020-11-12T08:00:00.0000000+00:00","reading":0.0213}]}'

The above command returns 201 OK and response as "Readings inserted successfully".

Get Stored Readings

Endpoint

GET /readings/read/<smartMeterId>

Parameters

Parameter	Description
smartMeterId	One of the smart meters' id listed above

Retrieving readings using CURL

$ curl "http://localhost:8000/readings/read/smart-meter-1"

Example output

[
  { "time": "2020-11-14T08:00:00.0000000+00:00", "reading": "0.8998" },
  { "time": "2020-11-15T08:00:00.0000000+00:00", "reading": "0.6023" }
]

View Current Price Plan and Compare Usage Cost Against all Price Plans

Endpoint

GET /price-plans/compare-all/<smartMeterId>

Parameters

Parameter	Description
smartMeterId	One of the smart meters' id listed above

Retrieving readings using CURL

$ curl "http://localhost:8000/price-plans/compare-all/smart-meter-1"

Example output

[
    {
        "key": "Dr Evil's Dark Energy",
        "value": 0.4529635476463834
    },
    {
        "key": "The Green Eco",
        "value": 0.009059270952927669
    },
    {
        "key": "Power for Everyone",
        "value": 0.004529635476463834
    },
    {
        "Current Supplier": "The Green Eco",
        "SmartMeterId": "smart-meter-1"
    }
]

View Recommended Price Plans for Usage

Endpoint

GET /price-plans/recommend/<smartMeterId>[?limit=<limit>]

Parameters

Parameter	Description
smartMeterId	One of the smart meters' id listed above
limit	(Optional) limit the number of plans to be displayed

Retrieving readings using CURL

$ curl "http://localhost:8000/price-plans/recommend/smart-meter-1?limit=2"

Example output

[
  {
    "key": "Power For Everyone",
    "value": 0.004529635476463834
  },
  {
    "key": "The Green Eco",
    "value": 0.009059270952927669
  }
]

Compatible IDEs

Tested on:

• Visual Studio Code(with PHP Intelephense & PHPUnit extension)
• IntelliJ IDEA Ultimate

Useful commands

Build & Run the application

$ ./deploy-joyenergy.php

Above command will start the application on url http://127.0.0.1:8000. Can be accessed using http://localhost:8000 as well.

Run the tests

$ php artisan test