Avoid a use of tuple and update approved specs

Tuples aren't supported by apispec yet marshmallow-code/apispec#399
Flowminder · Sep 18, 2019 · a9baa83 · a9baa83
1 parent 36d089f
commit a9baa83
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 13 deletions.
diff --git a/flowclient/flowclient/client.py b/flowclient/flowclient/client.py
@@ -1540,6 +1540,7 @@ def nocturnal_events(
     stop : str
         ISO format date of the day _after_ the final date for which to count nocturnal events, e.g. "2016-01-08"
     hours: tuple(int,int)
+        Tuple defining beginning and end of night
 
     subscriber_subset : dict or None, default None
         Subset of subscribers to include in event counts. Must be None
@@ -1556,7 +1557,8 @@ def nocturnal_events(
         "query_kind": "nocturnal_events",
         "start": start,
         "stop": stop,
-        "hours": hours,
+        "night_start_hour": hours[0],
+        "night_end_hour": hours[1],
         "subscriber_subset": subscriber_subset,
     }
 

diff --git a/flowmachine/flowmachine/core/server/query_schemas/nocturnal_events.py b/flowmachine/flowmachine/core/server/query_schemas/nocturnal_events.py
@@ -3,7 +3,7 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 from marshmallow import fields, post_load
-from marshmallow.validate import OneOf, Length
+from marshmallow.validate import OneOf, Length, Range
 
 from flowmachine.features import NocturnalEvents
 from .custom_fields import SubscriberSubset
@@ -19,7 +19,10 @@ class NocturnalEventsSchema(BaseQueryWithSamplingSchema):
     query_kind = fields.String(validate=OneOf(["nocturnal_events"]))
     start = fields.Date(required=True)
     stop = fields.Date(required=True)
-    hours = fields.Tuple((fields.Integer(), fields.Integer()))
+    night_start_hour = fields.Integer(
+        validate=Range(0, 23)
+    )  # Tuples aren't supported by apispec https://github.com/marshmallow-code/apispec/issues/399
+    night_end_hour = fields.Integer(validate=Range(0, 23))
     subscriber_subset = SubscriberSubset()
 
     @post_load
@@ -28,12 +31,21 @@ def make_query_object(self, params, **kwargs):
 
 
 class NocturnalEventsExposed(BaseExposedQueryWithSampling):
-    def __init__(self, *, start, stop, hours, subscriber_subset=None, sampling=None):
+    def __init__(
+        self,
+        *,
+        start,
+        stop,
+        night_start_hour,
+        night_end_hour,
+        subscriber_subset=None,
+        sampling=None
+    ):
         # Note: all input parameters need to be defined as attributes on `self`
         # so that marshmallow can serialise the object correctly.
         self.start = start
         self.stop = stop
-        self.hours = hours
+        self.hours = (night_start_hour, night_end_hour)
         self.subscriber_subset = subscriber_subset
         self.sampling = sampling
 

diff --git a/...ion_tests/tests/flowapi_tests/test_api_spec.test_generated_openapi_json_spec.approved.txt b/...ion_tests/tests/flowapi_tests/test_api_spec.test_generated_openapi_json_spec.approved.txt
@@ -1079,8 +1079,17 @@
       },
       "NocturnalEvents": {
         "properties": {
-          "hours": {
-            "type": "string"
+          "night_end_hour": {
+            "format": "int32",
+            "maximum": 23,
+            "minimum": 0,
+            "type": "integer"
+          },
+          "night_start_hour": {
+            "format": "int32",
+            "maximum": 23,
+            "minimum": 0,
+            "type": "integer"
           },
           "query_kind": {
             "enum": [

diff --git a/...on_tests/tests/flowapi_tests/test_api_spec.test_generated_openapi_redoc_spec.approved.txt b/...on_tests/tests/flowapi_tests/test_api_spec.test_generated_openapi_redoc_spec.approved.txt
@@ -1012,8 +1012,17 @@
       },
       "NocturnalEvents": {
         "properties": {
-          "hours": {
-            "type": "string"
+          "night_end_hour": {
+            "format": "int32",
+            "maximum": 23,
+            "minimum": 0,
+            "type": "integer"
+          },
+          "night_start_hour": {
+            "format": "int32",
+            "maximum": 23,
+            "minimum": 0,
+            "type": "integer"
           },
           "query_kind": {
             "enum": [

diff --git a/...ion_tests/tests/flowapi_tests/test_api_spec.test_generated_openapi_yaml_spec.approved.txt b/...ion_tests/tests/flowapi_tests/test_api_spec.test_generated_openapi_yaml_spec.approved.txt
@@ -1079,8 +1079,17 @@
       },
       "NocturnalEvents": {
         "properties": {
-          "hours": {
-            "type": "string"
+          "night_end_hour": {
+            "format": "int32",
+            "maximum": 23,
+            "minimum": 0,
+            "type": "integer"
+          },
+          "night_start_hour": {
+            "format": "int32",
+            "maximum": 23,
+            "minimum": 0,
+            "type": "integer"
           },
           "query_kind": {
             "enum": [

diff --git a/...wmachine_server_tests/test_server.test_api_spec_of_flowmachine_query_schemas.approved.txt b/...wmachine_server_tests/test_server.test_api_spec_of_flowmachine_query_schemas.approved.txt
@@ -1060,8 +1060,17 @@
   },
   "NocturnalEvents": {
     "properties": {
-      "hours": {
-        "type": "string"
+      "night_end_hour": {
+        "format": "int32",
+        "maximum": 23,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "night_start_hour": {
+        "format": "int32",
+        "maximum": 23,
+        "minimum": 0,
+        "type": "integer"
       },
       "query_kind": {
         "enum": [