Added coverage reports generartion in github action

Added coverage report github action
Changed methods name
Changed unit test cases
Code improvements
API Documentation

Author: sunil-lakshman

.github/workflows/unit-test.yml

@@ -0,0 +1,43 @@
+name: Pytest Workflow
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  coverage-report:
+    strategy:
+      matrix:
+        python-version:
+          - 3.9
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install build dependencies
+        run: pip install --upgrade setuptools
+      - name: Install dot env
+        run: pip install python-dotenv
+      - name: Install requests
+        run: pip install requests
+      - uses: lpenz/ghaction-pytest-cov@v1
+      - uses: AndreMiras/coveralls-python-action@v20201129
+        with:
+          parallel: true
+          flag-name: python-${{ matrix.python-version }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+       
+          
+  coverage-finish:
+    needs: coverage-report
+    runs-on: ubuntu-latest
+    steps:
+      - uses: AndreMiras/coveralls-python-action@v20201129
+        with:
+          parallel-finished: true

.gitignore

@@ -136,3 +136,4 @@ tests/resources/.DS_Store
 tests/.DS_Store
 tests/resources/.DS_Store
 .DS_Store
+.talismanrc

.talismanrc

@@ -48,4 +48,13 @@ fileignoreconfig:
   checksum: a2ba35250e069e789f11e40efa7c1b2786f5db6899497643b5bf3a0e344d13e9
 - filename: contentstack_management/stack/stack.py
   checksum: f1b63294922e19f41dbf30caa6cbefe381b0c8834950d94dad7c7a28dd707047
+version: ""
+
+fileignoreconfig:
+- filename: contentstack_management/organizations/organizations.py
+  checksum: 31dc00bc449f8a9e5cb9321da10384dd7d40bd8fce30e56699e0ce0a0e3de48e
+- filename: contentstack_management/users/user.py
+  checksum: 1aa5ed251d166293e2616c6a227ee945a8213c5fde03778db08abac5f1a09c72
+- filename: tests/stack/test_stack_unittest.py
+  checksum: 12389c99db0d917954cd9970b340cc443602b4acf512090f42d13f7a726c85b6
 version: ""

contentstack_management/organizations/organizations.py

@@ -15,11 +15,12 @@ def __init__(self, endpoint, authtoken, headers, api_client, organization_uid):
         self.authtoken = authtoken
         self.headers = headers
         self.organization_uid = organization_uid
+        self.headers['authtoken'] = self.authtoken
 
 
-    def get(self):
+    def find(self):
         """
-        Fetches the organizations entries 
+        Finds the organizations entries 
         :return: Json, with organizations details.
         -------------------------------
         [Example:]
@@ -28,21 +29,30 @@ def get(self):
             >>> client = contentstack.client(host='HOST NAME')
             >>> client.login(email="email_id", password="password")
             >>> result = client.organizations().get().json()
+        -------------------------------
+        """
+        url = "organizations"
+        return self.api_client.get(url, headers = self.headers)
+    
+    def fetch(self):
+        """
+        Fetches the organizations entry
+        :return: Json, with organizations details.
+        -------------------------------
+        [Example:]
 
+            >>> from contentstack_management import contentstack
+            >>> client = contentstack.client(host='HOST NAME')
+            >>> client.login(email="email_id", password="password")
             >>> result = client.organizations('ORG_UID').get().json()
 
         -------------------------------
         """
-        url = "organizations"
-        if self.organization_uid is None:
-            url = "organizations"
-        else:
-            url = f"organizations/{self.organization_uid}"
-        self.headers['authtoken'] = self.authtoken
+        url = f"organizations/{self.organization_uid}"
         return self.api_client.get(url, headers = self.headers)
 
 
-    def get_organization_roles(self):
+    def roles(self):
         """
         Fetches the organization roles entries 
         :return: Json, with organization role details.
@@ -57,11 +67,10 @@ def get_organization_roles(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/roles"
-        self.headers['authtoken'] = self.authtoken
         return self.api_client.get(url, headers = self.headers)
 
 
-    def organization_add_users(self, user_data):
+    def add_users(self, user_data):
         """
         Add user to the organization 
         :return: Json, with user details.
@@ -94,11 +103,10 @@ def organization_add_users(self, user_data):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/share"
-        self.headers['authtoken'] = self.authtoken
         data = json.dumps(user_data)
         return self.api_client.post(url, headers = self.headers, data = data)
 
-    def transfer_organizations_ownership(self, data):
+    def transfer_ownership(self, data):
         """
         Add user to the organization 
         :return: Json, with user details.
@@ -117,12 +125,11 @@ def transfer_organizations_ownership(self, data):
         """
 
         url = f"organizations/{self.organization_uid}/transfer-ownership"
-        self.headers['authtoken'] = self.authtoken
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data = data)
 
 
-    def organization_stacks(self):
+    def stacks(self):
         """
         Fetches the organization stacks 
         :return: Json, with organization stack details.
@@ -137,11 +144,10 @@ def organization_stacks(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/stacks"
-        self.headers['authtoken'] = self.authtoken
         return self.api_client.get(url, headers = self.headers)
 
 
-    def organization_logs(self):
+    def logs(self):
         """
         Fetches the organization log entries 
         :return: Json, with organization log details.
