canonicalwebteam.store-api 5.0.0__py3-none-any.whl → 6.1.0__py3-none-any.whl

canonicalwebteam/store_api/{store.py → devicegw.py}

@@ -1,71 +1,44 @@
-from canonicalwebteam.store_api.exceptions import (
-    StoreApiConnectionError,
-    StoreApiResourceNotFound,
-    StoreApiResponseDecodeError,
-    StoreApiResponseError,
-    StoreApiResponseErrorList,
-)
-
-
-class Store:
-    def __init__(self, session, store=None):
-        self.config = {1: {"base_url": "", "headers": {}}}
-        self.session = session
-
-    def process_response(self, response):
-        # 5xx responses are not in JSON format
-        if response.status_code >= 500:
-            raise StoreApiConnectionError("Service Unavailable")
-
-        try:
-            body = response.json()
-        except ValueError as decode_error:
-            raise StoreApiResponseDecodeError(
-                "JSON decoding failed: {}".format(decode_error)
-            )
+from os import getenv
+from typing import Optional
+
+from requests import Session
+from canonicalwebteam.store_api.base import Base
+
+
+DEVICEGW_URL = getenv("DEVICEGW_URL", "https://api.snapcraft.io/")
+
 
-        if not response.ok:
-            if "error_list" in body or "error-list" in body:
-                # V1 and V2 error handling
-                error_list = (
-                    body["error_list"]
-                    if "error_list" in body
-                    else body["error-list"]
-                )
-
-                for error in error_list:
-                    if error["code"] == "resource-not-found":
-                        raise StoreApiResourceNotFound
-
-                raise StoreApiResponseErrorList(
-                    "The API returned a list of errors",
-                    response.status_code,
-                    error_list,
-                )
-            else:
-                raise StoreApiResponseError(
-                    "Unknown error from API", response.status_code
-                )
-
-        if "_embedded" in body:
-            body["results"] = body["_embedded"]["clickindex:package"]
-            del body["_embedded"]
-
-        return body
-
-    def get_endpoint_url(self, endpoint, api_version=1):
+class DeviceGW(Base):
+    def __init__(self, namespace, session=Session(), store=None):
+        super().__init__(session)
+        self.config = {
+            1: {
+                "base_url": f"{DEVICEGW_URL}api/v1/{namespace}s/",
+                "headers": {"X-Ubuntu-Series": "16"},
+            },
+            2: {
+                "base_url": f"{DEVICEGW_URL}v2/{namespace}s/",
+                "headers": {"Snap-Device-Series": "16"},
+            },
+        }
+
+        if store:
+            self.config[1]["headers"].update({"X-Ubuntu-Store": store})
+            self.config[2]["headers"].update({"Snap-Device-Store": store})
+
+    def get_endpoint_url(self, endpoint, api_version=1) -> str:
         base_url = self.config[api_version]["base_url"]
         return f"{base_url}{endpoint}"
 
     def search(
         self,
-        search,
-        size=100,
-        page=1,
-        category=None,
-        arch="wide",
-        api_version=1,
-    ):
+        search: str,
+        size: int = 100,
+        page: int = 1,
+        category: Optional[str] = None,
+        arch: str = "wide",
+        api_version: int = 1,
+    ) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/search.html#snap_search
         Endpoint:  https://api.snapcraft.io/api/v1/snaps/search
@@ -116,7 +89,34 @@ class Store:
             self.session.get(url, params=params, headers=headers)
         )
 
-    def get_all_items(self, size, api_version=1):
+    def find(
+        self,
+        query: str = "",
+        category: str = "",
+        architecture: str = "",
+        publisher: str = "",
+        featured: str = "false",
+        fields: list = [],
+    ) -> dict:
+        """
+        Documentation: https://api.snapcraft.io/docs/search.html#snaps_find
+        Endpoint: [GET] https://api.snapcraft.io/v2/snaps/find
+        """
+        url = self.get_endpoint_url("find", 2)
+        headers = self.config[2].get("headers")
+        params = {
+            "q": query,
+            "category": category,
+            "architecture": architecture,
+            "publisher": publisher,
+            "featured": featured,
+        }
+        if fields:
+            params["fields"] = ",".join(fields)
+        response = self.session.get(url, params=params, headers=headers)
+        return self.process_response(response)
+
+    def get_all_items(self, size: int, api_version: int = 1) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/search.html#snap_search
         Endpoint:  https://api.snapcraft.io/api/v1/snaps/search
