Merge pull request #2263 from CachetHQ/meta-data

Components can now be supplied meta data
cachethq · Dec 5, 2016 · 6076eed · 6076eed
2 parents f5b6919 + edfbb23
commit 6076eed
Show file tree

Hide file tree

Showing 12 changed files with 140 additions and 15 deletions.
diff --git a/app/Bus/Commands/Component/AddComponentCommand.php b/app/Bus/Commands/Component/AddComponentCommand.php
@@ -62,6 +62,13 @@ final class AddComponentCommand
      */
     public $enabled;
 
+    /**
+     * JSON meta data for the component.
+     *
+     * @var string|null
+     */
+    public $meta;
+
     /**
      * The validation rules.
      *
@@ -75,22 +82,24 @@ final class AddComponentCommand
         'order'       => 'nullable|int',
         'group_id'    => 'nullable|int',
         'enabled'     => 'nullable|bool',
+        'meta'        => 'nullable|string',
     ];
 
     /**
      * Create a new add component command instance.
      *
-     * @param string $name
-     * @param string $description
-     * @param int    $status
-     * @param string $link
-     * @param int    $order
-     * @param int    $group_id
-     * @param bool   $enabled
+     * @param string      $name
+     * @param string      $description
+     * @param int         $status
+     * @param string      $link
+     * @param int         $order
+     * @param int         $group_id
+     * @param bool        $enabled
+     * @param string|null $meta
      *
      * @return void
      */
-    public function __construct($name, $description, $status, $link, $order, $group_id, $enabled)
+    public function __construct($name, $description, $status, $link, $order, $group_id, $enabled, $meta)
     {
         $this->name = $name;
         $this->description = $description;
@@ -99,5 +108,6 @@ public function __construct($name, $description, $status, $link, $order, $group_
         $this->order = $order;
         $this->group_id = $group_id;
         $this->enabled = $enabled;
+        $this->meta = $meta;
     }
 }
diff --git a/app/Bus/Commands/Component/UpdateComponentCommand.php b/app/Bus/Commands/Component/UpdateComponentCommand.php
@@ -71,6 +71,13 @@ final class UpdateComponentCommand
      */
     public $enabled;
 
+    /**
+     * JSON meta data for the component.
+     *
+     * @var string|null
+     */
+    public $meta;
+
     /**
      * The validation rules.
      *
@@ -84,6 +91,7 @@ final class UpdateComponentCommand
         'order'       => 'nullable|int',
         'group_id'    => 'nullable|int',
         'enabled'     => 'nullable|bool',
+        'meta'        => 'nullable|string',
     ];
 
     /**
@@ -97,10 +105,11 @@ final class UpdateComponentCommand
      * @param int                               $order
      * @param int                               $group_id
      * @param bool                              $enabled
+     * @param string|null                       $meta
      *
      * @return void
      */
-    public function __construct(Component $component, $name, $description, $status, $link, $order, $group_id, $enabled)
+    public function __construct(Component $component, $name, $description, $status, $link, $order, $group_id, $enabled, $meta)
     {
         $this->component = $component;
         $this->name = $name;
@@ -110,5 +119,6 @@ public function __construct(Component $component, $name, $description, $status,
         $this->order = $order;
         $this->group_id = $group_id;
         $this->enabled = $enabled;
+        $this->meta = $meta;
     }
 }
diff --git a/app/Bus/Handlers/Commands/Component/AddComponentCommandHandler.php b/app/Bus/Handlers/Commands/Component/AddComponentCommandHandler.php
@@ -50,6 +50,7 @@ protected function filter(AddComponentCommand $command)
             'enabled'     => $command->enabled,
             'order'       => $command->order,
             'group_id'    => $command->group_id,
+            'meta'        => $command->meta,
         ];
 
         return array_filter($params, function ($val) {

diff --git a/app/Bus/Handlers/Commands/Component/UpdateComponentCommandHandler.php b/app/Bus/Handlers/Commands/Component/UpdateComponentCommandHandler.php
@@ -56,6 +56,7 @@ protected function filter(UpdateComponentCommand $command)
             'enabled'     => $command->enabled,
             'order'       => $command->order,
             'group_id'    => $command->group_id,
+            'meta'        => $command->meta,
         ];
 
         return array_filter($params, function ($val) {

diff --git a/app/Bus/Handlers/Commands/Incident/ReportIncidentCommandHandler.php b/app/Bus/Handlers/Commands/Incident/ReportIncidentCommandHandler.php
@@ -100,6 +100,7 @@ public function handle(ReportIncidentCommand $command)
                 null,
                 null,
                 null,
+                null,
                 null
             ));
         }

diff --git a/app/Http/Controllers/Api/ComponentController.php b/app/Http/Controllers/Api/ComponentController.php
@@ -77,7 +77,8 @@ public function postComponents()
                 Binput::get('link'),
                 Binput::get('order'),
                 Binput::get('group_id'),
