README.md

Basis

Gritty has a toybox. Inside of this toybox are Gritty's devices. This Node.js server contains 2 API interfaces for Gritty to access his toys.

Dependencies

1. Install Node.js
2. Startup and Testing scripts will automatically install these Node.js modules using Node Package Manager (npm): Express, jest

How to run

1. Using Windows run winStartup.bat
2. Access getById API by calling localhost\devices\getById\{id}
3. Access getByType API by calling localhost\devices\getByType\{type}
4. Run winTests.bat to run unit tests

TODOs and assumptions

1. Add Unit/Linux bash scripts
2. Implement security
3. Add better Async support [Not necessary with current implementation, but will be necessary as this evolves]
4. The API implies the id property is unique.
5. Implement caching of devices.json (need to determine how CRUD ops will work for this file)
6. Implement hashed lookup byId and byType (returning an object and array, respectively)
7. (alternative to 3 above, providing a more robust lookup interface) Create a function similar to filter which would normalize the Modules data automatically before returning data. I think this would lead to better abstraction and could be used in conjunction with tasks 2 and 3.
8. Improve devices.js encapsulation using Javascript prototypes and singleton approach
9. Add API (URL) tests

Challenge

Wanna join the bestest most amazingest team at DICE? WHO DOESN'T?! Gotta do this challenge first tho.

Using Node.js complete the tasks below. Use any module you deem necessary. You will totally maybe be judged on your use of tabs v spaces or spaces v tabs. Once completed, please push it to your personal Github account. You totally wanna update your README jawn, just in case there are special instructions to git'er going.

Gritty always knows which editor you're using. You've been warned. :w :q :q

xoxo May The Grit Be With You

Tasks

1. Build an API with the following two routes
   • GET route: Get a single device based on id. The data is structured such that a device can have an associated module. The modules array will contain an object of id and type if a device has such a module. When returning the parent device, modules should be an object with a key being the module type and the value the modules object. Example below.
   • GET route: Get all devices based on type, again updating device configurations with the appropriate module object, if present.
2. Bonus Level: Write some tests for your API, even one would be nice to see, but not required.

Device json example

Raw json for a device:

{
	"id": "ABCXXX",
	"location": {
		"building": "Main",
		"campus": "Methodist",
		"floor": "3",
		"hospital": "Thomas Jefferson University Hospital",
		"room": "123",
		"unit": "Fake Unit"
	},
	"modules": [{
		"type": "nacelle",
		"id": "ABCYYY"
	}],
	"type": "warpdrive"
}

Combined device object

{
	"id": "ABCXXX",
	"location": {
		"building": "Main",
		"campus": "Methodist",
		"floor": "3",
		"hospital": "Thomas Jefferson University Hospital",
		"room": "123",
		"unit": "Fake Unit"
	},
	"modules": {
		"nacelle": {
			"location": {
				"unit": "Fake Unit",
				"floor": "3",
				"hospital": "Methodist Hospital",
				"campus": "Methodist",
				"building": "Main",
				"room": "123"
			},
			"lastHeartbeat": "2019-02-26T20:12:50.240Z",
			"id": "ABCYYY",
			"deviceMeta": {
				"temperature": 54.23,
				"git_describe": "1.0.0"
			},
			"lastUpdate": "2019-02-26T20:12:50.240Z",
			"type": "nacelle"
		}
	},
	"type": "warpdrive"
}