dwilson-request-auth-client 0.1.0__tar.gz

dwilson_request_auth_client-0.1.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: dwilson-request-auth-client
+Version: 0.1.0
+Summary: Python client for the Request Authorization gRPC service
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio>=1.64.0
+Requires-Dist: protobuf>=5.0.0
+
+# request-auth-client
+
+Python client for the Request Authorization gRPC permit service.
+
+## Installation
+
+Install from the local package directory:
+
+```bash
+pip install ./client
+```
+
+Or from PyPI:
+
+```bash
+pip install dwilson-request-auth-client
+```
+
+**Requires:** Python 3.11+, `grpcio>=1.64.0`, `protobuf>=5.0.0`
+
+---
+
+## Quick start
+
+```python
+from request_auth_client import RequestAuthClient
+
+client = RequestAuthClient("localhost:9000")
+
+try:
+    with client.acquire("example.com") as permit:
+        # run request here
+        permit.set_status(200)
+finally:
+    client.close()
+```
+
+### Explicit release
+
+```python
+permit = client.acquire("example.com")
+try:
+    # run request here
+    permit.release(200)
+except Exception:
+    permit.release(0)
+```

dwilson_request_auth_client-0.1.0/dwilson_request_auth_client.egg-info/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: dwilson-request-auth-client
+Version: 0.1.0
+Summary: Python client for the Request Authorization gRPC service
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio>=1.64.0
+Requires-Dist: protobuf>=5.0.0
+
+# request-auth-client
+
+Python client for the Request Authorization gRPC permit service.
+
+## Installation
+
+Install from the local package directory:
+
+```bash
+pip install ./client
+```
+
+Or from PyPI:
+
+```bash
+pip install dwilson-request-auth-client
+```
+
+**Requires:** Python 3.11+, `grpcio>=1.64.0`, `protobuf>=5.0.0`
+
+---
+
+## Quick start
+
+```python
+from request_auth_client import RequestAuthClient
+
+client = RequestAuthClient("localhost:9000")
+
+try:
+    with client.acquire("example.com") as permit:
+        # run request here
+        permit.set_status(200)
+finally:
+    client.close()
+```
+
+### Explicit release
+
+```python
+permit = client.acquire("example.com")
+try:
+    # run request here
+    permit.release(200)
+except Exception:
+    permit.release(0)
+```

dwilson_request_auth_client-0.1.0/dwilson_request_auth_client.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+pyproject.toml
+readme.md
+request_auth_client.py
+dwilson_request_auth_client.egg-info/PKG-INFO
+dwilson_request_auth_client.egg-info/SOURCES.txt
+dwilson_request_auth_client.egg-info/dependency_links.txt
+dwilson_request_auth_client.egg-info/requires.txt
+dwilson_request_auth_client.egg-info/top_level.txt
+proto/__init__.py
+proto/permit_pb2.py
+proto/permit_pb2_grpc.py
+tests/test_request_auth_client.py

dwilson_request_auth_client-0.1.0/dwilson_request_auth_client.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dwilson_request_auth_client-0.1.0/dwilson_request_auth_client.egg-info/requires.txt

@@ -0,0 +1,2 @@
+grpcio>=1.64.0
+protobuf>=5.0.0

dwilson_request_auth_client-0.1.0/dwilson_request_auth_client.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+proto
+request_auth_client

