Chore/setup update api v2

[thepsalmist]

Description

The PR introduces build fixes and dependency upgrades & patches for implementation of authentication for key endpoints prone to bot crawling. The affected endpoints/views in API v1 are data, now and node. The API endpoints in v2 all use Token and Session authentication.

Push sensors data endpoint still remains on v1/push-sensor-data. Note: This would require firmware upgrade

API v1 endpoint	API v2 endpoint
/api/v1/data.	/api/v2/data.
/api/v1/node.	/api/v1/node.
/api/v1/now.	/api/v2/now.
/api/v1/statistics	/api/v1/statistics
api/v1/sensor	/api/v2/sensors

Fixes issues #134, #135, #136

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation

[gideonmaina]

@thepsalmist all v2 endpoints passed but a confusion may arise with v2/nodes vs v1/node. The former registers a node to the database via a POST request while the latter lists nodes owned by an authenticated user. A more descriptive name for the endpoints would solve this. E.g. /add-node or /register-node and /my-nodes

Check out API endpoints list we have on V2 and V1

endpoint	v2 (staging)	v1 (production)
1./data	ok	ok
2. /cities	ok	missing
3. /now	ok	ok
4. /locations	ok	missing
5. /sensors	ok	missing
6. /sensor-types	ok	missing
7. /statistics	ok	ok
8. /nodes	ok	missing
9. /node	missing	ok
10. /user	missing	ok
11. /meta	ok	missing
12. /sensor	missing	ok

The /sensor and /user are not useful in my opinion therefore they can be excluded in v2.

[thepsalmist]

@thepsalmist all v2 endpoints passed but a confusion may arise with v2/nodes vs v1/node. The former registers a node to the database via a POST request while the latter lists nodes owned by an authenticated user. A more descriptive name for the endpoints would solve this. E.g. /add-node or /register-node and /my-nodes

Check out API endpoints list we have on V2 and V1

endpoint v2 (staging) v1 (production)
1./data ok ok
2. /cities ok missing
3. /now ok ok
4. /locations ok missing
5. /sensors ok missing
6. /sensor-types ok missing
7. /statistics ok ok
8. /nodes ok missing
9. /node missing ok
10. /user missing ok
11. /meta ok missing
12. /sensor missing ok
The /sensor and /user are not useful in my opinion therefore they can be excluded in v2.

Thanks @gideonmaina updating as per above

[gideonmaina]

🚨🚨 /v1/push-sensor-data does not allow POST requests @thepsalmist. Also, push_sensor_data_urls router is appended to the endpoint as /v1/push-sensor-data/push-sensor-data

[thepsalmist]

@thepsalmist all v2 endpoints passed but a confusion may arise with v2/nodes vs v1/node. The former registers a node to the database via a POST request while the latter lists nodes owned by an authenticated user. A more descriptive name for the endpoints would solve this. E.g. /add-node or /register-node and /my-nodes
Check out API endpoints list we have on V2 and V1
endpoint v2 (staging) v1 (production)
1./data ok ok
2. /cities ok missing
3. /now ok ok
4. /locations ok missing
5. /sensors ok missing
6. /sensor-types ok missing
7. /statistics ok ok
8. /nodes ok missing
9. /node missing ok
10. /user missing ok
11. /meta ok missing
12. /sensor missing ok
The /sensor and /user are not useful in my opinion therefore they can be excluded in v2.

Thanks @gideonmaina updating as per above

The above issues have been resolved

[thepsalmist]

🚨🚨 /v1/push-sensor-data does not allow POST requests @thepsalmist. Also, push_sensor_data_urls router is appended to the endpoint as /v1/push-sensor-data/push-sensor-data

Resolved

[gideonmaina]

Observations for v2 endpoints:

1. /nodes/list-nodes: this can go just to /nodes
2. sensors/{sensor_id}: still missing. We can implement this later alongside other filtering requests like /nodes/{node_id}

[gideonmaina]

@thepsalmist There is also this v1/sensor/ endpoint that does not make sense. On v2 this not need as we will have /sensors to list all sensors and filter a sensor via /sensors/{sensor_id}

[gideonmaina]

@thepsalmist the endpoints called from the frontend currently are:

v1

1. https://api.sensors.africa/v1/sensors/{sensor_id}/
2. https://api.sensors.africa/v1/filter?city=&country=&type=
3. https://api.sensors.africa/v1/data/
4. https://api.sensors.africa/v1/now/
5. http://api.sensors.africa/v1/sensor/%7BsensorID%7D/

v2

1. v2/cities
2. v2/data/air?city={slug}&
3. v2/nodes
4. v2/data.json
5. v2/data.1h.json
6. v2/data.24h.json
7. v2/data.dust.min.json
8. v2/data.temp.min.json

and this filter https://api.sensors.africa/v2/data/air/?city=${city}&from=${fromDate}&interval=day&value_type=P2

[gideonmaina]

All v2 endpoints are working as expected 🙌🏼.

These observations/ recommendations can be a new issue.

[gideonmaina]

@thepsalmist a .dockerignore file will be necessary for local builds.

[gideonmaina]

Not a priority at the moment though

[gideonmaina]

@thepsalmist let's remove the second pip upgrade attempt && pip install -q -U .as it is already sorted by RUN python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --upgrade pip setuptools

[gideonmaina]

This is Django v >=1.10

[gideonmaina]

@thepsalmist this router will no longer be used. We can delete it.

[gideonmaina]

Let's add that a .env file is needed that refers to .env.template

[gideonmaina]

Ooh this should be under Docker setup

[gideonmaina]

Hey @thepsalmist what is holding us back?