Merge pull request #29 from daniviga/dps

Rename API to DPS and othe rimprovements

README.md

@@ -13,6 +13,8 @@ This project is for educational purposes only. It does not implement any
 authentication and/or encryption protocol, so it is not suitable for real
 production.
 
+![Application Schema](./docs/application_chart.png)
+
 ## Installation
 
 ### Requirements

arduino/tempLightSensor/tempLightSensor.ino

@@ -55,7 +55,7 @@ struct netConfig {
 } config;
 
 char serial[9];
-const String apiURL = "/api/device/subscribe/";
+const String dpsURL = "/dps/device/subscribe/";
 const String telemetryURL = "/telemetry/";
 
 void setup(void) {
@@ -63,7 +63,7 @@ void setup(void) {
 
   analogReference(EXTERNAL);
 
-  StaticJsonDocument<20> api;
+  StaticJsonDocument<20> dps;
 
   byte mac[6];
   int eeAddress = 0;
@@ -110,8 +110,8 @@ void setup(void) {
   Serial.println("DEBUG: clock updated via NTP.");
 #endif
 
-  api["serial"] = serial;
-  postData(config, apiURL, api);
+  dps["serial"] = serial;
+  postData(config, dpsURL, dps);
 
   telemetry["device"] = serial;
   // payload["id"] = serverName;

bite/bite/local_settings.py.sample

@@ -0,0 +1,20 @@
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'bite',
+        'USER': 'bite',
+        'PASSWORD': 'password',
+        'HOST': 'localhost',
+        'PORT': '5432',
+    }
+}
+
+MQTT_BROKER = {
+    'HOST': 'localhost',
+    'PORT': '1883',
+}
+
+KAFKA_BROKER = {
+    'HOST': 'localhost',
+    'PORT': '29092',
+}

bite/bite/settings.py

@@ -61,7 +61,7 @@ INSTALLED_APPS = [
     # 'health_check.storage',
     'rest_framework',
     'bite',
-    'api',
+    'dps',
     'telemetry',
 ]
 
@@ -167,11 +167,12 @@ KAFKA_BROKER = {
     'PORT': '9092',
 }
 
-# If no local_settings.py is availble in the current folder let's try to
-# load it from the application root
+try:
+    from bite.local_settings import *
+except ImportError:
+    pass
+
 try:
     from bite.production import *
 except ImportError:
-    # If a local_setting.py does not exist
-    # settings in this file only will be used
     pass

bite/bite/urls.py

@@ -37,13 +37,13 @@ from django.contrib import admin
 from django.conf import settings
 from django.urls import include, path
 
-from api import urls as api_urls
+from dps import urls as dps_urls
 from telemetry import urls as telemetry_urls
 
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('ht/', include('health_check.urls')),
-    path('api/', include(api_urls)),
+    path('dps/', include(dps_urls)),
     path('telemetry/', include(telemetry_urls)),
 ]
 

bite/dps/admin.py

@@ -18,7 +18,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from django.contrib import admin
-from api.models import Device, WhiteList
+from dps.models import Device, WhiteList
 
 
 @admin.register(Device)

bite/dps/apps.py

@@ -20,5 +20,5 @@
 from django.apps import AppConfig
 
 
-class ApiConfig(AppConfig):
-    name = 'api'
+class DPSConfig(AppConfig):
+    name = 'dps'

bite/dps/migrations/0001_initial.py

@@ -1,6 +1,6 @@
 # Generated by Django 3.1.3 on 2021-03-19 08:08
 
-import api.models
+import dps.models
 from django.db import migrations, models
 import uuid
 
