howler-api 4.1.0.dev1573__tar.gz → 4.1.0.dev1582__tar.gz

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.1.0.dev1573
+Version: 4.1.0.dev1582
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/api/v1/action.py

@@ -4,6 +4,7 @@ from flask import Response, request
 
 import howler.actions as actions
 from howler.api import bad_request, created, forbidden, internal_error, make_subapi_blueprint, no_content, not_found, ok
+from howler.api.v1.utils.etag import add_etag
 from howler.api.v1.utils.params import parse_parameters, parse_refresh
 from howler.common.exceptions import HowlerException
 from howler.common.loader import datastore
@@ -46,6 +47,34 @@ def get_actions(**_) -> Response:
     return ok(datastore().action.search("*:*", as_obj=False)["items"])
 
 
+@generate_swagger_docs()
+@action_api.route("/<id>", methods=["GET"])
+@api_login(
+    audit=True,
+    check_xsrf_token=False,
+    required_type=["admin", "automation_basic", "automation_advanced", "actionrunner_basic", "actionrunner_advanced"],
+)
+@add_etag(getter=action_service.get_action)
+def get_action(id: str, record: Action | None, server_version: str, **kwargs) -> Response | tuple[Response, str]:
+    """Get an existing action.
+
+    Variables:
+    id  => The id of the action to retrieve
+
+    Optional Arguments:
+    None
+
+    Result Example:
+    {
+        ...action   # The requested action
+    }
+    """
+    if not record:
+        return not_found(err="The specified action does not exist")
+
+    return ok(record), server_version
+
+
 @generate_swagger_docs()
 @action_api.route("/", methods=["POST"])
 @api_login(audit=False, check_xsrf_token=False, required_type=["admin", "automation_basic", "automation_advanced"])

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/remote/datatypes/__init__.py

@@ -7,7 +7,7 @@ import socket
 import time
 from datetime import datetime, timezone
 from pathlib import Path
-from typing import Any
+from typing import Any, Protocol
 
 import redis
 from packaging.version import parse
@@ -29,6 +29,11 @@ if parse(redis.__version__) <= parse("2.10.0"):
 
 APP_NAME = os.environ.get("APP_NAME", "howler")
 
+
+class RedisScriptClient(Protocol):
+    def register_script(self, script: str) -> Any: ...
+
+
 log = logging.getLogger(f"{APP_NAME}.queue")
 pool: dict[tuple[str, str, bool], redis.BlockingConnectionPool] = {}
 

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/remote/datatypes/hash.py

@@ -2,12 +2,12 @@ from __future__ import annotations
 
 import json
 import time
-from typing import TYPE_CHECKING, Any, Generic, Optional, TypeVar
+from typing import TYPE_CHECKING, Any, Generic, Optional, TypeVar, cast
 
 from redis import RedisCluster
 
 from howler.common.exceptions import HowlerValueError
-from howler.remote.datatypes import get_client, retry_call
+from howler.remote.datatypes import RedisScriptClient, get_client, retry_call
 
 if TYPE_CHECKING:
     from redis import Redis
@@ -78,9 +78,9 @@ class Hash(Generic[T]):
     ):
         self.c: Any = get_client(host, port, False)
         self.name = name
-        self._pop = self.c.register_script(h_pop_script)
-        self._limited_add = self.c.register_script(_limited_add)
-        self._conditional_remove = self.c.register_script(_conditional_remove_script)
+        self._pop = cast(RedisScriptClient, self.c).register_script(h_pop_script)
+        self._limited_add = cast(RedisScriptClient, self.c).register_script(_limited_add)
+        self._conditional_remove = cast(RedisScriptClient, self.c).register_script(_conditional_remove_script)
 
     def __iter__(self):
         return HashIterator(self)

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/remote/datatypes/lock.py

@@ -1,6 +1,6 @@
-from typing import Any
+from typing import Any, cast
 
