Merge pull request #2 from mattjacksoncello/configclass

Configclass

Author: mattjacksoncello

USAGE.md

@@ -56,7 +56,69 @@ async_client: AsyncClient = new_async_client(
     proxies={"http://": "http://proxy.example.com"})  # Proxy configuration
 ```
 
-Both client types support all [httpx client options](https://www.python-httpx.org/api/#client) through their respective configuration classes.
+## Client Configuration
+
+The SDK provides a `ClientConfig` class that allows you to configure the underlying httpx client. This includes SSL certificate verification and all other httpx client options.
+
+### SSL Certificate Verification
+
+When connecting to a 1Password Connect server using HTTPS, you may need to configure SSL certificate verification:
+
+```python
+from onepasswordconnectsdk.config import ClientConfig
+
+# Verify SSL using a custom CA certificate
+config = ClientConfig(cafile="path/to/ca.pem")
+client = new_client("https://connect.example.com", "your-token", config=config)
+
+# Disable SSL verification (not recommended for production)
+config = ClientConfig(verify=False)
+client = new_client("https://connect.example.com", "your-token", config=config)
+```
+
+### Additional Configuration Options
+
+The ClientConfig class accepts all httpx client options as keyword arguments. These options are passed directly to the underlying httpx client:
+
+```python
+# Configure timeouts and redirects
+config = ClientConfig(
+    cafile="path/to/ca.pem",
+    timeout=30.0,              # 30 second timeout
+    follow_redirects=True,     # Follow HTTP redirects
+    max_redirects=5           # Maximum number of redirects to follow
+)
+
+# Configure proxy settings
+config = ClientConfig(
+    proxies={
+        "http://": "http://proxy.example.com",
+        "https://": "https://proxy.example.com"
+    }
+)
+
+# Configure custom headers
+config = ClientConfig(
+    headers={
+        "User-Agent": "CustomApp/1.0",
+        "X-Custom-Header": "value"
+    }
+)
+```
+
+### Async Client Configuration
+
+The same configuration options work for both synchronous and asynchronous clients:
+
+```python
+config = ClientConfig(
+    cafile="path/to/ca.pem",
+    timeout=30.0
+)
+async_client = new_client("https://connect.example.com", "your-token", is_async=True, config=config)
+```
+
+For a complete list of available configuration options, see the [httpx client documentation](https://www.python-httpx.org/api/#client).
 
 ## Environment Variables
 
@@ -199,6 +261,4 @@ async def main():
         await async_client.session.aclose()
 
 asyncio.run(main())
-```
-
-All the examples shown above for the sync client work the same way with the async client, just with async/await syntax.
+```

example/ca_file_example/list_secrets.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+"""
+Example script demonstrating how to connect to a 1Password Connect server
+using CA certificate verification and list all secrets in a vault.
+
+Shows both synchronous and asynchronous usage.
+Update the configuration variables below with your values.
+"""
+
+import asyncio
+from onepasswordconnectsdk.client import new_client
+from onepasswordconnectsdk.config import ClientConfig
+
+# Configuration
+CONNECT_URL = "https://connect.example.com"  # Your 1Password Connect server URL
+TOKEN = "eyJhbGc..."                         # Your 1Password Connect token
+VAULT_ID = "vaults_abc123"                   # ID of the vault to list secrets from
+CA_FILE = "path/to/ca.pem"                   # Path to your CA certificate file
+
+def list_vault_secrets():
+    """
+    Connect to 1Password Connect server and list all secrets in the specified vault.
+    Uses CA certificate verification for secure connection.
+    """
+    try:
+        # Configure client with CA certificate verification
+        config = ClientConfig(
+            cafile=CA_FILE,
+            timeout=30.0  # 30 second timeout
+        )
+        
+        # Initialize client with configuration
+        client = new_client(CONNECT_URL, TOKEN, config=config)
+        
+        # Get all items in the vault
+        items = client.get_items(VAULT_ID)
+        
+        # Print items
+        print(f"\nSecrets in vault {VAULT_ID}:")
+        print("-" * 40)
+        for item in items:
+            print(f"- {item.title} ({item.category})")
+            
+    except Exception as e:
+        print(f"Error: {str(e)}")
+
+
+async def list_vault_secrets_async():
+    """
+    Async version: Connect to 1Password Connect server and list all secrets in the specified vault.
+    Uses CA certificate verification for secure connection.
+    """
+    try:
+        # Configure client with CA certificate verification
+        config = ClientConfig(
+            cafile=CA_FILE,
+            timeout=30.0  # 30 second timeout
+        )
+        
+        # Initialize async client with configuration
+        client = new_client(CONNECT_URL, TOKEN, is_async=True, config=config)
+        
+        # Get all items in the vault
+        items = await client.get_items(VAULT_ID)
+        
+        # Print items
+        print(f"\nSecrets in vault {VAULT_ID} (async):")
+        print("-" * 40)
+        for item in items:
+            print(f"- {item.title} ({item.category})")
+            
+        # Close the client gracefully
+        await client.session.aclose()
+            
+    except Exception as e:
+        print(f"Error: {str(e)}")
+
+if __name__ == "__main__":
+    # Run sync version
+    print("Running synchronous example...")
+    list_vault_secrets()
+    
+    # Run async version
+    print("\nRunning asynchronous example...")
+    asyncio.run(list_vault_secrets_async())

src/onepasswordconnectsdk/async_client.py

@@ -1,13 +1,14 @@
 """Python AsyncClient for connecting to 1Password Connect"""
 import httpx
 from httpx import HTTPError
-from typing import Dict, List, Union
+from typing import Dict, List, Union, Optional
 import os
 
 from onepasswordconnectsdk.client import ENV_SERVICE_ACCOUNT_JWT_VARIABLE
 from onepasswordconnectsdk.models.constants import CONNECT_HOST_ENV_VARIABLE
 
 from onepasswordconnectsdk.serializer import Serializer
+from onepasswordconnectsdk.config import ClientConfig
 from onepasswordconnectsdk.utils import build_headers, is_valid_uuid, PathBuilder, get_timeout
 from onepasswordconnectsdk.errors import (
     EnvironmentHostNotSetException,
@@ -21,24 +22,22 @@
 class AsyncClient:
     """Python Async Client Class"""
 
-    def __init__(self, config: 'AsyncClientConfig') -> None:
+    def __init__(self, url: str, token: str, config: Optional[ClientConfig] = None) -> None:
         """Initialize async client
         
         Args:
-            config: AsyncClientConfig instance containing all client configuration
+            url (str): The url of the 1Password Connect API
+            token (str): The 1Password Service Account token
+            config (Optional[ClientConfig]): Optional configuration for httpx client
         """
-        self.url = config.url
-        self.token = config.token
-        self.session = self.create_session(config)
+        self.url = url
+        self.token = token
+        self.config = config
+        self.session = self.create_session(url, token)
         self.serializer = Serializer()
 
-    def create_session(self, config: 'AsyncClientConfig') -> httpx.AsyncClient:
-        """Create an HTTP session using the provided configuration"""
-        # Update headers in the existing config
-        headers = config.headers or {}
-        headers.update(self.build_headers(config.token))
-        config.headers = headers
-        return config
+    def create_session(self, url: str, token: str) -> httpx.AsyncClient:
+        return httpx.AsyncClient(base_url=url, headers=self.build_headers(token), timeout=get_timeout())
 
     def build_headers(self, token: str) -> Dict[str, str]:
         return build_headers(token)

src/onepasswordconnectsdk/client.py

@@ -2,9 +2,11 @@
 import httpx
 from httpx import HTTPError, USE_CLIENT_DEFAULT
 import json
-from typing import Dict, List, Union
+from typing import Dict, List, Union, Optional
 import os
 
+from onepasswordconnectsdk.async_client import AsyncClient
+from onepasswordconnectsdk.config import ClientConfig
 from onepasswordconnectsdk.serializer import Serializer
 from onepasswordconnectsdk.utils import build_headers, is_valid_uuid, PathBuilder, get_timeout
 from onepasswordconnectsdk.errors import (
@@ -22,24 +24,15 @@
 class Client:
     """Python Client Class"""
 
-    def __init__(self, config: 'ClientConfig') -> None:
-        """Initialize client
-        
-        Args:
-            config: ClientConfig instance containing all client configuration
-        """
-        self.url = config.url
-        self.token = config.token
-        self.session = self.create_session(config)
+    def __init__(self, url: str, token: str) -> None:
+        """Initialize client"""
+        self.url = url
+        self.token = token
+        self.session = self.create_session(url, token)
         self.serializer = Serializer()
 
-    def create_session(self, config: 'ClientConfig') -> httpx.Client:
-        """Create an HTTP session using the provided configuration"""
-        # Update headers in the existing config
-        headers = config.headers or {}
-        headers.update(self.build_headers(config.token))
-        config.headers = headers
-        return config
+    def create_session(self, url: str, token: str) -> httpx.Client:
+        return httpx.Client(base_url=url, headers=self.build_headers(token), timeout=get_timeout())
 
     def build_headers(self, token: str) -> Dict[str, str]:
         return build_headers(token)
@@ -388,20 +381,19 @@ def sanitize_for_serialization(self, obj):
         return self.serializer.sanitize_for_serialization(obj)
 
 
-def new_client(url: str, token: str, **kwargs) -> Client:
+def new_client(url: str, token: str, is_async: bool = False) -> Union[AsyncClient, Client]:
     """Builds a new client for interacting with 1Password Connect
-    
-    Args:
-        url: The url of the 1Password Connect API
-        token: The 1Password Service Account token
-        **kwargs: Additional httpx.Client configuration options
+    Parameters:
+    url: The url of the 1Password Connect API
+    token: The 1Password Service Account token
+    is_async: Initialize async or sync client
 
     Returns:
-        Client: The 1Password Connect client
+    Client: The 1Password Connect client
     """
-    from onepasswordconnectsdk.config import ClientConfig
-    config = ClientConfig(url=url, token=token, **kwargs)
-    return Client(config)
+    if is_async:
+        return AsyncClient(url, token)
+    return Client(url, token)
 
 
 def new_client_from_environment(url: str = None, **kwargs) -> Client: