nmhummel / beam-dental-ruby

The Boxing Kata

Everyone who has dental insurance through Beam receives perks in the form of electric toothbrushes, replacement brush heads, and paste kits (toothpaste and floss). These perks are provided at the start of an insurance contract and then semi-frequently throughout the life of the contract. Each family member gets to choose a toothbrush color at enrollment, and will receive replacement toothbrush heads of the same color.

This kata involves building the brains of a boxing system which will determine how the perks are boxed up and shipped. Given a family's brush color preferences, the system will generate a description of how the boxes should be filled. A shipping manager must be able to load data for a family, create starter and refill boxes, and perform other operations in real-time. The focus of this kata should be building a library for the system rather than a UI.

Instructions

Please read through the user stories below and implement the functionality to complete them according to their requirements. The design is entirely up to you as long as the solution can be run via the entry point in the bin directory (see Setup). We also ask that you commit your work to git frequently as you go.

Evaluation criteria

As there are often trade-offs when crafting a solution, the following is the priority of what we are considering when reviewing your kata:

• Functionality: The solution should fulfill the requirements and work correctly. Please feel free to reach out if you have questions about the provided user stories.
• Testing: Beam firmly believes in testing as a practice and as such we ask that you add tests. We prefer to see code that has good test coverage.
• Structure: Well-factored code is easier to reason about and maintain. We prefer to see good separation of concerns in the architecture.
• Idiomatic code: Along similar lines, code that adopts the best practices, idiom and conventions of the language/framework helps with readability and maintainability.

Additional sections to include

These sections will help us understand your thought process and workflow while we review your solution. Feel free to add these sections to this README or in a separate file.

• Technical decision making: Please add a section explaining the technical decision making involved in designing your solution. What options were you considering at various levels (eg. tech stack choice, libraries, and design, as applicable) and what were the trade-offs in choosing one option over another?
• Instructions on running your code: As you decide on the tools to build the solution, please add a section letting us know how to run your code and tests if it is different from the provided setup.

Setup

Install dependencies with the following command:

$ bundle install

The rspec testing framework has been installed for you, and tests can be run with the following command:

$ bin/rspec

If you would prefer to not use rspec for your tests, or have included non-rspec ones, please add instructions on how to run them. We'd love to hear your thought process behind that decision as well! (see additional sections)

An entry point has been provided for running the Kata:

$ ruby ./bin/boxing-kata <spec/fixtures/family_preferences.csv

Submitting your work to Beam

For ease of evaluation, we require that this kata is completed using the 2.7.0 version of ruby. This has already been set in the .ruby-version file and, for reinforcement, in the gem specifications as well. Please make sure to complete your kata using this version.

Once you're happy with your submission (evaluation criteria, additional sections), you can send it back in one of two formats, as a git bundle or as a zip file.

To create the git bundle simply execute the following from the root of the kata:

$ git bundle create boxing-kata.bundle <YOUR BRANCH NAME HERE>

This will create a .bundle file which contains the entire git repository in binary form, so you can easily send it as an attachment. Alternately, you could send the project as a zip file.

To ensure that our review of your kata remains as unbiased as possible, your submission will be anonymized before it is reviewed. To help us with this process, please double check that any personally identifiable information, such as your name or email address, is removed from your code, readme or any commit messages. Your author and committer information will be scrubbed by our anonymizing process.

Example Input File

The input file is a CSV file which contains the following fields:

id,name,brush_color,primary_insured_id,contract_effective_date
2,Anakin,blue,,2018-01-01
3,Padme,pink,2,,
4,Luke,blue,2,,
5,Leia,green,2,,
6,Ben,green,2,,

Currently, we only support one family per configuration file.

User Stories

Importing family preferences

As a Beam Shipping Manager
In order to ship perks
I want to view family member brush preferences

To begin the boxing process the shipping manager must import family data. When the system receives the input file, then the brush color counts will be displayed in the format below.

BRUSH PREFERENCES
blue: 2
green: 2
pink: 1

Starter boxes

As a Beam Shipping Manager
In order to ship perks
I want to fill starter boxes

Now that member data has been imported, the shipping manager can begin filling boxes. Each family member will receive one brush and one replacement head. Both the brush and the replacement head must be in the family member's preferred color. A starter box can contain a maximum of 2 brushes and 2 replacement heads in any combination of colors.

When the shipping manager presses the starter boxes button, then a number of boxes are output. Using the brush preferences example above, box output will be generated in the following format:

STARTER BOX
2 blue brushes
2 blue replacement heads

STARTER BOX
2 green brushes
2 green replacement heads

STARTER BOX
1 pink brush
1 pink replacement head

If no family preferences have been entered then the message NO STARTER BOXES GENERATED should be displayed.

Refills

As a Beam Shipping Manager
In order to ship perks
I want to fill refill boxes

A family should receive refill boxes with a replacement brush head in each member's preferred color. A refill box can contain a maximum of 4 replacement heads. When the shipping manager presses the refill boxes button, then a number of refill boxes are output. Using the brush preferences example above, box output will be generated in the following format:

REFILL BOX
2 blue replacement heads
2 green replacement heads

REFILL BOX
1 pink replacement head

If no starter boxes have been generated, then the message PLEASE GENERATE STARTER BOXES FIRST should be displayed.

Scheduling

As a Beam Shipping Manager
In order to ship perks
I want to schedule boxes for shipping

Members should receive perks throughout the length of their contract (1 year). The shipping date is based on the contract effective date of the primary insured family member. Starter boxes should be scheduled on the contract effective date. Refills are scheduled every 90 days after that for the remainder of the year. When boxes are generated then each box should have a line appended with its scheduled ship date(s).

Example for a starter box:

STARTER BOX
2 green brushes
2 green replacement head
Schedule: 2018-01-01

Example for a refill box:

REFILL BOX
1 pink replacement head
Schedule: 2018-04-01, 2018-06-30, 2018-09-28, 2018-12-27

Mail Class

As a Beam shipping manager
In order to save money on shipping
I want to determine mail class

In order to manage shipping costs and to deliver perks quickly we want to determine the mail class of boxes. Mail class is based on the weight of the box. Boxes that weigh 16oz or more have a class of "priority". Boxes that weigh less than 16oz have a mail class of "first". Weight is calculated as such: 1 brush weighs 9oz, and 1 replacement head weighs 1oz. When boxes are generated, then each box should have a line appended with its mail class.

Example for a starter box:

STARTER BOX
2 green brushes
2 green replacement head
Schedule: 2018-01-01
Mail class: priority

Example for a refill box:

REFILL BOX
1 pink replacement head
Schedule: 2018-04-01, 2018-06-30, 2018-09-28, 2018-12-27
Mail class: first

Paste Kits

As a Beam shipping manager
In order to ship paste kits
I want to add paste kits to the boxes

For each brush or replacement head that is shipped a paste kit is also shipped which contains toothpaste and floss. A paste kit weighs 7.6 oz which will impact on the mail class choice.

Example for a starter box:

STARTER BOX
1 pink brush
1 pink replacement head
1 paste kit
Schedule: 2018-01-01
Mail class: priority

Example for a refill box:

REFILL BOX
1 pink replacement head
1 paste kit
Schedule: 2018-04-01, 2018-06-30, 2018-09-28, 2018-12-27
Mail class: first