Merge pull request #3 from contentstack/dev

Dev

Author: ishaileshmishra

contentstack/__init__.py

@@ -8,14 +8,14 @@
 
 from .entry import Entry
 from .asset import Asset
-from .asset_library import AssetLibrary
 from .config import Config
 from .content_type import ContentType
 from .errors import Error, ConfigError
 from .http_connection import HTTPConnection
 
 # Set a default logger to prevent "No handler found" warnings
 import logging
+
 try:
     from logging import NullHandler
 except ImportError:

contentstack/asset_library.py

@@ -21,58 +21,71 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
 
- """
+"""
 import logging
 
 
-logging.basicConfig(filename='contentstack.log', format='%(asctime)s - %(message)s', level=logging.INFO)
+logging.basicConfig(filename='cs.log', format='%(asctime)s - %(message)s', level=logging.INFO)
 logging.getLogger("Config")
 
 
-class Config:
+class Config(object):
+    """
+    All API paths are relative to this base URL, for example, /users actually means <scheme>://<host>/<basePath>/users.
+
+    """
 
     def __init__(self):
-        self.defaultConfig = dict(protocol="https://", host="cdn.contentstack.io", port=443, version="v3", path={
-            "stacks": "stacks",
-            "sync": "stacks/sync",
-            "content_types": "content_types",
-            "entries": "content_types",
-            "assets": "assets",
-            "environments": "environments"
-        })
-
-    def host(self, host_url=None):
-        if host_url is not None:
-            self.defaultConfig["host"] = host_url
-        return self.defaultConfig["host"]
-
-    def version(self, version: str = None):
-        if version is not None and isinstance(version, str):
-            self.defaultConfig['version'] = version
-            return self.defaultConfig['version']
-        else:
-            return self.defaultConfig['version']
-
-    def path(self, path):
-        url_section = self.defaultConfig['path']
-        if path in url_section:
-            return url_section[path]
-        else:
-            logging.error("{0} is invalid endpoint path".format(path))
-            raise ValueError('Invalid endpoint!!, {0} is invalid endpoint path, '
-                             'Path can be found among {1}'
-                             .format(path, url_section.keys()))
-
-    def endpoint(self, path):
-        url = self.path(path)
-        if url is not None and isinstance(url, str):
-            url = "{0}{1}/{2}/{3}".format(self.defaultConfig["protocol"], self.host(), self.version(), url)
-            logging.info('endpoint is :: {0} '.format(url))
-        return url
 
+        # It initialises the Config with the default endpoint
+        self.default = dict(protocol="https", host="cdn.contentstack.io", port=443, version="v3")
+
+    def host(self, host):
+
+        """
+        The base URL for Content Delivery API is cdn.contentstack.io.
+        host is the domain name or IP address (
+        IPv4) of the host that serves the API. It may include the port number if different from the scheme's default
+        port (443 for HTTPS).
+
+        Note: contentstack supports HTTPS only
+        :param host: host is the domain name
+        :type host: str
+        :return: self
+        :rtype: Config
+
+        Example:
+
+            >>> config  = Config().host('api.contentstack.io')
 
-config = Config()
-config.host("cdn.contentstack.io")
-result_url = config.endpoint('entries')
-print(result_url)
+        """
 
+        if host is not None and isinstance(host, str):
+            self.default['host'] = host
+        return self
+
+    def version(self, version=None):
+
+        """
+        Note: Only version 3 is supported on the CDN. If you're still using version 2 (which we recommend you should
+        not), switch to the CDN version for even faster loading.
+        :param version: The API version can be found in the URL that is basePath
+        :type version: str
+        :return: self
+        :rtype: Config
+
+        Example: The API version (in our case, 'v3') can be found in the URL, e.g.
+
+            >>> config  = Config()
+            >>> config.version = 'v3'
+
+        """
+        if version is not None and isinstance(version, str):
+            self.default['version'] = version
+
+        return self
+
+    @property
+    def endpoint(self):
+        url = "{0}://{1}/{2}".format(self.default["protocol"], self.default["host"], self.default["version"])
+        return url

contentstack/config.py

@@ -14,7 +14,7 @@
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
@@ -24,54 +24,91 @@
 
 
 class Error:
+
     """
     contentstack.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
         self.__cause_err = str
 
     def config(self, result: dict):
 
+        """
+
+        :param result:
+        :type result:
+        :return:
+        :rtype:
+        """
         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']
             self.__cause_err = self.__error_dict['errors']
-
         return self
 
     @property
     def error_code(self):
+
         """
+        It returns error code from the stack response
         :return: error_code as int
+        :rtype: int
+
+        Example. code = error.error_code
+
         """
         return self.__error_code
 
     @property
     def error_message(self):
+
         """
+        Returns error_message from the stack response
         :return: error_message
+        :rtype: str
+
+        Example. error.error_message
+
         """
+
         return self.__msg
 
     @property
     def error(self):
+
         """
+        This returns error code and error_message in dict formats
         :return: error dict
+        :rtype: dict
+
+        Example. error = error.error
         """
+
         return self.__cause_err
 
     @property
     def error_info(self) -> dict:
+
         """
-        :return: dict, error information
+        error information
+        :return: error information
+        :rtype: dict
+
+        Example. error.error_info
+
         """
         return self.__error_dict