initial commit of transition to api v0.0.4

aces · Sep 1, 2020 · 801d93b · 801d93b
1 parent 8a6893c
commit 801d93b
Show file tree

Hide file tree

Showing 39 changed files with 1,168 additions and 26 deletions.
diff --git a/modules/api/docs/LorisRESTAPI_v0.0.4.md b/modules/api/docs/LorisRESTAPI_v0.0.4.md
diff --git a/modules/api/php/endpoints/candidate/candidate.class.inc b/modules/api/php/endpoints/candidate/candidate.class.inc
@@ -65,6 +65,7 @@ class Candidate extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/dicom/dicom.class.inc b/modules/api/php/endpoints/candidate/visit/dicom/dicom.class.inc
@@ -79,7 +79,9 @@ class Dicom extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ['v0.0.3'];
+        return [
+            'v0.0.3'
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/candidate/visit/dicoms.class.inc b/modules/api/php/endpoints/candidate/visit/dicoms.class.inc
@@ -68,7 +68,10 @@ class Dicoms extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ['v0.0.3'];
+        return [
+            'v0.0.3',
+            'v0.0.4',
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile.class.inc
@@ -59,6 +59,7 @@ class BidsFile extends Endpoint
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/archive.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/archive.class.inc
@@ -66,6 +66,7 @@ class Archive extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/channels.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/channels.class.inc
@@ -66,6 +66,7 @@ class Channels extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/electrodes.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/electrodes.class.inc
@@ -66,6 +66,7 @@ class Electrodes extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/events.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/events.class.inc
@@ -66,6 +66,7 @@ class Events extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/channels.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/channels.class.inc
@@ -75,6 +75,7 @@ class Channels extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 
@@ -142,4 +143,4 @@ class Channels extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return md5(json_encode($this->_handleGET($request)->getBody()));
     }
-}
+}
diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/electrodes.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/electrodes.class.inc
@@ -75,6 +75,7 @@ class Electrodes extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/events.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/events.class.inc
@@ -75,6 +75,7 @@ class Events extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/metadata.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/metadata.class.inc
@@ -76,6 +76,7 @@ class Metadata extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 
@@ -155,4 +156,4 @@ class Metadata extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return md5(json_encode($this->_handleGET($request)->getBody()));
     }
-}
+}
diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/recording.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/recording.class.inc
@@ -70,6 +70,7 @@ class Recording extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 
@@ -217,4 +218,4 @@ class Recording extends Endpoint implements \LORIS\Middleware\ETagCalculator
 
         return md5(json_encode($signature));
     }
-}
+}
diff --git a/modules/api/php/endpoints/candidate/visit/image/format.class.inc b/modules/api/php/endpoints/candidate/visit/image/format.class.inc
@@ -63,6 +63,7 @@ class Format extends Endpoint
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format/brainbrowser.class.inc b/modules/api/php/endpoints/candidate/visit/image/format/brainbrowser.class.inc
@@ -69,6 +69,7 @@ class Brainbrowser extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format/raw.class.inc b/modules/api/php/endpoints/candidate/visit/image/format/raw.class.inc
@@ -64,6 +64,7 @@ class Raw extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format/thumbnail.class.inc b/modules/api/php/endpoints/candidate/visit/image/format/thumbnail.class.inc
@@ -64,6 +64,7 @@ class Thumbnail extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/headers.class.inc b/modules/api/php/endpoints/candidate/visit/image/headers.class.inc
@@ -78,6 +78,7 @@ class Headers extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/image.class.inc b/modules/api/php/endpoints/candidate/visit/image/image.class.inc
@@ -74,6 +74,7 @@ class Image extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/qc.class.inc b/modules/api/php/endpoints/candidate/visit/image/qc.class.inc
@@ -81,6 +81,7 @@ class Qc extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/images.class.inc b/modules/api/php/endpoints/candidate/visit/images.class.inc
@@ -71,6 +71,7 @@ class Images extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/instrument/flags.class.inc b/modules/api/php/endpoints/candidate/visit/instrument/flags.class.inc
@@ -78,6 +78,7 @@ class Flags extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/instrument/instrument.class.inc b/modules/api/php/endpoints/candidate/visit/instrument/instrument.class.inc
@@ -78,6 +78,7 @@ class Instrument extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/instruments.class.inc b/modules/api/php/endpoints/candidate/visit/instruments.class.inc
@@ -71,6 +71,7 @@ class Instruments extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/qc.class.inc b/modules/api/php/endpoints/candidate/visit/qc.class.inc
@@ -75,6 +75,7 @@ class Qc extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/recordings.class.inc b/modules/api/php/endpoints/candidate/visit/recordings.class.inc
@@ -67,6 +67,7 @@ class Recordings extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/visit.class.inc b/modules/api/php/endpoints/candidate/visit/visit.class.inc
@@ -76,7 +76,11 @@ class Visit extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         // Removed 0.0.2 since session requires a project.
-        return ['v0.0.3'];
+         return [
+            'v0.0.2',
+            'v0.0.3',
+            'v0.0.4',
+         ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/candidates.class.inc b/modules/api/php/endpoints/candidates.class.inc
@@ -75,20 +75,10 @@ class Candidates extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             "v0.0.2",
             "v0.0.3",
+            "v0.0.4",
         ];
     }
 
