Workers management

Author: tzurbaev

CHANGELOG.md

@@ -7,7 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 ### Added
 - Allow to set default credential ID for specific server providers;
-- `hasPayload` method added to `Provider` class.
+- `hasPayload` method added to `Provider` class;
+- Workers Management.
 
 ### Fixed
 - Fixed `ArrayAccessTrait`'s `offsetExists` method.

docs/getting-started.md

@@ -21,7 +21,6 @@ This SDK supports following Forge API features:
 ## Coming soon
 
 - SSL certificates management;
-- Workers;
 - Services configuration;
 - Recipes.
 

docs/readme.md

@@ -14,3 +14,4 @@
 - [Sites](./sites.md)
     + [Site Applications](./site-applications.md)
     + [Deployment](./deployment.md)
+    + [Workers](./workers.md)

docs/workers.md

@@ -0,0 +1,80 @@
+# Overview
+
+SDK provides Workers Manager that allows you to create, list and delete workers for your Forge sites.
+
+# Usage
+
+Documentation assumes that you've already retrieved site instance from `SitesManager` class.
+
+All operations are performed via `Laravel\Forge\Sites\WorkersManager` instance.
+
+All methods return either instance of `Laravel\Forge\Sites\Worker` or array of `Laravel\Forge\Sites\Worker` instances.
+
+## Create new worker
+
+You can specify worker connection, queue name, timeout, sleep seconds, max tries count and indicate that worker should be created as daemon.
+
+```php
+<?php
+
+use Laravel\Forge\Sites\WorkersManager;
+
+$workers = new WorkersManager();
+
+$worker = $workers()->start('sqs')
+    ->withTimeout(90)
+    ->sleepFor(3)
+    ->maxTries(3)
+    ->asDaemon()
+    ->onQueue('my-queue-name')
+    ->for($site);
+```
+
+## List workers
+
+```php
+<?php
+
+use Laravel\Forge\Sites\WorkersManager;
+
+$workers = new WorkersManager();
+
+$siteWorkers = $workers->list()->for($site);
+
+foreach ($siteWorkers as $worker) {
+    echo 'Worker is running on '.$worker->connection().' connection, has timeout of '.$worker->timeout().' seconds and '.$worker->maxTries().'max tries.';
+}
+```
+
+## Get single worker by ID
+
+```php
+<?php
+
+use Laravel\Forge\Sites\WorkersManager;
+
+$workers = new WorkersManager();
+
+$workerId = 1234;
+$worker = $workers->get($workerId)->for($site);
+
+echo 'Worker is running on '.$worker->connection().' connection, has timeout of '.$worker->timeout().' seconds and '.$worker->maxTries().'max tries.';
+```
+
+## Delete worker
+
+```php
+<?php
+
+use Laravel\Forge\Sites\WorkersManager;
+
+$workers = new WorkersManager();
+
+$worker = $workers->get($workerId)->for($site);
+
+if ($worker->delete()) {
+    echo 'Worker was deleted.';
+}
+```
+
+[Back to Table of Contents](./readme.md)

src/ServerResources/Commands/ServerResourceCommand.php

@@ -104,6 +104,18 @@ public function getItemId()
         return $this->itemId;
     }
 
