Merge pull request #1 from spurjobs/support-remote-sources

Support remote sources
hotmeteor · Jun 9, 2020 · 1a49ac8 · 1a49ac8
2 parents c275263 + ebb20af
commit 1a49ac8
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 20 deletions.
diff --git a/config/spectator.php b/config/spectator.php
@@ -27,19 +27,20 @@
     'sources' => [
         'local' => [
             'source' => 'local',
-            'base_folder' => env('SPEC_FOLDER'),
+            'base_path' => env('SPEC_PATH'),
         ],
 
         'remote' => [
             'source' => 'remote',
-            'base_url' => env('SPEC_URL'),
+            'base_path' => env('SPEC_PATH'),
+            'params' => env('SPUR_URL_PARAMS', ''),
         ],
 
         'github' => [
             'source' => 'github',
+            'base_path' => env('SPEC_PATH'),
             'repo' => env('SPEC_GITHUB_REPO'),
             'token' => env('SPEC_GITHUB_TOKEN'),
-            'base_folder' => env('SPEC_FOLDER'),
         ],
     ],
 ];
diff --git a/phpunit.xml b/phpunit.xml
@@ -18,6 +18,7 @@
         </whitelist>
     </filter>
     <php>
-        <env name="SPEC_FOLDER" value="./tests/Fixtures"/>
+        <env name="SPEC_PATH" value="./tests/Fixtures"/>
+        <env name="SPEC_URL_PARAMS" value=""/>
     </php>
 </phpunit>
diff --git a/src/RequestFactory.php b/src/RequestFactory.php
@@ -54,24 +54,45 @@ protected function getFile()
             throw new MissingSpecException('Cannot resolve schema with missing or invalid spec.');
         }
 
-        if ($source['source'] === 'local') {
-            $path = $source['base_folder'];
+        $method = Str::camel("get_{$source['source']}_path");
 
-            if (!Str::endsWith($path, '/')) {
-                $path = $path.'/';
-            }
+        if (method_exists($this, $method)) {
+            return $this->{$method}($source, str_replace('/', '', $this->specName));
+        }
 
-            $file = str_replace('/', '', $this->specName);
+        throw new MissingSpecException('Cannot resolve schema with missing or invalid spec.');
+    }
 
-            $path = realpath("{$path}/{$file}");
+    protected function getLocalPath(array $source, $file)
+    {
+        $path = $this->standardizePath($source['base_path']);
 
-            if (!file_exists($path)) {
-                throw new MissingSpecException('Cannot resolve schema with missing or invalid spec.');
-            }
+        $path = realpath("{$path}{$file}");
 
-            return $path;
+        if (!file_exists($path)) {
+            throw new MissingSpecException('Cannot resolve schema with missing or invalid spec.');
         }
 
-        throw new MissingSpecException('Cannot resolve schema with missing or invalid spec.');
+        return $path;
+    }
+
+    protected function getRemotePath(array $source, $file)
+    {
+        $path = $this->standardizePath($source['base_path']);
+
+        $params = Arr::get($source, 'params', '');
+
+        $path = "{$path}{$file}{$params}";
+
+        return $path;
+    }
+
+    protected function standardizePath($path)
+    {
+        if (!Str::endsWith($path, '/')) {
+            $path = $path.'/';
+        }
+
+        return $path;
     }
 }
diff --git a/tests/RequestFactoryTest.php b/tests/RequestFactoryTest.php
@@ -74,7 +74,7 @@ public function test_throws_exception_on_invalid_source()
 
         $factory->using($name);
 
-        $spec = $factory->resolve();
+        $factory->resolve();
     }
 
     public function test_throws_exception_on_missing_spec_name()
@@ -84,7 +84,7 @@ public function test_throws_exception_on_missing_spec_name()
 
         $factory = new RequestFactory();
 
-        $spec = $factory->resolve();
+        $factory->resolve();
     }
 
     public function test_throws_exception_on_invalid_spec_name()
@@ -98,7 +98,7 @@ public function test_throws_exception_on_invalid_spec_name()
 
         $factory->using($name);
 
-        $spec = $factory->resolve();
+        $factory->resolve();
     }
 
     public function test_throws_exception_on_invalid_spec_extension()
@@ -112,6 +112,6 @@ public function test_throws_exception_on_invalid_spec_extension()
 
         $factory->using($name);
 
-        $spec = $factory->resolve();
+        $factory->resolve();
     }
 }