Merge pull request #206 from canonical/multiple-filters

feat: Add third filter for querying engage pages

Author: britneywwc

canonicalwebteam/discourse/app.py

@@ -312,6 +312,7 @@ def get_index(
         self,
         limit=50,
         offset=0,
+        tag_value=None,
         key=None,
         value=None,
         second_key=None,
@@ -323,31 +324,29 @@ def get_index(
         - URL map
         And set those as properties on this object
         """
-        if key == "tag":
+
+        params = {
+            "category_id": self.category_id,
+            "limit": limit,
+            "offset": offset,
+            "tag_value": tag_value,
+            "key": key,
+            "value": value,
+            "second_key": second_key,
+            "second_value": second_value,
+        }
+
+        params = {k: v for k, v in params.items() if v is not None}
+
+        if tag_value and not value and not second_value:
             list_topics = self.api.get_engage_pages_by_tag(
                 category_id=self.category_id,
                 limit=limit,
                 offset=offset,
-                tag=value,
-            )
-        elif key and second_key:
-            list_topics = self.api.get_engage_pages_by_param(
-                category_id=self.category_id,
-                limit=limit,
-                offset=offset,
-                key=key,
-                value=value,
-                second_key=second_key,
-                second_value=second_value,
+                tag=tag_value,
             )
         else:
-            list_topics = self.api.get_engage_pages_by_param(
-                category_id=self.category_id,
-                limit=limit,
-                offset=offset,
-                key=key,
-                value=value,
-            )
+            list_topics = self.api.get_engage_pages_by_param(**params)
 
         topics = []
         for topic in list_topics:

canonicalwebteam/discourse/models.py

@@ -1,4 +1,5 @@
 from canonicalwebteam.discourse.exceptions import DataExplorerError
+import json
 
 
 class DiscourseAPI:
@@ -130,6 +131,7 @@ def get_engage_pages_by_param(
         offset=0,
         second_key=None,
         second_value=None,
+        tag_value=None,
     ):
         """
         Uses data-explorer to query topics with the category
@@ -169,42 +171,31 @@ def get_engage_pages_by_param(
         # See https://discourse.ubuntu.com/admin/plugins/explorer?id=16
         data_explorer_id = 16
 
-        params = (
-            {
-                "params": (
-                    f'{{"category_id":"{category_id}", '
-                    f'"limit":"{limit}", "offset":"{offset}"}}'
-                )
-            },
-        )
+        params_dict = {
+            "category_id": str(category_id),
+            "limit": str(limit),
+            "offset": str(offset),
+        }
 
-        if key and value and second_key and second_value:
-            params = (
-                {
-                    "params": (
-                        f'{{"category_id":"{category_id}", '
-                        f'"keyword":"{key}", "value":"{value}", '
-                        f'"second_keyword":"{second_key}", '
-                        f'"second_value":"{second_value}", '
-                        f'"limit":"{limit}", "offset":"{offset}"}}'
-                    )
-                },
-            )
-        elif key and value:
-            params = (
-                {
-                    "params": (
-                        f'{{"category_id":"{category_id}", '
-                        f'"keyword":"{key}", "value":"{value}", '
-                        f'"limit":"{limit}", "offset":"{offset}"}}'
-                    )
-                },
-            )
+        # Tags have to be queried differently due to the way they are stored
+        if tag_value:
+            params_dict["tag_value"] = str(tag_value)
 
+        if key and value:
+            params_dict["keyword"] = key
+            params_dict["value"] = value
+
+        if second_key and second_value:
+            params_dict["second_keyword"] = second_key
+            params_dict["second_value"] = second_value
+
+        # Get all engage pages to compile list of tags
+        # last resort if you need to get all pages, not performant
         if limit == -1:
-            # Get all engage pages to compile list of tags
-            # last resort if you need to get all pages, not performant
-            params = ({"params": f'{{"category_id":"{category_id}"}}'},)
+            params_dict.pop("limit")
+            params_dict.pop("offset")
+
+        params = ({"params": json.dumps(params_dict)},)
 
         response = self.session.post(
             f"{self.base_url}/admin/plugins/explorer/"

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name="canonicalwebteam.discourse",
-    version="5.8.0",
+    version="5.8.1",
     author="Canonical webteam",
     author_email="webteam@canonical.com",
     url="https://github.com/canonical/canonicalwebteam.discourse",