Perfilometer - Server

Perfilometer Server is a NodeJS server to insert and get roads with perfilometer metrics.

1. Dependencies

Required

• MongoDB
• Node ~v6.10.2
• Yarn or NPM

Optional

• Robomongo
• PostMan

2. Managing Dependencies

For all instructions, use one of options. (NPM or Yarn)

To install all node dependencies, execute the command:

$ yarn install

$ npm install

To install all production node dependencies, execute the command:

$ yarn install --prod

$ npm install --prod

3. Environment Configurations

The environment configurations are managed by the file server/config.json.

The file is not tracked by the git because contains sensitive informations. There is a template named server/config.json.template that can be used as reference. Remember that is highly recommend that the JWT_SECRET is randomly used and diferent in each environment.

You can generate the secret the way you want or simple execute the script that uses the package crypto-extra to generate a random string of length 64:

$ yarn generate:secret

$ npm run generate:secret

4. Running Server

To run the server, execute the command:

$ yarn start

$ npm run start

In development is recommend to use the command below that restart the server automatically when changes in the source code happens:

$ yarn autostart

$ npm run autostart

After the server start, access the url http://localhost:3000/

4. Server on Heroku

The main server is available on Heroku Apps - https://perfilometer-node.herokuapp.com/

a. Get all roads:

Route to get medition historic of all roads.

• Path: /api/roads/
• Type: GET
• Headers: api-version: 0.1.0
• Response:

{
    "api": {
        "version": "0.1.0"
    },
    "data": {
        "roads": [
            {
                "identifier": "0s2j01db2buf4fjn", 
                "name": "Road 1",
                "lasers": [
                    [0, 1, 0, 0, 0],
                    [0, 1, 0, 0, 0],
                    [0, 1, 0, 0, 0],
                    [0, 2, 0, -1, 0],
                    [0, 1, 0, 0, 0]
                ],
                "locations": [
                    {
                        "latitude": 12.12131412,
                        "longitude": 13.1213131
                    },
                    {
                        "latitude": 12.12131412,
                        "longitude": 13.1213132
                    },
                    {
                        "latitude": 12.12131413,
                        "longitude": 13.1213133
                    }
                ],
                "date": "2019-07-04T05:27:47+00:00"
            },
            {
                "identifier": "1d0129jd018h0121k2",
                "name": "Road 2",
                "lasers": [
                    [0, 1, 1, 0, 2],
                    [0, 1, 0, 0, 0],
                    [1, 3, 0, -1, 0],
                    [0, 2, 0, -1, 0],
                    [0, 1, 0, 0, 0]
                ],
                "locations": [
                    {
                        "latitude": 12.12131412,
                        "longitude": 13.1213131
                    },
                    {
                        "latitude": 12.12131412,
                        "longitude": 13.1213132
                    },
                    {
                        "latitude": 12.12131413,
                        "longitude": 13.1213133
                    }
                ],
                "date": "2019-07-04T05:27:47+00:00"
            }
        ]
    }
}

b. Get one specific road:

Route to get medition of one specific road.

• Path: /api/roads/:id
• Type: GET
• Headers: api-version: 0.1.0
• Query: identifier of road. Example: 1d0129jd018h0121k2
• Response:

{
    "api": {
        "version": "0.1.0"
    },
    "data": {
        "road": {
            "identifier": "1d0129jd018h0121k2",
            "name": "Road 1",
            "lasers": [ 
                [0, 1, 1, 0, 2],
                [0, 1, 0, 0, 0],
                [1, 3, 0, -1, 0],
                [0, 2, 0, -1, 0],
                [0, 1, 0, 0, 0]
            ],
            "locations": [
                {
                    "latitude": 12.12131412,
                    "longitude": 13.1213131
                },
                {
                    "latitude": 12.12131412,
                    "longitude": 13.1213132
                },
                {
                    "latitude": 12.12131413,
                    "longitude": 13.1213133
                }
            ],
            "date": "2019-07-04T05:27:47+00:00"
        }
    }
}

c. Add new road:

Route to add new medition of one road.

• Path: /api/roads/
• Type: POST
• Headers: api-version: 0.1.0
• Request:

{
    "lasers": [
        [0, 1, 1, 0, 2],
        [0, 1, 0, 0, 0],
        [1, 3, 0, -1, 0],
        [0, 2, 0, -1, 0],
        [0, 1, 0, 0, 0]
    ],
    "locations": [
        {
            "latitude": 12.12131412,
            "longitude": 13.1213131
        },
        {
            "latitude": 12.12131412,
            "longitude": 13.1213132
        },
        {
            "latitude": 12.12131413,
            "longitude": 13.1213133
        }
    ],
}

• Response:

{
    "api": {
        "version": "0.1.0"
    },
    "data": {
        "road": "d091jd012nd01290219d"
    }
}