girder-jsonforms 2.0.2__tar.gz → 2.0.4__tar.gz

{girder_jsonforms-2.0.2/girder_jsonforms.egg-info → girder_jsonforms-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: girder-jsonforms
-Version: 2.0.2
+Version: 2.0.4
 Summary: Girder plugin adding forms based on JSON-editor
 License: BSD-3-Clause
 Classifier: Development Status :: 4 - Beta

{girder_jsonforms-2.0.2 → girder_jsonforms-2.0.4}/girder_jsonforms/__init__.py

@@ -8,6 +8,7 @@ from girder import events
 from girder.constants import AccessType
 from girder.models.file import File
 from girder.models.item import Item
+from girder.models.setting import Setting
 from girder.plugin import GirderPlugin, registerPluginStaticContent
 from girder.utility.model_importer import ModelImporter
 
@@ -16,6 +17,7 @@ from .models.entry import FormEntry as FormEntryModel
 from .models.form import Form as FormModel
 from .rest.entry import FormEntry
 from .rest.form import Form
+from .settings import PluginSettings
 
 GDRIVE_SERVICE = None
 logger = logging.getLogger(__name__)
@@ -42,6 +44,9 @@ def annotate_uploads(event):
 
 def upload_to_gdrive(event):
     global GDRIVE_SERVICE
+    if GDRIVE_SERVICE is None:
+        logger.error("Google Drive integration is not enabled.")
+        return
     info = event.info
     file = info["file"]
 
@@ -66,14 +71,16 @@ class JSONFormsPlugin(GirderPlugin):
         ModelImporter.registerModel("form", FormModel, plugin="jsonforms")
         ModelImporter.registerModel("entry", FormEntryModel, plugin="jsonforms")
         global GDRIVE_SERVICE
-        try:
-            GDRIVE_SERVICE = authenticate_gdrive()
-        except ValueError:
-            logger.exception("Failed to authenticate with Google Drive")
+        if Setting().get(PluginSettings.GOOGLE_DRIVE_ENABLED):
+            try:
+                GDRIVE_SERVICE = authenticate_gdrive()
+            except ValueError:
+                logger.exception("Failed to authenticate with Google Drive")
         info["apiRoot"].form = Form()
         info["apiRoot"].entry = FormEntry()
         events.bind("data.process", "jsonforms", annotate_uploads)
-        events.bind("gdrive.upload", "jsonforms", upload_to_gdrive)
+        if GDRIVE_SERVICE is not None:
+            events.bind("gdrive.upload", "jsonforms", upload_to_gdrive)
         registerPluginStaticContent(
             plugin="jsonforms",
             css=["/style.css"],

{girder_jsonforms-2.0.2 → girder_jsonforms-2.0.4}/girder_jsonforms/models/entry.py

@@ -51,7 +51,7 @@ class FormEntry(acl_mixin.AccessControlMixin, Model):
             print("Error:", e)
             return None
 
-    def create(self, form, data, source, destination, creator):
+    def create_entry(self, form, data, source, destination, creator):
         now = datetime.datetime.utcnow()
         unique_field = form.get("uniqueField")
         entry = {

{girder_jsonforms-2.0.2 → girder_jsonforms-2.0.4}/girder_jsonforms/models/form.py

@@ -44,7 +44,7 @@ class Form(AccessControlledModel):
     def validate(self, doc):
         return doc
 
-    def create(
+    def create_form(
         self,
         name,
         description,
@@ -77,7 +77,7 @@ class Form(AccessControlledModel):
 
         return self.save(form)
 
-    def update(
+    def update_form(
         self,
         form,
         name,
@@ -155,7 +155,7 @@ class Form(AccessControlledModel):
 
         return form
 
-    def export(self, form, export_format):
+    def export_form(self, form, export_format):
         from .entry import FormEntry
 
         entries = [

{girder_jsonforms-2.0.2 → girder_jsonforms-2.0.4}/girder_jsonforms/rest/entry.py

@@ -108,7 +108,7 @@ class FormEntry(Resource):
     )
     @filtermodel(model=FormEntryModel, plugin="jsonforms")
     def createFormEntry(self, form, data, source, destination):
-        return FormEntryModel().create(
+        return FormEntryModel().create_entry(
             form,
             data,
             source,

{girder_jsonforms-2.0.2 → girder_jsonforms-2.0.4}/girder_jsonforms/rest/form.py

@@ -111,7 +111,7 @@ class Form(Resource):
         .errorResponse("Read access was denied on the form.", 403)
     )
     def exportForm(self, form, exportFormat):
-        export = FormModel().export(form, exportFormat)
+        export = FormModel().export_form(form, exportFormat)
         setResponseHeader("Content-Length", export.getbuffer().nbytes)
         content_type = (
             "text/csv" if exportFormat == "csv" else "application/vnd.ms-excel"
@@ -199,7 +199,7 @@ class Form(Resource):
         serialize,
         uniqueField,
     ):
-        return FormModel().create(
+        return FormModel().create_form(
             name,
             description,
             schema,

girder_jsonforms-2.0.4/girder_jsonforms/settings.py

@@ -0,0 +1,26 @@
+from girder.exceptions import ValidationException
+from girder.utility import setting_utilities
+
+
+class PluginSettings:
+    GOOGLE_DRIVE_ENABLED = "jsonforms.google_drive_enabled"
+
+
+@setting_utilities.default(PluginSettings.GOOGLE_DRIVE_ENABLED)
+def default_google_drive_enabled():
+    """
+    Default setting for enabling Google Drive integration.
+    """
+    return False
+
+
+@setting_utilities.validator(PluginSettings.GOOGLE_DRIVE_ENABLED)
+def validate_google_drive_enabled(doc):
+    """
+    Validate the Google Drive integration setting.
+    """
+    if not isinstance(doc["value"], bool):
+        raise ValidationException(
+            "Google Drive integration must be a boolean.",
+            "value",
+        )