AuditDriver: ElasticSearch

Author: rankarpan

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+Contributions are always welcome, but to keep things organized, keep in mind the following rules.
+
+# Bug Reports
+
+When reporting a bug in the Laravel Auditing Filesystem driver package, use the [issue tracker](https://github.com/iconscout/laravel-auditing-elasticsearch/issues) of the main repository.
+
+# Pull Requests
+
+Fixing a bug, correcting a typo or adding a new feature?
+
+Just remember that all pull requests should be done against the `master` branch.

LICENSE.md

@@ -0,0 +1,21 @@
+### The MIT License (MIT)
+
+Copyright (c) 2018 Iconscout.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,92 @@
+This driver provides the ability to save your model audits in elasticsearch.
+
+### Installation
+
+This driver requires that you are using `owen-it/laravel-auditing: ^6.0`. Provided this is fulfilled,
+you can install the driver like so:
+
+```
+composer require iconscout/laravel-auditing-elasticsearch
+```
+
+### Setup
+
+You need to add the following config entries in config/audit.php if you need to change the default behaviour of the driver.
+The `queue` key of the config file should look like so:
+
+```
+    ...
+    'queue' => env('AUDIT_QUEUE', true),
+    ...
+```
+
+OR
+
+```
+    ...
+    'queue' => env('AUDIT_QUEUE', [
+        'queue' => 'default',
+        'connection' => 'redis'
+    ]),
+    ...
+```
+
+The `driver` key of the config file should look like so:
+
+```
+    ...
+    'driver' => Iconscout\Auditing\Drivers\ElasticSearch::class,
+    ...
+```
+
+The `drivers` key of the config file should look like so:
+
+```
+    ...
+    'drivers' => [
+        'database' => [
+            'table'      => 'audits',
+            'connection' => null,
+        ],
+        'es' => [
+            'client' => [
+                'hosts' => [
+                    env('AUDIT_HOST', 'localhost:9200')
+                ]
+            ],
+            'index' => env('AUDIT_INDEX', 'laravel_auditing'),
+            'type' => env('AUDIT_TYPE', 'audits')
+        ],
+    ],
+    ...
+```
+
+### Usage
+
+You can use the driver in any Auditable model like so:
+
+```
+<?php
+namespace App\Models;
+
+use Iconscout\Auditing\Drivers\ElasticSearch;
+use Illuminate\Database\Eloquent\Model;
+use OwenIt\Auditing\Auditable;
+use OwenIt\Auditing\Contracts\Auditable as AuditableContract;
+
+class SomeModel extends Model implements AuditableContract
+{
+    use Auditable;
+
+    /**
+     * ElasticSearch Audit Driver
+     *
+     * @var Iconscout\Auditing\Drivers\ElasticSearch
+     */
+    protected $auditDriver = ElasticSearch::class;
+
+    // ...
+}
+```
+
+More information on using customer drivers with owen-it/laravel-auditing can be found on their [homepage](http://laravel-auditing.com/docs/6.0/audit-drivers)

composer.json

@@ -0,0 +1,44 @@
+{
+    "name": "iconscout/laravel-auditing-elasticsearch",
+    "description": "A elasticsearch driver for the owen-it/laravel-auditing package. Allows storage of the audits in elasticsearch.",
+    "keywords": [
+        "accountability",
+        "audit",
+        "auditing",
+        "changes",
+        "eloquent",
+        "history",
+        "log",
+        "logging",
+        "observer",
+        "laravel",
+        "lumen",
+        "record",
+        "revision",
+        "tracking",
+        "elasticsearch",
+        "es"
+    ],
+    "type": "package",
+    "license": "MIT",
+    "support": {
+        "issues": "https://github.com/iconscout/laravel-auditing-elasticsearch/issues",
+        "source": "https://github.com/iconscout/laravel-auditing-elasticsearch"
+    },
+    "authors": [
+        {
+            "name": "Arpan Rank",
+            "email": "arpan@iconscout.com"
+        }
+    ],
+    "require": {
+        "php": ">=7.0",
+        "owen-it/laravel-auditing": "^6.0",
+        "elasticsearch/elasticsearch": "6.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "Iconscout\\Auditing\\": "src/"
+        }
+    }
+}

src/Console/DeleteCommand.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * This file is part of the Laravel Auditing package.
+ *
+ * @author     Arpan Rank <arpan@iconscout.com>
+ * @copyright  2018
+ *
+ * For the full copyright and license information,
+ * please view the LICENSE.md file that was distributed
+ * with this source code.
+ */
+
+namespace Iconscout\Auditing\Console;
+
+use Illuminate\Console\Command;
+
+use Illuminate\Support\Facades\Config;
+use Iconscout\Auditing\Drivers\ElasticSearch;
+
+class DeleteCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'audit:es-delete';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = "Delete all of the model's records from the index";
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle(ElasticSearch $elasticsearch)
+    {
+        $index = Config::get('audit.drivers.es.index', 'laravel_auditing');
+
+        if ($elasticsearch->existsIndex()) {
+
+            $elasticsearch->deleteIndex();
+            $this->info("The {$index} index was deleted!");
+
+        } else {
+            $this->info("The {$index} index doesn't exist!");
+        }
+    }
+}

src/Console/IndexCommand.php

@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * This file is part of the Laravel Auditing package.
+ *
+ * @author     Arpan Rank <arpan@iconscout.com>
+ * @copyright  2018
+ *
+ * For the full copyright and license information,
+ * please view the LICENSE.md file that was distributed
+ * with this source code.
+ */
+
+namespace Iconscout\Auditing\Console;
+
+use Illuminate\Console\Command;
+
+use Illuminate\Support\Facades\Config;
+use Iconscout\Auditing\Drivers\ElasticSearch;
+
+class IndexCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'audit:es-index';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = "Index all of the model's records into the search index";
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle(ElasticSearch $elasticsearch)
+    {
+        $index = Config::get('audit.drivers.es.index', 'laravel_auditing');
+
+        if ($elasticsearch->existsIndex() === false) {
+
+            $elasticsearch->createIndex();
+            $this->info("The {$index} index was created!");
+
+            $elasticsearch->updateAliases();
+            $this->info("The {$index}_write alias for the {$index} index was created!");
+            
+            $elasticsearch->putMapping();
+            $this->info("The {$index} mapping was updated!");
+
+        } else {
+            $this->info("The {$index} index already exist!");
+        }
+    }
+}