flyvictor / fortune-client Goto Github PK

We have some support for custom actions in our version of Fortune. However, we don't have a way to call these from a Fortune Client yet.

Support a fluent interface on fortune client, that allows us to, for example query with:

fortuneClient.users.get({ name : "Craig" }).fields(["name", "id"]).sort({ name : -1 }).page(1).pageSize(10)

Or maybe

fortuneClient.getUsers({ name : "Craig" }).fields(["name", "id"]).sort({ name : -1 }).page(1).pageSize(10)

Should we keep the existing interface too?

The fortune API returns linked resources in a seperate array, to remove duplication, minimising the data transferred on the wire.

I.e. Given the example https://github.com/flyvictor/fortune/blob/master/examples/relationships.js, a GET /users?include=addresses request would get a response like:

{ "users" : [{ "name" : "craig", links : { "addresses" : [ "1"] } }]
  "linked" : {
    "addresses" : [ { id : "1" ... } ]
  }
}

This normalised form is great for transfer, but more difficult for a client app to process.

Fortune client should make this easier for client apps by de-normalising the data before providing it to the client app.

The current implementation is not recursive. We should add a new one (but keep the old one for backwards compatability).