willisapi-client 1.6__tar.gz → 1.7__tar.gz

{willisapi_client-1.6 → willisapi_client-1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: willisapi_client
-Version: 1.6
+Version: 1.7
 Summary: A Python client for willisapi
 Home-page: https://github.com/bklynhlth/willsiapi_client
 Author: bklynhlth

{willisapi_client-1.6 → willisapi_client-1.7}/tests/test_auth.py

@@ -1,6 +1,5 @@
 from willisapi_client.services.auth.login_manager import login
 
-from willisapi_client.services.auth.account_manager import account_create
 from unittest.mock import patch
 from datetime import timedelta, datetime
 
@@ -68,60 +67,3 @@ class TestLoginFunction:
         key, expire_in = login(self.username, self.password)
         assert key == None
         assert expire_in == None
-
-    @patch("willisapi_client.services.auth.account_manager.AuthUtils.account_create")
-    def test_create_account_success(self, mocked_create_account):
-        mocked_create_account.return_value = {
-            "status_code": 200,
-            "message": "Account Created Successfully",
-        }
-        result = account_create(
-            self.id_token,
-            self.account,
-        )
-        assert result == "Account Created Successfully"
-
-    @patch("willisapi_client.services.auth.account_manager.AuthUtils.account_create")
-    def test_create_account_failed(self, mocked_create_account):
-        mocked_create_account.return_value = {
-            "status_code": 400,
-            "message": "Validation Error",
-        }
-        result = account_create(
-            self.id_token,
-            self.account,
-        )
-        assert result == "Validation Error"
-
-    @patch("willisapi_client.services.auth.account_manager.AuthUtils.account_create")
-    def test_create_account_failed_for_non_admin_user(self, mocked_create_account):
-        mocked_create_account.return_value = {
-            "status_code": 401,
-            "message": "Not an Admin",
-        }
-        result = account_create(
-            self.id_token,
-            self.account,
-        )
-        assert result == "Not an Admin"
-
-    @patch("willisapi_client.services.auth.account_manager.AuthUtils.account_create")
-    def test_create_account_failed_unexpected(self, mocked_create_account):
-        mocked_create_account.return_value = {
-            "status_code": 500,
-            "message": None,
-        }
-        result = account_create(
-            self.id_token,
-            self.account,
-        )
-        assert result == None
-
-    @patch("willisapi_client.services.auth.account_manager.AuthUtils.account_create")
-    def test_create_account_failed_no_response_from_server(self, mocked_create_account):
-        mocked_create_account.return_value = {}
-        result = account_create(
-            self.id_token,
-            self.account,
-        )
-        assert result == None

{willisapi_client-1.6 → willisapi_client-1.7}/tests/test_download.py

@@ -38,16 +38,23 @@ class TestDownloadFunction:
     def test_download_no_items_from_api(self, mocked_data):
         mocked_data.return_value = {
             "status_code": 200,
-            "items": {},
+            "presigned_url": None,
         }
         data = download(self.key, self.project_name)
         assert data.empty == True
 
     @patch("willisapi_client.services.download.download_utils.DownloadUtils.request")
-    def test_download_success(self, mocked_data):
+    @patch(
+        "willisapi_client.services.download.download_utils.DownloadUtils.get_data_from_presigned_url"
+    )
+    def test_download_success(self, mocked_data, mocked_response):
         with open("tests/test.json") as json_file:
             data = json.load(json_file)
         mocked_data.return_value = data
+        mocked_response.return_value = {
+            "status_code": 200,
+            "presigned_url": "https://google.com",
+        }
         data = download(self.key, self.project_name)
         assert data.empty == False
         assert data.filename.tolist()[0] == "test_video.mp4"

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client/__init__.py

@@ -5,8 +5,6 @@ from willisapi_client.services.api import (
     login,
     upload,
     download,
-    user_permissions,
-    account_create,
 )
 
-__all__ = ["login", "upload", "download", "user_permissions", "account_create"]
+__all__ = ["login", "upload", "download"]

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client/__version__.py

@@ -1,7 +1,7 @@
 """Version details for willisapi_client
 """
 __client__ = "willisapi_client"
-__latestVersion__ = "1.6"
+__latestVersion__ = "1.7"
 __url__ = "https://github.com/bklynhlth/willsiapi_client"
 __short_description__ = "A Python client for willisapi"
 __content_type__ = "text/markdown"

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client/services/api.py

@@ -1,6 +1,6 @@
 # website:   https://www.brooklyn.health
 
 # import the required packages
-from willisapi_client.services.auth import login, user_permissions, account_create
+from willisapi_client.services.auth import login
 from willisapi_client.services.upload import upload
 from willisapi_client.services.download import download

willisapi_client-1.7/willisapi_client/services/auth/__init__.py

@@ -0,0 +1,6 @@
+# website:   https://www.brooklyn.health
+from willisapi_client.services.auth.login_manager import (
+    login,
+)
+
+__all__ = ["login"]

willisapi_client-1.7/willisapi_client/services/auth/auth_utils.py

@@ -0,0 +1,52 @@
+import requests
+import time
+import json
+import random
+
+from willisapi_client.services.exceptions import (
+    UnableToLoginClientError,
+    UnableToCreateAccountError,
+    UnableToUpdatePermissionsClientError,
+)
+
+
+class AuthUtils:
+    @staticmethod
+    def login(url, data, headers, try_number):
+        """
+        ------------------------------------------------------------------------------------------------------
+        Class: AuthUtils
+
+        Function: login
+
+        Description: This function makes a POST API call to the brooklyn.health API server to authenticate a user.
+
+        Parameters:
+        ----------
+        url: The URL of the API endpoint.
+        data: The data to be sent in the request body.
+        headers: The headers to be sent in the request.
+        try_number: The number of times the function has been tried.
+
+        Returns:
+        ----------
+        json: The JSON response from the API server.
+
+        Raises:
+        ----------
+        UnableToLoginClientError: If the function fails to login after 3 tries.
+        ------------------------------------------------------------------------------------------------------
+        """
+        try:
+            response = requests.post(url, json=data, headers=headers)
+            res_json = response.json()
+        except (
+            requests.exceptions.ConnectionError,
+            json.decoder.JSONDecodeError,
+        ) as ex:
+            if try_number == 3:
+                raise UnableToLoginClientError
+            time.sleep(random.random() * 2)
+            return AuthUtils.login(url, data, headers, try_number=try_number + 1)
+        else:
+            return res_json

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client/services/download/download_handler.py

@@ -43,7 +43,8 @@ def download(key: str, project_name: str, **kwargs):
             logger.error("No access to project/data for download.")
         if response["status_code"] == HTTPStatus.OK:
             logger.info(f'{datetime.now().strftime("%H:%M:%S")}: Download Complete')
-            response_df, err = DownloadUtils.generate_response_df(response)
+            data = DownloadUtils.get_data_from_presigned_url(response["presigned_url"])
+            response_df, err = DownloadUtils.generate_response_df(data)
             if not err:
                 return response_df
     return empty_response_df

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client/services/download/download_utils.py

@@ -4,6 +4,8 @@ import time
 import random
 import pandas as pd
 from typing import Tuple
+from http import HTTPStatus
+
 
 vocal_acoustic_summary = "vocal_acoustics_summary"
 speech_characteristics_summary = "speech_characteristics_summary"
@@ -64,8 +66,8 @@ class DownloadUtils:
         ------------------------------------------------------------------------------------------------------
         """
         return (
-            response["items"]["project"]["project_name"],
-            len(response["items"]["project"]["participant"]),
+            response["project"]["project_name"],
+            len(response["project"]["participant"]),
         )
 
     def _get_pt_id_ext_and_num_records(response, pt):
@@ -88,8 +90,8 @@ class DownloadUtils:
         ------------------------------------------------------------------------------------------------------
         """
         return (
-            response["items"]["project"]["participant"][pt]["participant_Id"],
-            len(response["items"]["project"]["participant"][pt]["results"]),
+            response["project"]["participant"][pt]["participant_Id"],
+            len(response["project"]["participant"][pt]["results"]),
         )
 
     def _get_filename_and_timestamp(response, pt, rec):
@@ -113,12 +115,8 @@ class DownloadUtils:
         ------------------------------------------------------------------------------------------------------
         """
         return (
-            response["items"]["project"]["participant"][pt]["results"][rec][
-                "file_name"
-            ],
-            response["items"]["project"]["participant"][pt]["results"][rec][
-                "timestamp"
-            ],
+            response["project"]["participant"][pt]["results"][rec]["file_name"],
+            response["project"]["participant"][pt]["results"][rec]["timestamp"],
         )
 
     def _get_defined_columns():
@@ -158,7 +156,7 @@ class DownloadUtils:
         df: A pandas dataframe of specific workflow tag
         ------------------------------------------------------------------------------------------------------
         """
-        measures_dict = response["items"]["project"]["participant"][pt]["results"][rec][
+        measures_dict = response["project"]["participant"][pt]["results"][rec][
             "measures"
         ]
         if (
@@ -174,7 +172,35 @@ class DownloadUtils:
             return pd.read_json(json.dumps(measures_dict[workflow_tag][0]))
         return pd.DataFrame()
 
-    def generate_response_df(response) -> Tuple[pd.DataFrame, str]:
+    def get_data_from_presigned_url(url: str):
+        """
+        ------------------------------------------------------------------------------------------------------
+        Class: DownloadUtils
+
+        Function: get_data_from_presigned_url
+
+        Description: This function downloads the json data using S3 preisgned URL
+
+        Parameters:
+        ----------
+        response: S3 Presigned URL
+
+        Returns:
+        ----------
+        (data, error): Generates response data and error message
+        ------------------------------------------------------------------------------------------------------
+        """
+        response = {}
+        try:
+            data = requests.get(url)
+            if data.status_code == HTTPStatus.OK:
+                response = data.json()
+        except Exception:
+            pass
+
+        return response
+
+    def generate_response_df(data) -> Tuple[pd.DataFrame, str]:
         """
         ------------------------------------------------------------------------------------------------------
         Class: DownloadUtils
@@ -185,7 +211,7 @@ class DownloadUtils:
 
         Parameters:
         ----------
-        response: The JSON response from the API server.
+        data: The JSON data from the API server.
 
         Returns:
         ----------
@@ -194,20 +220,20 @@ class DownloadUtils:
         """
         response_df = pd.DataFrame()
         try:
-            if not response["items"]:
+            if not data:
                 return response_df, "No Data Found"
             (project_name, num_pts) = DownloadUtils._get_project_name_and_pts_count(
-                response
+                data
             )
             for pt in range(0, num_pts):
                 (pt_id_ext, num_records) = DownloadUtils._get_pt_id_ext_and_num_records(
-                    response, pt
+                    data, pt
                 )
                 for rec in range(0, num_records):
                     (
                         filename,
                         time_collected,
-                    ) = DownloadUtils._get_filename_and_timestamp(response, pt, rec)
+                    ) = DownloadUtils._get_filename_and_timestamp(data, pt, rec)
                     main_df = pd.DataFrame(
                         [[project_name, pt_id_ext, filename, time_collected]],
                         columns=DownloadUtils._get_defined_columns(),
@@ -215,16 +241,16 @@ class DownloadUtils:
 
                     vocal_acoustics_summary_df = (
                         DownloadUtils._get_summary_df_from_json(
-                            response, pt, rec, vocal_acoustic_summary
+                            data, pt, rec, vocal_acoustic_summary
                         )
                     )
                     speech_characteristics_summary_df = (
                         DownloadUtils._get_summary_df_from_json(
-                            response, pt, rec, speech_characteristics_summary
+                            data, pt, rec, speech_characteristics_summary
                         )
                     )
                     rater_qa_summary_df = DownloadUtils._get_summary_df_from_json(
-                        response, pt, rec, rater_qa_summary
+                        data, pt, rec, rater_qa_summary
                     )
                     df = pd.concat(
                         [

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client/willisapi_client.py

@@ -15,7 +15,6 @@ class WillisapiClient:
         self.client_version = get_client_version()
         self.api_version = math.floor(self.client_version)
         self.api_uri = "api.brooklyn.health"
-        self.app_url = f"app.brooklyn.health/api/v{self.api_version}/"
         self.env = kwargs["env"] if "env" in kwargs else None
 
     def get_base_url(self):
@@ -33,15 +32,7 @@ class WillisapiClient:
         return self.get_base_url() + "upload"
 
     def get_download_url(self):
-        if self.env:
-            return f"https://{self.env}-{self.app_url}download"
-        return f"https://{self.app_url}download"
-
-    def get_account_create_url(self):
-        return self.get_base_url() + "account-create"
-
-    def get_user_permissions_url(self):
-        return self.get_base_url() + "user-permissions"
+        return self.get_base_url() + "download"
 
     def get_headers(self):
         return {"Content-Type": "application/json", "Accept": "application/json"}

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: willisapi-client
-Version: 1.6
+Version: 1.7
 Summary: A Python client for willisapi
 Home-page: https://github.com/bklynhlth/willsiapi_client
 Author: bklynhlth

{willisapi_client-1.6 → willisapi_client-1.7}/willisapi_client.egg-info/SOURCES.txt

@@ -9,7 +9,6 @@ tests/test_auth.py
 tests/test_csv_validation.py
 tests/test_download.py
 tests/test_upload.py
-tests/test_user_permissions.py
 willisapi_client/__init__.py
 willisapi_client/__version__.py
 willisapi_client/logging_setup.py
@@ -25,10 +24,8 @@ willisapi_client/services/__init__.py
 willisapi_client/services/api.py
 willisapi_client/services/exceptions.py
 willisapi_client/services/auth/__init__.py
-willisapi_client/services/auth/account_manager.py
 willisapi_client/services/auth/auth_utils.py
 willisapi_client/services/auth/login_manager.py
-willisapi_client/services/auth/permissions_manager.py
 willisapi_client/services/download/__init__.py
 willisapi_client/services/download/download_handler.py
 willisapi_client/services/download/download_utils.py

willisapi_client-1.6/tests/test_user_permissions.py

@@ -1,72 +0,0 @@
-from unittest.mock import patch
-from willisapi_client.services.auth.permissions_manager import user_permissions
-
-import sys
-import logging
-
-logger = logging.getLogger()
-logger.level = logging.INFO
-stream_handler = logging.StreamHandler(sys.stdout)
-logger.addHandler(stream_handler)
-
-
-class TestUserPermissions:
-    def setup_method(self):
-        self.username = "dummy"
-        self.password = "password"
-        self.id_token = "dummy_token"
-        self.user_email = "dummy@gmail.com"
-        self.client_name = "dummy_group"
-        self.expires_in = 100
-        self.failed_message = "Something went wrong"
-        self.invalid_role = "Invalid role"
-
-    @patch("willisapi_client.services.auth.login_manager.AuthUtils.user_permissions")
-    def test_user_permissions_failed(self, mocked_user_permissions):
-        mocked_user_permissions.return_value = {
-            "status_code": 500,
-            "message": self.failed_message,
-        }
-        message = user_permissions(
-            self.id_token, self.user_email, self.client_name, "rw"
-        )
-        assert message == self.failed_message
-
-    def test_user_permissions_invalidrole(self):
-        message = user_permissions(
-            self.id_token, self.user_email, self.client_name, "rww"
-        )
-        assert message == self.invalid_role
-
-    @patch("willisapi_client.services.auth.login_manager.AuthUtils.user_permissions")
-    def test_user_permissions_unauthoristed(self, mocked_user_permissions):
-        mocked_user_permissions.return_value = {
-            "status_code": 401,
-            "message": "not an admin",
-        }
-        message = user_permissions(
-            self.id_token, self.user_email, self.client_name, "rw"
-        )
-        assert message == "not an admin"
-
-    @patch("willisapi_client.services.auth.login_manager.AuthUtils.user_permissions")
-    def test_user_permissions_success(self, mocked_user_permissions):
-        mocked_user_permissions.return_value = {
-            "status_code": 200,
-            "message": "success",
-        }
-        message = user_permissions(
-            self.id_token, self.user_email, self.client_name, "rw"
-        )
-        assert message == "success"
-
-    @patch("willisapi_client.services.auth.login_manager.AuthUtils.user_permissions")
-    def test_user_permissions_invalid_group(self, mocked_user_permissions):
-        mocked_user_permissions.return_value = {
-            "status_code": 404,
-            "message": "Account not found",
-        }
-        message = user_permissions(
-            self.id_token, self.user_email, self.client_name, "rw"
-        )
-        assert message == "Account not found"

willisapi_client-1.6/willisapi_client/services/auth/__init__.py

@@ -1,8 +0,0 @@
-# website:   https://www.brooklyn.health
-from willisapi_client.services.auth.login_manager import (
-    login,
-)
-from willisapi_client.services.auth.permissions_manager import user_permissions
-from willisapi_client.services.auth.account_manager import account_create
-
-__all__ = ["login", "user_permissions", "account_create"]

willisapi_client-1.6/willisapi_client/services/auth/account_manager.py

@@ -1,49 +0,0 @@
-# website:   https://www.brooklyn.health
-from http import HTTPStatus
-
-from willisapi_client.willisapi_client import WillisapiClient
-from willisapi_client.services.auth.auth_utils import AuthUtils
-from willisapi_client.logging_setup import logger as logger
-
-from datetime import datetime
-
-
-def account_create(
-    key: str,
-    account: str,
-    **kwargs,
-) -> str:
-    """
-    ---------------------------------------------------------------------------------------------------
-    Function: account_create
-
-    Description: This function to creates account in RDS and AWS Cognito using willis account create API
-
-    Parameters:
-    ----------
-    key: Admin access token
-    account: Client Name
-
-    Returns:
-    ----------
-    None
-    ---------------------------------------------------------------------------------------------------
-    """
-    wc = WillisapiClient(env=kwargs.get("env"))
-    url = wc.get_account_create_url()
-    headers = wc.get_headers()
-    headers["Authorization"] = key
-    data = dict(
-        account=account.lower(),
-    )
-    logger.info(f'{datetime.now().strftime("%H:%M:%S")}: Creating account')
-    response = AuthUtils.account_create(url, data, headers, try_number=1)
-    if response and "status_code" in response:
-        if response["status_code"] == HTTPStatus.OK:
-            logger.info(response["message"])
-        else:
-            logger.error(response["message"])
-        return response["message"]
-    else:
-        logger.error(f"Failed")
-        return None

willisapi_client-1.6/willisapi_client/services/auth/auth_utils.py

@@ -1,143 +0,0 @@
-import requests
-import time
-import json
-import random
-
-from willisapi_client.services.exceptions import (
-    UnableToLoginClientError,
-    UnableToCreateAccountError,
-    UnableToUpdatePermissionsClientError,
-)
-
-
-class AuthUtils:
-    @staticmethod
-    def login(url, data, headers, try_number):
-        """
-        ------------------------------------------------------------------------------------------------------
-        Class: AuthUtils
-
-        Function: login
-
-        Description: This function makes a POST API call to the brooklyn.health API server to authenticate a user.
-
-        Parameters:
-        ----------
-        url: The URL of the API endpoint.
-        data: The data to be sent in the request body.
-        headers: The headers to be sent in the request.
-        try_number: The number of times the function has been tried.
-
-        Returns:
-        ----------
-        json: The JSON response from the API server.
-
-        Raises:
-        ----------
-        UnableToLoginClientError: If the function fails to login after 3 tries.
-        ------------------------------------------------------------------------------------------------------
-        """
-        try:
-            response = requests.post(url, json=data, headers=headers)
-            res_json = response.json()
-        except (
-            requests.exceptions.ConnectionError,
-            json.decoder.JSONDecodeError,
-        ) as ex:
-            if try_number == 3:
-                raise UnableToLoginClientError
-            time.sleep(random.random() * 2)
-            return AuthUtils.login(url, data, headers, try_number=try_number + 1)
-        else:
-            return res_json
-
-    @staticmethod
-    def account_create(url, data, headers, try_number):
-        """
-        ------------------------------------------------------------------------------------------------------
-        Class: AuthUtils
-
-        Function: account_create
-
-        Description: This is an internal account_create function which makes a POST API call to the brooklyn.health API server.
-
-        Parameters:
-        ----------
-        url: The URL of the API endpoint.
-        data: The data to be sent in the request body.
-        headers: The headers to be sent in the request.
-        try_number: The number of times the function has been tried.
-
-        Returns:
-        ----------
-        json: The JSON response from the API server.
-
-        Raises:
-        ----------
-        UnableToCreateAccountError: If the function fails to signup after 3 tries.
-        ------------------------------------------------------------------------------------------------------
-        """
-        try:
-            response = requests.post(url, json=data, headers=headers)
-            res_json = response.json()
-        except (
-            requests.exceptions.ConnectionError,
-            json.decoder.JSONDecodeError,
-        ) as ex:
-            if try_number == 3:
-                raise UnableToCreateAccountError
-            time.sleep(random.random() * 2)
-            return AuthUtils.account_create(url, data, headers, try_number)
-        else:
-            return res_json
-
-    @staticmethod
-    def user_permissions(url, data, headers, try_number):
-        """
-        ------------------------------------------------------------------------------------------------------
-        Class: AuthUtils
-
-        Function: user_permissions
-
-        Description: This function makes a POST API call to the brooklyn.health API server to update user permissions.
-
-        Parameters:
-        ----------
-        url: The URL of the API endpoint.
-        data: The data to be sent in the request body.
-        headers: The headers to be sent in the request.
-        try_number: The number of times the function has been tried.
-
-        Returns:
-        ----------
-        json: The JSON response from the API server.
-
-        Raises:
-        ----------
-        UnableToLoginClientError: If the function fails to login after 3 tries.
-        ------------------------------------------------------------------------------------------------------
-        """
-        try:
-            response = requests.post(url, json=data, headers=headers)
-            res_json = response.json()
-        except (
-            requests.exceptions.ConnectionError,
-            json.decoder.JSONDecodeError,
-        ) as ex:
-            if try_number == 3:
-                raise UnableToUpdatePermissionsClientError
-            time.sleep(random.random() * 2)
-            return AuthUtils.user_permissions(
-                url, data, headers, try_number=try_number + 1
-            )
-        else:
-            return res_json
-
-    @staticmethod
-    def validate_role(role: str):
-        READ = "r"
-        READ_WRITE = "rw"
-        FULL_ACCESS = "*"
-        if role in [READ, READ_WRITE, FULL_ACCESS]:
-            return True
-        return False

willisapi_client-1.6/willisapi_client/services/auth/permissions_manager.py

@@ -1,44 +0,0 @@
-from http import HTTPStatus
-
-from willisapi_client.willisapi_client import WillisapiClient
-from willisapi_client.services.auth.auth_utils import AuthUtils
-from willisapi_client.logging_setup import logger as logger
-
-
-def user_permissions(
-    key: str, user_email: str, account: str, role: str, **kwargs
-) -> str:
-    """
-    ---------------------------------------------------------------------------------------------------
-    Function: user_permissions
-
-    Description: This function is responsible for making a call to the /user_permissions API for access control
-
-    Parameters:
-    ----------
-    key: string representation of id_token generate after login
-    user_email: string representation of user's email
-    account: string representation of account/client name
-    role: r/rw/*
-
-    Returns:
-    ----------
-    None
-
-    ---------------------------------------------------------------------------------------------------
-    """
-    wc = WillisapiClient(env=kwargs.get("env"))
-    url = wc.get_user_permissions_url()
-    headers = wc.get_headers()
-    headers["Authorization"] = key
-    data = dict(user_email=user_email, account=account, role=role)
-    is_role_valid = AuthUtils.validate_role(role)
-    if is_role_valid:
-        response = AuthUtils.user_permissions(url, data, headers, try_number=1)
-        message = response["message"]
-        logger.info(message)
-    else:
-        message = "Invalid role"
-        logger.info(message)
-
-    return message