@@ -131,7 +131,13 @@ class Store:
             )
         )
 
-    def get_category_items(self, category, size=10, page=1, api_version=1):
+    def get_category_items(
+        self,
+        category: str,
+        size: int = 10,
+        page: int = 1,
+        api_version: int = 1,
+    ) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/search.html#snap_search
         Endpoint:  https://api.snapcraft.io/api/v1/snaps/search
@@ -144,7 +150,9 @@ class Store:
             api_version=api_version,
         )
 
-    def get_featured_items(self, size=10, page=1, api_version=1):
+    def get_featured_items(
+        self, size: int = 10, page: int = 1, api_version: int = 1
+    ) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/search.html#snap_search
         Endpoint:  https://api.snapcraft.io/api/v1/snaps/search
@@ -157,7 +165,13 @@ class Store:
             api_version=api_version,
         )
 
-    def get_publisher_items(self, publisher, size=500, page=1, api_version=1):
+    def get_publisher_items(
+        self,
+        publisher: str,
+        size: int = 500,
+        page: int = 1,
+        api_version: int = 1,
+    ) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/search.html#snap_search
         Endpoint:  https://api.snapcraft.io/api/v1/snaps/search
@@ -169,27 +183,34 @@ class Store:
             api_version=api_version,
         )
 
-    def get_item_details(self, name, channel=None, fields=[], api_version=2):
+    def get_item_details(
+        self,
+        name: str,
+        channel: Optional[str] = None,
+        fields: list = [],
+        api_version: int = 2,
+    ) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/info.html
         Endpoint: [GET]
             https://api.snapcraft.io/api/v2/{name_space}/info/{package_name}
         """
         url = self.get_endpoint_url("info/" + name, api_version)
-        params = {"fields": ",".join(fields)}
+        params = {}
+        if fields:
+            params = {"fields": ",".join(fields)}
+        headers = self.config[api_version].get("headers")
 
         if channel:
             params["channel"] = channel
-
-        return self.process_response(
-            self.session.get(
-                url,
-                params=params,
-                headers=self.config[api_version].get("headers"),
-            )
+        response = self.session.get(
+            url,
+            params=params,
+            headers=headers,
         )
+        return self.process_response(response)
 
-    def get_public_metrics(self, json, api_version=1):
+    def get_public_metrics(self, json: dict, api_version: int = 1) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/metrics.html
         Endpoint: https://api.snapcraft.io/api/v1/snaps/metrics
@@ -203,7 +224,9 @@ class Store:
             self.session.post(url, headers=headers, json=json)
         )
 
-    def get_categories(self, api_version=2, type="shared"):
+    def get_categories(
+        self, api_version: int = 2, type: str = "shared"
+    ) -> dict:
         """
         Documentation: https://api.snapcraft.io/docs/categories.html
         Endpoint: https://api.snapcraft.io/api/v2/{name_space}/categories
@@ -217,7 +240,9 @@ class Store:
             )
         )
 
-    def get_resource_revisions(self, name, resource_name, api_version=2):
+    def get_resource_revisions(
+        self, name: str, resource_name: str, api_version: int = 2
+    ) -> dict:
         """
         Documentation:
             https://api.snapcraft.io/docs/charms.html#list_resource_revisions
@@ -234,3 +259,26 @@ class Store:
                 headers=self.config[api_version].get("headers"),
             )
         )["revisions"]
+
+    def get_featured_snaps(
+        self, api_version: int = 1, fields: str = "snap_id"
+    ) -> dict:
+        """
+        Documentation: (link to spec)
+            https://docs.google.com/document/d/1UAybxuZyErh3ayqb4nzL3T4BbvMtnmKKEPu-ixcCj_8/edit
+        Endpoint: https://api.snapcraft.io/api/v1/snaps/search
+        """
+        url = self.get_endpoint_url("search")
+        headers = self.config[api_version].get("headers")
+
+        params = {
+            "scope": "wide",
+            "arch": "wide",
+            "confinement": "strict,classic,devmode",
+            "fields": fields,
+            "section": "featured",
+        }
+
+        return self.process_response(
+            self.session.get(url, params=params, headers=headers)
+        )