Initial project

Author: Oleg Menteshashvili

blazingdocs/__init__.py

@@ -0,0 +1,8 @@
+__version__ = '1.0.0'
+
+from .client import BlazingClient
+from .models import *
+from .enums import DataSourceType
+from .exceptions import BlazingException
+from .parameters import MergeParameters
+from .utils import FormFile, Object

blazingdocs/client.py

@@ -0,0 +1,97 @@
+import uuid
+import requests
+from builtins import isinstance
+from typing import List, Union
+from .exceptions import BlazingException
+from .models import Operation, Account, Usage, Template
+from .parameters import MergeParameters
+from .utils import FormFile
+
+
+# BlazingClient API client.
+class BlazingClient:
+    __headers = None
+    __api_key: str = None
+    __base_url: str = 'https://api.blazingdocs.com'
+
+    # Creates new instance of client.
+    def __init__(self, api_key: str):
+        self.__api_key = api_key
+        self.__headers = {'X-API-Key': self.__api_key}
+
+    # Executes merge operation with union template.
+    def __merge(self, data: str, filename: str, parameters: MergeParameters, template: Union[str, uuid.UUID, FormFile]) -> Operation:
+        url = self.__base_url + '/operation/merge'
+
+        if not (data and data.strip()):
+            raise ValueError('Data is not provided')
+
+        if not (filename and filename.strip()):
+            raise ValueError('Output filename is not provided')
+
+        if not parameters:
+            raise ValueError('Merge parameters are not provided')
+
+        payload = dict(
+            Data=(None, data),
+            OutputName=(None, filename),
+            MergeParameters=(None, parameters.to_json())
+        )
+
+        if isinstance(template, uuid.UUID):
+            payload['Template'] = (None, str(template))
+        elif isinstance(template, str):
+            payload['Template'] = (None, template.replace('\\', '/'))
+        elif isinstance(template, FormFile):
+            payload['Template'] = (template.name, template.content)
+        else:
+            raise ValueError('Template is not provided')
+
+        response = requests.post(url=url, headers=self.__headers, files=payload, timeout=10)
+        return Operation(self.__handle_response(response))
+
+    # Gets account info.
+    def get_account(self) -> Account:
+        url = self.__base_url + '/account'
+        response = requests.get(url, headers=self.__headers, timeout=10)
+        return Account(self.__handle_response(response))
+
+    # Gets usage info.
+    def get_usage(self) -> Usage:
+        url = self.__base_url + '/usage'
+        response = requests.get(url, headers=self.__headers, timeout=10)
+        return Usage(self.__handle_response(response))
+
+    # Gets templates list.
+    def get_templates(self, path: str = None) -> List[Template]:
+        url = self.__base_url + '/templates'
+
+        if path is not None:
+            url += path
+
+        response = requests.get(url, headers=self.__headers, timeout=10)
+        decoded = self.__handle_response(response)
+        return list(map(Template, decoded))
+
+    # Executes merge operation with template id.
+    def merge_with_id(self, data: str, filename: str, parameters: MergeParameters, template: uuid.UUID) -> Operation:
+        return self.__merge(data, filename, parameters, template)
+
+    # Executes merge operation with template path.
+    def merge_with_relative_path(self, data: str, filename: str, parameters: MergeParameters, template: str) -> Operation:
+        return self.__merge(data, filename, parameters, template)
+
+    # Executes merge operation with template form file.
+    def merge_with_form_file(self, data: str, filename: str, parameters: MergeParameters, template: FormFile) -> Operation:
+        return self.__merge(data, filename, parameters, template)
+
+    # Handle response.
+    def __handle_response(self, response: requests.Response):
+        try:
+            if not response.status_code == requests.codes.ok:
+                message = response.json().get('message', '[Message not found]')
+                raise BlazingException(response.status_code, message)
+        except ValueError as ex:
+            raise ex
+
+        return response.json()

blazingdocs/enums.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class DataSourceType(str, Enum):
+    CSV: str = 'CSV'
+    JSON: str = 'JSON'
+    XML: str = 'XML'

blazingdocs/exceptions.py

@@ -0,0 +1,10 @@
+class BlazingException(Exception):
+    def __init__(self, http_status_code: int, message: str):
+        super(BlazingException, self).__init__(message)
+
+        self.message: str = message
+        self.status_code: int = http_status_code
+
+    def __str__(self):
+        message = "Message: %s. Status Code: %s" % (self.message, self.status_code)
+        return message.strip()

blazingdocs/json_encoders.py

@@ -0,0 +1,13 @@
+from json import JSONEncoder
+from .parameters import MergeParameters
+
+
+# JSONEncoder that encodes MergeParameters objects as JSON
+class MergeParametersEncoder(JSONEncoder):
+    def default(self, object):
+        if isinstance(object, MergeParameters):
+            return object.__dict__
+        else:
+            # Call base class implementation which takes care of
+            # raising exceptions for unsupported types
+            return JSONEncoder.default(self, object)

blazingdocs/models.py

