eclinical-requester 1.0.0__py3-none-any.whl

api_requester/__init__.py

@@ -0,0 +1,9 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 1/8/2025 3:52 PM
+@Description: Description
+@File: __init__.py.py
+"""
+__version__ = "1.0.0"

api_requester/core/admin/api/auth_api.py

@@ -0,0 +1,34 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/04/26 19:01
+@Description: Description
+@File: auth_api.py
+"""
+from api_requester.http.eclinical_requests import *
+
+
+class AdminAuthApi:
+    """
+    The AdminAuthApi was generated by Generator from the AuthController.java file.
+    """
+    
+    @post('/auth')
+    def create_authentication_token_api(self, *args, **kwargs): ...
+    
+    @get('/refresh')
+    def refresh_and_get_authentication_token_api(self, *args, **kwargs): ...
+    
+    @get('/auth/logout')
+    def logout_api(self, *args, **kwargs): ...
+    
+    @get('/auth/all/logout')
+    def logout_all_api(self, *args, **kwargs): ...
+    
+    @get('/me')
+    def me_api(self, *args, **kwargs): ...
+    
+    @post('/auth/sso/token')
+    def auth_sso_token_api(self, *args, **kwargs): ...
+    

api_requester/core/admin/api/user_on_board_application_api.py

@@ -0,0 +1,31 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/04/24 20:45
+@Description: Description
+@File: user_on_board_application_api.py
+"""
+from api_requester.http.eclinical_requests import *
+
+
+class AdminUserOnBoardApplicationApi:
+    """
+    The AdminUserOnBoardApplicationApi was generated by Generator from the UserOnBoardApplicationController.java file.
+    """
+    
+    @get('/user/onboard/company')
+    def get_company_list_api(self, *args, **kwargs): ...
+    
+    @get('/user/onboard/applications')
+    def get_user_onboard_application_list_api(self, *args, **kwargs): ...
+    
+    @post('/user/onboard')
+    def on_board_api(self, *args, **kwargs): ...
+    
+    @get('/user/entry/portal')
+    def entry_portal_api(self, *args, **kwargs): ...
+    
+    @post('/user/entry/portal')
+    def login_portal_api(self, *args, **kwargs): ...
+    

api_requester/core/admin/service/auth_service.py

@@ -0,0 +1,34 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/09/06 14:40
+@Description: Description
+@File: auth_service.py
+"""
+from api_requester.core.admin.api.auth_api import AdminAuthApi
+from api_requester.dto.admin.jwt_authentication_request import JwtAuthenticationRequest
+
+
+class AdminAuthService(AdminAuthApi):
+    """
+    The AdminAuthService was generated by Generator from the AuthController.java file.
+    """
+
+    def __init__(self):
+        AdminAuthApi.__init__(self)
+
+    def create_authentication_token(self, authentication_request: JwtAuthenticationRequest = None):
+        return self.create_authentication_token_api(json=authentication_request)
+
+    def refresh_and_get_authentication_token(self):
+        return self.refresh_and_get_authentication_token_api()
+
+    def logout(self):
+        return self.logout_api()
+
+    def logout_all(self, login_name: str = None):
+        return self.logout_all_api(params=dict(loginName=login_name))
+
+    def me(self):
+        return self.me_api()

api_requester/core/admin/service/impl/system_env_service_impl.py