dwilson_request_auth_client-0.1.0/proto/permit_pb2.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: permit.proto
+# Protobuf Python Version: 6.31.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    31,
+    1,
+    '',
+    'permit.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0cpermit.proto\x12\x06permit\"i\n\rClientMessage\x12(\n\x07request\x18\x01 \x01(\x0b\x32\x15.permit.PermitRequestH\x00\x12#\n\x03ret\x18\x02 \x01(\x0b\x32\x14.permit.PermitReturnH\x00\x42\t\n\x07payload\"f\n\rServerMessage\x12$\n\x05grant\x18\x01 \x01(\x0b\x32\x13.permit.PermitGrantH\x00\x12$\n\x05\x65rror\x18\x02 \x01(\x0b\x32\x13.permit.ServerErrorH\x00\x42\t\n\x07payload\"/\n\rPermitRequest\x12\x0e\n\x06\x64omain\x18\x01 \x01(\t\x12\x0e\n\x06req_id\x18\x02 \x01(\x03\"@\n\x0bPermitGrant\x12\x11\n\tpermit_id\x18\x01 \x01(\t\x12\x0e\n\x06req_id\x18\x02 \x01(\x03\x12\x0e\n\x06ttl_ms\x18\x03 \x01(\x05\"6\n\x0cPermitReturn\x12\x11\n\tpermit_id\x18\x01 \x01(\t\x12\x13\n\x0bstatus_code\x18\x02 \x01(\x05\".\n\x0bServerError\x12\x0e\n\x06req_id\x18\x01 \x01(\x03\x12\x0f\n\x07message\x18\x02 \x01(\t2Q\n\rPermitService\x12@\n\x0cPermitStream\x12\x15.permit.ClientMessage\x1a\x15.permit.ServerMessage(\x01\x30\x01\x42\'Z%github.com/dwilson/request-auth/protob\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'permit_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'Z%github.com/dwilson/request-auth/proto'
+  _globals['_CLIENTMESSAGE']._serialized_start=24
+  _globals['_CLIENTMESSAGE']._serialized_end=129
+  _globals['_SERVERMESSAGE']._serialized_start=131
+  _globals['_SERVERMESSAGE']._serialized_end=233
+  _globals['_PERMITREQUEST']._serialized_start=235
+  _globals['_PERMITREQUEST']._serialized_end=282
+  _globals['_PERMITGRANT']._serialized_start=284
+  _globals['_PERMITGRANT']._serialized_end=348
+  _globals['_PERMITRETURN']._serialized_start=350
+  _globals['_PERMITRETURN']._serialized_end=404
+  _globals['_SERVERERROR']._serialized_start=406
+  _globals['_SERVERERROR']._serialized_end=452
+  _globals['_PERMITSERVICE']._serialized_start=454
+  _globals['_PERMITSERVICE']._serialized_end=535
+# @@protoc_insertion_point(module_scope)

dwilson_request_auth_client-0.1.0/proto/permit_pb2_grpc.py

