Contentstack 0.1.0__py3-none-any.whl

contentstack/errors.py

@@ -0,0 +1,162 @@
+
+"""
+
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+contentstack.error
+~~~~~~~~~~~~~~~~~~
+
+API Reference: https://www.contentstack.com/docs/apis/content-delivery-api/#error
+
+"""
+
+
+class Error:
+    
+    """
+    This module implements the Error class.
+    
+    API Reference: https://www.contentstack.com/docs/apis/content-delivery-api/#error
+
+    """
+
+    def __init__(self):
+
+        self.__error_dict = {}
+        self.__error_code = str
+        self.__msg = str
+
+    def _config(self, result: dict):
+        
+        # _instance is the protected member of the asset, So outsiders can not access this file.
+        if result is not None and len(result) > 0:
+            self.__error_dict = result
+            self.__error_code = self.__error_dict['error_code']
+            self.__msg = self.__error_dict['error_message']
+
+        return self
+
+    @property
+    def error_code(self):
+        """It returns error code from the stack response
+        
+        Returns:
+            int -- error_code as int
+        
+        ==============================
+        
+        [Example:]
+
+        >>> error_code = error.error_code
+
+        ==============================
+
+        """
+        return self.__error_code
+
+    @property
+    def error_message(self):
+
+        """
+        Returns error_message from the stack response
+
+        Returns:
+            str -- error_message from the stack response
+
+        ==============================
+
+        [Example:]
+
+        >>> message = error.error_message
+
+        ==============================
+        """
+
+        return self.__msg
+
+    @property
+    def error(self):
+
+        """
+        error property returns error code and error_message in dict formats
+
+        Returns:
+            dict -- error code and error_message in dict formats
+
+        ==============================
+
+        [Example:]
+
+        >>> error = error.error
+
+        ==============================
+        """
+
+        return self.__msg
+
+    @property
+    def error_info(self) -> dict:
+
+        """error information
+
+        Returns:
+            dict -- error information
+
+        ==============================
+
+        [Example:]
+
+        >>> ode = error.error_info
+        
+        ==============================
+        """
+        return self.__error_dict
+
+    errors_str = {
+
+        'invalid_json': "Please provide valid JSON.",
+        'api_key_is_none': "Stack api key can not be None.",
+        'empty_content_type': "Please set contentType name.",
+        'access_token_error': "Access token can not be None.",
+        'environment_error': "Environment can not be None.",
+        'connection_error': "Connection error",
+        'auth_failure': "Authentication Not present.",
+        'parse_error': "Parsing Error.",
+        'server_error': "Server interaction went wrong, Please try again.",
+        'error_default': "Oops! Something went wrong. Please try again.",
+        'no_network': "Network not available.",
+        'query_error': "Please provide valid params."
+    }
+
+    __error_code = {
+
+        400: "The request was incorrect or corrupted.",
+        401: "The login credentials are invalid.",
+        403: "The page or resource that is being accessed is forbidden.",
+        404: "The requested page or resource could not be found.",
+        412: "The entered API key is invalid.",
+        422: "The request is syntactically correct but contains semantic errors",
+        429: "The number of requests exceeds the allowed limit for the given time period.",
+        500: "The server is malfunctioning and is not specific on what the problem is.",
+        502: "A server received an invalid response from another server.",
+        504: """ A server did not receive a timely response from another server that it was accessing while attempting
+             to load the web page or fill another request by the browser. """
+    }
+
+
+class StackException(Exception):
+    """
+    StackException used to handle Stack validation Errors.
+    """
+    pass
+
+
+class RequestsWarning(Warning):
+    """Base warning for Requests."""
+    pass
+
+
+class FileModeWarning(RequestsWarning, DeprecationWarning):
+    """A file was opened in text mode, but Requests determined its binary length."""
+    pass

contentstack/http_connection.py

