sky-api-client 3.3.0__tar.gz → 3.3.2__tar.gz

{sky_api_client-3.3.0 → sky_api_client-3.3.2}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: sky_api_client
-Version: 3.3.0
+Version: 3.3.2
 Summary: Python client for RENXT APIs
 Home-page: https://bitbucket.org/kalyanvarma/skyapi
-Author: Uddesh Jain
-Author-email: uddesh@almabase.com
+Author: Rajeev K L
+Author-email: rajeev@almabase.com
 License: UNKNOWN
 Description: # Sky Api Client
         

{sky_api_client-3.3.0 → sky_api_client-3.3.2}/setup.py

@@ -5,9 +5,9 @@ with open('README.md', 'r', encoding='utf-8') as fh:
 
 setuptools.setup(
     name='sky_api_client',
-    version='3.3.0',
-    author='Uddesh Jain',
-    author_email='uddesh@almabase.com',
+    version='3.3.2',
+    author='Rajeev K L',
+    author_email='rajeev@almabase.com',
     description='Python client for RENXT APIs',
     long_description=long_description,
     long_description_content_type='text/markdown',

sky_api_client-3.3.2/sky_api_client/common/tasks/asyncio.py

@@ -0,0 +1,71 @@
+import abc
+import asyncio
+import functools
+from typing import Any, Dict, List, Tuple
+
+
+class BaseAsyncIOTask:
+    @classmethod
+    async def execute(cls, data: Dict = {}) -> Any:
+        """
+        Executes the async logic by awaiting the task logic
+        This function is mainly used by all async application logic to execute async logic
+        """
+        task = cls()
+        return await task.perform_task(**data)
+
+    @classmethod
+    def execute_sync(cls, data: Dict = {}) -> Any:
+        """This is used to run the asyncio task if any inside a synchronous code"""
+        task = cls()
+        # If there is an event loop already running, get it otherwise create a new event loop.
+        try:
+            loop = asyncio.get_event_loop()
+            result = loop.run_until_complete(task.perform_task(**data))
+            loop.close()
+        except RuntimeError:
+            loop = asyncio.new_event_loop()
+            asyncio.set_event_loop(loop)
+            result = loop.run_until_complete(task.perform_task(**data))
+            loop.close()
+        return result
+
+    @abc.abstractmethod
+    async def perform_task(self, **data) -> Any:
+        """
+        This function holds the logic of the async task which will be run on the event loop
+        """
+
+        raise NotImplementedError('Implement the logic for {}.'.format(self.__class__.__name__))
+
+
+class BulkTaskExecutor(BaseAsyncIOTask):
+    @classmethod
+    def execute_sync(cls, data: Dict = {}) -> Any:
+        task = cls()
+
+        loop = asyncio.new_event_loop()
+        asyncio.set_event_loop(loop)
+        result = loop.run_until_complete(task.perform_task(**data))
+        loop.close()
+
+        return result
+
+    async def perform_task(self, task_list: List[Tuple] = None) -> List:
+        loop = asyncio.get_event_loop()
+        results = await asyncio.gather(
+            *[
+                asyncio.ensure_future(loop.run_in_executor(None, functools.partial(*task[0], **task[1])), loop=loop)
+                for task in task_list
+            ],
+            loop=loop,
+            return_exceptions=True,
+        )
+
+        # If there is exception in performing any task
+        # we pass that exception to the parent function instead of returning the results
+        for result in results:
+            if isinstance(result, Exception):
+                raise result
+
+        return [result for result in results]

sky_api_client-3.3.2/sky_api_client/entity/constituent_education.py

@@ -0,0 +1,60 @@
+import re
+
+import six
+from sky_api_client.entity.base import Entity
+from sky_api_client.entity.education import EducationCustomField
+from sky_api_client.entity.registry import EntityRegistry
+from sky_api_client.common.tasks.asyncio import BulkTaskExecutor
+
+
+def slugify_underscore(name):
+    """Return slug for the given name i.e. replace any non alphanumeric character with underscore."""
+    if name is None or not isinstance(name, six.text_type):
+        return None
+
+    name = name.strip().lower()
+    # Any non word characters (letters, digits, and underscores) are replaced by '-'
+    name = re.sub(r'\W+', '_', name)
+    # Removing any trailing or leading dash
+    name = re.sub(r'^[-_]|[-_]$', '', name)
+    # Replace multiple continuous hipens with one
+    name = re.sub('[-_]+', '_', name)
+    return name
+
+
+@EntityRegistry.register('constituent_education')
+class ConstituentEducation(Entity):
+    LIST_URL = '/constituent/v1/constituents/{id}/educations'
+
+    def list(self, id=None, parent_id=None, params=None):
+        data = super().list(id=id, parent_id=parent_id, params=params)
+
+        pull_education_custom_fields = params.pop('pull_education_custom_fields', False)
+        if not pull_education_custom_fields:
+            return data
+
+        self.add_custom_fields_async(data)
+
+        return data
+
+    def add_custom_fields(self, education):
+        education_custom_fields = EducationCustomField(self._api).custom_fields(education_id=education['id'])
+        custom_fields = {}
+        for custom_field in education_custom_fields:
+            default_value = []
+            field_value = custom_fields.setdefault(slugify_underscore(custom_field['category']), default_value)
+            field_value.append(custom_field['value'])
+
+        for key, value in custom_fields.items():
+            education[key] = value if len(value) > 1 else value[0]
+
+    def add_custom_fields_async(self, data):
+        task_list = []
+        for education in data.get('value', []):
+            task_list.append(((self.add_custom_fields, education), {}))
+
+        return BulkTaskExecutor.execute_sync(
+            {
+                'task_list': task_list,
+            }
+        )

sky_api_client-3.3.2/sky_api_client/entity/education.py

@@ -0,0 +1,59 @@
+from sky_api_client.entity.base import Entity
+from sky_api_client.entity.registry import EntityRegistry
+from sky_api_client.exceptions.exception import MethodNotDefined
+
+
+@EntityRegistry.register('education')
+class Education(Entity):
+    LIST_URL = '/constituent/v1/educations/'
+    CREATE_URL = '/constituent/v1/educations/'
+    GET_URL = '/constituent/v1/constituents/educations/{id}'
+    UPDATE_URL = '/constituent/v1/educations/{id}'
+    DELETE_URL = '/constituent/v1/educations/{id}'
+    SUBJECTS_URL = '/constituent/v1/educations/subjects'
+    DEGREES_URL = '/constituent/v1/educations/degrees'
+
+    def subjects(self):
+        if self.SUBJECTS_URL:
+            return self._api.request(method='GET', path=self.SUBJECTS_URL).get('value', [])
+        raise MethodNotDefined('subjects')
+
+    def degrees(self):
+        if self.DEGREES_URL:
+            return self._api.request(method='GET', path=self.DEGREES_URL).get('value', [])
+        raise MethodNotDefined('degrees')
+
+
+@EntityRegistry.register('education_custom_field')
+class EducationCustomField(Entity):
+    LIST_URL = 'constituent/v1/educations/customfields/categories/details?limit=5000'
+    CREATE_URL = 'constituent/v1/educations/customfields'
+    DELETE_URL = 'constituent/v1/educations/customfields/{custom_field_id}'
+    UPDATE_URL = 'constituent/v1/educations/customfields/{custom_field_id}'
+    CUSTOM_FIELDS_URL = 'constituent/v1/educations/{education_id}/customfields'
+    CUSTOM_FIELD_CATEGORIES_CODE_TABLE_URL = 'constituent/v1/educations/customfields/categories/values?category_name={}'
+
+    def list(self, id=None, parent_id=None, params=None, all=False):
+        data = super().list(id=id, parent_id=parent_id, params=params)
+        if not all:
+            return data
+        count = data['count']
+        while count > 5000:
+            params['offset'] = params.get('offset', 0) + 5000
+            data['value'] += super().list(id=id, parent_id=parent_id, params=params)['value']
+            count -= 5000
+        return data
+
+    def custom_fields(self, education_id):
+        if self.CUSTOM_FIELDS_URL:
+            return self._api.request(method='GET', path=self.CUSTOM_FIELDS_URL.format(education_id=education_id)).get(
+                'value', []
+            )
+        raise MethodNotDefined('custom_fields')
+
+    def custom_field_categories_code_table(self, category_name):
+        if self.CUSTOM_FIELD_CATEGORIES_CODE_TABLE_URL:
+            return self._api.request(
+                method='GET', path=self.CUSTOM_FIELD_CATEGORIES_CODE_TABLE_URL.format(category_name)
+            ).get('value', [])
+        raise MethodNotDefined('custom_field_categories_code_table')

{sky_api_client-3.3.0 → sky_api_client-3.3.2}/sky_api_client/exceptions/exception.py

@@ -1,15 +1,5 @@
-import json
-
-
 class GeneralError(Exception):
-    def __init__(self, text: str) -> None:
-        try:
-            json.loads(self.text)
-            super().__init__(text)
-        except json.JSONDecodeError as exc:
-            super().__init__(
-                [{'error_code': 500, 'error_name': 'JSONDecodeError', 'message': text, 'raw_message': exc.msg}]
-            )
+    pass
 
 
 class MethodNotDefined(Exception):

{sky_api_client-3.3.0 → sky_api_client-3.3.2}/sky_api_client.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: sky-api-client
-Version: 3.3.0
+Version: 3.3.2
 Summary: Python client for RENXT APIs
 Home-page: https://bitbucket.org/kalyanvarma/skyapi
-Author: Uddesh Jain
-Author-email: uddesh@almabase.com
+Author: Rajeev K L
+Author-email: rajeev@almabase.com
 License: UNKNOWN
 Description: # Sky Api Client
         

{sky_api_client-3.3.0 → sky_api_client-3.3.2}/sky_api_client.egg-info/SOURCES.txt

@@ -7,6 +7,9 @@ sky_api_client.egg-info/PKG-INFO
 sky_api_client.egg-info/SOURCES.txt
 sky_api_client.egg-info/dependency_links.txt
 sky_api_client.egg-info/top_level.txt
+sky_api_client/common/__init__.py
+sky_api_client/common/tasks/__init__.py
+sky_api_client/common/tasks/asyncio.py
 sky_api_client/entity/__init__.py
 sky_api_client/entity/address.py
 sky_api_client/entity/base.py

sky_api_client-3.3.0/sky_api_client/entity/constituent_education.py

@@ -1,7 +0,0 @@
-from sky_api_client.entity.base import Entity
-from sky_api_client.entity.registry import EntityRegistry
-
-
-@EntityRegistry.register('constituent_education')
-class ConstituentEducation(Entity):
-    LIST_URL = '/constituent/v1/constituents/{id}/educations'

sky_api_client-3.3.0/sky_api_client/entity/education.py

@@ -1,24 +0,0 @@
-from sky_api_client.entity.base import Entity
-from sky_api_client.entity.registry import EntityRegistry
-from sky_api_client.exceptions.exception import MethodNotDefined
-
-
-@EntityRegistry.register('education')
-class Education(Entity):
-    LIST_URL = '/constituent/v1/educations/'
-    CREATE_URL = '/constituent/v1/educations/'
-    GET_URL = '/constituent/v1/constituents/educations/{id}'
-    UPDATE_URL = '/constituent/v1/educations/{id}'
-    DELETE_URL = '/constituent/v1/educations/{id}'
-    SUBJECTS_URL = '/constituent/v1/educations/subjects'
-    DEGREES_URL = '/constituent/v1/educations/degrees'
-
-    def subjects(self):
-        if self.SUBJECTS_URL:
-            return self._api.request(method='GET', path=self.SUBJECTS_URL).get('value', [])
-        raise MethodNotDefined('subjects')
-
-    def degrees(self):
-        if self.DEGREES_URL:
-            return self._api.request(method='GET', path=self.DEGREES_URL).get('value', [])
-        raise MethodNotDefined('degrees')