New activity package

Author: mlantz

src/Console/Activity.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Yab\Laracogs\Console;
+
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+use Yab\Laracogs\Traits\FileMakerTrait;
+
+class Activity extends Command
+{
+    use FileMakerTrait;
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $signature = 'laracogs:activity';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Add an activity tracker for your users';
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        if (!file_exists(base_path('resources/views/team/create.blade.php'))) {
+            $this->line("\n\nPlease perform the starter command:\n");
+            $this->info("\n\nphp artisan laracogs:starter\n");
+            $this->line("\n\nThen one you're able to run the unit tests successfully re-run this command, to bootstrap your app :)\n");
+        } else {
+            $fileSystem = new Filesystem();
+
+            $files = $fileSystem->allFiles(__DIR__.'/../Packages/Activity');
+            $this->line("\n");
+            foreach ($files as $file) {
+                $this->line(str_replace(__DIR__.'/../Packages/Activity/', '', $file));
+            }
+
+            $this->info("\n\nThese files will be published\n");
+
+            $result = $this->confirm('Are you sure you want to overwrite any files of the same name?');
+
+            if ($result) {
+                $this->copyPreparedFiles(__DIR__.'/../Packages/Activity', base_path());
+                $this->appendTheFactory();
+
+                $this->info("\n\n Please review the setup details for activity tracking.");
+                $this->line("\n You need to add the activity service provider to your app config:");
+                $this->comment("\n App\Providers\ActivityServiceProvider::class,");
+                $this->line("\n You will also need to the activity middleware to the Kernel in the \$routeMiddleware array:");
+                $this->comment("\n 'activity' => \App\Http\Middleware\Activity::class,");
+                $this->line("\n Now to track all you need to do is add the middleware `activity` to your routes");
+                $this->line("\n In order to get a user's activities use this:");
+                $this->comment("\n app(App\Services\ActivityService::class)->getByUser(\$userId);");
+                $this->info("\n Finished setting up activity");
+            } else {
+                $this->info("\n You cancelled the laracogs activity");
+            }
+        }
+    }
+
+    public function appendTheFactory()
+    {
+        $activityPrepared = '
+/*
+|--------------------------------------------------------------------------
+| Activity Factory
+|--------------------------------------------------------------------------
+*/
+
+$factory->define('.$this->getAppNamespace()."Models\Activity::class, function (Faker\Generator \$faker) {
+    return [
+        'id' => 1,
+        'user_id' => 1,
+        'description' => 'Standard User Activity',
+        'request' => [],
+    ];
+});
+";
+
+        $factoryMaster = base_path('database/factories/ModelFactory.php');
+
+        return file_put_contents($factoryMaster, $activityPrepared, FILE_APPEND);
+    }
+}

src/Packages/Activity/app/Facades/Activity.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace {{App\}}Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class Activity extends Facade
+{
+    /**
+     * Create the Facade
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor() { return 'ActivityService'; }
+}

src/Packages/Activity/app/Http/Middleware/Activity.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace {{App\}}Http\Middleware;
+
+use Closure;
+use Illuminate\Contracts\Auth\Guard;
+
+class Activity
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        activity('Standard User Action');
+
+        return $next($request);
+    }
+}

src/Packages/Activity/app/Models/Activity.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace {{App\}}Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Activity extends Model
+{
+    public $table = "activities";
+
+    public $primaryKey = "id";
+
+    public $timestamps = true;
+
+    public $fillable = [
+        'user_id',
+        'description',
+        'request',
+    ];
+
+    public static $rules = [
+        'request' => 'required',
+    ];
+}

src/Packages/Activity/app/Providers/ActvityServiceProvider.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace {{App\}}Providers;
+
+use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\ServiceProvider;
+
+class ActivityServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     */
+    public function boot()
+    {
+        if (function_exists('activity')) {
+            function activity($description)
+            {
+                return Activity::log($description);
+            }
+        }
+    }
+
+    /**
+     * Register any application services.
+     */
+    public function register()
+    {
+        $loader = \Illuminate\Foundation\AliasLoader::getInstance();
+
+        $loader->alias('Activity', \App\Facades\Activity::class);
+
+        $this->app->singleton('ActivityService', function ($app) {
+            return app(\App\Services\ActivityService::class);
+        });
+    }
+}

src/Packages/Activity/app/Services/ActivityService.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace {{App\}}Services;
+
+use {{App\}}Models\Activity;
+use Illuminate\Support\Facades\Schema;
+
+class ActivityService
+{
+    public function __construct(Activity $model)
+    {
+        $this->model = $model;
+    }
+
+    /**
+     * All activities
+     *
+     * @return  Collection
+     */
+    public function getByUser($userId, $paginate = null)
+    {
+        $query = $this->model->where('user', $userId);
+
+        if (!is_null($paginate)) {
+            return $query->paginate($paginate);
+        }
+
+        return $query->get();
+    }
+
+    /**
+     * Create an activity record
+     *
+     * @param  string $description
+     * @return  Activity
+     */
+    public function log($description = '')
+    {
+        $payload = [
+            'user_id' => auth()->id(),
+            'description' => $description,
+            'request' => [
+                'url' => request()->url(),
+                'method' => request()->method(),
+                'query' => request()->fullUrlWithQuery(),
+                'secure' => request()->secure(),
+                'client_ip' => request()->ip(),
+                'payload' => request()->all(),
+            ],
+        ];
+
+        return $this->model->create($payload);
+    }
+}

src/Packages/Activity/database/migrations/2017_04_07_210036_create_activity_table.php

@@ -0,0 +1,29 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateActivityTable extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up()
+    {
+        Schema::create('activities', function (Blueprint $table) {
+            $table->increments('id');
+            $table->integer('user_id');
+            $table->string('description');
+            $table->text('request');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down()
+    {
+        Schema::drop('activities');
+    }
+}