Contentstack 0.1.0__py3-none-any.whl

contentstack/config.py

@@ -0,0 +1,162 @@
+import enum
+import logging
+
+"""
+Config
+contentstack
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+"""
+
+logging.basicConfig(filename='report.log', format='%(asctime)s - %(message)s', level=logging.INFO)
+logging.getLogger(__name__)
+
+
+class ContentstackRegion(enum.Enum):
+    US = 'us'
+    EU = 'eu'
+
+
+class Config(object):
+
+    def __init__(self):
+
+        """Config class arguments accepts protocol, region, host and version:
+        
+        protocol: It support https protocol only
+        region: It accepts us and eu region.
+        host: host of the stack
+        version: API version, contentstack support v3 API version
+        
+        """
+        self.default = dict(protocol="https", region=ContentstackRegion.US, host="cdn.contentstack.io", version="v3")
+
+    @property
+    def region(self):
+
+        """It sets the region in the API, We support us and eu region
+        default region will be us.
+        
+        Returns:
+            ContentstackRegion -- It returns type of ContentstackRegion
+        """
+        return self.default['region']
+
+    @region.setter
+    def region(self, region=ContentstackRegion.US):
+
+        """
+        A Contentstack region refers to the location of the data centers where your organization's data resides.
+        
+        Keyword Arguments:
+            region {ContentstackRegion} -- region refers to the location of the data centers where your organization's
+            data resides. (default: {ContentstackRegion.US})
+
+        For more details: https://www.contentstack.com/docs/guide/contentstack-regions
+        
+        ==============================
+
+        [Example:]
+
+            >>> config = Config()
+            >>> config.region = ContentstackRegion.US
+
+        ==============================
+        """
+
+        if region is not None and isinstance(region, ContentstackRegion):
+            if region != ContentstackRegion.US:
+                if self.default["host"] == 'cdn.contentstack.io':
+                    self.default["host"] = 'cdn.contentstack.com'
+            self.default['region'] = region
+
+    @property
+    def host(self):
+
+        """host property returns host of the API
+        
+        Returns:
+            str -- host of the API
+        """
+
+        return self.default['host']
+
+    @host.setter
+    def host(self, host):
+
+        """
+        The base URL for Content Delivery API is cdn.contentstack.io.
+        host is the domain name or IP address of the host that serves the API. It may include the 
+        port number if different from the scheme's default
+        port (443 for HTTPS).
+        
+        Arguments:
+            host {str} -- host of the stack
+        
+        Returns:
+            [Config] -- Config, So we can chain more functions
+
+        ==============================
+        
+        [Example:] 
+
+            >>> config  = Config()
+            >>> config.host = 'cdn.contentstack.io'
+        
+        ==============================
+        """
+
+        if host is not None and isinstance(host, str):
+            self.default['host'] = host
+
+    def version(self, version=None):
+
+        """
+        Only version v3 is supported on the CDN.
+        
+        Keyword Arguments:
+            version {str} -- version of the API (default: {None})
+        
+        Returns:
+            Config -- class instance to chain the functions
+
+        ==============================
+        
+        [Example:] 
+
+            >>> config = Config()
+            >>> config = config.version('v3')
+        
+        ==============================
+
+        """
+
+        if version is not None and isinstance(version, str):
+            self.default['version'] = version
+
+        return self
+
+    @property
+    def endpoint(self):
+
+        """It returns endpoint url of the API
+        The base URL for Content Delivery API for the US region is cdn.contentstack.io. and  
+        for the European region it is  eu-cdn.contentstack.com
+        For more details: https://www.contentstack.com/docs/apis/content-delivery-api/#base-url
+        
+        Returns:
+            str -- endpoint url of the API
+
+        """
+        return self.__get_url()
+
+    def __get_url(self):
+        host = self.default["host"]
+        region = self.default['region'].value
+        if region is not None:
+            if region is not 'us':
+                if self.default["host"] == 'cdn.contentstack.io':
+                    self.default["host"] = 'cdn.contentstack.com'
+                host = '{}-{}'.format(region, self.default["host"])
+        return "{0}://{1}/{2}".format(self.default["protocol"], host, self.default["version"])

contentstack/content_type.py

