Initial access control logic (fs 937) (#2)

* feat: Adds creates unit and product AS API methods

* feat: Working unit/product creation

- Run-time ability to debug requests (SQUONK2_API_DEBUG_REQUESTS)
- Adds unit/product/project example

* fix: Working example unit/product/project

Co-authored-by: Alan Christie <alan.christie@matildapeak.com>

Author: alanbchristie

CONTRIBUTING.md

@@ -32,7 +32,7 @@ by the GitHib Actions: -
 
 And then uninstall using pip: -
 
-    pip uninstall im-squonk2-client
+    pip uninstall -y im-squonk2-client
 
 ---
 

README.rst

@@ -76,13 +76,19 @@ The following Squonk2 Account Server API functions are available: -
 
 - ``AsApi.ping()``
 
-- ``AsApi.get_version()``
+- ``AsApi.create_product()``
+- ``AsApi.create_unit()``
+- ``AsApi.delete_product()``
+- ``AsApi.delete_unit()``
 - ``AsApi.get_available_assets()``
 - ``AsApi.get_available_units()``
 - ``AsApi.get_available_products()``
+- ``AsApi.get_merchants()``
 - ``AsApi.get_product()``
 - ``AsApi.get_product_charges()``
-- ``AsApi.get_merchants()``
+- ``AsApi.get_unit()``
+- ``AsApi.get_units()``
+- ``AsApi.get_version()``
 
 A ``namedtuple`` is used as the return value for many of the methods: -
 
@@ -92,6 +98,16 @@ It contains a boolean ``success`` field and a dictionary ``msg`` field. The
 ``msg`` typically contains the underlying REST API response content
 (rendered as a Python dictionary), or an error message if the call failed.
 
+Debugging the API requests
+==========================
+For development purposes you can expose detailed debug information relating to
+the underlying API requests by setting the environment variable
+``SQUONK2_API_DEBUG_REQUESTS``::
+
+    export SQUONK2_API_DEBUG_REQUESTS=yes
+
+This will enable detailed debug of both the DM and AS API calls.
+
 Installation
 ============
 The Squonk2 package is published on `PyPI`_ and can be installed from

examples/README.md

@@ -31,16 +31,23 @@ Check it all works by running one of the examples: -
 
 ## Examples
 
-### GetToken.py
+### get_token.py
 Illustrates how to get an access token from Keycloak
 (see the project `README.rst` on requiring a Keycloak password).
 That token can then be passed or used in the other examples.
 
-### CalcRDkitProps.py
+### calc_rdkit_props.py
 Illustrates how to: -
 
 - upload a file
 - run a simple job (with options) using that file
 - wait for the job to complete
 - download the results and, finally...
 - cleanup (delete) the job instance
+
+### units_products_and_projects.py
+Illustrates how to: -
+
+- create an Account Server (AS) organisational unit
+- create AS storage and data-tier products
+- create a project using an AS project

examples/get_token.py

@@ -24,7 +24,8 @@
 parser.add_argument(
     "--keycloak-client-id",
     "-i",
-    help='The Keycloak client ID, i.e. "data-manager-api-dev"',
+    help='The Keycloak client ID, i.e. "data-manager-api-dev"'
+    ' or "account-server-api-dev"',
     required=True,
 )
 args = parser.parse_args()

examples/units_products_and_projects.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python
+"""An example that illustrates how to use the client to create AS
+Units and Products and then to create a DM project from the Product.
+
+Required environment: -
+
+    SQUONK2_DMAPI_URL
+    SQUONK2_ASAPI_URL
+    KEYCLOAK_TOKEN
+    KEYCLOAK_TOKEN_AS
+    ORG_ID
+"""
+import os
+import sys
+
+from squonk2.dm_api import DmApi, DmApiRv
+from squonk2.as_api import AsApi, AsApiRv
+
+# Squonk2 authentication token and the organisation id
+# are taken from environment variables...
+as_token: str = os.environ.get("KEYCLOAK_TOKEN_AS")
+dm_token: str = os.environ.get("KEYCLOAK_TOKEN")
+org_id: str = os.environ.get("ORG_ID")
+
+if as_token:
+    print("AS token present")
+else:
+    print("No AS token provided")
+    sys.exit(1)
+
+if dm_token:
+    print("DM token present")
+else:
+    print("No DM token provided")
+    sys.exit(1)
+
+if org_id:
+    print("ORG_ID present")
+else:
+    print("No ORG_ID provided")
+    sys.exit(1)
+
+# Create the unit.
+as_rv: AsApiRv = AsApi.create_unit(
+    as_token,
+    org_id=org_id,
+    billing_day=8,
+    unit_name="Example unit",
+)
+if not as_rv.success:
+    print("Failed to create unit")
+    print(as_rv)
+    sys.exit(1)
+unit_id = as_rv.msg["id"]
+print(f"Created Unit '{unit_id}'")
+
+# Create the storage product.
+as_rv = AsApi.create_product(
+    as_token,
+    product_name="Example storage",
+    unit_id=unit_id,
+    product_type="DATA_MANAGER_STORAGE_SUBSCRIPTION",
+    allowance=10,
+    limit=10,
+)
+if not as_rv.success:
+    print("Failed to create storage product")
+    sys.exit(1)
+storage_product_id = as_rv.msg["id"]
+print(f"Created Storage Product '{storage_product_id}'")
+
+# Create the Data Tier product.
+# We do not set allowances on DT products.
+as_rv = AsApi.create_product(
+    as_token,
+    product_name="Example data tier",
+    unit_id=unit_id,
+    product_type="DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
+    flavour="BRONZE",
+)
+if not as_rv.success:
+    print("Failed to create data tier product")
+    sys.exit(1)
+dt_product_id = as_rv.msg["id"]
+print(f"Created DataTier Product '{dt_product_id}'")
+
+# Create a Data Manger Project using the AS DT Product.
+dm_rv: DmApiRv = DmApi.create_project(
+    dm_token,
+    project_name="Example project",
+    as_tier_product_id=dt_product_id,
+)
+if not dm_rv.success:
+    print("Failed to create DM project")
+    sys.exit(1)
+project_id = dm_rv.msg["project_id"]
+print(f"Created Project '{project_id}'")
+
+# Now delete the Project, Products and unit
+
+dm_rv = DmApi.delete_project(dm_token, project_id=project_id)
+if as_rv.success:
+    print("Project deleted")
+else:
+    print("Failed to delete product")
+    sys.exit(1)
+
+as_rv = AsApi.delete_product(as_token, product_id=dt_product_id)
+if as_rv.success:
+    print("Data Tier Product deleted")
+else:
+    print("Failed to delete data tier product")
+    sys.exit(1)
+
+as_rv = AsApi.delete_product(as_token, product_id=storage_product_id)
+if as_rv.success:
+    print("Storage Product deleted")
+else:
+    print("Failed to delete storage product")
+    sys.exit(1)
+
+as_rv = AsApi.delete_unit(as_token, unit_id=unit_id)
+if as_rv.success:
+    print("Unit deleted")
+else:
+    print("Failed to delete unit")
+    sys.exit(1)