Merge pull request #40 from contentstack/feat/CS-38762-ci/cd-azure-eu-live_preview_include_metadata

Feat/cs 38762 ci/cd azure eu live preview include metadata

Author: ishaileshmishra

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_PASSWORD }}

.github/workflows/python-publish.yml

@@ -4,3 +4,6 @@ fileignoreconfig:
 
 - filename: README.md
   checksum: d9d20b2badbf1aa62649bb174db47a9e491d8687e33ac69fee62568efa23fc56
+fileignoreconfig:
+- filename: .github/workflows/publish.yml
+  checksum: 4f2e1a9283c5aadaaec639f5efa0111dc35f385ead74e9a6a585f839d27aa0c8

.talismanrc

@@ -2,7 +2,7 @@
 
 ## _v1.8.0_
 
-### **Date: 23-MAY-2023**
+### **Date: 26-MAY-2023**
 
 - AZURE_EU, Region support added
 - Include Metadata support added to asset, entry and query

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Security
+
+Contentstack takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations.
+
+If you believe you have found a security vulnerability in any Contentstack-owned repository, please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Send email to [security@contentstack.com](mailto:security@contentstack.com).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+[https://www.contentstack.com/trust/](https://www.contentstack.com/trust/)

SECURITY.md

@@ -5,7 +5,7 @@
 *v1.8.0*
 ============
 
-**Date: 23-MAY-2023**
+**Date: 26-MAY-2023**
 
 - AZURE_EU, Region support added
 - Include Metadata support added to asset, entry and query

changelog.rst

@@ -2,7 +2,7 @@
 The Get a single entry request fetches a particular entry of a content type.
 API Reference: https://www.contentstack.com/docs/developers/apis/content-delivery-api/#single-entry
 """
-
+#min-similarity-lines=10
 import logging
 from urllib import parse
 

contentstack/entry.py

@@ -27,21 +27,11 @@ def __get_os_platform():
 def user_agents():
     header = {'sdk': dict(name=contentstack.__package__,
                           version=contentstack.__version__
-                          ), 'os': __get_os_platform, 'Content-Type': 'application/json'}
+                          ), 'os': __get_os_platform(), 'Content-Type': 'application/json'}
     package = f"{contentstack.__title__}/{contentstack.__version__}"
     return {'User-Agent': str(header), "X-User-Agent": package}
 
 
-def get_api_data(response):
-    try:
-        response.raise_for_status()
-    except requests.exceptions.HTTPError as error:
-        print(f"Error: {error}")
-        return None
-    else:
-        return response.json()
-
-
 class HTTPSConnection:  # R0903: Too few public methods
     def __init__(self, endpoint, headers, timeout, retry_strategy, live_preview):
         if None not in (endpoint, headers):
@@ -53,22 +43,6 @@ def __init__(self, endpoint, headers, timeout, retry_strategy, live_preview):
             self.retry_strategy = retry_strategy
             self.live_preview = live_preview
 
-    def impl_live_preview(self):
-        if self.live_preview['enable']:
-            host = self.live_preview['host']
-            authorization = self.live_preview['authorization']
-            ct = self.live_preview['content_type_uid']
-            entry_uid = self.live_preview['entry_uid']
-            url = f'https://{host}/v3/content_types/{ct}/entries'
-            if entry_uid is not None:
-                url = f'{url}/{entry_uid}'
-            self.headers['authorization'] = authorization
-            lp_resp = get_request(self.session, url, headers=self.headers, timeout=self.timeout)
-            if lp_resp is not None and not 'error_code' in lp_resp:
-                return lp_resp
-            return None
-        return None
-
     def get(self, url):
         self.headers.update(user_agents())
         adapter = HTTPAdapter(max_retries=self.retry_strategy)

contentstack/https_connection.py

@@ -1,7 +1,7 @@
 """
 Contentstack provides certain queries that you can use to fetch filtered results
 """
-
+#min-similarity-lines=10
 import enum
 import json
 import logging

contentstack/query.py

@@ -2,6 +2,7 @@
 
 import config
 import contentstack
+from contentstack.deep_merge_lp import DeepMergeMixin
 
 management_token = 'cs8743874323343u9'
 entry_uid = 'blt8743874323343u9'
@@ -131,5 +132,84 @@ def test_10_live_preview_check_hash_value(self):
         self.assertEqual(ENVIRONMENT, self.stack.headers['environment'])
 
 
+lp_response = [
+    {
+        "uid": "76743678743",
+        "comment": "this belongs to live preview object",
+        "_version": 2,
+        "locale": "en-us",
+        "ACL": {},
+        "author": [
+            {
+                "uid": "77f3f0ea3630e06",
+                "_content_type_uid": "author"
+            }
+        ]
+    },
+    {
+        "uid": "7634767463",
+        "_version": 2,
+        "locale": "en-us",
+        "comment": "this belongs to live preview object",
+        "ACL": {},
+        "author": [
+            {
+                "uid": "bltb77f3f0ea3630e06",
+                "_content_type_uid": "author"
+            }
+        ]
+    }
+]
+
+entry_response = [
+    {
+        "uid": "76743678743",
+        "_version": 3,
+        "locale": "en-uk",
+        "title": "Updated Title",
+        "comment": "this belongs to entry object",
+    },
+    {
+        "uid": "47634767463",
+        "_version": 3,
+        "locale": "en-uk",
+        "title": "Updated Title",
+        "comment": "this belongs to entry object",
+    },
+    {
+        "uid": "34767463",
+        "_version": 3,
+        "locale": "en-us",
+        "comment": "this belongs to entry object",
+        "title": "You have received a new merged entry response"
+    }
+]
+
+
+class TestLivePreviewObject(unittest.TestCase):
+
+    def setUp(self):
+        self.stack = contentstack.Stack(
+            API_KEY, DELIVERY_TOKEN,
+            ENVIRONMENT, host=HOST)
+
+    def test_setup_live_preview(self):
+        self.stack = contentstack.Stack(API_KEY, DELIVERY_TOKEN, ENVIRONMENT, live_preview={
+            'enable': False,
+            'host': 'api.contentstack.io',
+            'management_token': 'string987654321'
+        })
+        self.stack.content_type('product').entry(entry_uid)
+        self.assertEqual(3, len(self.stack.get_live_preview))
+        self.assertFalse(self.stack.get_live_preview['enable'])
+        self.assertTrue(self.stack.get_live_preview['management_token'])
+
+    def test_deep_merge_object(self):
+        merged_response = DeepMergeMixin(entry_response, lp_response)
+        self.assertTrue(isinstance(merged_response.entry_response, list))
+        self.assertEqual(3, len(merged_response.entry_response))
+        print(merged_response.entry_response)
+
+
 if __name__ == '__main__':
     unittest.main()