add GET /api/aliases/:alias_id/activities endpoint

README.md

@@ -810,6 +810,37 @@ If success, 200 along with the new alias status:
 }
 ```
 
+#### GET /api/aliases/:alias_id/activities
+
+Get activities for a given alias.
+
+Input:
+- `Authentication` header that contains the api key
+- `alias_id`: the alias id, passed in url.
+- `page_id` used in request query (`?page_id=0`). The endpoint returns maximum 20 aliases for each page. `page_id` starts at 0.
+
+Output:
+If success, 200 with the list of activities, for example:
+
+```json
+{
+  "activities": [
+    {
+      "action": "reply",
+      "from": "yes_meo_chat@sl.local",
+      "timestamp": 1580903760,
+      "to": "marketing@example.com"
+    },
+    {
+      "action": "reply",
+      "from": "yes_meo_chat@sl.local",
+      "timestamp": 1580903760,
+      "to": "marketing@example.com"
+    }
+  ]
+}
+```
+
 
 ### Database migration
 

app/api/views/alias.py

@@ -3,6 +3,7 @@ from flask import jsonify, request
 from flask_cors import cross_origin
 
 from app.api.base import api_bp, verify_api_key
+from app.dashboard.views.alias_log import get_alias_log
 from app.dashboard.views.index import get_alias_info, AliasInfo
 from app.extensions import db
 from app.models import GenEmail
@@ -103,3 +104,56 @@ def toggle_alias(alias_id):
     db.session.commit()
 
     return jsonify(enabled=gen_email.enabled), 200
+
+
+@api_bp.route("/aliases/<int:alias_id>/activities")
+@cross_origin()
+@verify_api_key
+def get_alias_activities(alias_id):
+    """
+    Get aliases
+    Input:
+        page_id: in query
+    Output:
+        - activities: list of activity:
+            - from
+            - to
+            - timestamp
+            - action: forward|reply|block
+
+    """
+    user = g.user
+    try:
+        page_id = int(request.args.get("page_id"))
+    except (ValueError, TypeError):
+        return jsonify(error="page_id must be provided in request query"), 400
+
+    gen_email: GenEmail = GenEmail.get(alias_id)
+
+    if gen_email.user_id != user.id:
+        return jsonify(error="Forbidden"), 403
+
+    alias_logs = get_alias_log(gen_email, page_id)
+
+    activities = []
+    for alias_log in alias_logs:
+        activity = {"timestamp": alias_log.when.timestamp}
+        if alias_log.is_reply:
+            activity["from"] = alias_log.alias
+            activity["to"] = alias_log.website_from or alias_log.website_email
+            activity["action"] = "reply"
+        else:
+            activity["to"] = alias_log.alias
+            activity["from"] = alias_log.website_from or alias_log.website_email
+
+            if alias_log.blocked:
+                activity["action"] = "block"
+            else:
+                activity["action"] = "forward"
+
+        activities.append(activity)
+
+    return (
+        jsonify(activities=activities),
+        200,
+    )

tests/api/test_alias.py

@@ -1,8 +1,10 @@
+import json
+
 from flask import url_for
 
 from app.config import EMAIL_DOMAIN, MAX_NB_EMAIL_FREE_PLAN, PAGE_LIMIT
 from app.extensions import db
-from app.models import User, ApiKey, GenEmail
+from app.models import User, ApiKey, GenEmail, ForwardEmail, ForwardEmailLog
 from app.utils import random_word
 
 
@@ -98,3 +100,51 @@ def test_toggle_alias(flask_client):
 
     assert r.status_code == 200
     assert r.json == {"enabled": False}
+
+
+def test_alias_activities(flask_client):
+    user = User.create(
+        email="a@b.c", password="password", name="Test User", activated=True
+    )
+    db.session.commit()
+
+    # create api_key
+    api_key = ApiKey.create(user.id, "for test")
+    db.session.commit()
+
+    gen_email = GenEmail.create_new_random(user.id)
+    db.session.commit()
+
+    # create some alias log
+    forward_email = ForwardEmail.create(
+        website_email="marketing@example.com",
+        reply_email="reply@a.b",
+        gen_email_id=gen_email.id,
+    )
+    db.session.commit()
+
+    for _ in range(int(PAGE_LIMIT / 2)):
+        ForwardEmailLog.create(forward_id=forward_email.id, is_reply=True)
+
+    for _ in range(int(PAGE_LIMIT / 2) + 2):
+        ForwardEmailLog.create(forward_id=forward_email.id, blocked=True)
+
+    r = flask_client.get(
+        url_for("api.get_alias_activities", alias_id=gen_email.id, page_id=0),
+        headers={"Authentication": api_key.code},
+    )
+
+    assert r.status_code == 200
+    assert len(r.json["activities"]) == PAGE_LIMIT
+    for ac in r.json["activities"]:
+        assert ac["action"]
+        assert ac["from"]
+        assert ac["action"]
+        assert ac["action"]
+
+    # second page, should return 1 or 2 results only
+    r = flask_client.get(
+        url_for("api.get_alias_activities", alias_id=gen_email.id, page_id=1),
+        headers={"Authentication": api_key.code},
+    )
+    assert len(r.json["activities"]) < 3