feat: Adds load/save ER scripts

Author: Alan Christie

.gitignore

@@ -2,3 +2,4 @@
 venv/
 **/__pycache__/
 setenv.sh
+*.yaml

requirements.txt

@@ -1,3 +1,4 @@
-im-squonk2-client >= 1.9.0, < 2.0.0
+im-squonk2-client >= 1.9.3, < 2.0.0
 python-dateutil == 2.8.2
 rich == 12.5.1
+pyyaml == 6.0

tools/load-er.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python
+"""Loads Job/Application Exchange Rates from a file.
+"""
+import argparse
+from pathlib import Path
+import sys
+from typing import Any, Dict, List, Optional
+import urllib3
+
+from rich.console import Console
+from squonk2.auth import Auth
+from squonk2.dm_api import DmApi, DmApiRv
+import yaml
+
+from common import Env, get_env
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+
+def main(c_args: argparse.Namespace) -> None:
+    """Main function."""
+
+    console = Console()
+
+    env: Optional[Env] = get_env()
+    if not env:
+        return
+
+    token: str = Auth.get_access_token(
+        keycloak_url=env.keycloak_url,
+        keycloak_realm=env.keycloak_realm,
+        keycloak_client_id=env.keycloak_dm_client_id,
+        username=env.keycloak_user,
+        password=env.keycloak_user_password,
+    )
+
+    # Just read the list from the chosen file
+    file_content: str = Path(c_args.file).read_text(encoding='utf8')
+    rates: List[Dict[str, Any]] = yaml.load(file_content, Loader=yaml.FullLoader)
+    er_rv: DmApiRv = DmApi.set_job_exchange_rates(token, rates=rates)
+    if not er_rv.success:
+        console.log(f'[bold red]ERROR[/bold red] {er_rv.msg["error"]}')
+        sys.exit(1)
+
+    num_rates: int = len(rates)
+    if num_rates:
+        console.log(f'Loaded {num_rates}')
+    else:
+        console.log('Loaded [bold red]nothing[/bold red]')
+
+
+if __name__ == "__main__":
+
+    # Parse command line arguments
+    parser = argparse.ArgumentParser(
+        prog="coins",
+        description="Loads exchange rates (from a YAML file)"
+    )
+    parser.add_argument('file', type=str, help='The source file')
+    args: argparse.Namespace = parser.parse_args()
+
+    # File must exist
+    if not Path(args.file).is_file():
+        parser.error("File does not exist")
+
+    main(args)

tools/save-er.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+"""Saves Job/Application Exchange Rates to a file.
+"""
+from datetime import datetime
+import argparse
+from pathlib import Path
+import sys
+from typing import Optional
+import urllib3
+
+from rich.console import Console
+from squonk2.auth import Auth
+from squonk2.dm_api import DmApi, DmApiRv
+import yaml
+
+from common import Env, get_env
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+
+def main(c_args: argparse.Namespace) -> None:
+    """Main function."""
+
+    env: Optional[Env] = get_env()
+    if not env:
+        return
+
+    console = Console()
+
+    token: str = Auth.get_access_token(
+        keycloak_url=env.keycloak_url,
+        keycloak_realm=env.keycloak_realm,
+        keycloak_client_id=env.keycloak_dm_client_id,
+        username=env.keycloak_user,
+        password=env.keycloak_user_password,
+    )
+
+    er_rv: DmApiRv = DmApi.get_job_exchange_rates(token)
+    if not er_rv.success:
+        console.log(f'[bold red]ERROR[/bold red] {er_rv.msg["error"]}')
+        sys.exit(1)
+
+    filename: str = c_args.file
+    if not filename.endswith('.yaml'):
+        filename += '.yaml'
+
+    # Just write the list to the chosen file,
+    # with a handy header detailing the source
+    header: str = "---"
+    header += "\n# Saved Job Exchange Rates (using save-er.py)"
+    header += "\n# From Keycloak: " + env.keycloak_url
+    header += "\n#        Client: " + env.keycloak_dm_client_id
+    header += "\n#    Time (UTC): " + str(datetime.utcnow())
+    header += "\n\n"
+
+    num_rates: int = len(er_rv.msg['exchange_rates'])
+    rates: str = yaml.dump(er_rv.msg['exchange_rates'], default_flow_style=False)
+    Path(filename).write_text(header + rates, encoding='utf8')
+
+    if num_rates:
+        console.log(f'Saved {num_rates} (to {filename})')
+    else:
+        console.log('Saved [bold red]nothing[/bold red]')
+
+
+if __name__ == "__main__":
+
+    # Parse command line arguments
+    parser = argparse.ArgumentParser(
+        prog="coins",
+        description="Saves existing exchange rates (to a YAML file)"
+    )
+    parser.add_argument('file', type=str, help='The destination file')
+    args: argparse.Namespace = parser.parse_args()
+
+    main(args)