@@ -0,0 +1,39 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 4/29/2024 2:41 PM
+@Description: Description
+@File: system_env_service_impl.py
+"""
+from api_requester.core.common.service.system_env_service import CommonSystemEnvService
+from api_requester.http.token_manager import apply_token_to_headers
+from api_requester.utils.log import Logger
+
+
+class CommonSystemEnvServiceImpl(CommonSystemEnvService):
+    """
+    CommonSystemEnvServiceImpl
+    """
+
+    def __init__(self):
+        CommonSystemEnvService.__init__(self)
+
+    def switch_role(self, role, env=None):
+        payload = self.get_current_system_env()
+        if payload.get("role").get("code") == role or (env is not None and payload.get("env").get("name") == env):
+            return
+        items = self.sponsor_env_list()
+        if not items:
+            return
+        for item in items:
+            if item.get("defaultEnv"):
+                pass
+            if env is None and item.get("defaultEnv") or item.get("name") == env:
+                onboard_role_list = item.get("onboardRoleList")
+                onboard_role = next((role_dto for role_dto in onboard_role_list if role_dto.get("name") == role), None)
+                if onboard_role:
+                    self.switch_env(env_id=item.get("id"), role_id=onboard_role.get("id"))
+                    apply_token_to_headers(self)
+                    Logger().info(f"The user switches the {role} role successfully.")
+                    return

api_requester/core/admin/service/impl/user_on_board_application_service_impl.py

@@ -0,0 +1,23 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/03/19 13:55
+@Description: Description
+@File: user_on_board_application_service_impl.py
+"""
+from api_requester.core.admin.service.user_on_board_application_service import AdminUserOnBoardApplicationService
+from api_requester.utils.lib import get_val_from_list
+
+
+class AdminUserOnBoardApplicationServiceImpl(AdminUserOnBoardApplicationService):
+    """
+    AdminUserOnBoardApplicationServiceImpl
+    """
+
+    def __init__(self):
+        AdminUserOnBoardApplicationService.__init__(self)
+
+    @get_val_from_list()
+    def get_company_id(self, name=None):
+        return self.get_company_list()

api_requester/core/admin/service/user_on_board_application_service.py

@@ -0,0 +1,35 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/09/06 14:41
+@Description: Description
+@File: user_on_board_application_service.py
+"""
+from api_requester.core.admin.api.user_on_board_application_api import AdminUserOnBoardApplicationApi
+from api_requester.dto.admin.cross_user_user_on_board_dto import CrossUserUserOnBoardDto
+from api_requester.dto.admin.user_on_board_dto import UserOnBoardDto
+
+
+class AdminUserOnBoardApplicationService(AdminUserOnBoardApplicationApi):
+    """
+    The AdminUserOnBoardApplicationService was generated by Generator from the UserOnBoardApplicationController.java file.
+    """
+
+    def __init__(self):
+        AdminUserOnBoardApplicationApi.__init__(self)
+
+    def get_company_list(self):
+        return self.get_company_list_api()
+
+    def get_user_onboard_application_list(self, company_id: int = None):
+        return self.get_user_onboard_application_list_api(params=dict(companyId=company_id))
+
+    def on_board(self, user_on_board_dto: UserOnBoardDto = None):
+        return self.on_board_api(json=user_on_board_dto)
+
+    def entry_portal(self):
+        return self.entry_portal_api()
+
+    def login_portal(self, cross_user_user_on_board_dto: CrossUserUserOnBoardDto = None):
+        return self.login_portal_api(json=cross_user_user_on_board_dto)

api_requester/core/call_api.py

@@ -0,0 +1,64 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 12/27/2024 2:59 PM
+@Description: Description
+@File: call_api.py
+"""
+from requests import request
+
+from api_requester.dto.admin.user_on_board_dto import UserOnBoardDto
+from api_requester.dto.biz_base import BizBase
+from api_requester.dto.user import EClinicalUser
+from api_requester.http.app_url import AppUrl
+from api_requester.http.authorize import Authorize
+from api_requester.utils.placeholder_replacer import PlaceholderReplacer
+
+
+class CallApi(BizBase):
+
+    def __init__(self, username=None, password=None, sponsor=None, study=None, test_env=None, app_env=None, app=None,
+                 company=None, role=None, external=False):
+        u = EClinicalUser(
+            username=username,
+            password=password,
+            sponsor=sponsor,
+            study=study,
+            test_env=test_env,
+            app_env=app_env,
+            app=app,
+            company=company,
+            role=role,
+            external=external
+        )
+        super().__init__(u)
+        self.headers = dict()
+        self.user_onboard_dto: UserOnBoardDto = UserOnBoardDto(-1)
+
+    def login(self):
+        auth = Authorize(self.user)
+        auth.login()
+        self.headers = auth.headers
+        self.time_mills = auth.time_mills
+        self.user_onboard_dto = auth.user_onboard_dto
+        return self
+
+    def run(self, method, api, **kwargs):
+        self.login()
+        replacer = PlaceholderReplacer({
+            "Sponsor ID": self.user_onboard_dto.sponsorId,
+            "Study ID": self.user_onboard_dto.studyId,
+            "Env ID": self.user_onboard_dto.envId,
+            "Sponsor Name": self.user.sponsor,
+            "Study Name": self.user.study,
+            "Lifecycle": self.user.app_env,
+        })
+        url = replacer.replace(api)
+        for key, value in kwargs.items():
+            kwargs[key] = replacer.replace(value)
+        if self.user.external is False:
+            url = AppUrl(self.user.app, self.user.test_env).which_url(self.user.app)(url)
+        else:
+            url = AppUrl(self.user.app, self.user.test_env).external_url(url)
+        request(method, url, headers=self.headers, **kwargs)

