Iflux POC APP is an academic node.js REST service that implements the Iflux specs

Our team (Nicolas & Lukas) decided to build the project with LoopBack which is a totalty RESTful API framework on the top of express.

To run our projet, you need

• Nodes.js
• npm Package manager
• Strongloop
• A MongoDB database
• Projet source: git clone git://github.com/kretinus/Teaching-HEIGVD-CM_WEBS-2016-Project.git
• Feel free to use our MongoDB dump https://github.com/kretinus/Teaching-HEIGVD-CM_WEBS-2016-Project/blob/master/mongodump-iflux_Nicolas_Lukas.tar.gz

• Install StrongLoop $ npm install -g strongloop This will install the LoopBack framework, the slc command-line and various tools such as Yeoman and Grunt*
• To start a new projet use $ slc loopback
• We will need the MongoDB connector, please note that a compiler is require to produce bson $ npm install loopback-connector-mongodb –save
• Configure MongoDB as datasource, use the loopback datasource generator that will write the settings in /server/datasources.json for you $ slc loopback:datasource DB_name
• To run the app just hit $ slc run or $ node . if everthing went fine you should get this Browse your REST API at http://0.0.0.0:3000/explorer Web server listening at: http://0.0.0.0:3000/

Here you'll see how to perform several queries.

• Get the list of issues raised by a particular user.

http://127.0.0.1:3000/api/Citizens/{id}/issues

• Get the list of issues of a certain type.

http://127.0.0.1:3000/api/Issues?filter[where][categoryId]={categoryId}

• Get the list of issues in a particular region.

http://127.0.0.1:3000/api/issues?filter[where][geoInfo][near]=lat,lng&filter[limit]=5 Use the limit filter to retrieve only the 5 first results

• Get the list of issues solved between two dates.

http://127.0.0.1:3000/api/Issues?filter[where][date][between][0]=YYYY-MM-DDT00:00:00.000Z&filter[where][date][between][1]=YYYY-MM-DD&filter[where][status]=solved

• Get the list of issues created between two dates that are still unresolved.

http://127.0.0.1:3000/api/Issues?filter[where][date][between][0]=1999-01-01T00:00:00.000Z&filter[where][date][between][1]=2999-01-01&filter[where][status][neq]=solved

• Get the history of an issue (list of actions taken on the issue).

http://127.0.0.1:3000/api/Actions?filter[where][issueID]=56dd976fb6f267cc49fabd63 Or any other issue ID

• Get the list of users who have created most issues.

http://127.0.0.1:3000/api/Issues/statActive

• Get the list of users who have solved most issues.

http://127.0.0.1:3000/api/Issues/statSolve

• Get the list of users who have the least assigned issues not yet solved or rejected.

http://127.0.0.1:3000/api/Issues/statLeastAssigned

Loopback handle the pagination for standard route, juste use the skip and limit filter

http://127.0.0.1:3000/api/Issues?filter[limit]=10&filter[skip]=0

http://127.0.0.1:3000/api/Issues?filter[limit]=10&filter[skip]=10

http://127.0.0.1:3000/api/Issues?filter[limit]=10&filter[skip]=20

For custom route you need to add the skip and limit filter directly in the controller, like for issue.js

{$skip: 0}, {$limit: 3}