Improve PostgrestClient.auth() (#14)

Author: lqmanh

CHANGELOG.md

@@ -1,10 +1,18 @@
-## CHANGELOG
+# CHANGELOG
 
 ### _Unreleased_
 
-#### Added
+#### Features
 
 - Allow setting headers in `PostgrestClient`'s constructor
+- Improve `PostgrestClient.auth()` behavior
+
+#### Internal
+
+- Require Poetry >= 1.0.0
+- Update CI workflow
+- Use Dependabot
+- Update httpx to v0.19.0
 
 ### v0.4.0
 

postgrest_py/client.py

@@ -1,4 +1,4 @@
-from typing import Dict, Union
+from typing import Dict, Optional, Union
 
 from deprecation import deprecated
 from httpx import AsyncClient, BasicAuth, Response
@@ -40,16 +40,25 @@ async def aclose(self) -> None:
 
     def auth(
         self,
-        token: str,
+        token: Optional[str],
         *,
         username: Union[str, bytes, None] = None,
         password: Union[str, bytes] = "",
     ):
-        """Authenticate the client with either bearer token or basic authentication."""
-        if username:
+        """
+        Authenticate the client with either bearer token or basic authentication.
+
+        Raise `ValueError` if neither authentication scheme is provided.
+        Bearer token is preferred if both ones are provided.
+        """
+        if token:
+            self.session.headers["Authorization"] = f"Bearer {token}"
+        elif username:
             self.session.auth = BasicAuth(username, password)
         else:
-            self.session.headers["Authorization"] = f"Bearer {token}"
+            raise ValueError(
+                "Neither bearer token or basic authentication scheme is provided"
+            )
         return self
 
     def schema(self, schema: str):

tests/test_client.py

@@ -1,5 +1,5 @@
 import pytest
-from httpx import BasicAuth
+from httpx import BasicAuth, Headers
 from postgrest_py import PostgrestClient
 
 
@@ -9,33 +9,54 @@ async def postgrest_client():
         yield client
 
 
-@pytest.mark.asyncio
-def test_constructor(postgrest_client):
-    session = postgrest_client.session
+class TestConstructor:
+    @pytest.mark.asyncio
+    def test_simple(self, postgrest_client: PostgrestClient):
+        session = postgrest_client.session
 
-    assert session.base_url == "https://example.com"
-    default_headers = {
-        "accept": "application/json",
-        "content-type": "application/json",
-        "accept-profile": "public",
-        "content-profile": "public",
-    }
-    assert default_headers.items() <= session.headers.items()
+        assert session.base_url == "https://example.com"
+        headers = Headers(
+            {
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "Accept-Profile": "public",
+                "Content-Profile": "public",
+            }
+        )
+        assert session.headers.items() >= headers.items()
+
+    @pytest.mark.asyncio
+    async def test_custom_headers(self):
+        async with PostgrestClient(
+            "https://example.com", schema="pub", headers={"Custom-Header": "value"}
+        ) as client:
+            session = client.session
+
+            assert session.base_url == "https://example.com"
+            headers = Headers(
+                {
+                    "Accept-Profile": "pub",
+                    "Content-Profile": "pub",
+                    "Custom-Header": "value",
+                }
+            )
+            assert session.headers.items() >= headers.items()
 
 
 class TestAuth:
     @pytest.mark.asyncio
-    def test_auth_token(self, postgrest_client):
+    def test_auth_token(self, postgrest_client: PostgrestClient):
         postgrest_client.auth("s3cr3t")
         session = postgrest_client.session
 
         assert session.headers["Authorization"] == "Bearer s3cr3t"
 
     @pytest.mark.asyncio
-    def test_auth_basic(self, postgrest_client):
+    def test_auth_basic(self, postgrest_client: PostgrestClient):
         postgrest_client.auth(None, username="admin", password="s3cr3t")
         session = postgrest_client.session
 
+        assert isinstance(session.auth, BasicAuth)
         assert session.auth._auth_header == BasicAuth("admin", "s3cr3t")._auth_header