brynq-sdk-bob 0.0.1__tar.gz

brynq_sdk_bob-0.0.1/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: brynq_sdk_bob
+Version: 0.0.1
+Summary: Bob wrapper from BrynQ
+Home-page: UNKNOWN
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Description: Bob wrapper from BrynQ
+Platform: UNKNOWN

brynq_sdk_bob-0.0.1/brynq_sdk/bob/__init__.py

@@ -0,0 +1,73 @@
+import base64
+import re
+from typing import Union, List
+import pandas as pd
+import requests
+from brynq_sdk.brynq import BrynQ
+
+from .bank import Bank
+from .employment import Employment
+from .payments import Payments
+from .people import People
+from .salaries import Salaries
+from .timeoff import TimeOff
+from .work import Work
+
+
+class Bob(BrynQ):
+    def __init__(self, label: Union[str, List], test_environment: bool = True, debug: bool = False):
+        super().__init__()
+        self.headers = self._get_request_headers(label=label)
+        if test_environment:
+            self.base_url = "https://api.sandbox.hibob.com/v1/"
+        else:
+            self.base_url = "https://api.hibob.com/v1/"
+        self.session = requests.Session()
+        self.session.headers.update(self.headers)
+        self.people = People(self)
+        self.salaries = Salaries(self)
+        self.work = Work(self)
+        self.bank = Bank(self)
+        self.employment = Employment(self)
+        self.payments = Payments(self)
+        self.time_off = TimeOff(self)
+
+    def _get_request_headers(self, label):
+        credentials = self.get_system_credential(system='bob', label=label)
+        auth_token = base64.b64encode(f"{credentials['User ID']}:{credentials['API Token']}".encode()).decode('utf-8')
+        headers = {
+            "accept": "application/json",
+            "Authorization": f"Basic {auth_token}",
+            "Partner-Token": "001Vg00000A6FY6IAN"
+        }
+
+        return headers
+
+    def get_paginated_result(self, request: requests.Request) -> List:
+        has_next_page = True
+        result_data = []
+        while has_next_page:
+            prepped = request.prepare()
+            prepped.headers.update(self.session.headers)
+            resp = self.session.send(prepped)
+            resp.raise_for_status()
+            response_data = resp.json()
+            result_data += response_data['results']
+            next_cursor = response_data.get('response_metadata').get('next_cursor')
+            # If there is no next page, set has_next_page to False, we could use the falsy value of None but this is more readable
+            has_next_page = next_cursor is not None
+            if has_next_page:
+                request.params.update({"cursor": next_cursor})
+
+        return result_data
+
+    def rename_camel_columns_to_snake_case(self, df: pd.DataFrame) -> pd.DataFrame:
+        def camel_to_snake_case(column):
+            # Replace periods with underscores
+            column = column.replace('.', '_')
+            # Insert underscores before capital letters and convert to lowercase
+            return re.sub(r'(?<!^)(?=[A-Z])', '_', column).lower()
+
+        df.columns = map(camel_to_snake_case, df.columns)
+
+        return df

brynq_sdk_bob-0.0.1/brynq_sdk/bob/bank.py

@@ -0,0 +1,27 @@
+import pandas as pd
+from brynq_sdk.functions import Functions
+
+from src.bob.schemas.bank import BankSchema
+
+
+class Bank:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get(self, person_ids: pd.Series) -> pd.DataFrame:
+        data = []
+        for person_id in person_ids:
+            resp = self.bob.session.get(url=f"{self.bob.base_url}people/{person_id}/bank-accounts")
+            resp.raise_for_status()
+            temp_data = resp.json()['values']
+            # when an employee has one or more bank accounts, the response is a list of dictionaries.
+            for account in temp_data:
+                account['employee_id'] = person_id
+            data += temp_data
+
+        df = pd.DataFrame(data)
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+
+        valid_banks, invalid_banks = Functions.validate_data(df=df, schema=BankSchema, debug=True)
+
+        return valid_banks

brynq_sdk_bob-0.0.1/brynq_sdk/bob/company.py

@@ -0,0 +1,23 @@
+import pandas as pd
+
+
+class Company:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get_variable_values(self, list_name: str = None) -> dict:
+        values = {}
+
+        if list_name is not None:
+            resp = self.bob.session.get(url=f"{self.bob.base_url}company/named-lists/{list_name}")
+            resp.raise_for_status()
+            data = resp.json()
+            values.update({data["name"]: [value['id'] for value in data['values']]})
+        else:
+            resp = self.bob.session.get(url=f"{self.bob.base_url}company/named-lists")
+            resp.raise_for_status()
+            data = resp.json()
+            for list_key, list_data in data.items():
+                values.update({list_key: [value['id'] for value in list_data['values']]})
+
+        return values

brynq_sdk_bob-0.0.1/brynq_sdk/bob/documents.py

