scozv / bolero Goto Github PK

Bolero recommends an uniform HTTP Response design, that is all HTTP Response will be formatted as:

{
  ok: Boolean,
  data: T
  error: String
}

see

app/controllers/CanResponse.scala
app/models/interop/HTTPResponse.scala

need to add a script:

• download the master-zip
• read a name
• replace all bolero to name
• regenerate playGenerateSecret

Overview

The codes for challenge assignment are written within 3 consecutive day.
Percisely, they are started from Sep 3, 08:47 to Sep 4, 19:46. (see picture below)

The codes written before Sep 3, 08:47
are extracted from my SJTU project of last year
as a RESTful Code Template named Bolero.

Read more about Bolero from my posts:

• Bolero, a RESTful Scaffold with Scala, Play! and ReactiveMongo
• Bolero, Cumulative Update (Sep, 04 2016)

The codes in test/WithApplication.scala are copied from Play! 2.3
in order to make the Specs2 tests of Play! 2.3 even when I upgraded
project to Play! 2.4.

Branches and Deployments

I created 2 solutions for code challenge: liq-v1 and liq-v2.

They are corresponding to the branches (see picture below):

feature/liq-v1
feature/liq-v2

and to the deployments:

liq-v1.cloudapp.net
liq-v2.cloudapp.net

liq-v1 works as expected as the challenage assignment.

I prefer to liq-v2 that has 2 major differents from liq-v1:

• Uniform HTTP Response (see issue #4),
• transaction_id is String not Long (see issue #5)

RESTful API of liq-v2

Transaction model (tx for short) is defined as:

{
  _id: String, amount: Double, type: String, pranrent_id: String
}

GET /transactionservice/transaction

Lists all tx data (generated by activator test).

HTTP Response:

{
  ok: true,
  data: List[Transaction],
  error: ""
}

PUT /transactionservice/transaction/:id

Creates tx.

HTTP Payload data is Transaction.

HTTP Response:

{
  ok: true,
  data: Transaction
  error: ""
}

error Response will be returned when PUT duplicated _id.

GET /transactionservice/transaction/:id

Gets a specific tx data.

HTTP Response:

{
  ok: true,
  data: Transaction,
  error: ""
}

NOT_FOUND Response will be returned if _id is not existed, such as:

{"ok":false,"error":"201","data":"not found record in MongoDB from GET /transactionservice/transaction/1024"}

GET /transactionservice/types/:type

Lists the transaction_id of specific type.
If :type is not existed, empty array will be returned.

HTTP Response:

{
  ok: true,
  data: List[String],
  error: ""
}

GET /transactionservice/sum/:id

Gets the total amount of related tx data.
If :id is not existed, 0 will be returned.

HTTP Response:

{
  ok: true,
  data: Double,
  error: ""
}

Commit Tree

we need the Tests

I prefer to String _id other than Numeric _id, because:

• String _id contains A, B ... that can be used as the categories,
• We can apply RegEx on String _id, especially when we are using MongoDB

ModelOrError[A].map(A => B): ModelOrError[B]
ModelOrError[A].flatMap(A => ModelOrError[B]): ModelOrError[B]

See biz.rules