@@ -156,6 +162,5 @@ def organization_logs(self):
         -------------------------------
         """
         url = f"organizations/{self.organization_uid}/logs"
-        self.headers['authtoken'] = self.authtoken
         return self.api_client.get(url, headers = self.headers)
 

contentstack_management/stack/stack.py

@@ -20,6 +20,7 @@ def __init__(self, endpoint, authtoken, headers, api_client, api_key):
         self.authtoken = authtoken
         self.headers = headers
         self.api_key = api_key
+        self.headers['authtoken'] = self.authtoken
 
     def fetch(self):
         """
@@ -36,11 +37,10 @@ def fetch(self):
         -------------------------------
         """
         url = "stacks"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         return self.api_client.get(url, headers = self.headers)
 
-    def fetch_all(self):
+    def find(self):
 
         """
         Fetches the stacks entries 
@@ -57,7 +57,6 @@ def fetch_all(self):
         """
 
         url = "stacks"
-        self.headers['authtoken'] = self.authtoken
         return self.api_client.get(url, headers = self.headers)
 
     def create(self, organization_uid, data):
@@ -81,7 +80,7 @@ def create(self, organization_uid, data):
         -------------------------------
         """
         url = "stacks"
-        self.headers['authtoken'] = self.authtoken
+       
         self.headers['organization_uid'] = organization_uid
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data=data)
@@ -107,7 +106,6 @@ def update(self, data):
         -------------------------------
         """
         url = "stacks"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.put(url, headers = self.headers, data=data)
@@ -129,11 +127,10 @@ def delete(self):
         """
 
         url = "stacks"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         return self.api_client.delete(url, headers = self.headers)
 
-    def fetch_all_user(self):
+    def users(self):
         """
         Fetches the all users of a stack 
         :return: Json, with users of a stack details.
@@ -149,7 +146,6 @@ def fetch_all_user(self):
         """
 
         url = "stacks/users"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         return self.api_client.get(url, headers = self.headers)
 
@@ -172,12 +168,11 @@ def update_user_role(self, data):
         -------------------------------
         """
         url = "stacks/users/roles"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.put(url, headers = self.headers, data=data)
 
-    def stack_transfer_ownership(self, data):
+    def transfer_ownership(self, data):
         """
         Transfer owership of the stacks 
         :return: Json, with status code and message.
@@ -194,7 +189,6 @@ def stack_transfer_ownership(self, data):
         -------------------------------
         """
         url = "stacks/transfer_ownership"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data=data)
@@ -214,11 +208,10 @@ def accept_ownership(self, user_id, ownership_token):
         -------------------------------
         """
         url = f"stacks/accept_ownership/{ownership_token}"
-        self.headers['authtoken'] = self.authtoken
         params = {'api_key': self.api_key, 'uid': user_id}
         return self.api_client.get(url, headers = self.headers, params = params)
 
-    def get_stack_settings(self):
+    def settings(self):
         """
         Fetches the stack settings 
         :return: Json, with stack settings details.
@@ -233,12 +226,11 @@ def get_stack_settings(self):
         -------------------------------
         """
         url = "stacks/settings"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         return self.api_client.get(url, headers = self.headers)
 
 
-    def create_stack_settings(self, data):
+    def create_settings(self, data):
         """
         Create the stack settings 
         :return: Json, with stack setting details.
@@ -264,12 +256,11 @@ def create_stack_settings(self, data):
         -------------------------------
         """
         url = "stacks/settings"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data=data)
 
-    def reset_stack_settings(self, data):
+    def reset_settings(self, data):
         """
         Reset the stack settings
         :return: Json, with stack setting details.
@@ -286,12 +277,11 @@ def reset_stack_settings(self, data):
         -------------------------------
         """
         url = "stacks/settings/reset"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data=data)
 
-    def share_stack(self, data):
+    def share(self, data):
         """
         Share a stack to the users with user roles 
         :return: Json, with status code and message
@@ -315,12 +305,11 @@ def share_stack(self, data):
         -------------------------------
         """
         url = "stacks/share"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data=data)
 
-    def unshare_stack(self, data):
+    def unshare(self, data):
         """
         Unshare a stack to the users with user roles 
         :return: Json, with status code and message
@@ -337,7 +326,6 @@ def unshare_stack(self, data):
         -------------------------------
         """
         url = "stacks/unshare"
-        self.headers['authtoken'] = self.authtoken
         self.headers['api_key'] = self.api_key
         data = json.dumps(data)
         return self.api_client.post(url, headers = self.headers, data=data)