User-facing test cases and example code

.github/workflows/validate.yml

@@ -0,0 +1,36 @@
+# This workflow will build, test and check linting for the 1Password Python SDK.
+name: Validate
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Test with pytest
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.TEST_SERVICE_ACCOUNT_TOKEN }}
+        run: |
+          pip install pytest &&
+          pip install pytest-asyncio &&
+          python -m pytest src/onepassword/*.py
+
+      - name: Lint with Ruff
+        run: |
+          pip install ruff
+          ruff --output-format=github .
+        continue-on-error: true

src/onepassword/client.py

@@ -1,6 +1,6 @@
-import sys
 import platform
-from core import *
+import weakref
+from core import InitClient, ReleaseClient
 from secrets_api import Secrets
 
 SDK_LANGUAGE = "Python"
@@ -12,22 +12,30 @@
 
 
 class Client:
-    def __init__(self, auth, integration_name, integration_version):
+
+    """authenticate verifies the user's permissions and allows them to access their secrets."""
+    @classmethod
+    async def authenticate(cls, auth, integration_name, integration_version):
+        self = cls()
         self.config = new_default_config(auth=auth, integration_name=integration_name, integration_version=integration_version)
-        self.secrets = Secrets(client_id=InitClient(self.config))
+        self.client_id = int(await InitClient(self.config))
+        self.secrets = Secrets(client_id=self.client_id)
+        self._finalizer = weakref.finalize(self, ReleaseClient, self.client_id)
 
+        return self
 
+# Generates a configuration dictionary with the user's parameters
 def new_default_config(auth, integration_name, integration_version):
     client_config_dict = {
-        "SAToken": auth,
-        "Language": SDK_LANGUAGE,
-        "SDKVersion": SDK_VERSION,
-        "IntegrationName": integration_name,
-        "IntegrationVersion": integration_version,
-        "RequestLibraryName": DEFAULT_REQUEST_LIBRARY,
-        "RequestLibraryVersion": sys.version_info[0] + "." + sys.version_info[1] + "." + sys.version_info[2],
-        "SystemOS": platform.system(),
-        "SystemOSVersion": platform.architecture()[0],
-        "SystemArch": DEFAULT_OS_VERSION,
+        "serviceAccountToken": auth,
+        "programmingLanguage": SDK_LANGUAGE,
+        "sdkVersion": SDK_VERSION,
+        "integrationName": integration_name,
+        "integrationVersion": integration_version,
+        "requestLibraryName": DEFAULT_REQUEST_LIBRARY,
+        "requestLibraryVersion": platform.python_version(),
+        "os": platform.system().lower(),
+        "osVersion": DEFAULT_OS_VERSION,
+        "architecture": platform.machine(),
     }
     return client_config_dict

src/onepassword/core.py

@@ -1,22 +1,14 @@
-# omitting op_sdk_core_py.so import and shared library calls for the time being
-# should be added back when we start work on the core
-
-#import op_sdk_core_py
 import json
+import op_uniffi_core as op_uniffi_core
 
+# InitClient creates a client instance in the current core module and returns its unique ID.
+async def InitClient(client_config):
+    return await op_uniffi_core.init_client(json.dumps(client_config))
 
-def Invoke(invoke_config):
-    serialized_config = json.dump(invoke_config)
-    #secret = op_sdk_core_py.invoke(serialized_config)
-    #return secret
-
-
-def InitClient(client_config):
-    serialized_config = json.dump(client_config)
-    #client_id = op_sdk_core_py.init_client(serialized_config)
-    #return client_id
-
+# Invoke calls specified business logic from core.
+async def Invoke(invoke_config):
+    return await op_uniffi_core.invoke(json.dumps(invoke_config))
 
+# ReleaseClient releases memory in the core associated with the given client ID.
 def ReleaseClient(client_id):
-    #op_sdk_core_py.release_client(client_id)
-    pass
+    return op_uniffi_core.release_client(json.dumps(client_id))

src/onepassword/example.py

@@ -0,0 +1,17 @@
+import asyncio
+import os
+from onepassword.client import Client, DEFAULT_INTEGRATION_NAME, DEFAULT_INTEGRATION_VERSION
+
+async def main():
+    # Your service account token here
+    token = os.environ("OP_SERVICE_ACCOUNT_TOKEN")
+
+    # Connect to 1Password
+    client = await Client.authenticate(auth=token, integration_name=DEFAULT_INTEGRATION_NAME, integration_version=DEFAULT_INTEGRATION_VERSION)
+
+   # Retrieve secret from 1Password
+    value = await client.secrets.resolve("op://xw33qlvug6moegr3wkk5zkenoa/bckakdku7bgbnyxvqbkpehifki/foobar")
+    print(value)
+
+if __name__ == '__main__':
+    asyncio.run(main())