-    /**
-     * Tells the base class that this page's provisioner can support
-     * the UserProjectMatch filter.
-     *
-     * @return bool always true
-     */
-    public function useProjectFilter() : bool
-    {
-        return true;
-    }
-
     /**
      * Handles a request starts with /candidates
      *
@@ -165,11 +155,9 @@ class Candidates extends Endpoint implements \LORIS\Middleware\ETagCalculator
         $provisioner = (new \LORIS\api\Provisioners\CandidatesProvisioner())
             ->filter($filter);
 
-        if ($this->useProjectFilter()) {
-            $provisioner = $provisioner->filter(
-                new \LORIS\Data\Filters\UserProjectMatch()
-            );
-        }
+        $provisioner = $provisioner->filter(
+            new \LORIS\Data\Filters\UserProjectMatch()
+        );
 
         $candidates = (new \LORIS\Data\Table())
             ->withDataFrom($provisioner)

diff --git a/modules/api/php/endpoints/login.class.inc b/modules/api/php/endpoints/login.class.inc
@@ -82,6 +82,7 @@ class Login extends Endpoint
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/candidates.class.inc b/modules/api/php/endpoints/project/candidates.class.inc
@@ -69,6 +69,7 @@ class Candidates extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/images.class.inc b/modules/api/php/endpoints/project/images.class.inc
@@ -66,7 +66,10 @@ class Images extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ["v0.0.3"];
+        return [
+            "v0.0.3",
+            "v0.0.4",
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/project/instrument/instrument.class.inc b/modules/api/php/endpoints/project/instrument/instrument.class.inc
@@ -70,6 +70,7 @@ class Instrument extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/instruments.class.inc b/modules/api/php/endpoints/project/instruments.class.inc
@@ -69,6 +69,7 @@ class Instruments extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/project.class.inc b/modules/api/php/endpoints/project/project.class.inc
@@ -69,6 +69,7 @@ class Project extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/recordings.class.inc b/modules/api/php/endpoints/project/recordings.class.inc
@@ -84,7 +84,10 @@ class Recordings extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ["v0.0.3"];
+        return [
+            "v0.0.3",
+            "v0.0.4"
+        ];
     }
 
     /**
@@ -178,4 +181,4 @@ class Recordings extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return md5(json_encode($this->_handleGET($request)->getBody()));
     }
-}
+}
diff --git a/modules/api/php/endpoints/project/visits.class.inc b/modules/api/php/endpoints/project/visits.class.inc
@@ -69,6 +69,7 @@ class Visits extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/modules/api/php/endpoints/projects.class.inc b/modules/api/php/endpoints/projects.class.inc
@@ -65,6 +65,7 @@ class Projects extends Endpoint implements \LORIS\Middleware\ETagCalculator
         return [
             'v0.0.2',
             'v0.0.3',
+            'v0.0.4',
         ];
     }
 

diff --git a/raisinbread/test/api/LorisApiAuthenticatedTest.php b/raisinbread/test/api/LorisApiAuthenticatedTest.php
@@ -22,6 +22,7 @@ class LorisApiAuthenticatedTest extends LorisIntegrationTest
 {
 
     protected $client;
+    protected $version;
     protected $headers;
     protected $base_uri;
     protected $originalJwtKey;
@@ -36,6 +37,9 @@ class LorisApiAuthenticatedTest extends LorisIntegrationTest
     public function setUp()
     {
         parent::setUp();
+
+        $this->_version = 'v0.0.4';
+
         // store the original JWT key for restoring it later
         $jwtConfig = $this->DB->pselect(
             '
@@ -83,7 +87,7 @@ public function setUp()
      */
     public function apiLogin($username, $password)
     {
-        $this->base_uri = "$this->url/api/v0.0.3/";
+        $this->base_uri = "$this->url/api/$this->_version/";
         $this->client   = new Client(['base_uri' => $this->base_uri]);
         $response       = $this->client->request(
             'POST',