rm-assessment

Microservice to minify and send HTML emails.

Objectives

Implement at least 3 HTML/CSS strategies "by hand"
Simple HTTP server to handle post requests
Save processed emails with the input and output HTML to a database

API Methods

/

GET

Request

GET HTTP/1.1 Host: localhost:3434 Accept: application/json

  Response
  ```json
{
  "status": "success",
  "message": "Hello World!"
}

POST

Request

POST  HTTP/1.1
Host: localhost:3434
Content-Type: application/json
Accept: application/json

{
	"to": "teacher@some.domain",
	"from": "pink@some.domain",
	"subject": "HEY, teacher!",
	"html": "<!doctype html><html><head><title>HEY, teacher!</title><style>.words {font-weight: 900;}</style></head><body><p class=\"words\">Leave them kids alone!</p></body></html>"
}

Response

{
"status": "success",
"message": "Mail sent successfully."
}

Setup and Running

Global Dependencies

npm i -g gulp-cli # Build tool
npm i -g jshint # Javascript linting
npm i -g mocha # Testing framework
npm i -g knex # Database migration tool
# You also need a database adaptor for Bookshelf.js
npm i -g sqlite3 # Test database

Getting Started

Configuration

Modify ./config.js to export a config object to your liking. Customize by environment, utilize environment variables, etc.

The default configuration uses sqlite3 and a mock nodemailer transport.

Setup your database

If your database is properly configured running knex migrate:latest should bring your database up to a usable state. You can read more about knex migrations here.

Start the server or start gulp for development

Start the server: npm start or node app.js

$ npm start Listening on port 3434


  * Start gulp: `npm run dev` or `gulp`.

```bash
$ gulp
[14:59:14] Using gulpfile ~/projects/rebelmail/gulpfile.js
[14:59:14] Starting 'lint'...
[14:59:14] Starting 'watch'...
[14:59:14] Finished 'watch' after 13 ms
[16:51:48] Finished 'lint' after 105 ms
[16:51:48] Starting 'test'...
Using config environment 'test'
Knex:warning - sqlite does not support inserting default values. Set the `useNullAsDefault` flag to hide this warning. (see docs http://knexjs.org/#Builder-insert).


  db
    Mail model
      ✓ can be persisted (46ms)

  mailer
    ✓ can send mail

  minifier
    ✓ removes whitespace
    ✓ combines style tags and places them in <head>
    strategy optimizeClassNames
      ✓ optimizes ids and class names
    strategy removeUnusedClasses
      ✓ removes unused CSS classes from styles and elements
    strategy useShortHex
      ✓ replaces HEX with its shorthand (#FFFFFF => #FFF)

  server
    GET /
      ✓ says hello
    POST /
      ✓ sends email with optimized HTML to recipient (45ms)


  9 passing (132ms)

[16:51:48] Finished 'test' after 247 ms