Build rest endpoint to read service stats

- get stats by service id
- returns a list of stats objects

Not paginated - have 1 row per day.

app/__init__.py

@@ -49,6 +49,7 @@ def create_app():
     from app.invite.rest import invite as invite_blueprint
     from app.permission.rest import permission as permission_blueprint
     from app.accept_invite.rest import accept_invite
+    from app.notifications_statistics.rest import notifications_statistics as notifications_statistics_blueprint
 
     application.register_blueprint(service_blueprint, url_prefix='/service')
     application.register_blueprint(user_blueprint, url_prefix='/user')
@@ -59,6 +60,7 @@ def create_app():
     application.register_blueprint(invite_blueprint)
     application.register_blueprint(permission_blueprint, url_prefix='/permission')
     application.register_blueprint(accept_invite, url_prefix='/invite')
+    application.register_blueprint(notifications_statistics_blueprint)
 
     return application
 

app/dao/notifications_dao.py

@@ -1,34 +1,24 @@
 from flask import current_app
 from app import db
-from app.models import Notification, Job, ServiceNotificationStats, TEMPLATE_TYPE_SMS, TEMPLATE_TYPE_EMAIL
+from app.models import Notification, Job, NotificationStatistics, TEMPLATE_TYPE_SMS, TEMPLATE_TYPE_EMAIL
 from sqlalchemy import desc
 from datetime import datetime
 
 
+def dao_get_notification_statistics_for_service(service_id):
+    return NotificationStatistics.query.filter_by(
+        service_id=service_id
+    ).order_by(desc(NotificationStatistics.day)).all()
+
+
 def dao_create_notification(notification, notification_type):
     try:
         if notification.job_id:
             update_job_sent_count(notification)
 
-        day = datetime.utcnow().strftime('%Y-%m-%d')
-
-        if notification_type == TEMPLATE_TYPE_SMS:
-            update = {
-                ServiceNotificationStats.sms_requested: ServiceNotificationStats.sms_requested + 1
-            }
-        else:
-            update = {
-                ServiceNotificationStats.emails_requested: ServiceNotificationStats.emails_requested + 1
-            }
-
-        result = db.session.query(ServiceNotificationStats).filter_by(
-            day=day,
-            service_id=notification.service_id
-        ).update(update)
-
-        if result == 0:
-            stats = ServiceNotificationStats(
-                day=day,
+        if update_notification_stats(notification, notification_type) == 0:
+            stats = NotificationStatistics(
+                day=notification.created_at.strftime('%Y-%m-%d'),
                 service_id=notification.service_id,
                 sms_requested=1 if notification_type == TEMPLATE_TYPE_SMS else 0,
                 emails_requested=1 if notification_type == TEMPLATE_TYPE_EMAIL else 0
@@ -41,6 +31,22 @@ def dao_create_notification(notification, notification_type):
         raise
 
 
+def update_notification_stats(notification, notification_type):
+    if notification_type == TEMPLATE_TYPE_SMS:
+        update = {
+            NotificationStatistics.sms_requested: NotificationStatistics.sms_requested + 1
+        }
+    else:
+        update = {
+            NotificationStatistics.emails_requested: NotificationStatistics.emails_requested + 1
+        }
+
+    return db.session.query(NotificationStatistics).filter_by(
+        day=notification.created_at.strftime('%Y-%m-%d'),
+        service_id=notification.service_id
+    ).update(update)
+
+
 def update_job_sent_count(notification):
     db.session.query(Job).filter_by(
         id=notification.job_id

app/models.py

@@ -107,8 +107,8 @@ class ApiKey(db.Model):
     )
 
 
-class ServiceNotificationStats(db.Model):
-    __tablename__ = 'service_notification_stats'
+class NotificationStatistics(db.Model):
+    __tablename__ = 'notification_statistics'
 
     id = db.Column(db.Integer, primary_key=True)
     day = db.Column(db.String(255), nullable=False)

app/notifications_statistics/rest.py

@@ -0,0 +1,25 @@
+from flask import (
+    Blueprint,
+    jsonify,
+)
+
+from app.dao.notifications_dao import (
+    dao_get_notification_statistics_for_service
+)
+from app.schemas import notifications_statistics_schema
+
+notifications_statistics = Blueprint(
+    'notifications-statistics',
+    __name__, url_prefix='/service/<service_id>/notifications-statistics'
+)
+
+from app.errors import register_errors
+
+register_errors(notifications_statistics)
+
+
+@notifications_statistics.route('', methods=['GET'])
+def get_all_templates_for_service(service_id):
+    templates = dao_get_notification_statistics_for_service(service_id=service_id)
+    data, errors = notifications_statistics_schema.dump(templates, many=True)
+    return jsonify(data=data)

app/schemas.py

@@ -34,19 +34,6 @@ class BaseSchema(ma.ModelSchema):
         assert key is not None, "Envelope key undefined"
         return key
 
-    # Code to envelope the input and response.
-    # TOBE added soon.
-
-    # @pre_load(pass_many=True)
-    # def unwrap_envelope(self, data, many):
-    #     key = self.get_envelope_key(many)
-    #     return data[key]
-
-    # @post_dump(pass_many=True)
-    # def wrap_with_envelope(self, data, many):
-    #     key = self.get_envelope_key(many)
-    #     return {key: data}
-
     @post_load
     def make_instance(self, data):
         """Deserialize data to an instance of the model. Update an existing row
@@ -91,6 +78,11 @@ class TemplateSchema(BaseSchema):
         exclude = ("updated_at", "created_at", "service_id", "jobs")
 
 
+class NotificationsStatisticsSchema(BaseSchema):
+    class Meta:
+        model = models.NotificationStatistics
+
+
 class ApiKeySchema(BaseSchema):
     class Meta:
         model = models.ApiKey
@@ -216,3 +208,4 @@ notification_status_schema = NotificationStatusSchema()
 notification_status_schema_load_json = NotificationStatusSchema(load_json=True)
 invited_user_schema = InvitedUserSchema()
 permission_schema = PermissionSchema()
+notifications_statistics_schema = NotificationsStatisticsSchema()