@@ -0,0 +1,182 @@
+import requests
+from io import BytesIO
+from datetime import datetime
+from decimal import Decimal
+from uuid import UUID
+
+
+class Plan:
+
+    def __init__(self, response):
+        self.response = response
+
+    @property
+    def id(self) -> UUID:
+        return self.response['id']
+
+    @property
+    def name(self) -> str:
+        return self.response['name']
+
+    @property
+    def price(self) -> Decimal:
+        return self.response['price']
+
+    @property
+    def price_per_unit(self) -> Decimal:
+        return self.response['pricePerUnit']
+
+    @property
+    def quota(self) -> int:
+        return self.response['quota']
+
+
+class Account:
+
+    def __init__(self, response):
+        self.response = response
+
+    @property
+    def id(self) -> UUID:
+        return self.response['id']
+
+    @property
+    def name(self) -> str:
+        return self.response['name']
+
+    @property
+    def plan(self) -> Plan:
+        return Plan(self.response['plan'])
+
+    @property
+    def api_key(self) -> str:
+        return self.response['apiKey']
+
+    @property
+    def obsolete_api_key(self) -> str:
+        return self.response['obsoleteApiKey']
+
+    @property
+    def created_at(self) -> datetime:
+        return self.response['createdAt']
+
+    @property
+    def last_synced_at(self) -> datetime:
+        return self.response['lastSyncedAt']
+
+    @property
+    def updated_at(self) -> datetime:
+        return self.response['updatedAt']
+
+
+class OperationType:
+
+    def __init__(self, response):
+        self.response = response
+
+    @property
+    def name(self) -> str:
+        return self.response['name']
+
+
+class Operation:
+
+    def __init__(self, response):
+        self.response = response
+
+    @property
+    def id(self) -> UUID:
+        return self.response['id']
+
+    @property
+    def operation_type(self) -> OperationType:
+        return OperationType(self.response['type'])
+
+    @property
+    def page_count(self) -> int:
+        return self.response['pageCount']
+
+    @property
+    def elapsed_milliseconds(self) -> int:
+        return self.response['elapsedMilliseconds']
+
+    @property
+    def remote_ip_address(self) -> str:
+        return self.response['remoteIpAddress']
+
+    @property
+    def files(self) -> []:
+        return list(map(File, self.response['files']))
+
+    @property
+    def io(self) -> BytesIO:
+        if not self.files:
+            raise ValueError('File not found')
+
+        response = requests.get(self.files[0].download_url, timeout=1800)
+        return BytesIO(response.content)
+
+
+class File:
+
+    def __init__(self, response):
+        self.response = response
+
+    @property
+    def id(self) -> UUID:
+        return self.response['id']
+
+    @property
+    def name(self) -> str:
+        return self.response['name']
+
+    @property
+    def content_type(self) -> str:
+        return self.response['contentType']
+
+    @property
+    def download_url(self) -> str:
+        return self.response['downloadUrl']
+
+    @property
+    def created_at(self) -> datetime:
+        return self.response['createdAt']
+
+    @property
+    def last_modified_at(self) -> datetime:
+        return self.response['lastModifiedAt']
+
+    @property
+    def last_accessed_at(self) -> datetime:
+        return self.response['lastAccessedAt']
+
+    @property
+    def length(self) -> int:
+        return self.response['length']
+
+    @property
+    def io(self) -> BytesIO:
+        response = requests.get(self.download_url, timeout=1800)
+        return BytesIO(response.content)
+
+
+class Template(File):
+    pass
+
+
+class Usage:
+
+    def __init__(self, response):
+        self.response = response
+
+    @property
+    def quota(self) -> int:
+        return self.response['quota']
+
+    @property
+    def page_count(self) -> int:
+        return self.response['pageCount']
+
+    @property
+    def usage(self) -> int:
+        return self.response['usage']

blazingdocs/parameters.py

@@ -0,0 +1,11 @@
+from .enums import DataSourceType
+from .utils import Object
+
+
+class MergeParameters(Object):
+    def __init__(self):
+        self.dataSourceName: str = 'data'
+        self.dataSourceType: DataSourceType = DataSourceType.JSON
+        self.sequence: bool = False
+        self.parseColumns: bool = False
+        self.strict: bool = True

blazingdocs/utils.py

@@ -0,0 +1,15 @@
+import json
+from io import BytesIO
+
+
+class Object:
+    def to_json(self):
+        return json.dumps(self, default=lambda o: o.__dict__)
+
+
+class FormFile:
+
+    def __init__(self, name: str):
+        self.name: str = name
+        self.contentType: str
+        self.content: BytesIO

examples/get_account.py

@@ -0,0 +1,11 @@
+from blazingdocs import BlazingClient
+
+
+def get_account():
+    client = BlazingClient('YOUR-API-KEY')
+    account = client.get_account()
+
+
+if __name__ == '__main__':
+    get_account()
+

examples/get_templates.py

@@ -0,0 +1,11 @@
+from blazingdocs import BlazingClient
+
+
+def get_templates():
+    client = BlazingClient('YOUR-API-KEY')
+    templates = client.get_templates()
+
+
+if __name__ == '__main__':
+    get_templates()
+

examples/get_usage.py

@@ -0,0 +1,10 @@
+from blazingdocs import BlazingClient
+
+
+def get_usage():
+    client = BlazingClient('YOUR-API-KEY')
+    usage = client.get_usage()
+
+
+if __name__ == '__main__':
+    get_usage()