Restructure project and add v0 of setup.py

.github/workflows/validate.yml

@@ -27,7 +27,7 @@ jobs:
         run: |
           pip install pytest &&
           pip install pytest-asyncio &&
-          python -m pytest src/onepassword/*.py
+          python -m pytest onepassword/*.py
 
       - name: Lint with Ruff
         run: |

.gitignore

@@ -0,0 +1,5 @@
+.pytest_cache
+.idea
+*__pycache__
+.dist
+.onepassword.egg-info

src/onepassword/example.py → example.py

@@ -4,13 +4,13 @@
 
 async def main():
     # Your service account token here
-    token = os.environ("OP_SERVICE_ACCOUNT_TOKEN")
+    token = os.getenv("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://Test Login/test_username")
+    value = await client.secrets.resolve("op://Russian Blue Vault/hers/department")
     print(value)
 
 if __name__ == '__main__':

src/onepassword/client.py → onepassword/client.py

@@ -1,14 +1,14 @@
 import sys
 import platform
-from src.onepassword.core import InitClient, ReleaseClient
-from src.onepassword.secrets_api import Secrets
+from onepassword.core import _init_client, _release_client
+from onepassword.secrets_api import Secrets
 import weakref
 
-SDK_LANGUAGE = "Go"
+SDK_LANGUAGE = "Python"
 SDK_VERSION = "0010001"  # v0.1.0
 DEFAULT_INTEGRATION_NAME = "Unknown"
 DEFAULT_INTEGRATION_VERSION = "Unknown"
-DEFAULT_REQUEST_LIBRARY = "net/http"
+DEFAULT_REQUEST_LIBRARY = "Reqwest"
 DEFAULT_OS_VERSION = "0.0.0"
 
 
@@ -18,10 +18,10 @@ class Client:
     @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.client_id = int(await InitClient(self.config))
-        self.secrets = Secrets(client_id=self.client_id)
-        self._finalizer = weakref.finalize(self, ReleaseClient, self.client_id)
+        config = new_default_config(auth=auth, integration_name=integration_name, integration_version=integration_version)
+        client_id = int(await _init_client(config))
+        self.secrets = Secrets(client_id)
+        self._finalizer = weakref.finalize(self, _release_client, client_id)
 
         return self
 
@@ -35,8 +35,8 @@ def new_default_config(auth, integration_name, integration_version):
         "integrationVersion": integration_version,
         "requestLibraryName": DEFAULT_REQUEST_LIBRARY,
         "requestLibraryVersion": str(sys.version_info[0]) + "." + str(sys.version_info[1]) + "." + str(sys.version_info[2]),
-        "os": platform.system(),
+        "os": platform.system().lower(),
         "osVersion": DEFAULT_OS_VERSION,
-        "architecture": platform.architecture()[0],
+        "architecture": platform.machine(),
     }
     return client_config_dict

onepassword/core.py

@@ -0,0 +1,14 @@
+import json
+import onepassword.op_uniffi_core as core
+
+# InitClient creates a client instance in the current core module and returns its unique ID.
+async def _init_client(client_config):
+    return await core.init_client(json.dumps(client_config))
+
+# Invoke calls specified business logic from core.
+async def _invoke(invoke_config):
+    return await core.invoke(json.dumps(invoke_config))
+
+# ReleaseClient releases memory in the core associated with the given client ID.
+def _release_client(client_id):
+    return core.release_client(json.dumps(client_id))

src/onepassword/secrets_api.py → onepassword/secrets_api.py

@@ -1,4 +1,4 @@
-from src.onepassword.core import Invoke
+from onepassword.core import _invoke
 
 """Secrets represents all operations the SDK client can perform on 1Password secrets."""
 class Secrets:
@@ -7,7 +7,7 @@ def __init__(self, client_id):
 
     """resolve returns the secret the provided reference points to."""
     async def resolve(self, reference):
-        response = await Invoke({
+        response = await _invoke({
             "clientId": self.client_id,
             "invocation": {
                 "name": "Resolve",

onepassword/test_client.py

@@ -0,0 +1,68 @@
+import sys
+from onepassword.client import Client, new_default_config, DEFAULT_INTEGRATION_NAME, DEFAULT_INTEGRATION_VERSION, SDK_LANGUAGE, SDK_VERSION, DEFAULT_OS_VERSION, DEFAULT_REQUEST_LIBRARY
+import os
+import platform
+import pytest
+
+TOKEN = os.getenv('OP_SERVICE_ACCOUNT_TOKEN')
+
+## test resolve function
+
+# valid
+@pytest.mark.asyncio
+async def test_valid_resolve():
+    client = await Client.authenticate(auth=TOKEN, integration_name=DEFAULT_INTEGRATION_NAME, integration_version=DEFAULT_INTEGRATION_VERSION)
+    result = await client.secrets.resolve(reference="op://gowwbvgow7kxocrfmfvtwni6vi/6ydrn7ne6mwnqc2prsbqx4i4aq/password")
+    assert(result == "test_password_42")
+
+# invalid
+@pytest.mark.asyncio
+async def test_invalid_resolve():
+    client = await Client.authenticate(auth=TOKEN, integration_name=DEFAULT_INTEGRATION_NAME, integration_version=DEFAULT_INTEGRATION_VERSION)
+    with pytest.raises(Exception, match="error resolving secret reference: secret reference is not prefixed with \"op://\""):
+        await client.secrets.resolve(reference="invalid_reference")
+
+## test client constructor
+
+# valid
+@pytest.mark.asyncio
+async def test_good_client_construction():
+    client = await Client.authenticate(auth=TOKEN, integration_name=DEFAULT_INTEGRATION_NAME, integration_version=DEFAULT_INTEGRATION_VERSION)
+    assert(client.config['serviceAccountToken'] == TOKEN)
+    assert(client.config['integrationName'] == DEFAULT_INTEGRATION_NAME)
+    assert(client.config['integrationVersion'] == DEFAULT_INTEGRATION_VERSION)
+
+# invalid
+@pytest.mark.asyncio
+async def test_client_construction_no_auth():
+    with pytest.raises(Exception, match='invalid client configuration: encountered the following errors: service account token was not specified; service account token had invalid format'):
+        await Client.authenticate(auth="", integration_name=DEFAULT_INTEGRATION_NAME, integration_version=DEFAULT_INTEGRATION_VERSION)
+
+# invalid   
+@pytest.mark.asyncio
+async def test_client_construction_no_name():
+    with pytest.raises(Exception, match='invalid client configuration: encountered the following errors: integration name was not specified'):
+        await Client.authenticate(auth=TOKEN, integration_name="", integration_version=DEFAULT_INTEGRATION_VERSION)
+
+# invalid    
+@pytest.mark.asyncio
+async def test_client_construction_no_version():
+    with pytest.raises(Exception, match='invalid client configuration: encountered the following errors: integration version was not specified'):
+        await Client.authenticate(auth=TOKEN, integration_name=DEFAULT_INTEGRATION_NAME, integration_version="")
+
+## test config function
+
+# valid
+def test_good_new_default_config():
+    config = new_default_config(auth=TOKEN, integration_name=DEFAULT_INTEGRATION_NAME, integration_version=DEFAULT_INTEGRATION_VERSION)
+
+    assert(config["serviceAccountToken"] == TOKEN)
+    assert(config["programmingLanguage"] == SDK_LANGUAGE)
+    assert(config["sdkVersion"] == SDK_VERSION)
+    assert(config["integrationName"] == DEFAULT_INTEGRATION_NAME)
+    assert(config["integrationVersion"] == DEFAULT_INTEGRATION_VERSION)
+    assert(config["requestLibraryName"] == DEFAULT_REQUEST_LIBRARY)
+    assert(config["requestLibraryVersion"] == str(sys.version_info[0]) + "." + str(sys.version_info[1]) + "." + str(sys.version_info[2]))
+    assert(config["os"] == platform.system().lower())
+    assert(config["osVersion"] == DEFAULT_OS_VERSION)
+    assert(config["architecture"] == platform.machine())

setup.py

@@ -0,0 +1,9 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='onepassword',
+    version='0.1.0',
+    packages=find_packages(),
+    author='1Password',
+    url='https://github.com/1Password/onepassword-sdk-python',
+)