@@ -0,0 +1,97 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+import permit_pb2 as permit__pb2
+
+GRPC_GENERATED_VERSION = '1.80.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + ' but the generated code in permit_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class PermitServiceStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.PermitStream = channel.stream_stream(
+                '/permit.PermitService/PermitStream',
+                request_serializer=permit__pb2.ClientMessage.SerializeToString,
+                response_deserializer=permit__pb2.ServerMessage.FromString,
+                _registered_method=True)
+
+
+class PermitServiceServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def PermitStream(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_PermitServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'PermitStream': grpc.stream_stream_rpc_method_handler(
+                    servicer.PermitStream,
+                    request_deserializer=permit__pb2.ClientMessage.FromString,
+                    response_serializer=permit__pb2.ServerMessage.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'permit.PermitService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('permit.PermitService', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class PermitService(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def PermitStream(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            '/permit.PermitService/PermitStream',
+            permit__pb2.ClientMessage.SerializeToString,
+            permit__pb2.ServerMessage.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

dwilson_request_auth_client-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dwilson-request-auth-client"
+version = "0.1.0"
+description = "Python client for the Request Authorization gRPC service"
+readme = "readme.md"
+requires-python = ">=3.11"
+dependencies = [
+    "grpcio>=1.64.0",
+    "protobuf>=5.0.0",
+]
+
+[tool.setuptools]
+py-modules = ["request_auth_client"]
+
+[tool.setuptools.packages.find]
+include = ["proto", "proto.*"]

dwilson_request_auth_client-0.1.0/readme.md

@@ -0,0 +1,47 @@
+# request-auth-client
+
+Python client for the Request Authorization gRPC permit service.
+
+## Installation
+
+Install from the local package directory:
+
+```bash
+pip install ./client
+```
+
+Or from PyPI:
+
+```bash
+pip install dwilson-request-auth-client
+```
+
+**Requires:** Python 3.11+, `grpcio>=1.64.0`, `protobuf>=5.0.0`
+
+---
+
+## Quick start
+
+```python
+from request_auth_client import RequestAuthClient
+
+client = RequestAuthClient("localhost:9000")
+
+try:
+    with client.acquire("example.com") as permit:
+        # run request here
+        permit.set_status(200)
+finally:
+    client.close()
+```
+
+### Explicit release
+
+```python
+permit = client.acquire("example.com")
+try:
+    # run request here
+    permit.release(200)
+except Exception:
+    permit.release(0)
+```

dwilson_request_auth_client-0.1.0/request_auth_client.py

@@ -0,0 +1,164 @@
+"""
+Sync Python client for the Request Authorization gRPC service.
+
+Usage::
+
+    from request_auth_client import RequestAuthClient
+
+    client = RequestAuthClient("localhost:9000")
+
+    # Explicit release
+    permit = client.acquire("rockauto.com")
+    try:
+        response = requests.get(url)
+        permit.release(response.status_code)
+    except Exception:
+        permit.release(0)
+
+    # Context manager (preferred — auto-releases with status 0 on exception)
+    with client.acquire("rockauto.com") as permit:
+        response = requests.get(url)
+        permit.set_status(response.status_code)
+"""
+
+import queue
+import threading
+from typing import Optional
+
+import grpc
+
+import sys
+import os
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "proto"))
+
+from proto import permit_pb2, permit_pb2_grpc  # noqa: E402
+
+
+class RequestAuthClient:
+    """Manages one gRPC bidirectional stream to the permit server.
+
+    Thread-safe. Multiple threads can call acquire() concurrently;
+    each blocks independently until the server issues a grant.
+    """
+
+    def __init__(self, address: str, insecure: bool = True) -> None:
+        self._address = address
+        if insecure:
+            self._channel = grpc.insecure_channel(address)
+        else:
+            self._channel = grpc.secure_channel(address, grpc.ssl_channel_credentials())
+        self._stub = permit_pb2_grpc.PermitServiceStub(self._channel)
+
+        self._lock = threading.Lock()
+        self._req_id = 0
+        self._pending: dict[int, queue.Queue] = {}
+        self._send_q: queue.Queue = queue.Queue()
+        self._stopped = threading.Event()
+        self._connect()
+
+    # ------------------------------------------------------------------
+    # Public API
+    # ------------------------------------------------------------------
+
+    def acquire(self, domain: str) -> "Permit":
+        """Block until the server grants a permit for domain."""
+        with self._lock:
+            self._req_id += 1
+            req_id = self._req_id
+            result_q: queue.Queue = queue.Queue()
+            self._pending[req_id] = result_q
+
+        self._send_q.put(permit_pb2.ClientMessage(
+            request=permit_pb2.PermitRequest(domain=domain, req_id=req_id)
+        ))
+
+        kind, payload = result_q.get()
+        if kind == "error":
+            raise RuntimeError(f"permit acquisition failed for {domain!r}: {payload}")
+        return Permit(permit_id=payload.permit_id, client=self)
+
+    def close(self) -> None:
+        self._stopped.set()
+        self._send_q.put(None)  # unblock the request iterator
+        self._channel.close()
+
+    # ------------------------------------------------------------------
+    # Internal
+    # ------------------------------------------------------------------
+
+    def _release(self, permit_id: str, status_code: int) -> None:
+        self._send_q.put(permit_pb2.ClientMessage(
+            ret=permit_pb2.PermitReturn(permit_id=permit_id, status_code=status_code)
+        ))
+
+    def _connect(self) -> None:
+        self._stream = self._stub.PermitStream(self._request_iter())
+        t = threading.Thread(target=self._recv_loop, daemon=True)
+        t.start()
+
+    def _request_iter(self):
+        while not self._stopped.is_set():
+            try:
+                msg = self._send_q.get(timeout=1.0)
+                if msg is None:
+                    return
+                yield msg
+            except queue.Empty:
+                continue
+
+    def _recv_loop(self) -> None:
+        try:
+            for msg in self._stream:
+                self._recv_loop_step(msg)
+        except grpc.RpcError as e:
+            self._wake_all_pending(str(e))
+
+    def _recv_loop_step(self, msg) -> None:
+        if msg.HasField("grant"):
+            with self._lock:
+                q = self._pending.pop(msg.grant.req_id, None)
+            if q:
+                q.put(("grant", msg.grant))
+        elif msg.HasField("error"):
+            with self._lock:
+                q = self._pending.pop(msg.error.req_id, None)
+            if q:
+                q.put(("error", msg.error.message))
+
+    def _wake_all_pending(self, error_msg: str) -> None:
+        with self._lock:
+            pending = dict(self._pending)
+            self._pending.clear()
+        for q in pending.values():
+            q.put(("error", error_msg))
+
+
+class Permit:
+    """Handle returned by RequestAuthClient.acquire().
+
+    Call release(status_code) when done, or use as a context manager.
+    """
+
+    def __init__(self, permit_id: str, client: RequestAuthClient) -> None:
+        self._permit_id = permit_id
+        self._client = client
+        self._status_code: int = 0
+        self._released = False
+
+    def set_status(self, status_code: int) -> None:
+        """Set the HTTP status code to report when the permit is released."""
+        self._status_code = status_code
+
+    def release(self, status_code: Optional[int] = None) -> None:
+        """Release the permit back to the server."""
+        if self._released:
+            return
+        self._released = True
+        code = status_code if status_code is not None else self._status_code
+        self._client._release(self._permit_id, code)
+
+    def __enter__(self) -> "Permit":
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        self.release()