api_requester/core/common/api/system_env_api.py

@@ -0,0 +1,24 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/11/01 17:01
+@Description: Description
+@File: system_env_api.py
+"""
+from api_requester.http.eclinical_requests import *
+
+
+class CommonSystemEnvApi:
+    """
+    The CommonSystemEnvApi was generated by Generator from the SystemEnvController.java file.
+    """
+
+    @get('/system/env')
+    def get_current_system_env_api(self, *args, **kwargs): ...
+
+    @get('/system/env/list')
+    def sponsor_env_list_api(self, *args, **kwargs): ...
+
+    @put('/system/env/{envId}/role/{roleId}')
+    def switch_env_api(self, *args, **kwargs): ...

api_requester/core/common/service/system_env_service.py

@@ -0,0 +1,27 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/11/01 17:01
+@Description: Description
+@File: system_env_service.py
+"""
+from api_requester.core.common.api.system_env_api import CommonSystemEnvApi
+
+
+class CommonSystemEnvService(CommonSystemEnvApi):
+    """
+    The CommonSystemEnvService was generated by Generator from the SystemEnvController.java file.
+    """
+
+    def __init__(self):
+        CommonSystemEnvApi.__init__(self)
+
+    def get_current_system_env(self):
+        return self.get_current_system_env_api()
+
+    def sponsor_env_list(self):
+        return self.sponsor_env_list_api()
+
+    def switch_env(self, env_id: int, role_id: int):
+        return self.switch_env_api(url_kwargs=dict(envId=env_id, roleId=role_id))

api_requester/docs/application.yaml

