Merge pull request #2 from VH-Lab/port-ndi-cloud-deps-7399676479706870165

Update dependencies and port ndi.cloud routines

Author: stevevanhooser

DID-python

@@ -1 +1 @@
-Subproject commit 4abb259695485a1ab27854e7d95d9e07e9a01a6f
+Subproject commit 97ba45ccd02a8d8070395a48e5a80e691414253a

NDI-compress-python

@@ -0,0 +1 @@
+Subproject commit 0c05d9dbd63ed5d15866eb1bf0a096568ef0c192

NDI-matlab

@@ -1 +1 @@
-Subproject commit 9b3518cb354c975bc9860ac09d3d9f93c85d5d4d
+Subproject commit fc99679a3572881a56c5ae4738bbdaab73fb46fb

README.md

@@ -4,12 +4,18 @@ A Python port of VH-Lab/NDI-matlab.
 
 ## Installation
 
-To install the package, you can use pip:
+To install the package, run the following command in the root directory. **Note the dot `.` at the end**, which tells pip to install from the current directory. This will automatically install all required dependencies (including `did`, `ndi-compress`, etc.):
 
 ```bash
 pip install .
 ```
 
+If you are installing for development (editable mode), use the `-e` flag (again, **note the dot `.` at the end**):
+
+```bash
+pip install -e .
+```
+
 ## Usage
 
 ```python
@@ -29,7 +35,7 @@ source venv/bin/activate
 
 ### Dependency Installation
 
-Then, install the dependencies:
+Install the package in editable mode, which will also install all dependencies:
 
 ```bash
 pip install -e .

pyproject.toml

@@ -17,10 +17,12 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "did @ file:///app/DID-python",
+    "did @ git+https://github.com/VH-Lab/DID-python.git@main",
     "mkdocs",
     "pandas",
     "requests",
+    "ndi-compress @ git+https://github.com/Waltham-Data-Science/NDI-compress-python",
+    "vhlab-newstim @ git+https://github.com/VH-Lab/vhlab-NewStim-python",
 ]
 
 [project.urls]

src/ndi/cloud/__init__.py

@@ -0,0 +1,2 @@
+from .authenticate import authenticate
+from .logout import logout

src/ndi/cloud/api/datasets/create_dataset.py

@@ -0,0 +1,15 @@
+from ..implementation.datasets.create_dataset import CreateDataset as CreateDatasetImpl
+
+def create_dataset(dataset_info, organization_id=None):
+    """
+    User-facing wrapper to create a dataset.
+
+    Args:
+        dataset_info (dict): The dataset information.
+        organization_id (str, optional): Organization ID.
+
+    Returns:
+        tuple: (success, answer, response, url)
+    """
+    api_call = CreateDatasetImpl(dataset_info, organization_id)
+    return api_call.execute()

src/ndi/cloud/api/implementation/datasets/create_dataset.py

@@ -0,0 +1,55 @@
+from ...call import Call
+from ... import url
+from ....authenticate import authenticate
+import requests
+import json
+import os
+
+class CreateDataset(Call):
+    """
+    Implementation class for creating a new dataset.
+    """
+
+    def __init__(self, dataset_info, organization_id=None):
+        """
+        Creates a new CreateDataset API call object.
+
+        Args:
+            dataset_info (dict): The dataset information to create.
+            organization_id (str, optional): The ID of the organization.
+        """
+        self.dataset_info = dataset_info
+        self.organization_id = organization_id
+        self.endpoint_name = 'create_dataset'
+
+    def execute(self):
+        """
+        Performs the API call to create a dataset.
+        """
+        token = authenticate()
+
+        organization_id = self.organization_id
+        if organization_id is None:
+            organization_id = os.getenv('NDI_CLOUD_ORGANIZATION_ID')
+
+        if organization_id is None:
+            raise ValueError("Organization ID must be provided or set as an environment variable.")
+
+        api_url = url.get_url(self.endpoint_name, organization_id=organization_id)
+
+        headers = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': f'Bearer {token}'
+        }
+
+        response = requests.post(api_url, headers=headers, json=self.dataset_info)
+
+        if response.status_code in [200, 201]:
+            return True, response.json(), response, api_url
+        else:
+            try:
+                answer = response.json()
+            except json.JSONDecodeError:
+                answer = response.text
+            return False, answer, response, api_url