@@ -0,0 +1,40 @@
+from datetime import datetime
+import pandas as pd
+from brynq_sdk.functions import Functions
+
+
+class Documents:
+    def __init__(self, bob):
+        self.bob = bob
+        # self.headers_upload = self.bob.headers.copy()
+        # self.headers_upload['Content-Type'] = 'multipart/form-data'
+        # self.headers_upload['Accept'] = 'application/json'
+
+    def get(self, person_id: datetime) -> pd.DataFrame:
+        resp = self.bob.session.get(url=f"{self.bob.base_url}docs/people/{person_id}")
+        resp.raise_for_status()
+        data = resp.json()['documents']
+        df = pd.DataFrame(data)
+        # data = self.bob.get_paginated_result(request)
+        # df = pd.json_normalize(
+        #     data,
+        #     record_path='changes',
+        #     meta=['employeeId']
+        # )
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+        valid_documents, invalid_documents = Functions.validate_data(df=df, schema=DocumentsSchema, debug=True)
+
+        return valid_documents
+
+    def create_confidential(self,
+                            person_id: datetime,
+                            file_name: str,
+                            file_path: str):
+        files = {"file": (file_name, open(file_path, "rb"), "application/pdf")}
+        resp = self.bob.session.post(url=f"{self.bob.base_url}people/{person_id}/confidential/upload",
+                                     files=files)
+        resp.raise_for_status()
+
+    # def create_shared(self, person_id: datetime):
+    #     resp = self.bob.session.post(url=f"{self.bob.base_url}people/{person_id}/shared/upload")
+    #     resp.raise_for_status()

brynq_sdk_bob-0.0.1/brynq_sdk/bob/employment.py

@@ -0,0 +1,23 @@
+import pandas as pd
+import requests
+from src.bob.schemas.employment import EmploymentSchema
+from src.utils.validation_tracker import enhanced_validate_data, ValidationTracker
+from typing import Tuple
+
+class Employment:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get(self) -> Tuple[pd.DataFrame, ValidationTracker]:
+        request = requests.Request(method='GET',
+                                   url=f"{self.bob.base_url}bulk/people/employment")
+        data = self.bob.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='values',
+            meta=['employeeId']
+        )
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+        valid_contracts, invalid_contracts, tracker = enhanced_validate_data(df=df, schema=EmploymentSchema, debug=True)
+
+        return valid_contracts, tracker

brynq_sdk_bob-0.0.1/brynq_sdk/bob/payments.py

@@ -0,0 +1,22 @@
+from datetime import datetime
+import pandas as pd
+from brynq_sdk.functions import Functions
+from src.bob.schemas.payments import VariablePaymentSchema
+
+
+class Payments:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get(self, person_id: datetime) -> (pd.DataFrame, pd.DataFrame):
+        resp = self.bob.session.get(url=f"{self.bob.base_url}people/{person_id}/variable")
+        resp.raise_for_status()
+        data = resp.json()['values']
+        df = pd.json_normalize(
+            data,
+            record_path='values'
+        )
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+        valid_payments, invalid_payments = Functions.validate_data(df=df, schema=VariablePaymentSchema, debug=True)
+
+        return valid_payments, invalid_payments

brynq_sdk_bob-0.0.1/brynq_sdk/bob/people.py

@@ -0,0 +1,54 @@
+import pandas as pd
+from brynq_sdk.functions import Functions
+
+from src.bob.bank import Bank
+from src.bob.employment import Employment
+from src.bob.salaries import Salaries
+from src.bob.schemas.people import PeopleSchema
+from src.bob.work import Work
+
+
+class People:
+    def __init__(self, bob):
+        self.bob = bob
+        self.salaries = Salaries(bob)
+        self.employment = Employment(bob)
+        self.bank = Bank(bob)
+        self.work = Work(bob)
+
+    def get(self) -> pd.DataFrame:
+        resp = self.bob.session.get(url=f"{self.bob.base_url}profiles")
+        # Bob sucks with default fields so you need to do a search call to retrieve additional fields.
+        additional_fields = [
+            "personal.birthDate",
+            "address.city",
+            "address.postCode",
+            "address.line1",
+            "address.line2",
+            "address.activeEffectiveDate",
+            # "address.fullAddress",
+            "address.country",
+            "home.legalGender",
+            "home.spouse.firstName",
+            "home.spouse.surname",
+            "home.spouse.birthDate",
+            "home.spouse.gender",
+            "internal.terminationReason",
+            "internal.terminationDate",
+            "internal.terminationType",
+            "employee.lastDayOfWork"
+        ]
+        resp_additional_fields = self.bob.session.post(url=f"{self.bob.base_url}people/search",
+                                                       json={
+                                                           "fields": ["root.id"] + additional_fields,
+                                                           "filters": []
+                                                       })
+        df_extra_fields = pd.json_normalize(resp_additional_fields.json()['employees'])
+        resp.raise_for_status()
+        data = resp.json()
+        df = pd.json_normalize(data['employees'])
+        df = pd.merge(df, df_extra_fields[["id"] + additional_fields], left_on='id', right_on='id')
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+        valid_people, invalid_people = Functions.validate_data(df=df, schema=PeopleSchema, debug=True)
+
+        return valid_people