@@ -0,0 +1,46 @@
+serverUrl:
+  dev03: http://dev-03-app-01.chengdudev.edetekapps.cn
+  dev04: http://dev-04-app-01.chengdudev.edetekapps.cn
+  dev01: http://dev-01-app-01.chengdudev.edetekapps.cn
+  test01: http://test-01-app-01.chengdudev.edetekapps.cn
+  us.dev: https://ec.eclinical-dev.edetekapps.com
+  us.demo: https://ec4.ec4demo.edetekapps.com
+
+admin:
+  urlPrefix: /api/admin
+  blacklist:
+    - request /administration/coding/**
+    - request /monitor/{tokenBase64}/api/{monitorServerBase64}/**
+  filters:
+    - RewritePath=/api/external/admin(?P<segment>/?.*),/admin/api/external\g<segment>
+
+design:
+  urlPrefix: /api/design
+
+ctms:
+  urlPrefix: /api/ctms
+  filters:
+    - RewritePath=/api/external/facade(?P<segment>/?.*),/api/external\g<segment>
+
+etmf:
+  urlPrefix: /api/etmf
+
+edc:
+  urlPrefix: /api/edc
+  filters:
+    - RewritePath=/api/external/facade(?P<segment>/?.*),/api/external/edc\g<segment>
+
+iwrs:
+  urlPrefix: /api/iwrs
+
+external:
+  urlPrefix: /api/external
+
+coding:
+  urlPrefix: /api/coding
+
+imaging:
+  urlPrefix: /api/imaging
+
+pv:
+  urlPrefix: /api/pv

api_requester/dto/admin/cross_user_user_on_board_dto.py

@@ -0,0 +1,20 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/04/24 20:45
+@Description: Description
+@File: cross_user_user_on_board_dto.py
+"""
+from dataclasses import dataclass
+
+from api_requester.dto.base_dto import BaseDto
+
+
+@dataclass
+class CrossUserUserOnBoardDto(BaseDto):
+    """
+    The CrossUserUserOnBoardDto was generated by Generator from the CrossUserUserOnBoardDto.java file.
+    """
+    companyId: int = None
+    redirectUrl: str = None

api_requester/dto/admin/jwt_authentication_request.py

@@ -0,0 +1,20 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/04/24 20:45
+@Description: Description
+@File: jwt_authentication_request.py
+"""
+from dataclasses import dataclass
+
+from api_requester.dto.base_dto import BaseDto
+
+
+@dataclass
+class JwtAuthenticationRequest(BaseDto):
+    """
+    The JwtAuthenticationRequest was generated by Generator from the JwtAuthenticationRequest.java file.
+    """
+    userName: str
+    password: str

api_requester/dto/admin/user_on_board_dto.py

@@ -0,0 +1,29 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 2024/04/24 20:45
+@Description: Description
+@File: user_on_board_dto.py
+"""
+from dataclasses import dataclass
+
+from api_requester.dto.base_dto import BaseDto
+
+
+@dataclass
+class UserOnBoardDto(BaseDto):
+    """
+    The UserOnBoardDto was generated by Generator from the UserOnBoardDto.java file.
+    """
+    applicationId: int
+    sponsorId: int = None
+    studyId: int = None
+    envId: int = None
+    workForCompanyId: int = None
+    userId: int = None
+    userType: str = None
+    roleId: int = None
+    token: str = None
+    permissionId: int = None
+    companyLevelLogin: bool = False

api_requester/dto/base_dto.py

@@ -0,0 +1,167 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 7/24/2023 3:56 PM
+@Description: Description
+@File: base_dto.py
+"""
+import mimetypes
+import os
+from dataclasses import dataclass, fields, Field
+from typing import Dict, Any, TypeVar, Type, List, get_origin
+
+T = TypeVar('T', bound='BaseDto')
+
+
+@dataclass
+class BaseDto:
+
+    def __getattr__(self, name):
+        raise AttributeError(f"'{type(self).__name__}' object has no attribute '{name}'")
+
+    def __setattr__(self, key, value):
+        if key not in [field.name for field in fields(self)]:
+            raise AttributeError(f"'{type(self).__name__}' object has no attribute '{key}'")
+        super().__setattr__(key, value)
+
+    def data(self, has_none_value=True):
+        tmp = dict()
+        for k, v in self.__dict__.items():
+            if v is None and has_none_value is False:
+                continue
+            tmp.update({k: v})
+        return tmp
+
+    def to_dict(self) -> Dict[str, Any]:
+        data = dict()
+        for f in fields(self):
+            key = f.metadata.get('alias', f.name)
+            value = getattr(self, f.name)
+            multipart_file = f.metadata.get('multipart_file', False)
+            if multipart_file:
+                value = process_multipart_file(value)
+            elif isinstance(value, BaseDto):
+                value = value.to_dict()
+            elif isinstance(value, list):
+                value = [item.to_dict() if isinstance(item, BaseDto) else item for item in value]
+            elif isinstance(value, set):  # 20241104在Python的requests库中，传递JSON数据时，set类型并不是JSON可序列化的格式，
+                # 因此需要将 set 转换为其他类型（如 list）才能正确发送
+                value = list(value)
+            if not f.metadata.get('ignore', False):
+                data[key] = value
+        return data
+
+    @classmethod
+    def from_dict(cls: Type[T], data: Dict[str, Any]) -> T:
+        kwargs = dict()
+        for f in fields(cls):
+            key = f.metadata.get("alias", f.name)
+            if key in data:
+                kwargs[f.name] = convert_value(f, data[key])
+        return cls(**kwargs)
+
+    def build_multipart_fields(self, values_as_str=False, has_none=True) -> List[tuple[str, Any]]:
+        data = list()
+        for f in fields(self):
+            key = f.metadata.get('alias', f.name)
+            value = getattr(self, f.name)
+            multipart_file = f.metadata.get('multipart_file', False)
+            if multipart_file:
+                value = process_multipart_file(value)
+            if isinstance(value, BaseDto):
+                value = value.to_dict()
+            elif isinstance(value, list):
+                value = [item.to_dict() if isinstance(item, BaseDto) else item for item in value]
+            if not f.metadata.get('ignore', False):
+                # if multipart_file and isinstance(value, list):
+                #     data.extend((key, i) for i in value)
+                # elif isinstance(value, list):
+                #     for i in value:
+                #         if isinstance(i, BaseDto):
+                #             data.append((key, i.to_dict()))
+                #         elif values_as_str and i is not None:
+                #             data.append((key, str(i)))
+                #         else:
+                #             data.append((key, i))
+                # else:
+                #     if not has_none and value is None:
+                #         continue
+                #     data.append((key, str(value) if values_as_str and value is not None else value))
+                if value and isinstance(value, (list, dict)):
+                    if isinstance(value, list) and all(isinstance(i, (str, int)) for i in value):
+                        data.extend([(key, str(i)) if values_as_str else (key, i) for i in value])
+                    else:
+                        data.extend(tuple(
+                            flatten_data(value, parent_key=key, has_none=has_none,
+                                         values_as_str=values_as_str).items()))
+                else:
+                    if not has_none and (value is None or (isinstance(value, (list, dict)) and not value)):
+                        continue
+                    data.append((key, str(value) if values_as_str and value is not None else value))
+        return data
+
+    @classmethod
+    def has_multipart_file_field(cls) -> bool:
+        for f in fields(cls):
+            if f.metadata.get("multipart_file", False):
+                return True
+        return False
+
+
+def convert_value(field: Field, value: Any) -> Any:
+    origin = get_origin(field.type)
+    if origin is not None:
+        return value
+    if isinstance(value, field.type):
+        return value
+    elif isinstance(value, (dict, int)) and field.type is str:
+        return str(value)
+    elif isinstance(value, str) and field.type is int:
+        if value.isdigit():
+            return int(value)
+        else:
+            return value
+    else:
+        return value
+
+
+def build_file_dto(file_path):
+    return os.path.basename(file_path), open(file_path, 'rb'), next(iter(mimetypes.guess_type(file_path)))
+
+
+def process_multipart_file(value):
+    """处理 multipart_file 类型的值"""
+    if isinstance(value, str):
+        if os.path.exists(value) and os.path.isfile(value):
+            return build_file_dto(value)
+        else:
+            raise ValueError(f"无效的文件路径: {value}")
+    elif isinstance(value, list):
+        if all(isinstance(i, str) and os.path.exists(i) and os.path.isfile(i) for i in value):
+            return [build_file_dto(i) for i in value]
+        else:
+            raise ValueError(f"列表中包含无效的文件路径: {value}")
+    return value
+
+
+def flatten_data(data, parent_key='', sep='.', values_as_str=False, has_none=True):
+    items = []
+    if isinstance(data, dict):
+        for k, v in data.items():
+            if not has_none and v is None:
+                continue
+            new_key = f"{parent_key}{sep}{k}" if parent_key else k
+            items.extend(flatten_data(v, new_key, sep=sep, values_as_str=values_as_str, has_none=has_none).items())
+    elif isinstance(data, list):
+        for idx, v in enumerate(data):
+            if not has_none and v is None:
+                continue
+            new_key = f"{parent_key}[{idx}]"
+            items.extend(flatten_data(v, new_key, sep=sep, values_as_str=values_as_str, has_none=has_none).items())
+    else:
+        if not has_none and data is None:
+            return dict()
+        items.append(
+            (parent_key, str(data) if values_as_str and data is not None and not isinstance(data, tuple) else data))
+    return dict(items)

api_requester/dto/biz_base.py

@@ -0,0 +1,31 @@
+# !/usr/bin/python3
+# -*- coding:utf-8 -*-
+"""
+@Author: xiaodong.li
+@Time: 6/12/2024 2:20 PM
+@Description: Description
+@File: biz_base.py
+"""
+import time
+from abc import abstractmethod, ABC
+from typing import Optional
+
+from requests import Response
+
+from api_requester.dto.user import EClinicalUser
+
+
+class BizBase(ABC):
+
+    def __init__(self, user=None, headers=None, last_result=None, refresh_content_type=True):
+        self.user: Optional[EClinicalUser] = user
+        self.headers: dict = headers or dict()
+        self.last_kwargs: dict = dict()
+        self.last_result: Optional[Response] = last_result
+        self.time_mills = time.time()
+        self.refresh_content_type: bool = refresh_content_type
+        self.raises_exception: bool = True
+        self.allure_attach: bool = False
+
+    @abstractmethod
+    def login(self): ...