src/ndi/cloud/api/implementation/datasets/list_datasets.py

@@ -1,6 +1,6 @@
 from ...call import Call
 from ... import url
-from .... import authenticate
+from ....authenticate import authenticate
 import requests
 import json
 import os

src/ndi/cloud/authenticate.py

@@ -1,7 +1,110 @@
-def authenticate():
+import os
+import getpass
+from .internal import token_utils
+from .api.auth import login as auth_login
+
+def authenticate(username=None, interaction_enabled=True):
     """
-    Returns the authentication token for the current user.
+    Authenticates using secret, environment variables or prompt.
+
+    Args:
+        username (str, optional): Username to use for login.
+        interaction_enabled (bool, optional): Whether interactive steps are enabled.
 
-    This is a placeholder implementation.
+    Returns:
+        str: The authentication token.
     """
-    return "dummy_token"
+
+    # Check if already authenticated
+    if is_authenticated(username):
+        token, _ = token_utils.get_active_token()
+        return token
+
+    # Check environment variables
+    if authenticated_with_environment_variable(username):
+         token, _ = token_utils.get_active_token()
+         return token
+
+    # Prompt user
+    if interaction_enabled:
+        if prompt_login(username):
+             token, _ = token_utils.get_active_token()
+             return token
+
+    # If we get here, authentication failed or was skipped
+    # Matlab doesn't return anything or returns existing token (which might be empty/invalid?)
+    # But here we want to return a valid token or raise error?
+    # Matlab returns token found at the end.
+
+    token, _ = token_utils.get_active_token()
+    if not token:
+        # If no token, maybe we should raise an error if interaction was enabled but failed?
+        # Or just return None/empty string?
+        # Matlab doesn't explicitly raise error in the main function, but prompt might.
+        pass
+
+    return token
+
+def is_authenticated(username=None):
+    token, _ = token_utils.get_active_token()
+    if not token:
+        return False
+
+    if username:
+        decoded_token = token_utils.decode_jwt(token)
+        if decoded_token.get('email') != username:
+            return False
+
+    return True
+
+def authenticated_with_environment_variable(requested_username=None):
+    username = os.environ.get("NDI_CLOUD_USERNAME")
+    password = os.environ.get("NDI_CLOUD_PASSWORD")
+
+    if username and password:
+        if requested_username and username != requested_username:
+            return False
+        return perform_login(username, password)
+    return False
+
+def prompt_login(username=None):
+    if not username:
+        username = input("Enter NDI Cloud Email: ")
+
+    password = getpass.getpass(f"Enter Password for {username}: ")
+
+    return perform_login(username, password)
+
+def perform_login(username, password):
+    success, answer, response, _ = auth_login.login(username, password)
+
+    if success:
+        token = answer.get('token')
+        # Handle organizations. Structure might be user -> organizations -> id?
+        # Matlab: answer.user.organizations.id
+        # We need to be careful about structure.
+        # Let's try to find it.
+        user = answer.get('user', {})
+        organizations = user.get('organizations', [])
+        organization_id = ''
+
+        # If organizations is a list, take first? Or checks for specific one?
+        # Matlab code: answer.user.organizations.id. This suggests organizations is a struct (dict), not a list?
+        # Or maybe it is a list of structs and Matlab auto-vectorizes?
+        # But commonly in these APIs it's a list.
+        # If it's a list, we might pick the first one.
+
+        if isinstance(organizations, list) and len(organizations) > 0:
+             organization_id = organizations[0].get('id')
+        elif isinstance(organizations, dict):
+             organization_id = organizations.get('id')
+
+        os.environ['NDI_CLOUD_TOKEN'] = token
+        if organization_id:
+            os.environ['NDI_CLOUD_ORGANIZATION_ID'] = organization_id
+
+        return True
+    else:
+        print(f"Authentication failed: {response.status_code} {response.reason}")
+        # print body?
+        return False