-                (bool) Binput::get('enabled', true)
+                (bool) Binput::get('enabled', true),
+                Binput::get('meta', null)
             ));
         } catch (QueryException $e) {
             throw new BadRequestHttpException();
@@ -118,7 +119,8 @@ public function putComponent(Component $component)
                 Binput::get('link'),
                 Binput::get('order'),
                 Binput::get('group_id'),
-                (bool) Binput::get('enabled', true)
+                (bool) Binput::get('enabled', true),
+                Binput::get('meta', null)
             ));
         } catch (QueryException $e) {
             throw new BadRequestHttpException();

diff --git a/app/Http/Controllers/Dashboard/ComponentController.php b/app/Http/Controllers/Dashboard/ComponentController.php
@@ -134,7 +134,8 @@ public function updateComponentAction(Component $component)
                 $componentData['link'],
                 $componentData['order'],
                 $componentData['group_id'],
-                $componentData['enabled']
+                $componentData['enabled'],
+                null // Meta data cannot be supplied through the dashboard yet.
             ));
         } catch (ValidationException $e) {
             return cachet_redirect('dashboard.components.edit', [$component->id])
@@ -187,7 +188,8 @@ public function createComponentAction()
                 $componentData['link'],
                 $componentData['order'],
                 $componentData['group_id'],
-                $componentData['enabled']
+                $componentData['enabled'],
+                null // Meta data cannot be supplied through the dashboard yet.
             ));
         } catch (ValidationException $e) {
             return cachet_redirect('dashboard.components.create')

diff --git a/app/Models/Component.php b/app/Models/Component.php
@@ -35,6 +35,7 @@ class Component extends Model implements HasPresenter
         'description' => '',
         'link'        => '',
         'enabled'     => true,
+        'meta'        => null,
     ];
 
     /**
@@ -50,6 +51,7 @@ class Component extends Model implements HasPresenter
         'link'        => 'string',
         'group_id'    => 'int',
         'enabled'     => 'bool',
+        'meta'        => 'json',
         'deleted_at'  => 'date',
     ];
 
@@ -67,6 +69,7 @@ class Component extends Model implements HasPresenter
         'order',
         'group_id',
         'enabled',
+        'meta',
     ];
 
     /**

diff --git a/database/migrations/2016_12_05_185045_AlterTableComponentsAddMetaColumn.php b/database/migrations/2016_12_05_185045_AlterTableComponentsAddMetaColumn.php
@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AlterTableComponentsAddMetaColumn extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('components', function (Blueprint $table) {
+            $table->longText('meta')->nullable()->default(null)->after('enabled');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('components', function (Blueprint $table) {
+            $table->dropColumn('meta');
+        });
+    }
+}
diff --git a/tests/Api/ComponentTest.php b/tests/Api/ComponentTest.php
@@ -84,6 +84,31 @@ public function testPostComponentWithoutEnabledField()
         $this->assertResponseOk();
     }
 
+    public function testPostComponentWithMetaData()
+    {
+        $this->beUser();
+
+        $this->post('/api/v1/components', [
+            'name'        => 'Foo',
+            'description' => 'Bar',
+            'status'      => 1,
+            'link'        => 'http://example.com',
+            'order'       => 1,
+            'group_id'    => 1,
+            'enabled'     => true,
+            'meta'        => [
+                'uuid' => '172ff3fb-41f7-49d3-8bcd-f57b53627fa0',
+            ],
+        ]);
+
+        $this->seeJson([
+            'meta' => [
+                'uuid' => '172ff3fb-41f7-49d3-8bcd-f57b53627fa0',
+            ],
+        ]);
+        $this->assertResponseOk();
+    }
+
     public function testPostDisabledComponent()
     {
         $this->beUser();
@@ -122,6 +147,31 @@ public function testPutComponent()
         $this->assertResponseOk();
     }
 
+    public function testPutComponentWithMetaData()
+    {
+        $this->beUser();
+        $component = factory('CachetHQ\Cachet\Models\Component')->create([
+            'meta' => [
+                'uuid' => '172ff3fb-41f7-49d3-8bcd-f57b53627fa0',
+            ],
+        ]);
+
+        $this->put('/api/v1/components/1', [
+            'meta' => [
+                'uuid' => '172ff3fb-41f7-49d3-8bcd-f57b53627fa0',
+                'foo'  => 'bar',
+            ],
+        ]);
+
+        $this->seeJson([
+            'meta' => [
+                'uuid' => '172ff3fb-41f7-49d3-8bcd-f57b53627fa0',
+                'foo'  => 'bar',
+            ],
+        ]);
+        $this->assertResponseOk();
+    }
+
     public function testDeleteComponent()
     {
         $this->beUser();

diff --git a/tests/Bus/Commands/Component/AddComponentCommandTest.php b/tests/Bus/Commands/Component/AddComponentCommandTest.php
@@ -36,6 +36,7 @@ protected function getObjectAndParams()
             'order'       => 0,
             'group_id'    => 0,
             'enabled'     => true,
+            'meta'        => null,
         ];
         $object = new AddComponentCommand(
             $params['name'],
@@ -44,7 +45,8 @@ protected function getObjectAndParams()
             $params['link'],
             $params['order'],
             $params['group_id'],
-            $params['enabled']
+            $params['enabled'],
+            $params['meta']
         );
 
         return compact('params', 'object');

diff --git a/tests/Bus/Commands/Component/UpdateComponentCommandTest.php b/tests/Bus/Commands/Component/UpdateComponentCommandTest.php
@@ -38,6 +38,7 @@ protected function getObjectAndParams()
             'order'       => 0,
             'group_id'    => 0,
             'enabled'     => true,
+            'meta'        => null,
         ];
 
         $object = new UpdateComponentCommand(
@@ -48,7 +49,8 @@ protected function getObjectAndParams()
             $params['link'],
             $params['order'],
             $params['group_id'],
-            $params['enabled']
+            $params['enabled'],
+            $params['meta']
         );
 
         return compact('params', 'object');