Merge pull request #86 from girder/filter-dataset-by-name

shapeworks_cloud/core/filters.py

@@ -3,6 +3,12 @@
 from . import models
 
 
+class DatasetFilter(FilterSet):
+    class Meta:
+        model = models.Dataset
+        fields = ['name']
+
+
 class SubjectFilter(FilterSet):
     dataset = ModelChoiceFilter(queryset=models.Dataset.objects.all())
 

shapeworks_cloud/core/rest.py

@@ -38,6 +38,7 @@ def get_serializer_class(self) -> Type[BaseSerializer]:
 class DatasetViewSet(BaseViewSet):
     queryset = models.Dataset.objects.all().order_by('name')
     serializer_class = serializers.DatasetSerializer
+    filterset_class = filters.DatasetFilter
 
 
 class SubjectViewSet(BaseViewSet):

swcc/swcc/models.py

@@ -237,6 +237,14 @@ def subjects(self) -> Iterator[Subject]:
     def add_subject(self, name: str) -> Subject:
         return Subject(name=name, dataset=self).create()
 
+    @classmethod
+    def from_name(cls, name: str) -> Optional[Dataset]:
+        results = cls.list(name=name)
+        try:
+            return next(results)
+        except StopIteration:
+            return None
+
 
 class Subject(ApiModel):
     _endpoint = 'subjects'

swcc/tests/test_models.py

@@ -64,3 +64,17 @@ def test_model_crud(session, factory):
 
     obj.delete()
     assert obj.id not in {o.id for o in model.list()}
+
+
+def test_get_dataset_by_name(session):
+    factories.DatasetFactory(name='dataset1').create()
+    factories.DatasetFactory(name='dataset2').create()
+
+    dataset = models.Dataset.from_name('dataset1')
+    assert dataset and dataset.name == 'dataset1'
+
+    dataset = models.Dataset.from_name('dataset2')
+    assert dataset and dataset.name == 'dataset2'
+
+    dataset = models.Dataset.from_name('dataset3')
+    assert dataset is None