dwilson_request_auth_client-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dwilson_request_auth_client-0.1.0/tests/test_request_auth_client.py

@@ -0,0 +1,137 @@
+"""Unit tests for RequestAuthClient using a mock gRPC stream."""
+import queue
+import threading
+import unittest
+from unittest.mock import MagicMock, patch
+
+import sys, os
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "proto"))
+
+from proto import permit_pb2
+from request_auth_client import Permit, RequestAuthClient
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+def make_grant(req_id: int, permit_id: str = "test-permit") -> permit_pb2.ServerMessage:
+    return permit_pb2.ServerMessage(
+        grant=permit_pb2.PermitGrant(permit_id=permit_id, req_id=req_id, ttl_ms=1000)
+    )
+
+
+def make_error(req_id: int, msg: str = "boom") -> permit_pb2.ServerMessage:
+    return permit_pb2.ServerMessage(
+        error=permit_pb2.ServerError(req_id=req_id, message=msg)
+    )
+
+
+class FakeStream:
+    """Simulates the server-side of the bidirectional stream."""
+
+    def __init__(self, responses: list):
+        self._responses = iter(responses)
+        self.sent: list[permit_pb2.ClientMessage] = []
+
+    def __iter__(self):
+        return self._responses
+
+    def write(self, msg):
+        self.sent.append(msg)
+
+
+# ---------------------------------------------------------------------------
+# Tests
+# ---------------------------------------------------------------------------
+
+class TestPermit(unittest.TestCase):
+    def _make_permit(self, permit_id="abc"):
+        client = MagicMock()
+        return Permit(permit_id=permit_id, client=client), client
+
+    def test_release_calls_client(self):
+        permit, client = self._make_permit()
+        permit.release(200)
+        client._release.assert_called_once_with("abc", 200)
+
+    def test_release_only_once(self):
+        permit, client = self._make_permit()
+        permit.release(200)
+        permit.release(200)
+        client._release.assert_called_once()
+
+    def test_set_status_used_on_exit(self):
+        permit, client = self._make_permit()
+        permit.set_status(404)
+        permit.__exit__(None, None, None)
+        client._release.assert_called_once_with("abc", 404)
+
+    def test_context_manager_releases_on_exception(self):
+        permit, client = self._make_permit()
+        try:
+            with permit:
+                raise ValueError("oops")
+        except ValueError:
+            pass
+        client._release.assert_called_once_with("abc", 0)
+
+    def test_context_manager_releases_status(self):
+        permit, client = self._make_permit()
+        with permit:
+            permit.set_status(200)
+        client._release.assert_called_once_with("abc", 200)
+
+
+class TestRequestAuthClientRecvLoop(unittest.TestCase):
+    """Test _recv_loop by feeding messages directly into _pending."""
+
+    def _make_client_no_grpc(self):
+        """Create a client without starting a real gRPC connection."""
+        with patch("grpc.insecure_channel"), \
+             patch.object(RequestAuthClient, "_connect"):
+            client = RequestAuthClient("localhost:9000")
+        return client
+
+    def test_grant_unblocks_pending(self):
+        client = self._make_client_no_grpc()
+        result_q: queue.Queue = queue.Queue()
+        client._pending[1] = result_q
+
+        grant_msg = make_grant(req_id=1, permit_id="permit-xyz")
+        client._recv_loop_step(grant_msg)
+
+        kind, payload = result_q.get_nowait()
+        self.assertEqual(kind, "grant")
+        self.assertEqual(payload.permit_id, "permit-xyz")
+
+    def test_error_unblocks_pending(self):
+        client = self._make_client_no_grpc()
+        result_q: queue.Queue = queue.Queue()
+        client._pending[2] = result_q
+
+        err_msg = make_error(req_id=2, msg="unknown domain")
+        client._recv_loop_step(err_msg)
+
+        kind, payload = result_q.get_nowait()
+        self.assertEqual(kind, "error")
+        self.assertIn("unknown domain", payload)
+
+    def test_wake_all_pending_on_disconnect(self):
+        client = self._make_client_no_grpc()
+        q1: queue.Queue = queue.Queue()
+        q2: queue.Queue = queue.Queue()
+        client._pending[1] = q1
+        client._pending[2] = q2
+
+        client._wake_all_pending("stream disconnected")
+
+        for q in (q1, q2):
+            kind, _ = q.get_nowait()
+            self.assertEqual(kind, "error")
+        self.assertEqual(len(client._pending), 0)
+
+
+if __name__ == "__main__":
+    unittest.main()