chore(kno-1566) add tenant methods (#11)

Author: meryldakin

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+ignore = F401,F403
+max-line-length = 127

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install requests flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        python -m pytest

knockapi/client.py

@@ -65,6 +65,11 @@ def objects(self):
         from .resources import Objects
         return Objects(self)
 
+    @property
+    def tenants(self):
+        from .resources import Tenants
+        return Tenants(self)
+
     @property
     def bulk_operations(self):
         from .resources import BulkOperations
@@ -76,7 +81,14 @@ def messages(self):
         return Messages(self)
 
     # Defined at the top level here for convienience
-    def notify(self, key, actor, recipients, data={}, cancellation_key=None, tenant=None):
+    def notify(
+            self,
+            key,
+            actor,
+            recipients,
+            data={},
+            cancellation_key=None,
+            tenant=None):
         """
         Triggers a workflow.
 
@@ -92,12 +104,18 @@ def notify(self, key, actor, recipients, data={}, cancellation_key=None, tenant=
 
             data (dict): Any data to be passed to the notify call.
 
-            tenant (str): An optional identifier for the tenant object that the notifications belong to.
+            tenant (str): An optional identifier for the tenant that the notifications belong to.
 
             cancellation_key (str): A key used to cancel this notify.
 
         Returns:
             dict: Response from Knock.
         """
         # Note: this is essentially a delegated method
-        return self.workflows.trigger(key, actor, recipients, data=data, cancellation_key=cancellation_key, tenant=tenant)
+        return self.workflows.trigger(
+            key,
+            actor,
+            recipients,
+            data=data,
+            cancellation_key=cancellation_key,
+            tenant=tenant)

knockapi/resources/bulk_operations.py

@@ -15,4 +15,4 @@ def get(self, id):
             dict: A Knock BulkOperation
         """
         endpoint = '/bulk_operations/{}'.format(id)
-        return self.client.request('get', endpoint)
+        return self.client.request('get', endpoint)

knockapi/resources/messages.py

@@ -1,5 +1,6 @@
 from .service import Service
 
+
 class Messages(Service):
     def list(self, options=None):
         """

knockapi/resources/objects.py

@@ -113,7 +113,9 @@ def set_channel_data(self, collection, id, channel_id, channel_data):
         """
         endpoint = '/objects/{}/{}/channel_data/{}'.format(
             collection, id, channel_id)
-        return self.client.request('put', endpoint, payload={'data': channel_data})
+        return self.client.request(
+            'put', endpoint, payload={
+                'data': channel_data})
 
     def unset_channel_data(self, collection, id, channel_id):
         """
@@ -187,7 +189,14 @@ def get_preferences(self, collection, id, options={}):
 
         return self.client.request('get', endpoint)
 
-    def set_preferences(self, collection, id, channel_types=None, categories=None, workflows=None, options={}):
+    def set_preferences(
+            self,
+            collection,
+            id,
+            channel_types=None,
+            categories=None,
+            workflows=None,
+            options={}):
         """
         Sets the preference set
 
@@ -215,7 +224,8 @@ def set_preferences(self, collection, id, channel_types=None, categories=None, w
 
         return self.client.request('put', endpoint, payload=params)
 
-    def set_channel_types_preferences(self, collection, id, preferences, options={}):
+    def set_channel_types_preferences(
+            self, collection, id, preferences, options={}):
         """
         Sets the channel type preferences
 
@@ -235,15 +245,21 @@ def set_channel_types_preferences(self, collection, id, preferences, options={})
 
         return self.client.request('put', endpoint, payload=preferences)
 
-    def set_channel_type_preferences(self, collection, id, channel_type, setting, options={}):
+    def set_channel_type_preferences(
+            self,
+            collection,
+            id,
+            channel_type,
+            setting,
+            options={}):
         """
         Sets the channel type preference
 
         Args:
             collection (str): The collection the object belongs to
             id (str): The id of the object in the collection
             channel_type (str): The channel_type to set
-            setting (boolean): The preference setting 
+            setting (boolean): The preference setting
             options (dict): A dictionary of options
 
         Returns:
@@ -254,9 +270,16 @@ def set_channel_type_preferences(self, collection, id, channel_type, setting, op
         endpoint = '/objects/{}/{}/preferences/{}/channel_types/{}'.format(
             collection, id, preference_set_id, channel_type)
 
-        return self.client.request('put', endpoint, payload={'subscribed': setting})
+        return self.client.request(
+            'put', endpoint, payload={
+                'subscribed': setting})
 
-    def set_workflows_preferences(self, collection, id, preferences, options={}):
+    def set_workflows_preferences(
+            self,
+            collection,
+            id,
+            preferences,
+            options={}):
         """
         Sets the workflow preferences
 
@@ -276,15 +299,21 @@ def set_workflows_preferences(self, collection, id, preferences, options={}):
 
         return self.client.request('put', endpoint, payload=preferences)
 
-    def set_workflow_preferences(self, collection, id, key, setting, options={}):
+    def set_workflow_preferences(
+            self,
+            collection,
+            id,
+            key,
+            setting,
+            options={}):
         """
         Sets the workflow preferences
 
         Args:
             collection (str): The collection the object belongs to
             id (str): The id of the object in the collection
             key (str): The workflow key
-            setting (boolean or dict): The preference setting 
+            setting (boolean or dict): The preference setting
             options (dict): A dictionary of options
 
         Returns:
@@ -295,11 +324,17 @@ def set_workflow_preferences(self, collection, id, key, setting, options={}):
         endpoint = '/objects/{}/{}/preferences/{}/workflows/{}'.format(
             collection, id, preference_set_id, key)
 
-        params = setting if type(setting) is dict else {'subscribed': setting}
+        params = setting if isinstance(setting, dict) else {
+            'subscribed': setting}
 
         return self.client.request('put', endpoint, payload=params)
 
-    def set_categories_preferences(self, collection, id, preferences, options={}):
+    def set_categories_preferences(
+            self,
+            collection,
+            id,
+            preferences,
+            options={}):
         """
         Sets the categories preferences
 
@@ -319,15 +354,21 @@ def set_categories_preferences(self, collection, id, preferences, options={}):
 
         return self.client.request('put', endpoint, payload=preferences)
 
-    def set_category_preferences(self, collection, id, key, setting, options={}):
+    def set_category_preferences(
+            self,
+            collection,
+            id,
+            key,
+            setting,
+            options={}):
         """
         Sets the category preferences
 
         Args:
             collection (str): The collection the object belongs to
             id (str): The id of the object in the collection
             key (str): The category key
-            setting (boolean or dict): The preference setting 
+            setting (boolean or dict): The preference setting
             options (dict): A dictionary of options
 
         Returns:
@@ -338,6 +379,7 @@ def set_category_preferences(self, collection, id, key, setting, options={}):
         endpoint = '/objects/{}/{}/preferences/{}/categories/{}'.format(
             collection, id, preference_set_id, key)
 
-        params = setting if type(setting) is dict else {'subscribed': setting}
+        params = setting if isinstance(setting, dict) else {
+            'subscribed': setting}
 
         return self.client.request('put', endpoint, payload=params)

knockapi/resources/preferences.py

@@ -1,39 +1,84 @@
 from .service import Service
 from warnings import warn
 
+
 class Preferences(Service):
     def get_all(self, user_id):
-        warn("This method is deprecated. Use users.get_all_preferences instead.", DeprecationWarning, stacklevel=2)
+        warn(
+            "This method is deprecated. Use users.get_all_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
         return self.client.users.get_all_preferences(user_id)
 
     def get(self, user_id, options={}):
-        warn("This method is deprecated. Use users.get_preferences instead.", DeprecationWarning, stacklevel=2)
+        warn(
+            "This method is deprecated. Use users.get_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
         return self.client.users.get_preferences(user_id, options)
 
-    def update(self, user_id, channel_types=None, categories=None, workflows=None, options={}):
-        warn("This method is deprecated. Use users.set_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_preferences(user_id, channel_types=channel_types, categories=categories, workflows=workflows, options=options)
+    def update(
+            self,
+            user_id,
+            channel_types=None,
+            categories=None,
+            workflows=None,
+            options={}):
+        warn(
+            "This method is deprecated. Use users.set_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_preferences(
+            user_id,
+            channel_types=channel_types,
+            categories=categories,
+            workflows=workflows,
+            options=options)
 
     def set_channel_types(self, user_id, preferences, options={}):
-        warn("This method is deprecated. Use users.set_channel_types_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_channel_types_preferences(user_id, preferences, options=options)
+        warn(
+            "This method is deprecated. Use users.set_channel_types_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_channel_types_preferences(
+            user_id, preferences, options=options)
 
     def set_channel_type(self, user_id, channel_type, setting, options={}):
-        warn("This method is deprecated. Use users.set_channel_type_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_channel_types_preferences(user_id, channel_type, setting, options=options)
+        warn(
+            "This method is deprecated. Use users.set_channel_type_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_channel_types_preferences(
+            user_id, channel_type, setting, options=options)
 
     def set_workflows(self, user_id, preferences, options={}):
-        warn("This method is deprecated. Use users.set_workflows_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_workflows_preferences(user_id, preferences, options=options)
+        warn(
+            "This method is deprecated. Use users.set_workflows_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_workflows_preferences(
+            user_id, preferences, options=options)
 
     def set_workflow(self, user_id, key, setting, options={}):
-        warn("This method is deprecated. Use users.set_workflow_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_workflow_preferences(user_id, key, setting, setting, options=options)
+        warn(
+            "This method is deprecated. Use users.set_workflow_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_workflow_preferences(
+            user_id, key, setting, setting, options=options)
 
     def set_categories(self, user_id, preferences, options={}):
-        warn("This method is deprecated. Use users.set_categories_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_categories_preferences(user_id, preferences, options=options)
-        
+        warn(
+            "This method is deprecated. Use users.set_categories_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_categories_preferences(
+            user_id, preferences, options=options)
+
     def set_category(self, user_id, key, setting, options={}):
-        warn("This method is deprecated. Use users.set_category_preferences instead.", DeprecationWarning, stacklevel=2)
-        return self.client.users.set_category_preferences(user_id, key, setting, setting, options=options)
+        warn(
+            "This method is deprecated. Use users.set_category_preferences instead.",
+            DeprecationWarning,
+            stacklevel=2)
+        return self.client.users.set_category_preferences(
+            user_id, key, setting, setting, options=options)