brynq_sdk_bob-0.0.1/brynq_sdk/bob/salaries.py

@@ -0,0 +1,24 @@
+import pandas as pd
+import requests
+from brynq_sdk.functions import Functions
+from src.bob.schemas.salary import SalarySchema
+
+
+class Salaries:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get(self) -> pd.DataFrame:
+        request = requests.Request(method='GET',
+                                   url=f"{self.bob.base_url}bulk/people/salaries",
+                                   params={"limit": 100})
+        data = self.bob.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='values',
+            meta=['employeeId']
+        )
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+        valid_salaries, invalid_salaries = Functions.validate_data(df=df, schema=SalarySchema, debug=True)
+
+        return valid_salaries

brynq_sdk_bob-0.0.1/brynq_sdk/bob/timeoff.py

@@ -0,0 +1,25 @@
+from datetime import datetime, timezone
+import pandas as pd
+from brynq_sdk.functions import Functions
+from src.bob.schemas.timeoff import TimeOffSchema
+
+
+class TimeOff:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get(self, since: datetime) -> (pd.DataFrame, pd.DataFrame):
+        resp = self.bob.session.get(url=f"{self.bob.base_url}timeoff/requests/changes",
+                                    params={'since': since.replace(tzinfo=timezone.utc).isoformat(timespec='milliseconds')})
+        resp.raise_for_status()
+        data = resp.json()['changes']
+        # data = self.bob.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='changes',
+            meta=['employeeId']
+        )
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+        valid_timeoff, invalid_timeoff = Functions.validate_data(df=df, schema=TimeOffSchema, debug=True)
+
+        return valid_timeoff, invalid_timeoff

brynq_sdk_bob-0.0.1/brynq_sdk/bob/work.py

@@ -0,0 +1,25 @@
+import pandas as pd
+import requests
+from brynq_sdk.functions import Functions
+
+from src.bob.schemas.work import WorkSchema
+
+
+class Work:
+    def __init__(self, bob):
+        self.bob = bob
+
+    def get(self) -> pd.DataFrame:
+        request = requests.Request(method='GET',
+                                   url=f"{self.bob.base_url}bulk/people/work")
+        data = self.bob.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='values',
+            meta=['employeeId']
+        )
+        df = self.bob.rename_camel_columns_to_snake_case(df)
+
+        valid_work, invalid_work = Functions.validate_data(df=df, schema=WorkSchema, debug=True)
+
+        return valid_work

brynq_sdk_bob-0.0.1/brynq_sdk_bob.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: brynq-sdk-bob
+Version: 0.0.1
+Summary: Bob wrapper from BrynQ
+Home-page: UNKNOWN
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Description: Bob wrapper from BrynQ
+Platform: UNKNOWN

brynq_sdk_bob-0.0.1/brynq_sdk_bob.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+setup.py
+brynq_sdk/bob/__init__.py
+brynq_sdk/bob/bank.py
+brynq_sdk/bob/company.py
+brynq_sdk/bob/documents.py
+brynq_sdk/bob/employment.py
+brynq_sdk/bob/payments.py
+brynq_sdk/bob/people.py
+brynq_sdk/bob/salaries.py
+brynq_sdk/bob/timeoff.py
+brynq_sdk/bob/work.py
+brynq_sdk_bob.egg-info/PKG-INFO
+brynq_sdk_bob.egg-info/SOURCES.txt
+brynq_sdk_bob.egg-info/dependency_links.txt
+brynq_sdk_bob.egg-info/not-zip-safe
+brynq_sdk_bob.egg-info/requires.txt
+brynq_sdk_bob.egg-info/top_level.txt

brynq_sdk_bob-0.0.1/brynq_sdk_bob.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

brynq_sdk_bob-0.0.1/brynq_sdk_bob.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

brynq_sdk_bob-0.0.1/brynq_sdk_bob.egg-info/requires.txt

@@ -0,0 +1,2 @@
+brynq-sdk-brynq>=1
+pandas<3.0.0,>=2.2.0

brynq_sdk_bob-0.0.1/brynq_sdk_bob.egg-info/top_level.txt

@@ -0,0 +1 @@
+brynq_sdk

brynq_sdk_bob-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

brynq_sdk_bob-0.0.1/setup.py

@@ -0,0 +1,18 @@
+from setuptools import setup
+
+
+setup(
+    name='brynq_sdk_bob',
+    version='0.0.1',
+    description='Bob wrapper from BrynQ',
+    long_description='Bob wrapper from BrynQ',
+    author='BrynQ',
+    author_email='support@brynq.com',
+    packages=["brynq_sdk.bob"],
+    license='BrynQ License',
+    install_requires=[
+        'brynq-sdk-brynq>=1',
+        'pandas>=2.2.0,<3.0.0',
+    ],
+    zip_safe=False,
+)