@@ -0,0 +1,195 @@
+"""
+HttpConnection
+contentstack
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+"""
+
+import logging
+import requests
+from urllib.parse import urlencode
+from contentstack import Error
+from json import JSONDecodeError
+from requests.exceptions import Timeout, HTTPError
+
+
+class HTTPConnection(object):
+
+    def __init__(self, url, query, stack_headers):
+
+        if None not in (url, query, stack_headers):
+            self.__payload = None
+            self.__base_url = url
+            self.__query_params = query
+            self.__headers = stack_headers
+            self.__headers.update(self.__user_agents())
+
+            if 'environment' in self.__headers:
+                environment = self.__headers['environment']
+                self.__query_params['environment'] = environment
+
+    def get_result(self, url: str, query: dict, headers: dict):
+
+        if None not in (url, query, headers):
+            if len(url) > 0 and len(self.__headers) > 0:
+                self.__base_url = url
+                if len(headers) > 0:
+                    self.__headers.update(headers)
+                self.__query_params.update(query)
+
+                # Case: If UIR Parameter contains entries
+                if 'entries' in self.__base_url:
+                    self.__payload = self.__execute_entry()
+                else:
+                    url_param = ''
+                    for (key, value) in self.__query_params.items():
+                        url_param = '{}&{}={}'.format(url_param, key, value)
+                    self.__payload = url_param
+        try:
+            if self.__payload.startswith("&"):
+                self.__payload = self.__payload[1:]
+
+            _url = '{}?{}'.format(self.__base_url, self.__payload)
+            logging.info('{}?{}'.format(self.__base_url, self.__payload))
+            response = requests.get(_url, verify=True, timeout=(10, 8), headers=self.__headers)
+
+            if response.status_code == 200:
+                if response.raise_for_status() is None:
+                    return self.__parse_dict(response)
+            else:
+                err = response.json()
+                if err is not None:
+                    error = Error()
+                    error._config(err)
+                    return error
+
+            logging.info('\n\nrequest url => {}\nresponse={}'.format(response.url, response))
+
+        except Timeout:
+            raise TimeoutError('The request timed out')
+        except ConnectionError:
+            raise ConnectionError('Connection error occurred')
+        except JSONDecodeError:
+            raise JSONDecodeError('Invalid JSON in request')
+        except HTTPError:
+            raise HTTPError('Http Error Occurred')
+
+    def __parse_dict(self, response):
+        from contentstack.stack import SyncResult
+
+        result = response.json()
+        if 'stack' in result:
+            return result['stack']
+        if 'entry' in result:
+            dict_entry = result['entry']
+            return self.__parse_entries(dict_entry)
+        if 'entries' in result:
+            entry_list = result['entries']
+            return self.__parse_entries(entry_list)
+        if 'asset' in result:
+            dict_asset = result['asset']
+            return self.__parse_assets(dict_asset, 1)
+        if 'assets' in result:
+            asset_list = result['assets']
+            asset_count = 0
+            if 'count' in result:
+                asset_count = result['count']
+            return self.__parse_assets(asset_list, asset_count)
+        if 'content_type' in result:
+            return result['content_type']
+        if 'content_types' in result:
+            return result['content_types']
+        if 'items' in result:
+            sync_result = SyncResult()
+            sync_result._configure(result)
+            return sync_result
+
+        return None
+
+    @staticmethod
+    def __parse_entries(result):
+        from contentstack import Entry
+        entries = []
+        entry = Entry()
+        # if 'count' in result:
+        # entry.count = result['count']
+        if result is not None and len(result) > 0:
+            if isinstance(result, dict):
+                return entry._configure(result)
+            if isinstance(result, list):
+                for entry_obj in result:
+                    each_entry = Entry()._configure(entry_obj)
+                    entries.append(each_entry)
+                return entries
+
+    @staticmethod
+    def __parse_assets(result, asset_count):
+        from contentstack import Asset
+        assets = []
+        asset = Asset()
+
+        if result is not None and len(result) > 0:
+            if isinstance(result, dict):
+                return asset._configure(result)
+            if isinstance(result, list):
+                for asset_obj in result:
+                    itr_asset = asset._configure(asset_obj)
+                    assets.append(itr_asset)
+                asset._count(asset_count)
+                return assets
+
+    @staticmethod
+    def __user_agents() -> dict:
+
+        import contentstack
+        import platform
+
+        header = {'sdk': dict(name=contentstack.__package__, version=contentstack.__version__)}
+        os = platform.system()
+        if os == 'Darwin':
+            os = 'macOS'
+        elif not os or os == 'Java':
+            os = None
+        elif os and os not in ['macOS', 'Windows']:
+            os = 'Linux'
+        header['os'] = {'name': os, 'version': platform.release()}
+        package = "contentstack-python, - {}".format(contentstack.__version__)
+        local_headers = {'User-Agent': str(header), "Content-Type": 'application/json', "X-User-Agent": package}
+        return local_headers
+
+    def __execute_entry(self):
+
+        url_param = ''
+
+        for (key, value) in self.__query_params.items():
+            if key == 'include[]':
+                if isinstance(value, list):
+                    url_param = '{}&{}'.format(url_param, urlencode({key: value}, doseq=True))
+            elif key == 'only[BASE][]':
+                if isinstance(value, list):
+                    url_param = '{}&{}'.format(url_param, urlencode({key: value}, doseq=True))
+            elif key == 'except[BASE][]':
+                if isinstance(value, list):
+                    url_param = '{}&{}'.format(url_param, urlencode({key: value}, doseq=True))
+            elif key == 'only':
+                for uid in value:
+                    inner_list = value[uid]
+                    inner_key = 'only[{}][]'.format(uid)
+                    if isinstance(inner_list, list):
+                        url_param = '{}&{}'.format(url_param, urlencode({inner_key: inner_list}, doseq=True))
+            elif key == 'except':
+                for uid in value:
+                    inner_list = value[uid]
+                    inner_key = 'except[{}][]'.format(uid)
+                    if isinstance(inner_list, list):
+                        url_param = '{}&{}'.format(url_param, urlencode({inner_key: inner_list}, doseq=True))
+            elif key == 'query':
+                url_param = '{}&{}={}'.format(url_param, key, value.__str__().replace("\'", "\""))
+                print(url_param)
+            else:
+                url_param = '{}&{}={}'.format(url_param, key, value)
+
+        return url_param
+
+