geoservercloud 0.8.8.dev3__tar.gz → 0.8.9.dev1__tar.gz

{geoservercloud-0.8.8.dev3 → geoservercloud-0.8.9.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: geoservercloud
-Version: 0.8.8.dev3
+Version: 0.8.9.dev1
 Summary: Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services
 License: BSD-2-Clause
 Author: Camptocamp

{geoservercloud-0.8.8.dev3 → geoservercloud-0.8.9.dev1}/geoservercloud/geoservercloud.py

@@ -15,6 +15,7 @@ from geoservercloud.models.featuretype import FeatureType
 from geoservercloud.models.gwclayer import GridSubset, GwcLayer, ParameterFilter
 from geoservercloud.models.layer import Layer
 from geoservercloud.models.layergroup import LayerGroup
+from geoservercloud.models.s3blobstore import S3Blobstore
 from geoservercloud.models.style import Style
 from geoservercloud.models.wmslayer import WmsLayer
 from geoservercloud.models.wmssettings import WmsSettings
@@ -2281,3 +2282,71 @@ class GeoServerCloud:
         :rtype: tuple
         """
         return self.rest_service.create_gridset(epsg)
+
+    def create_gwc_blobstore(
+        self,
+        id: str,
+        bucket: str,
+        max_connections: int,
+        aws_access_key: str | None = None,
+        aws_secret_key: str | None = None,
+        prefix: str | None = None,
+        enabled: bool | None = None,
+        default: bool | None = None,
+        access: str | None = None,
+        use_https: bool | None = None,
+        proxy_domain: str | None = None,
+        proxy_workstation: str | None = None,
+        proxy_host: str | None = None,
+        proxy_port: str | None = None,
+        proxy_username: str | None = None,
+        proxy_password: str | None = None,
+        use_gzip: bool | None = None,
+        endpoint: str | None = None,
+    ) -> tuple[str, int]:
+        """
+        Create or update a blobstore for GeoWebCache cache storage
+
+        :param id: Identifier of the blobstore
+        :param bucket: Name of the AWS S3 bucket where to store tiles
+        :param max_connections: Maximum number of allowed open HTTP connections
+        :param aws_access_key: AWS access key, not required if using anonymous or role-based credentials
+        :param aws_secret_key: AWS secret key, not required if using anonymous or role-based credentials
+        :param prefix: Optional base prefix path to use as the root to store tiles under the bucket
+        :param enabled: Whether the blobstore is enabled
+        :param default: Whether this blobstore is the default one
+        :param access: Access control for stored tiles, either "PUBLIC" or "PRIVATE"
+        :param use_https: Whether to use HTTPS (True) or HTTP (False) when talking to S3 (GeoServer defaults to True if omitted)
+        :param proxy_domain: Optional Windows domain name for configuring an NTLM proxy
+        :param proxy_workstation: Optional Windows workstation name for configuring NTLM proxy support
+        :param proxy_host: Optional proxy host the client will connect through
+        :param proxy_port: Optional proxy port the client will connect through
+        :param proxy_username: Optional proxy user name to use if connecting through a proxy
+        :param proxy_password: Optional proxy password to use when connecting through a proxy
+        :param use_gzip: Whether to use gzip compression
+        :param endpoint: Host of the S3-compatible server (if not AWS)
+        :return: Tuple of (content, status_code)
+        :rtype: tuple
+        """
+
+        blobstore = S3Blobstore(
+            id=id,
+            bucket=bucket,
+            max_connections=max_connections,
+            aws_access_key=aws_access_key,
+            aws_secret_key=aws_secret_key,
+            prefix=prefix,
+            enabled=enabled,
+            default=default,
+            access=access,
+            use_https=use_https,
+            proxy_domain=proxy_domain,
+            proxy_workstation=proxy_workstation,
+            proxy_host=proxy_host,
+            proxy_port=proxy_port,
+            proxy_username=proxy_username,
+            proxy_password=proxy_password,
+            use_gzip=use_gzip,
+            endpoint=endpoint,
+        )
+        return self.rest_service.create_gwc_blobstore(blobstore)

geoservercloud-0.8.9.dev1/geoservercloud/models/s3blobstore.py

@@ -0,0 +1,104 @@
+import json
+from typing import Any
+
+from geoservercloud.models.common import EntityModel
+
+
+class S3Blobstore(EntityModel):
+    def __init__(
+        self,
+        id: str,
+        bucket: str,
+        max_connections: int,
+        aws_access_key: str | None = None,
+        aws_secret_key: str | None = None,
+        prefix: str | None = None,
+        enabled: bool | None = None,
+        default: bool | None = None,
+        access: str | None = None,
+        use_https: bool | None = None,
+        proxy_domain: str | None = None,
+        proxy_workstation: str | None = None,
+        proxy_host: str | None = None,
+        proxy_port: str | None = None,
+        proxy_username: str | None = None,
+        proxy_password: str | None = None,
+        use_gzip: bool | None = None,
+        endpoint: str | None = None,
+    ):
+        self.id = id
+        self.bucket = bucket
+        self.max_connections = max_connections
+        self.aws_access_key = aws_access_key
+        self.aws_secret_key = aws_secret_key
+        self.prefix = prefix
+        self.enabled = enabled
+        self.default = default
+        self.access = access
+        self.use_https = use_https
+        self.proxy_domain = proxy_domain
+        self.proxy_workstation = proxy_workstation
+        self.proxy_host = proxy_host
+        self.proxy_port = proxy_port
+        self.proxy_username = proxy_username
+        self.proxy_password = proxy_password
+        self.use_gzip = use_gzip
+        self.endpoint = endpoint
+
+    def asdict(self) -> dict[str, Any]:
+        content: dict[str, Any] = {
+            "id": self.id,
+            "bucket": self.bucket,
+            "maxConnections": self.max_connections,
+        }
+        optional_items: dict[str, Any] = {
+            "awsAccessKey": self.aws_access_key,
+            "awsSecretKey": self.aws_secret_key,
+            "prefix": self.prefix,
+            "enabled": self.enabled,
+            "default": self.default,
+            "access": self.access,
+            "useHTTPS": self.use_https,
+            "proxyDomain": self.proxy_domain,
+            "proxyWorkstation": self.proxy_workstation,
+            "proxyHost": self.proxy_host,
+            "proxyPort": self.proxy_port,
+            "proxyUsername": self.proxy_username,
+            "proxyPassword": self.proxy_password,
+            "useGzip": self.use_gzip,
+            "endpoint": self.endpoint,
+        }
+        return EntityModel.add_items_to_dict(content, optional_items)
+
+    def post_payload(self) -> dict[str, Any]:
+        return {"S3BlobStore": self.asdict()}
+
+    def put_payload(self) -> dict[str, Any]:
+        return self.post_payload()
+
+    @classmethod
+    def from_get_response_payload(cls, content: dict):
+        s3blobstore = content["S3BlobStore"]
+        return cls(
+            s3blobstore["id"],
+            s3blobstore["bucket"],
+            s3blobstore["maxConnections"],
+            s3blobstore.get("awsAccessKey"),
+            s3blobstore.get("awsSecretKey"),
+            s3blobstore.get("prefix"),
+            s3blobstore.get("enabled"),
+            s3blobstore.get("default"),
+            s3blobstore.get("access"),
+            s3blobstore.get("useHTTPS"),
+            s3blobstore.get("proxyDomain"),
+            s3blobstore.get("proxyWorkstation"),
+            s3blobstore.get("proxyHost"),
+            s3blobstore.get("proxyPort"),
+            s3blobstore.get("proxyUsername"),
+            s3blobstore.get("proxyPassword"),
+            s3blobstore.get("useGzip"),
+            s3blobstore.get("endpoint"),
+        )
+
+    def __repr__(self) -> str:
+        return json.dumps(self.put_payload(), indent=4)

{geoservercloud-0.8.8.dev3 → geoservercloud-0.8.9.dev1}/geoservercloud/services/restservice.py

@@ -18,6 +18,7 @@ from geoservercloud.models.layer import Layer
 from geoservercloud.models.layergroup import LayerGroup
 from geoservercloud.models.layergroups import LayerGroups
 from geoservercloud.models.resourcedirectory import ResourceDirectory
+from geoservercloud.models.s3blobstore import S3Blobstore
 from geoservercloud.models.style import Style
 from geoservercloud.models.styles import Styles
 from geoservercloud.models.wmslayer import WmsLayer
@@ -344,6 +345,13 @@ class RestService:
         )
         return response.content.decode(), response.status_code
 
+    def create_gwc_blobstore(self, blobstore: S3Blobstore) -> tuple[str, int]:
+        response: Response = self.rest_client.put(
+            self.gwc_endpoints.blobstore(blobstore.id),
+            json=blobstore.put_payload(),
+        )
+        return response.content.decode(), response.status_code
+
     def get_feature_types(
         self, workspace_name: str, datastore_name: str
     ) -> tuple[FeatureTypes | str, int]:
@@ -899,6 +907,12 @@ class RestService:
         def gridset(self, epsg: int) -> str:
             return f"{self.base_url}/gridsets/EPSG:{str(epsg)}.xml"
 
+        def blobstores(self) -> str:
+            return f"{self.base_url}/blobstores.json"
+
+        def blobstore(self, id: str) -> str:
+            return f"{self.base_url}/blobstores/{id}.json"
+
     class RestEndpoints:
         def __init__(self, base_url: str = "/rest") -> None:
             self.base_url: str = base_url

{geoservercloud-0.8.8.dev3 → geoservercloud-0.8.9.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "geoservercloud"
-version = "0.8.8.dev3"
+version = "0.8.9.dev1"
 description = "Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services"
 authors = ["Camptocamp <info@camptocamp.com>"]
 license = "BSD-2-Clause"