initial rundown show/template api

apps/archive/archive.py

@@ -58,7 +58,7 @@
     transtype_metadata,
 )
 from superdesk.media.crop import CropService
-from flask import current_app as app, json
+from flask import current_app as app, json, request
 from superdesk import get_resource_service
 from superdesk.errors import SuperdeskApiError
 from eve.versioning import resolve_document_version, versioned_id_field
@@ -116,6 +116,17 @@ def private_content_filter():
     Also filter out content of stages not visible to current user (if any).
     """
     user = getattr(flask.g, "user", None)
+    query = {
+        "bool": {
+            "must": [
+                {"exists": {"field": "task.desk"}},
+            ],
+            "must_not": [
+                {"term": {"state": "draft"}},
+            ],
+        },
+    }
+
     if user:
         private_filter = {
             "should": [
@@ -155,7 +166,7 @@ def private_content_filter():
                 {"terms": {"task.desk": [str(d["_id"]) for d in desks]}},
             )
 
-        return {
+        query = {
             "bool": {
                 "should": [
                     {"bool": private_filter},
@@ -164,13 +175,12 @@ def private_content_filter():
                 "minimum_should_match": 1,
             },
         }
-    else:  # no user specific filtering, filter out private content
-        return {
-            "bool": {
-                "must": {"exists": {"field": "task.desk"}},
-                "must_not": {"term": {"state": "draft"}},
-            },
-        }
+
+    if request is not None and request.args.get("scope"):
+        query["bool"].setdefault("must", []).append({"term": {"scope": request.args.get("scope")}})
+    else:
+        query["bool"].setdefault("must_not", []).append({"exists": {"field": "scope"}})
+    return query
 
 
 def update_image_caption(body, name, caption):

apps/rundowns/__init__.py

@@ -0,0 +1,32 @@
+import superdesk
+
+from flask_babel import lazy_gettext
+
+from superdesk.factory.app import SuperdeskEve
+
+SCOPE = "rundowns"
+
+from . import shows, templates, privileges, create  # noqa: E402
+
+
+def init_app(app: SuperdeskEve) -> None:
+    superdesk.privilege(
+        name=privileges.RUNDOWNS,
+        label=lazy_gettext("Rundowns"),
+        description=lazy_gettext("Rundowns management"),
+    )
+
+    superdesk.register_resource("rundown_shows", shows.ShowsResource, shows.ShowsService, _app=app)
+    superdesk.register_resource("rundown_templates", templates.TemplatesResource, templates.TemplatesService, _app=app)
+    superdesk.register_resource(
+        "rundown_from_template", create.FromTemplateResource, create.FromTemplateService, backend=None, _app=app
+    )
+
+    app.item_scope(
+        SCOPE,
+        schema={
+            "duration": {
+                "type": "number",
+            },
+        },
+    )

apps/rundowns/create.py

@@ -0,0 +1,61 @@
+import superdesk
+
+from . import privileges, SCOPE
+
+from flask import current_app as app
+from eve.methods.common import document_link
+from superdesk.utc import utcnow, utc_to_local
+
+
+class FromTemplateResource(superdesk.Resource):
+    schema = {
+        "template": superdesk.Resource.rel("rundown_templates", required=True),
+    }
+
+    datasource = {
+        "projection": {
+            "_links": 1,
+            "headline": 1,
+        },
+    }
+
+    item_methods = []
+    resource_methods = ["POST"]
+    privileges = {"POST": privileges.RUNDOWNS}
+
+
+class FromTemplateService(superdesk.Service):
+    def create(self, docs, **kwargs):
+        ids = []
+        for doc in docs:
+            template = superdesk.get_resource_service("rundown_templates").find_one(req=None, _id=doc["template"])
+            assert template
+            rundown = {"scope": SCOPE, "type": "composite", "particular_type": "rundown"}
+
+            if template.get("headline_template") and template.get("air_time"):
+                now = utcnow()
+                air_time = template.get("air_time").split(":")
+                date = utc_to_local(app.config["RUNDOWNS_TIMEZONE"], now)
+                date = date.replace(
+                    hour=int(air_time[0]),
+                    minute=int(air_time[1]),
+                    second=int(air_time[2]) if len(air_time) == 3 else 0,
+                    microsecond=0,
+                )
+                rundown["headline"] = " ".join(
+                    filter(
+                        bool,
+                        [
+                            template["headline_template"].get("prefix"),
+                            template["headline_template"].get("separator", ""),
+                            date.strftime(template["headline_template"].get("date_format", "")),
+                        ],
+                    )
+                )
+
+            superdesk.get_resource_service("archive").post([rundown])
+            rundown["_links"] = {"self": document_link("archive", rundown["_id"])}
+            doc.update(rundown)
+            ids.append(rundown.get("_id"))
+
+        return ids

apps/rundowns/privileges.py

@@ -0,0 +1 @@
+RUNDOWNS = "rundowns"

apps/rundowns/shows.py

@@ -0,0 +1,26 @@
+import superdesk
+
+from . import privileges
+
+
+class ShowsResource(superdesk.Resource):
+    schema = {
+        "name": {
+            "type": "string",
+            "required": True,
+        },
+        "description": {
+            "type": "string",
+        },
+        "duration": {
+            "type": "number",
+        },
+        "created_by": superdesk.Resource.rel("users"),
+        "updated_by": superdesk.Resource.rel("users"),
+    }
+
+    privileges = {"POST": privileges.RUNDOWNS, "PATCH": privileges.RUNDOWNS, "DELETE": privileges.RUNDOWNS}
+
+
+class ShowsService(superdesk.Service):
+    pass

apps/rundowns/templates.py

@@ -0,0 +1,51 @@
+import superdesk
+
+from . import privileges
+
+
+class TemplatesResource(superdesk.Resource):
+    schema = {
+        "name": {
+            "type": "string",
+            "required": True,
+        },
+        "show": superdesk.Resource.rel("rundown_shows", required=True),
+        "description": {
+            "type": "string",
+        },
+        "air_time": {
+            "type": "string",
+            "regex": r"[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+        },
+        "duration": {
+            "type": "number",
+        },
+        "schedule": {
+            "type": "dict",
+            "schema": {
+                "is_active": {
+                    "type": "boolean",
+                },
+                "day_of_week": {
+                    "type": "list",
+                    "allowed": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"],
+                },
+            },
+        },
+        "headline_template": {
+            "type": "dict",
+            "schema": {
+                "prefix": {"type": "string"},
+                "separator": {"type": "string"},
+                "date_format": {"type": "string"},
+            },
+        },
+        "created_by": superdesk.Resource.rel("users"),
+        "updated_by": superdesk.Resource.rel("users"),
+    }
+
+    privileges = {"POST": privileges.RUNDOWNS, "PATCH": privileges.RUNDOWNS, "DELETE": privileges.RUNDOWNS}
+
+
+class TemplatesService(superdesk.Service):
+    pass

features/rundowns.feature

@@ -0,0 +1,144 @@
+Feature: Rundowns
+
+    @auth
+    Scenario: Show CRUD
+        When we post to "/rundown_shows"
+        """
+        {"name": "Test", "description": "Test description", "duration": 10.5}
+        """
+        Then we get response code 201
+
+        When we get "/rundown_shows"
+        Then we get list with 1 items
+        """
+        {"_items": [{"name": "Test"}]}
+        """
+
+        When we get "/rundown_shows/#rundown_shows._id#"
+        Then we get existing resource
+        """
+        {"name": "Test", "description": "Test description", "duration": 10.5}
+        """
+
+        When we patch "/rundown_shows/#rundown_shows._id#"
+        """
+        {"name": "Updated", "duration": 11.1}
+        """
+        Then we get OK response
+
+        When we delete "/rundown_shows/#rundown_shows._id#"
+        Then we get OK response
+
+        When we get "/rundown_shows"
+        Then we get list with 0 items
+
+
+    @auth
+    Scenario: Templates CRUD
+        Given "rundown_shows"
+        """
+        [{"name": "Test"}]
+        """
+
+        When we post to "/rundown_templates"
+        """
+        {
+            "show": "#rundown_shows._id#",
+            "name": "test template",
+            "air_time": "06:00",
+            "headline_template": {
+                "prefix": "Marker",
+                "separator": "||",
+                "date_format": "dd.MM.yyyy"
+            }
+        }
+        """
+        Then we get response code 201
+
+        When we patch "/rundown_templates/#rundown_templates._id#"
+        """
+        {"schedule": {"is_active": true, "day_of_week": ["MON", "FRI"]}}
+        """
+        Then we get OK response
+
+        When we get "/rundown_templates"
+        Then we get list with 1 items
+        """
+        {"_items": [{"schedule": {"is_active": true}}]}
+        """
+
+        When we delete "/rundown_templates/#rundown_templates._id#"
+        Then we get OK response
+
+        When we get "/rundown_templates"
+        Then we get list with 0 items
+
+    @auth
+    Scenario: Rundown scope
+        When we post to "archive"
+        """
+        {"headline": "test", "scope": "rundowns", "duration": 60}
+        """
+        Then we get OK response
+
+        When we get "archive"
+        Then we get list with 0 items
+
+        When we get "search"
+        Then we get list with 0 items
+
+        When we get "archive?scope=rundowns"
+        Then we get list with 1 items
+        """
+        {"_items": [
+            {"duration": 60}
+        ]}
+        """
+
+    @auth
+    Scenario: Create rundown using template
+        Given "rundown_shows"
+        """
+        [
+            {"name": "Test"}
+        ]
+        """
+        And "rundown_templates"
+        """
+        [
+            {
+                "name": "Test",
+                "headline_template": {
+                    "prefix": "Prefix",
+                    "separator": "//",
+                    "date_format": "%H:%M"
+                },
+                "air_time": "06:00"
+            }
+        ]
+        """
+
+        When we post to "rundown_from_template"
+        """
+        {"template": "#rundown_templates._id#"}
+        """
+        Then we get new resource
+        """
+        {
+            "headline": "Prefix // 06:00",
+            "_links": {
+                "self": {
+                    "href": "archive/#rundown_from_template._id#",
+                    "title": "Archive"
+                }
+            }
+        }
+        """
+
+        When we get "archive?scope=rundowns"
+        Then we get list with 1 items
+        """
+        {"_items": [
+            {"headline": "Prefix // 06:00"}
+        ]}
+        """