@@ -16,7 +16,7 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='Device',
             fields=[
-                ('serial', models.CharField(max_length=128, unique=True, validators=[api.models.device_validation])),
+                ('serial', models.CharField(max_length=128, unique=True, validators=[dps.models.device_validation])),
                 ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
                 ('creation_time', models.DateTimeField(auto_now_add=True)),
                 ('updated_time', models.DateTimeField(auto_now=True)),

bite/dps/serializers.py

@@ -18,7 +18,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from rest_framework import serializers
-from api.models import Device, device_validation
+from dps.models import Device, device_validation
 
 
 class DeviceSerializer(serializers.ModelSerializer):

bite/dps/tests.py

@@ -18,10 +18,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from django.test import TestCase, Client
-from api.models import Device, WhiteList
+from dps.models import Device, WhiteList
 
 
-class ApiTestCase(TestCase):
+class DPSTestCase(TestCase):
     c = Client()
 
     def setUp(self):
@@ -29,17 +29,17 @@ class ApiTestCase(TestCase):
         Device.objects.create(serial='test1234')
 
     def test_no_whitelist(self):
-        response = self.c.post('/api/device/subscribe/',
+        response = self.c.post('/dps/device/provision/',
                                {'serial': 'test12345'})
         self.assertEqual(response.status_code, 400)
 
-    def test_subscribe_post(self):
+    def test_provision_post(self):
         WhiteList.objects.create(serial='test12345')
-        response = self.c.post('/api/device/subscribe/',
+        response = self.c.post('/dps/device/provision/',
                                {'serial': 'test12345'})
         self.assertEqual(response.status_code, 201)
 
-    def test_subscribe_get(self):
-        response = self.c.get('/api/device/list/')
+    def test_provision_get(self):
+        response = self.c.get('/dps/device/list/')
         self.assertEqual(
             response.json()[0]['serial'], 'test1234')

bite/dps/urls.py

@@ -33,13 +33,13 @@ Including another URLconf
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.urls import path
-from api.views import APISubscribe
+from dps.views import DPS
 
 urlpatterns = [
-    path('device/subscribe/',
-         APISubscribe.as_view({'post': 'create'}),
-         name='device-subscribe'),
+    path('device/provision/',
+         DPS.as_view({'post': 'create'}),
+         name='device-provision'),
     path('device/list/',
-         APISubscribe.as_view({'get': 'list'}),
+         DPS.as_view({'get': 'list'}),
          name='device-list'),
 ]

bite/dps/views.py

@@ -19,10 +19,10 @@
 
 from rest_framework.viewsets import ModelViewSet
 
-from api.models import Device
-from api.serializers import DeviceSerializer
+from dps.models import Device
+from dps.serializers import DeviceSerializer
 
 
-class APISubscribe(ModelViewSet):
+class DPS(ModelViewSet):
     queryset = Device.objects.all()
     serializer_class = DeviceSerializer

bite/telemetry/management/commands/dispatcher.py

@@ -31,7 +31,7 @@ from django.conf import settings
 from django.core.management.base import BaseCommand
 from django.core.exceptions import ObjectDoesNotExist
 
-from api.models import Device
+from dps.models import Device
 
 
 class Command(BaseCommand):

bite/telemetry/management/commands/handler.py

@@ -26,7 +26,7 @@ from django.conf import settings
 from django.core.management.base import BaseCommand
 from django.core.exceptions import ObjectDoesNotExist
 
-from api.models import Device
+from dps.models import Device
 from telemetry.models import Telemetry
 
 

bite/telemetry/migrations/0001_initial.py

@@ -11,7 +11,7 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        ('api', '0001_initial'),
+        ('dps', '0001_initial'),
     ]
 
     operations = [
@@ -23,7 +23,7 @@ class Migration(migrations.Migration):
                 ('transport', models.CharField(choices=[('http', 'http'), ('mqtt', 'mqtt')], default='http', max_length=4)),
                 ('clock', models.IntegerField(null=True, validators=[django.core.validators.MinValueValidator(0)])),
                 ('payload', models.JSONField(validators=[telemetry.models.telemetry_validation])),
-                ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.device')),
+                ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dps.device')),
             ],
             options={
                 'verbose_name_plural': 'Telemetry',

bite/telemetry/models.py

@@ -21,7 +21,7 @@ from django.db import models
 from django.core.validators import MinValueValidator
 from django.core.exceptions import ValidationError
 
-from api.models import Device
+from dps.models import Device
 
 
 def telemetry_validation(value):

bite/telemetry/serializers.py

@@ -18,7 +18,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from rest_framework import serializers
-from api.models import Device
+from dps.models import Device
 from telemetry.models import Telemetry
 
 

bite/telemetry/tests.py

@@ -19,7 +19,7 @@
 
 import json
 from django.test import TestCase, Client
-from api.models import Device, WhiteList
+from dps.models import Device, WhiteList
 
 
 class ApiTestCase(TestCase):

docker/docker-compose.dev.yml

@@ -37,8 +37,11 @@ services:
         - "${CUSTOM_DOCKER_IP:-0.0.0.0}:8000:8000"
 
   kafka:
+    environment:
+      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092,PLAINTEXT_HOST://localhost:29092
+      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
     ports:
-        - "${CUSTOM_DOCKER_IP:-0.0.0.0}:9092:9092"
+        - "${CUSTOM_DOCKER_IP:-0.0.0.0}:29092:29092"
 
   data-migration:
     volumes:

docker/docker-compose.yml

@@ -69,8 +69,6 @@ services:
     environment:
       ZOOKEEPER_CLIENT_PORT: 2181
       ZOOKEEPER_TICK_TIME: 2000
-    ports:
-      - 22181:2181
 
   kafka:
     image: confluentinc/cp-kafka:latest
@@ -81,8 +79,8 @@ services:
     environment:
       KAFKA_BROKER_ID: 1
       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
-      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092,PLAINTEXT_HOST://localhost:29092
-      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
+      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092
+      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT
       KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
       KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
 

docker/simulator/device_simulator.py

@@ -114,7 +114,7 @@ def main():
     )
     args = parser.parse_args()
 
-    subscribe = "/api/device/subscribe/"
+    dps = "/dps/device/provision/"
     telemetry = "/telemetry/"
 
     if args.serial is None:
@@ -123,7 +123,7 @@ def main():
         )
 
     data = {"serial": args.serial}
-    post_json(args.endpoint, subscribe, data)
+    post_json(args.endpoint, dps, data)
 
     while True:
         data = {

esp32/rssiHall/rssiHall.ino

@@ -55,13 +55,13 @@ struct netConfig {
 } config;
 
 char* serial;
-const String apiURL = "/api/device/subscribe/";
+const String dpsURL = "/dps/device/subscribe/";
 const String telemetryURL = "/telemetry/";
 
 void setup(void) {
   Serial.begin(115200);
 
-  StaticJsonDocument<64> api;
+  StaticJsonDocument<64> dps;
 
   preferences.begin("iot");
   // Get the serial number from flash
@@ -117,8 +117,8 @@ void setup(void) {
   Serial.println("DEBUG: clock updated via NTP.");
 #endif
 
-  api["serial"] = serial;
-  postData(config, apiURL, api);
+  dps["serial"] = serial;
+  postData(config, dpsURL, dps);
 
   telemetry["device"] = serial;
   // payload["id"] = serverName;