Merge pull request #2 from contentstack/dev

Dev

Author: ishaileshmishra

.gitignore

@@ -24,8 +24,8 @@ wheels/
 .installed.cfg
 *.egg
 MANIFEST
-.DS_Store
-.DS_Store?
+*.DS_Store
+*.DS_Store?
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -104,3 +104,7 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+
+.idea/
+.DS_Store?

CHANGELOGS.md

@@ -1,3 +1,3 @@
 
-## v1.0.0
+## v 0.0.1
 Initial release of the python Content Delivery API SDK.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Contentstack
+Copyright (c) 2012 - 2019 Contentstack. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

contentstack/__init__.py

@@ -1,43 +1,26 @@
-# -*- coding: utf-8 -*-
+""" contentstack python sdk. """
 
-# __init__.py
-# Contentstack
-# Created by Shailesh on 22/06/19.
-# Copyright (c) 2012 - 2019 Contentstack. All rights reserved.
-
-# [MIT License] :: Permission is hereby granted, free of charge, to any person
-# obtaining a copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-
-# 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
-# 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
-# SOFTWARE.
-
-"""Export module packages."""
+__author__ = 'Shailesh Mishra'
+__status__ = 'debug'
+__version__ = '1.0.0'
+__package__ = 'contentstack'
+__endpoint__ = 'cdn.contentstack.io'
 
 from .entry import Entry
 from .asset import Asset
 from .asset_library import AssetLibrary
 from .config import Config
-from .sync_stack import SyncStack
-from .query_result import QueryResult
 from .content_type import ContentType
-from .entry_model import EntryModel
-from .errors import HTTPError, ConfigError
-from .group import Group
-from .http_request import HTTPRequestConnection
+from .errors import Error, ConfigError
+from .http_connection import HTTPConnection
 
-__author__ = 'contentstack - (www.github.con/contentstack)'
-__email__ = 'shailesh.mishra@contentstack.com'
-__version__ = '0.0.1'
-__endpoint__ = 'cdn.contentstack.io'
+# Set a default logger to prevent "No handler found" warnings
+import logging
+try:
+    from logging import NullHandler
+except ImportError:
+    class NullHandler(logging.Handler):
+        def emit(self, record):
+            pass
+
+logging.getLogger(__name__).addHandler(NullHandler())

contentstack/asset_library.py

@@ -23,10 +23,98 @@
  *
  """
 
-import logging
 
+class OrderType(object):
 
-class AssetLibrary():
+    """
+    OrderType is used to choose one of the ascending and descending
+    It returns either ascending or descending
+    """
+    ASC, DESC = range(0, 2)
+
+    pass
+
+
+class AssetLibrary:
+
+    """
+    contentstack.asset_library
+    ~~~~~~~~~~~~~~~~~~
+    This module implements the AssetLibrary class.
+    API Reference: https://www.contentstack.com/docs/apis/content-delivery-api/#assets
+
+    """
 
     def __init__(self):
-        logging.info('Asset initialised')
+
+        self.__count = 0
+        self.__stack_instance = None
+        self.__http_request = None
+        self.__stack_headers = {}
+        self.__query_params = {}
+
+    def instance(self, stack_instance):
+
+        self.__stack_instance = stack_instance
+        self.__stack_headers.update(self.__stack_instance.headers)
+        self.__http_request = self.__stack_instance.http_request
+
+    def set_header(self, key: str, value):
+
+        if key is not None and value is not None:
+            self.__stack_headers[key] = value
+            return self
+
+    def headers(self, headers: dict):
+
+        if headers is not None and len(headers) > 0 and isinstance(headers, dict):
+            self.__stack_headers = headers
+            if 'environment' in self.__stack_headers:
+                env_value = self.__stack_headers['environment']
+                self.__query_params["environment"] = env_value
+        return self
+
+    def remove_header(self, key):
+
+        if key is not None:
+            if key in self.__stack_headers:
+                self.__stack_headers.pop(key)
+        return self
+
+    def include_count(self):
+        self.__query_params['include_count'] = 'true'
+        return self
+
+    def include_relative_url(self):
+        self.__query_params['relative_urls'] = 'true'
+        return self
+
+    def get_count(self) -> int:
+        """
+        get_count returns the total size of content
+        :return: count of content
+        :rtype: int
+        """
+        return self.__count
+
+    def sort(self, key: str, order_by: OrderType):
+
+        """
+        :param key: provides key on which ASC/DESC need to apply.
+        :param order_by: object option either "asc" or "desc"
+        :return self , instance of AssetLibrary
+        """
+        if order_by == 1:
+            self.__query_params['asc'] = key
+        else:
+            self.__query_params['desc'] = key
+
+        return self.__query_params
+
+    def fetch_all(self):
+        from contentstack import Config
+        asset_url = Config().endpoint('assets')
+        return self.__http_request.get_result(asset_url, self.__query_params, self.__stack_headers)
+
+
+

contentstack/config.py

@@ -20,39 +20,59 @@
  * 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
  * SOFTWARE.
- *
- """
 
+ """
 import logging
 
 
-class Config(object):
+logging.basicConfig(filename='contentstack.log', format='%(asctime)s - %(message)s', level=logging.INFO)
+logging.getLogger("Config")
+
+
+class Config:
+
+    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 __init__(self, host_url: str = 'cdn.contentstack.io'):
-        self.host_url = host_url
-        self.api_version: str = 'v3'
-        self.http_protocol: str = 'https://'
+    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 set_host(self, host_url=None):
-        logging.info("set host", host_url)
-        self.host_url = host_url
-        return self
+    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 get_host(self):
-        logging.info('getting host url', self.host_url)
-        return self.host_url
+    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
 
-    def get_version(self):
-        logging.info('getting api version', self.api_version)
-        return self.api_version
 
-    def get_http_protocol(self):
-        logging.info('get http protocol', self.http_protocol)
-        return self.http_protocol
+config = Config()
+config.host("cdn.contentstack.io")
+result_url = config.endpoint('entries')
+print(result_url)
 
-    def get_endpoint(self, url_path):
-        api_version: str = self.get_version()
-        host_url = self.get_host()
-        http_protocol = self.get_http_protocol()
-        config_url = "{0}{1}/{2}/{3}".format(http_protocol, host_url, api_version, url_path)
-        return config_url