Switch over to a generic remote queue package

Author: mzur

.gitignore

@@ -0,0 +1 @@
+/vendor/

README.md

@@ -1,86 +1,36 @@
-# BIIGLE GPU Module
+# Remote Queue
 
-Handle communication between BIIGLE and the BIIGLE GPU server.
+Submit jobs to other Laravel or Lumen instances.
 
 ## Installation
 
-This module needs to be installed both for the BIIGLE instance and the GPU server.
-
 ```
-composer config repositories.gpu vcs https://github.com/biigle/gpu
-composer require biigle/gpu
+composer config repositories.laravel-remote-queue vcs https://github.com/biigle/larave-remote-queue
+composer require biigle/laravel-remote-queue
 ```
 
-### BIIGLE
+### Laravel
 
-The service provider and `Gpu` facade are auto discovered by BIIGLE.
+The service provider is auto-discovered by Laravel.
 
-### GPU Server
+### Lumen
 
-Add `$app->register(Biigle\Modules\Gpu\GpuServerServiceProvider::class);` to `bootstrap/app.php`.
+Add `$app->register(Biigle\RemoteQueue\RemoteQueueServiceProvider::class);` to `bootstrap/app.php`.
 
 ## Configuration
 
 todo
 
 ## Usage
 
-To submit a job to the GPU server, it must extend `Biigle\Modules\Gpu\Jobs\GpuJob`. A job instance can be submitted with `Gpu::push($job)` and will be executed on the GPU server. To return the result data back to the BIIGLE instance, the job must call `$this->submitResponse($response)` at the end of its `handle` method. The response object must extend `Biigle\Jobs\Job` and will be executed on the BIIGLE instance where it can handle storage of the result data.
-
-Be aware that the GPU server has no database access. All required information needs to be stored in the `GpuJob`.
-
-**Example:**
-
 ```php
-use Gpu;
-use Biigle\Jobs\Job;
-use Biigle\Modules\Gpu\Jobs\GpuJob;
+use App\Jobs\MyJob;
 
-/*
- * Instances of this class are submitted to the GPU server with Gpu::push().
- */
-class MyGpuJob extends GpuJob
-{
-    /*
-     * Instances of this class are created in BIIGLE.
-     */
-    public function __construct($data)
-    {
-        $this->data = $data;
-    }
-
-    /*
-     * But the handle() method is executed on the GPU server.
-     */
-    public function handle()
-    {
-        $result = $this->computeGpuStuff($data);
-        $this->submitResponse(new MyGpuResponse($result));
-    }
-}
+MyJob::dispatch($data)->onConnection('remote');
+```
 
-/*
- * Instances of this class are used as argument for GpuJob::submitResponse.
- */
-class MyGpuResponse extends Job
-{
-    /*
-     * Instances of this class are created on the GPU server.
-     */
-    public function __construct($result)
-    {
-        $this->result = $result;
-    }
+## Submit/Response Pattern
 
-    /*
-     * But the handle() method is executed in BIIGLE.
-     */
-    public function handle()
-    {
-        $this->storeResultInDatabase($this->result);
-    }
-}
+We developed this package to be able to process jobs on a remote machine with GPU. To return the computed results, we applied what we call the "submit/response" pattern.
 
-// In the BIIGLE instance:
-Gpu::push(new MyGpuJob('some data'));
-```
+In this pattern, this package is installed on both Laravel/Lumen instances (let's call them A and B). In instance A, the remote queue is configured to push jobs to instance B (the one with the GPU). In instance B, the remote queue is configured to push jobs to instance A. New GPU jobs are submitted from instance A to the remote queue on instance B. Once the results are computed, they are returned as a "response job" to the remote queue on instance A where the results can be further processed.

composer.json

@@ -1,6 +1,6 @@
 {
-    "name": "biigle/gpu",
-    "description": "Handle communication between BIIGLE and the BIIGLE GPU server.",
+    "name": "biigle/laravel-remote-queue",
+    "description": "Submit jobs to another Laravel or Lumen instance.",
     "type": "library",
     "authors": [
         {
@@ -9,21 +9,33 @@
         }
     ],
     "require": {
-        "guzzlehttp/guzzle": "~6.0"
+        "guzzlehttp/guzzle": "~6.0",
+        "illuminate/queue": "^5.5",
+        "illuminate/support": "^5.5",
+        "illuminate/contracts": "^5.5"
     },
     "autoload": {
         "psr-4": {
-            "Biigle\\Modules\\Gpu\\": "src"
+            "Biigle\\RemoteQueue\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Biigle\\RemoteQueue\\Tests\\": "tests/"
+        },
+        "classmap": [
+            "tests/TestCase.php"
+        ]
+    },
     "extra": {
         "laravel": {
             "providers": [
-                "Biigle\\Modules\\Gpu\\GpuServiceProvider"
-            ],
-            "aliases": {
-                "Gpu": "Biigle\\Modules\\Gpu\\Facades\\Gpu"
-            }
+                "Biigle\\RemoteQueue\\RemoteQueueServiceProvider"
+            ]
         }
+    },
+    "require-dev": {
+        "laravel/laravel": "^5.5",
+        "phpunit/phpunit": "^7.4"
     }
 }