@@ -0,0 +1,233 @@
+"""
+
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+contentstack.content_type
+~~~~~~~~~~~~~~~~~~
+
+API Reference: https://www.contentstack.com/docs/guide/content-types
+
+"""
+
+
+class ContentType:
+    """Content type defines the structure or schema of a page or a section of your web or mobile property. To create
+    content for your application, you are required to first create a content type, and then create entries using the
+    content type.
+
+    Read more about Content Types[https://www.contentstack.com/docs/guide/content-types].
+
+    """
+
+    def __init__(self, content_type_uid: str):
+        self.__config = None
+        self.__stack_instance = None
+        self.__http_request = None
+        self.__stack_headers = {}
+
+        if content_type_uid is None or not isinstance(content_type_uid, str):
+            raise KeyError('content_type_uid can not be None')
+        self.__content_type_uid = content_type_uid
+
+    def _instance(self, stack_instance):
+        # _instance is the protected member of the asset, So outsiders can not access this file.
+        from contentstack.stack import Stack
+        from contentstack.errors import StackException
+        if stack_instance is None:
+            raise StackException('Kindly initialise stack first')
+        self.__stack_instance: Stack = stack_instance
+        self.__config = self.__stack_instance.config
+        self.__stack_headers.update(self.__stack_instance.headers)
+        self.__http_request = self.__stack_instance.get_http_instance
+
+    @property
+    def header(self):
+
+        """header property is useful to get header of the the content_type
+        
+        Returns:
+            dict -- It returns stack_headers
+
+        ==============================
+        
+        [Example:]
+
+            >>> from contentstack import Stack
+            >>> stack = Stack(api_key='stack_api_key', access_token='stack_access_token', environment='env')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> headers = content_type.header
+        
+        ==============================
+
+        """
+
+        return self.__stack_headers
+
+    def add_header(self, key, value):
+
+        """
+        Adds header in content_type as key value pair
+        
+        Arguments:
+            key {str} -- key of the header
+            value {object} -- value of the respected key in header
+        
+        Raises:
+            KeyError: key and value should not be None
+            KeyError: key and value both should be str type
+        
+        Returns:
+            ContentType -- ContentType, So we can chain the call
+
+        ==============================
+        
+        [Example:]
+            >>> from contentstack import Stack
+            >>> stack = Stack(api_key='stack_api_key', access_token='stack_access_token', environment='env')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> content_type = content_type.add_header('key', 'value')
+        
+        ==============================
+        """
+        if None in (key, value):
+            raise KeyError('Kindly provide a valid key and value')
+        elif isinstance(key, str) and isinstance(value, str):
+            self.__stack_headers[key] = value
+        else:
+            raise KeyError('Key and value should be str type')
+
+        return self
+
+    def remove_header(self, key):
+
+        """It deletes the header against specified key
+        
+        Arguments:
+            key {str} -- existing key that has to delete from header
+    
+        Raises:
+            KeyError: If Key is None, Empty or not str type
+        
+        Returns:
+            ContentType -- ContentType class object so we can chain more functions
+        
+        ==============================
+        
+        [Example:]
+            >>> from contentstack import Stack
+            >>> stack = Stack(api_key='stack_api_key', access_token='stack_access_token', environment='env')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> content_type = content_type.remove_header('key')
+        
+        ==============================
+
+        """
+
+        if key is None:
+            raise KeyError('key should not be None')
+        elif isinstance(key, str):
+            if key in self.__stack_headers:
+                self.__stack_headers.pop(key)
+
+        return self
+
+    def entry(self, uid):
+
+        """An entry is the actual piece of content created using one of the defined content types.
+        
+        Read more about Entries. 
+        [https://www.contentstack.com/docs/apis/content-delivery-api/#entries]
+
+        Arguments:
+            uid {str} -- uid of the entry
+        
+        Raises:
+            EnvironmentError: http instance is not found (invalid http request)
+            KeyError: entru uid should be str type
+        
+        Returns:
+            Entry -- Returns the Entry class object so we can chain the entry functions
+
+        ==============================
+        
+        [Example:]
+
+            >>> from contentstack import Stack
+            >>> stack = Stack(api_key='stack_api_key', access_token='stack_access_token', environment='env')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> entry: Entry = content_type.entry('uid')
+        
+        ==============================
+
+        """
+
+        from contentstack import Entry
+        if self.__http_request is None:
+            raise EnvironmentError("Invalid http request")
+        entry: Entry = Entry(content_type_id=self.__content_type_uid)
+        entry._instance(self.__stack_instance)
+        if uid is not None:
+            if isinstance(uid, str):
+                entry.uid=uid
+            else:
+                raise KeyError('entry uid should be str type')
+        return entry
+
+    def query(self):
+
+        """
+        It returns query class object so we can query on entry of specified ContentType
+        
+        Returns:
+            Query -- query object instance, so we can chain the query functions to it.
+        
+        ==============================
+        
+        [Example:]
+
+            >>> from contentstack import Stack
+            >>> stack = Stack(api_key='stack_api_key', access_token='stack_access_token', environment='env')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> query: Query = content_type.query()
+        
+        ==============================
+
+        """
+
+        from contentstack.query import Query
+        query = Query(self.__content_type_uid)
+        query._instance(self.__stack_instance)
+        return query
+
+    def fetch(self, params=None):
+
+        """This method is useful to fetch ContentType of the of the stack.
+        :return: response returns Json
+        :rtype: ContentType
+        
+        Returns:
+            dict -- Returns dictionary response
+        
+        ==============================
+
+        Example:
+
+            >>> from contentstack import Stack
+            >>> stack = Stack(api_key='stack_api_key', access_token='stack_access_token', environment='env')
+            >>> content_type = stack.content_type('content_type_uid')
+            >>> content_type.add_header('key', 'someheader')
+            >>> some_dict = {'abc':'something'}
+            >>> response = content_type.fetch(some_dict)
+
+        ==============================
+
+        """
+        params_dict = {}
+        endpoint = self.__config.endpoint
+        url = '{}/content_types'.format(endpoint)
+        content_type_url = '{0}/{1}'.format(url, self.__content_type_uid)
+        if params is not None and isinstance(dict, params):
+            params_dict.update(params)
+        result = self.__http_request.get_result(content_type_url, params_dict, self.__stack_headers)
+        return result