-from howler.remote.datatypes import get_client, retry_call
+from howler.remote.datatypes import RedisScriptClient, get_client, retry_call
 from howler.utils.uid import get_random_id
 
 lock_acquire_script = """
@@ -33,8 +33,8 @@ class Lock(object):
         self.lock_release = "-".join(("lock", str(timeout), name, "released"))
         self.lock_holder = "-".join(("lock", str(timeout), name, "holder"))
         self.timeout = timeout
-        self._acquire = self.c.register_script(lock_acquire_script)
-        self._release = self.c.register_script(lock_release_script)
+        self._acquire = cast(RedisScriptClient, self.c).register_script(lock_acquire_script)
+        self._release = cast(RedisScriptClient, self.c).register_script(lock_release_script)
 
     def __enter__(self):
         while not retry_call(self._acquire, args=[self.lock_holder, self.uuid, self.timeout]):

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/remote/datatypes/queues/priority.py

@@ -2,10 +2,10 @@ from __future__ import annotations
 
 import json
 import time
-from typing import Any, Generic, Optional, TypeVar, Union
+from typing import Any, Generic, Optional, TypeVar, Union, cast
 
 from howler.common.exceptions import HowlerTypeError
-from howler.remote.datatypes import decode, get_client, retry_call
+from howler.remote.datatypes import RedisScriptClient, decode, get_client, retry_call
 
 SORTING_KEY_LEN = 21
 
@@ -37,7 +37,7 @@ T = TypeVar("T")
 class PriorityQueue(Generic[T]):
     def __init__(self, name, host=None, port=None, private=False):
         self.c: Any = get_client(host, port, private)
-        self._deque_range = self.c.register_script(pq_dequeue_range_script)
+        self._deque_range = cast(RedisScriptClient, self.c).register_script(pq_dequeue_range_script)
         self.name = name
 
     def __enter__(self):

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/remote/datatypes/set.py

@@ -1,8 +1,8 @@
 import json
 import time
-from typing import Any
+from typing import Any, cast
 
-from howler.remote.datatypes import get_client, retry_call
+from howler.remote.datatypes import RedisScriptClient, get_client, retry_call
 
 _drop_card_script = """
 local set_name = ARGV[1]
@@ -29,8 +29,8 @@ class Set(object):
     def __init__(self, name, host=None, port=None):
         self.c: Any = get_client(host, port, False)
         self.name = name
-        self._drop_card = self.c.register_script(_drop_card_script)
-        self._limited_add = self.c.register_script(_limited_add)
+        self._drop_card = cast(RedisScriptClient, self.c).register_script(_drop_card_script)
+        self._limited_add = cast(RedisScriptClient, self.c).register_script(_limited_add)
 
     def __enter__(self):
         return self

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/remote/datatypes/user_quota_tracker.py

@@ -1,8 +1,8 @@
-from typing import Any
+from typing import Any, cast
 
 from redis.exceptions import ResponseError
 
-from howler.remote.datatypes import get_client, retry_call
+from howler.remote.datatypes import RedisScriptClient, get_client, retry_call
 
 begin_script = """
 local t = redis.call('time')
@@ -25,7 +25,7 @@ end
 class UserQuotaTracker(object):
     def __init__(self, prefix, timeout=120, redis=None, host=None, port=None, private=False):
         self.c: Any = redis or get_client(host, port, private)
-        self.bs = self.c.register_script(begin_script)
+        self.bs = cast(RedisScriptClient, self.c).register_script(begin_script)
         self.prefix = prefix
         self.timeout = timeout
 

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/howler/services/action_service.py

@@ -1,7 +1,7 @@
 import json
 from collections import defaultdict
 from importlib.util import find_spec
-from typing import Any, Optional, TypedDict
+from typing import Any, Literal, Optional, TypedDict, overload
 
 from cryptography.exceptions import InvalidTag
 from flask import Response, has_request_context, request
@@ -35,6 +35,41 @@ class TriggeredAction(TypedDict):
 _action_queues: dict[str, NamedQueue[TriggeredAction]] = {}
 
 
+@overload
+def get_action(
+    id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None
+) -> tuple[Action, str]: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[True], version: Literal[False]) -> Action: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[True]) -> Action: ...
+
+
+@overload
+def get_action(id: str) -> Action: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+
+
+@overload
+def get_action(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+
+
+def get_action(id: str, as_odm=False, version=False, user: User | None = None):
+    """Retrieve an action from the datastore as an ODM object or dictionary."""
+    return datastore().action.get_if_exists(key=id, as_obj=as_odm, version=version)
+
+
 def _is_builtin_operation(operation_id: str) -> bool:
     """Return whether an operation is implemented by Howler's built-in actions package."""
     return find_spec(f"howler.actions.{operation_id}") is not None

{howler_api-4.1.0.dev1573 → howler_api-4.1.0.dev1582}/pyproject.toml

@@ -152,7 +152,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "4.1.0.dev1573"
+version = "4.1.0.dev1582"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",