Updates for IPA 6.x (#230)

* [CAT-501] ADD: functionality for adding exchange integration to a workflow (#202)

* WIP

* ADD: support for adding exchange integration

* fix type conversion

* Clean up types and add docstrings

* [CAT-502] ADD: support for starting an integration (#203)

* ADD: mutation + test for starting an integration

* fix: use existing _AddComponent call to add output component

* FIX: add output nodes to workflow created during integration tests (#214)

* [CAT-515] FIX: force decompress when deserializing if url ends in gz (#213)

* FIX: force decompress when deserializing if url ends in gz

* update syntax for checking url suffixes in http client

* undo dev url change

* [CAT-525] ADD: post processing submission status (#215)

* ADD: post processing submission status

* FIX: update WaitForSubmission to wait until after post processing

* Revert "[CAT-525] ADD: post processing submission status (#215)" (#220)

This reverts commit 3d946e4.

* fix typing for questionnaire calls and update tests (#226)

* remove TODO

* remove pytest mark skip

Author: meghanhickey

.gitignore

@@ -54,6 +54,7 @@ indico_api_token.txt
 examples/readme.py
 docsrc/_build
 docs/.doctrees
+setup_tests.sh
 
 .venv
 .vscode/

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.9.15
 
-ENV INDICO_HOST="dev.indico.io"
+ENV INDICO_HOST="dev-ci.us-east-2.indico-dev.indico.io"
 
 COPY . /indico-client
 WORKDIR /indico-client

codeship-services.yml

@@ -3,7 +3,7 @@ indico-client-test:
     dockerfile: tox.Dockerfile
   container_name: indico-client-test
   environment:
-    - INDICO_HOST=dev.indico.io
+    - INDICO_HOST=dev-ci.us-east-2.indico-dev.indico.io
     - TOX_PARALLEL_NO_SPINNER=true
   encrypted_env_file:
     - env.encrypted

indico/config/config.py

@@ -46,6 +46,7 @@ class IndicoConfig:
     _disable_cookie_domain: bool = False
 
     def __init__(self, **kwargs):
+
         self.host: str = os.getenv("INDICO_HOST", "app.indico.io")
         self.protocol: str = os.getenv("INDICO_PROTOCOL", "https")
         self.serializer: str = os.getenv("INDICO_SERIALIZER", "msgpack")

indico/http/client.py

@@ -1,6 +1,5 @@
 import http.cookiejar
 import logging
-from collections import defaultdict
 from contextlib import contextmanager
 from copy import deepcopy
 from pathlib import Path
@@ -149,11 +148,8 @@ def _make_request(
                 **new_kwargs,
             )
 
-        # code, api_response =
-        url_parts = path.split(".")
-        json = False
-        if len(url_parts) > 1 and (url_parts[-1] == "json" or url_parts[-2] == "json"):
-            json = True
+        json: bool = ".json" in Path(path).suffixes
+        decompress: bool = Path(path).suffix == ".gz"
 
         # If auth expired refresh
         if response.status_code == 401 and not _refreshed:
@@ -172,7 +168,7 @@ def _make_request(
                 code=response.status_code
             )
 
-        content = deserialize(response, force_json=json)
+        content = deserialize(response, force_json=json, force_decompress=decompress)
 
         if response.status_code >= 400:
             if isinstance(content, dict):

indico/http/serialization.py

@@ -21,14 +21,10 @@ def decompress(response):
     return gzip.decompress(value)
 
 
-def raw_bytes(content, *args, **kwargs):
-    return content
-
-
-def deserialize(response, force_json=False):
+def deserialize(response, force_json=False, force_decompress=False):
     content_type, params = cgi.parse_header(response.headers.get("Content-Type"))
 
-    if content_type in ["application/x-gzip", "application/gzip"]:
+    if force_decompress or content_type in ["application/x-gzip", "application/gzip"]:
         content = decompress(response)
     else:
         content = response.content
@@ -48,6 +44,10 @@ def deserialize(response, force_json=False):
         )
 
 
+
+def raw_bytes(content, *args, **kwargs):
+    return content
+
 def msgpack_deserialization(content, charset):
     return msgpack.unpackb(content)
 

indico/queries/__init__.py

@@ -10,3 +10,4 @@
 from .workflow_components import *
 from .example import *
 from .questionnaire import *
+from .integration import *

indico/queries/integration.py

@@ -0,0 +1,84 @@
+import jsons
+from typing import List
+
+from indico import GraphQLRequest, RequestChain
+from indico.errors import IndicoInputError
+from indico.types.integration import ExchangeIntegration, ExchangeIntegrationConfiguration, ExchangeIntegrationCredentials
+
+class AddExchangeIntegration(GraphQLRequest):
+    """
+    Mutation to add a Microsoft Exchange integration to a workflow
+
+    Args:
+        workflow_id(int): workflow to add integration to
+        config(ExchangeIntegrationConfiguration): settings for which mailbox to point to and which emails to process
+        credentials(ExchangeIntegrationCredentials): client id, client secret, and tenant id for authenticating with Exchange
+
+    """
+
+    query = """
+    mutation addExchangeIntegration($workflow_id: Int!, $config: ExchangeIntegrationConfigurationInput!, $credentials: ExchangeIntegrationCredentialsInput!){
+  addExchangeIntegrationToWorkflow(workflowId: $workflow_id, config: $config, credentials: $credentials){
+    integration{
+      id
+      enabled
+      workflowId
+      createdAt
+      config {
+        filters
+        userId
+        folderName
+        folderId
+      }
+    }
+  }
+}
+    """
+
+    def __init__(
+        self,
+        config: ExchangeIntegrationConfiguration,
+        credentials: ExchangeIntegrationCredentials,
+        workflow_id: int,
+    ):
+        super().__init__(
+            self.query,
+            variables={
+                "config": config,
+                "credentials": credentials,
+                "workflow_id": workflow_id,
+            },
+        )
+
+    def process_response(self, response) -> ExchangeIntegration:
+        return ExchangeIntegration(
+            **super().process_response(response)["addExchangeIntegrationToWorkflow"]["integration"]
+        )
+
+class StartIntegration(GraphQLRequest):
+    """
+    Mutation to start an existing integration. Once an integration is started, documents will be submitted to the associated workflow.
+
+    Args:
+        integration_id(int): id of the integration to start
+
+    """
+
+    query = """
+        mutation StartIntegration($integration_id: Int!){
+          startWorkflowIntegration(integrationId: $integration_id){
+            success
+          }
+        }
+    """
+
+    def __init__(
+        self,
+        integration_id: int,
+    ):
+        super().__init__(
+            self.query,
+            variables={
+                "integration_id": integration_id
+            },
+        )

indico/queries/questionnaire.py

@@ -10,7 +10,7 @@
     Debouncer,
 )
 from indico.queries import AddModelGroupComponent
-from indico.types import NewLabelsetArguments, NewQuestionnaireArguments, Workflow
+from indico.types import NewLabelsetArguments, NewQuestionnaireArguments, Workflow, ModelTaskType
 
 from indico.types.questionnaire import Questionnaire, Example
 from indico.types.dataset import Dataset
@@ -48,6 +48,7 @@ def __init__(
         labelset_id: int,
         labels: List[dict],
         model_group_id: int = None,
+        dataset_id: int = None
     ):
         super().__init__(
             query=self.query,
@@ -297,10 +298,9 @@ def requests(self):
         new_labelset_args = NewLabelsetArguments(
             datacolumn_id=self.previous.datacolumns[0].id,
             name=self.name,
-            task_type=self.task_type,
+            task_type=next(v for v in ModelTaskType if v.name == self.task_type),
             target_names=self.targets,
         )
-
         yield AddModelGroupComponent(
             workflow_id=self.workflow_id[0],
             source_column_id=self.previous.datacolumns[0].id,

indico/queries/workflow.py

@@ -33,6 +33,7 @@ class ListWorkflows(GraphQLRequest):
                     autoReviewEnabled
                     createdAt
                     createdBy
+                    submissionRunnable
                 components {
                         id
                         componentType
@@ -500,6 +501,7 @@ class CreateWorkflow(GraphQLRequest):
                     status
                     reviewEnabled
                     autoReviewEnabled
+                    submissionRunnable
                 components {
                         id
                         componentType