Revised the climate api to include Django self-documentation

srv/endpoints/climate/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'climate.apps.ClimateConfig'

srv/endpoints/climate/admin.py

@@ -0,0 +1 @@
+# Register your models here.

srv/endpoints/api/apps.py → srv/endpoints/climate/apps.py

@@ -1,6 +1,5 @@
 from django.apps import AppConfig
 
-
-class ApiConfig(AppConfig):
+class ClimateConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
-    name = 'api'
+    name = 'climate'

srv/endpoints/climate/migrations/0001_initial.py

@@ -0,0 +1,27 @@
+# Generated by Django 5.0.6 on 2024-06-02 16:07
+
+import django.db.models.manager
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='TransientModel',
+            fields=[
+                ('id', models.IntegerField(primary_key=True, serialize=False)),
+            ],
+            options={
+                'managed': False,
+            },
+            managers=[
+                ('obj', django.db.models.manager.Manager()),
+            ],
+        ),
+    ]

srv/endpoints/climate/migrations/0002_climatemodel_delete_transientmodel.py

@@ -0,0 +1,42 @@
+# Generated by Django 5.0.6 on 2024-06-05 19:04
+
+import django.db.models.manager
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('climate', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ClimateModel',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('coord', models.JSONField()),
+                ('weather', models.JSONField()),
+                ('base', models.JSONField()),
+                ('main', models.JSONField()),
+                ('visibility', models.JSONField()),
+                ('wind', models.JSONField()),
+                ('rain', models.JSONField()),
+                ('clouds', models.JSONField()),
+                ('dt', models.JSONField()),
+                ('sys', models.JSONField()),
+                ('timezone', models.JSONField()),
+                ('name', models.JSONField()),
+                ('cod', models.JSONField()),
+            ],
+            options={
+                'managed': False,
+            },
+            managers=[
+                ('obj', django.db.models.manager.Manager()),
+            ],
+        ),
+        migrations.DeleteModel(
+            name='TransientModel',
+        ),
+    ]

srv/endpoints/climate/models.py

@@ -0,0 +1,68 @@
+import os
+import requests
+from collections import UserList
+from django.db import models
+from django.core import serializers
+from django.core.cache import caches
+from dotenv import load_dotenv
+
+load_dotenv()
+CACHE = caches["default"]
+
+# This functionality builds on an answer for the following SO question,
+# but not the accepted answer; this one is farther down in the post:
+#
+# https://stackoverflow.com/questions/9091305/django-models-without-database
+
+class ClimateModelManager(models.Manager):
+
+    api = os.getenv("OPENWEATHER_API")
+    lat = os.getenv("OPENWEATHER_LAT")
+    lon = os.getenv("OPENWEATHER_LON")
+
+    cache_key = "cached-transient-models"
+    cache_sentinel = object()
+    cache_timeout = 600
+
+    def get_queryset(self):
+        climate_model_data = CACHE.get(self.cache_key, self.cache_sentinel)
+        if climate_model_data is self.cache_sentinel:
+            response = requests.get(
+                 f"https://api.openweathermap.org/data/2.5/weather?lat={self.lat}&lon={self.lon}&appid={self.api}"
+            )
+            response.raise_for_status()
+            climate_model_data = response.json()
+            CACHE.set(self.cache_key, climate_model_data, self.cache_timeout)
+        return ClimateModelQueryset(
+            [ClimateModel(**climate_model_data)]
+        )
+
+class ClimateModelQueryset(UserList):
+    pass
+
+class ClimateModel(models.Model):
+    class Meta:
+        managed = False
+
+    obj = ClimateModelManager.from_queryset(ClimateModelQueryset)()
+
+    coord = models.JSONField()
+    weather = models.JSONField()
+    base = models.JSONField()
+    main = models.JSONField()
+    visibility = models.JSONField()
+    wind = models.JSONField()
+    rain = models.JSONField()
+    clouds = models.JSONField()
+    dt = models.JSONField()
+    sys = models.JSONField()
+    timezone = models.JSONField()
+    name = models.JSONField()
+    cod = models.JSONField()
+
+    def as_dict(self):
+        result = {}
+        fields = self._meta.fields
+        for field in fields:
+            result[field.name] = getattr(self, field.name)
+        return result

srv/endpoints/climate/serializers.py

@@ -0,0 +1,9 @@
+from rest_framework import serializers
+from climate.models import ClimateModel
+
+class ClimateModelSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = ClimateModel
+        fields = "__all__"
+

srv/endpoints/climate/static/climate/swagger-ui/index.css

@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}

srv/endpoints/climate/static/climate/swagger-ui/index.html

@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="index.css" />
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>

srv/endpoints/climate/static/climate/swagger-ui/oauth2-redirect.html

@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1).replace('?', '&');
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>

srv/endpoints/climate/static/climate/swagger-ui/swagger-initializer.js

@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "https://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};

srv/endpoints/climate/tests.py

@@ -0,0 +1 @@
+# Create your tests here.

srv/endpoints/climate/urls.py

@@ -0,0 +1,6 @@
+from django.urls import re_path, path
+from .views import ClimateDataViewAll
+
+urlpatterns = [
+    path('', ClimateDataViewAll.as_view(), name='climate-all'),
+]

srv/endpoints/climate/utils.py

@@ -0,0 +1,7 @@
+from drf_yasg.inspectors import SwaggerAutoSchema
+
+class CustomAutoSchema(SwaggerAutoSchema):
+    def get_operation(self, operation_keys):
+        operation = super().get_operation(operation_keys)
+        # Customize the operation object as needed here
+        return operation

srv/endpoints/climate/views.py

@@ -0,0 +1,27 @@
+import json
+
+from rest_framework.generics import ListAPIView, RetrieveAPIView
+from rest_framework.exceptions import APIException
+from rest_framework.response import Response
+from django.http import HttpResponse
+from django.core import serializers
+from rest_framework.permissions import AllowAny
+
+from climate.models import ClimateModel
+from climate.serializers import ClimateModelSerializer
+
+class ClimateDataViewAll(RetrieveAPIView):
+
+    permission_classes = [AllowAny]
+    serializer_class = ClimateModelSerializer
+
+    def get_queryset(self):
+        try:
+            queryset = ClimateModel.obj.all()
+            return queryset
+        except Exception as e:
+            raise APIException(e) from e
+
+    def get(self, request):
+        fields = [obj.as_dict() for obj in self.get_queryset()][-1]
+        return HttpResponse(json.dumps(fields), content_type = "application/json")

srv/endpoints/core/asgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings')
+
+application = get_asgi_application()