+    /**
+     * Processes new response item.
+     *
+     * @param mixed $item
+     *
+     * @return mixed
+     */
+    public function processResponseItem($item)
+    {
+        return $item;
+    }
+
     /**
      * Handle command response.
      *
@@ -120,7 +132,9 @@ public function handleResponse(ResponseInterface $response, Server $server)
 
         $className = $this->resourceClass();
 
-        return $className::createFromResponse($response, $server);
+        return $this->processResponseItem(
+            $className::createFromResponse($response, $server)
+        );
     }
 
     /**
@@ -147,7 +161,7 @@ public function handleListCommandResponse(ResponseInterface $response, Server $s
         $className = $this->resourceClass();
 
         foreach ($json[$itemsKey] as $item) {
-            $items[] = new $className($server, $item);
+            $items[] = $this->processResponseItem(new $className($server, $item));
         }
 
         return $items;

src/Sites/Commands/DeployCommand.php renamed to src/Sites/Commands/Deployment/DeployCommand.php

@@ -1,9 +1,10 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
 
 use Laravel\Forge\Server;
 use Psr\Http\Message\ResponseInterface;
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class DeployCommand extends SiteResourceCommand
 {

src/Sites/Commands/DisableDeploymentCommand.php renamed to src/Sites/Commands/Deployment/DisableDeploymentCommand.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
+
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class DisableDeploymentCommand extends SiteResourceCommand
 {

src/Sites/Commands/EnableDeploymentCommand.php renamed to src/Sites/Commands/Deployment/EnableDeploymentCommand.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
+
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class EnableDeploymentCommand extends SiteResourceCommand
 {

src/Sites/Commands/GetDeploymentLogCommand.php renamed to src/Sites/Commands/Deployment/GetDeploymentLogCommand.php

@@ -1,9 +1,10 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
 
 use Laravel\Forge\Server;
 use Psr\Http\Message\ResponseInterface;
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class GetDeploymentLogCommand extends SiteResourceCommand
 {

src/Sites/Commands/GetDeploymentScriptCommand.php renamed to src/Sites/Commands/Deployment/GetDeploymentScriptCommand.php

@@ -1,9 +1,10 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
 
 use Laravel\Forge\Server;
 use Psr\Http\Message\ResponseInterface;
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class GetDeploymentScriptCommand extends SiteResourceCommand
 {

src/Sites/Commands/ResetDeploymentStatusCommand.php renamed to src/Sites/Commands/Deployment/ResetDeploymentStatusCommand.php

@@ -1,9 +1,10 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
 
 use Laravel\Forge\Server;
 use Psr\Http\Message\ResponseInterface;
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class ResetDeploymentStatusCommand extends SiteResourceCommand
 {

src/Sites/Commands/UpdateDeploymentScriptCommand.php renamed to src/Sites/Commands/Deployment/UpdateDeploymentScriptCommand.php

@@ -1,9 +1,10 @@
 <?php
 
-namespace Laravel\Forge\Sites\Commands;
+namespace Laravel\Forge\Sites\Commands\Deployment;
 
 use Laravel\Forge\Server;
 use Psr\Http\Message\ResponseInterface;
+use Laravel\Forge\Sites\Commands\SiteResourceCommand;
 
 class UpdateDeploymentScriptCommand extends SiteResourceCommand
 {

src/Sites/Commands/SiteCommand.php

@@ -24,6 +24,11 @@ public function resourcePath()
      */
     public function resourceClass()
     {
+        // Check if we're working with site resource.
+        if (method_exists($this, 'siteResourceClass') && !is_null($this->siteResourceClass())) {
+            return $this->siteResourceClass();
+        }
+
         return Site::class;
     }
 }

src/Sites/Commands/SiteResourceCommand.php

@@ -15,6 +15,13 @@ abstract class SiteResourceCommand extends SiteCommand
      */
     protected $site;
 
+    /**
+     * Resource ID.
+     *
+     * @var int
+     */
+    protected $siteResourceId = 0;
+
     /**
      * Site resource path.
      *
@@ -23,7 +30,17 @@ abstract class SiteResourceCommand extends SiteCommand
     abstract public function siteResourcePath();
 
     /**
-     * Set associated site.
+     * Site resource class.
+     *
+     * @return string|null
+     */
+    public function siteResourceClass()
+    {
+        //
+    }
+
+    /**
+     * Set associated site and execute command on site server.
      *
      * @param \Laravel\Forge\Sites\Site $site
      *
@@ -34,9 +51,43 @@ public function for(Site $site)
         $this->site = $site;
         $this->setItemId($site->id());
 
+        return $this->on($site->getServer());
+    }
+
+    /**
+     * Set site resource ID.
+     *
+     * @param int $resourceId
+     *
+     * @return static
+     */
+    public function setSiteResourceId(int $resourceId)
+    {
+        $this->siteResourceId = $resourceId;
+
         return $this;
     }
 
+    /**
+     * Get site resource ID.
+     *
+     * @return int
+     */
+    public function getSiteResourceId(): int
+    {
+        return $this->siteResourceId;
+    }
+
+    /**
+     * Get associated site.
+     *
+     * @return \Laravel\Forge\Sites\Site
+     */
+    public function getSite(): Site
+    {
+        return $this->site;
+    }
+
     /**
      * HTTP request URL.
      *
@@ -51,6 +102,18 @@ public function requestUrl(Server $server)
         return $requestUrl.'/'.$this->siteResourcePath();
     }
 
+    /**
+     * Processes new response item.
+     *
+     * @param mixed $item
+     *
+     * @return mixed
+     */
+    public function processResponseItem($item)
+    {
+        return $item->setSite($this->getSite());
+    }
+
     /**
      * Handle command response.
      *
@@ -61,6 +124,12 @@ public function requestUrl(Server $server)
      */
     public function handleResponse(ResponseInterface $response, Server $server)
     {
-        return true;
+        $siteResourceClass = $this->siteResourceClass();
+
+        if (is_null($siteResourceClass)) {
+            return true;
+        }
+
+        return parent::handleResponse($response, $server);
     }
 }