Init

Author: jjnesbitt

.circleci/config.yml

@@ -0,0 +1,36 @@
+---
+version: 2.1
+jobs:
+  test:
+    docker:
+      - image: girder/girder_test:latest
+      - image: circleci/mongo:4.0-ram
+        command: ["mongod", "--storageEngine", "ephemeralForTest", "--dbpath", "/dev/shm/mongo"]
+
+    steps:
+      - checkout
+      - run:
+          name: Run server tests
+          command: tox
+      - run:
+          name: Run web tests
+          command: |
+            npm install
+            npm run lint
+          working_directory: import_tracker/web_client
+
+workflows:
+  version: 2
+  ci:
+    jobs:
+      - test
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - test

.editorconfig

@@ -0,0 +1,27 @@
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[*.py]
+indent_size = 4
+max_line_length = 100
+
+[*.js]
+indent_size = 4
+
+[*.json]
+indent_size = 4
+
+[*.pug]
+indent_size = 2
+
+[*.styl]
+indent_size = 2
+
+[*.yml]
+indent_size = 2

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+# Recommend matching the black line length (default 88),
+# rather than using the flake8 default of 79:
+max-line-length = 88
+extend-ignore =
+    # See https://github.com/PyCQA/pycodestyle/issues/373
+    E203,

.gitignore

@@ -0,0 +1,50 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/

LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) 2022, Kitware, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE
+include README.rst
+include setup.py
+
+graft import_tracker
+graft docs
+prune test
+global-exclude *.py[co] *.cmake __pycache__ node_modules

README.rst

@@ -0,0 +1,10 @@
+==============
+import_tracker
+==============
+
+A Girder plu
+
+Features
+--------
+
+* TODO

import_tracker/__init__.py

@@ -0,0 +1,22 @@
+from girder import plugin, events
+from girder.utility.model_importer import ModelImporter
+
+from import_tracker.models import AssetstoreImport
+
+
+class GirderPlugin(plugin.GirderPlugin):
+    DISPLAY_NAME = "import_tracker"
+    CLIENT_SOURCE_PATH = "web_client"
+
+    def load(self, info):
+        ModelImporter.registerModel("image", AssetstoreImport, "import_tracker")
+        events.bind(
+            "rest.post.assetstore/:id/import.before",
+            "create_assetstore_import",
+            AssetstoreImport().createAssetstoreImport,
+        )
+        events.bind(
+            "filesystem_assetstore_imported",
+            "finish_assetstore_import",
+            AssetstoreImport().finishAssetstoreImport,
+        )

import_tracker/models.py

@@ -0,0 +1,36 @@
+from bson.objectid import ObjectId
+from datetime import datetime
+from girder.events import Event
+from girder.models.model_base import Model
+from girder.exceptions import ValidationException
+
+
+class AssetstoreImport(Model):
+    """A model that tracks assetstore import events."""
+
+    def initialize(self):
+        self.name = "assetstoreImport"
+
+    def validate(self, doc):
+        # fields = {"name", "started", "completed", "assetstoreId", "params"}
+        fields = {"name", "started", "assetstoreId", "params"}
+        missing_keys = doc.keys() - fields
+        if missing_keys:
+            raise ValidationException("Fields missing.", ",".join(missing_keys))
+
+        return doc
+
+    def createAssetstoreImport(self, event: Event):
+        now = datetime.utcnow()
+        return self.save(
+            {
+                "name": now.isoformat(),
+                "started": now,
+                # "completed": None,
+                "assetstoreId": ObjectId(event.info["id"]),
+                "params": event.info["params"],
+            }
+        )
+
+    def finishAssetstoreImport(self, event: Event):
+        pass

import_tracker/web_client/main.js

@@ -0,0 +1 @@
+console.log('Loaded import_tracker!');