Merge pull request #5 from City-of-Helsinki/release/0.1.0

Release/0.1.0

Author: quyenlq

.gitlab-ci.yml

@@ -42,3 +42,27 @@ staging:
     K8S_SECRET_DEFAULT_FROM_EMAIL: "no-reply@hel.ninja"
     K8S_SECRET_SENTRY_DSN: "$GL_SENTRY_DNS"
     K8S_SECRET_SENTRY_ENVIRONMENT: "test"
+    K8S_SECRET_QURIIRI_API_KEY: "$GL_QURIIRI_API_KEY"
+    K8S_SECRET_QURIIRI_API_URL: "$GL_QURIIRI_API_URL"
+production:
+  # It is highly discouraged to define own triggering rules in production. Don't do it.
+  # only:
+  #   refs:
+  #     - master
+  # These variables are available only for production env and are merged with the general variables defined above
+  variables:
+    K8S_SECRET_ALLOWED_HOSTS: "*"
+    K8S_SECRET_CORS_ORIGIN_ALLOW_ALL: 1
+    K8S_SECRET_SECRET_KEY: "$GL_PRODUCTION_DJANGO_SECRET_KEY"
+    K8S_SECRET_SKIP_DATABASE_CHECK: 1
+    K8S_SECRET_TOKEN_AUTH_AUTHSERVER_URL: "https://api.hel.fi/sso/openid"
+    K8S_SECRET_ILMOITIN_QUEUE_NOTIFICATIONS: 1
+    K8S_SECRET_MAIL_MAILGUN_KEY: "$SECRET_MAILGUN_API_KEY"
+    K8S_SECRET_MAIL_MAILGUN_DOMAIN: "mail.hel.ninja"
+    K8S_SECRET_MAIL_MAILGUN_API: "https://api.eu.mailgun.net/v3"
+    K8S_SECRET_MAILER_EMAIL_BACKEND: "anymail.backends.mailgun.EmailBackend"
+    K8S_SECRET_DEFAULT_FROM_EMAIL: "no-reply@hel.ninja"
+    K8S_SECRET_SENTRY_DSN: "$GL_SENTRY_DNS"
+    K8S_SECRET_SENTRY_ENVIRONMENT: "production"
+    K8S_SECRET_QURIIRI_API_KEY: "$GL_QURIIRI_API_KEY"
+    K8S_SECRET_QURIIRI_API_URL: "$GL_QURIIRI_API_URL"

.prod/uwsgi.ini

@@ -1,7 +1,7 @@
 [uwsgi]
 http-socket = :8000
 chdir = /app
-module = palvelutarjotin.wsgi
+module = notification_service.wsgi
 static-map = /static=/var/static
 static-map = /media=/app/var/media
 uid = appuser

CHANGELOG.md

@@ -0,0 +1,15 @@
+<!-- REMINDER: While updating changelog, also remember to update
+the version in notification_service/__init.py__ -->
+
+## [0.1.0] - 5 Oct 2020
+### Added
+
+- Notification REST API:
+    - Add API token authentication
+    - Add API to send SMS to phone numbers
+    - Add delivery log endpoint to receive delivery report from webhook
+    - Add API to query delivery report by message UUID
+
+[Unreleased]: https://github.com/City-of-Helsinki/notificartion-service/compare/release-v0.1.0...HEAD
+[0.1.0]: https://github.com/City-of-Helsinki/notification-service/releases/tag/release-v0.1.0
+

api/admin.py

@@ -1,3 +1,4 @@
-# from django.contrib import admin
+from api.models import DeliveryLog
+from django.contrib import admin
 
-# Register your models here.
+admin.site.register(DeliveryLog)

api/apps.py

@@ -3,3 +3,6 @@
 
 class ApiConfig(AppConfig):
     name = "api"
+
+    def ready(self):
+        import api.signals  # noqa

api/const.py

@@ -0,0 +1 @@
+NOTIFICATION_TYPE_MOBILE = "mobile"

api/factories.py

@@ -0,0 +1,11 @@
+import factory
+from api.models import DeliveryLog
+from users.factories import UserFactory
+
+
+class DeliveryLogFactory(factory.django.DjangoModelFactory):
+    report = factory.Faker("pystr", max_chars=255)
+    user = factory.SubFactory(UserFactory)
+
+    class Meta:
+        model = DeliveryLog

api/migrations/0001_initial.py

@@ -0,0 +1,63 @@
+# Generated by Django 2.2.13 on 2020-07-27 13:18
+
+import uuid
+
+import django.contrib.postgres.fields.jsonb
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="DeliveryLog",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="UUID",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(auto_now_add=True, verbose_name="created at"),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(auto_now=True, verbose_name="updated_at"),
+                ),
+                (
+                    "report",
+                    django.contrib.postgres.fields.jsonb.JSONField(
+                        blank=True, null=True, verbose_name="report"
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="delivery_logs",
+                        to=settings.AUTH_USER_MODEL,
+                        verbose_name="user",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "delivery log",
+                "verbose_name_plural": "delivery logs",
+                "ordering": ["-updated_at"],
+            },
+        ),
+    ]

api/models.py

@@ -1,3 +1,39 @@
-# from django.db import models
-
 # Create your models here.
+from copy import deepcopy
+
+from common.models import TimestampedModel, UUIDPrimaryKeyModel
+from django.contrib.postgres.fields import JSONField
+from django.db import models
+from django.utils.translation import ugettext_lazy as _
+
+
+class DeliveryLog(UUIDPrimaryKeyModel, TimestampedModel):
+    user = models.ForeignKey(
+        "users.User",
+        related_name="delivery_logs",
+        on_delete=models.CASCADE,
+        verbose_name=_("user"),
+    )
+    report = JSONField(verbose_name=_("report"), blank=True, null=True)
+
+    class Meta:
+        verbose_name = _("delivery log")
+        verbose_name_plural = _("delivery logs")
+        ordering = ["-updated_at"]
+
+    def update_report(self, report_data):
+        """
+        Update delivery of single message base on json data sent from Quriiri to
+        our service
+        :param report_data: JSON
+        :return:
+        """
+        report = self.report
+        updated_messages = deepcopy(report["messages"])
+        destination = report_data["destination"]
+        for k, v in report["messages"].items():
+            if k == destination or v["converted"] == destination:
+                updated_messages[k] = report_data
+        report["messages"] = updated_messages
+        self.report = report
+        self.save()

api/serializers.py

@@ -0,0 +1,10 @@
+from api.models import DeliveryLog
+from rest_framework import serializers
+
+
+class DeliveryLogSerializer(serializers.ModelSerializer):
+    report = serializers.JSONField()
+
+    class Meta:
+        model = DeliveryLog
+        fields = ("id", "report")