Added base

Author: voidgraphics

.gitignore

@@ -4,3 +4,4 @@ composer.phar
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
 # composer.lock
+composer.lock

README.md

@@ -1,2 +1,111 @@
 # laravel-pageview-counter
-A stupid simple analytics tool to keep track of page views
+
+A stupid simple analytics tool to keep track of page views in Laravel projects. It logs requests to a database table and you can access the data with an Eloquent model.
+
+## Installation
+
+```bash
+composer require voidgraphics/laravel-pageview-counter
+```
+
+You need to publish the migration that will add the pageviews table: 
+
+```bash
+php artisan vendor:publish --tag=pageview-counter-migrations
+```
+
+Then run the migrations
+
+```bash
+php artisan migrate
+```
+
+After this, register the `LogRequest` middleware. You can do it globally or on specific routes. Here's how to install it globally in Laravel 11
+
+```php
+// bootstrap/app.php
+
+<?php
+
+use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Configuration\Exceptions;
+use Illuminate\Foundation\Configuration\Middleware;
+use PageviewCounter\Middleware\LogRequest;
+
+return Application::configure(basePath: dirname(__DIR__))
+    // ...
+    ->withMiddleware(function (Middleware $middleware) {
+        $middleware->append(LogRequest::class);
+    })
+    // ...
+    ->create();
+```
+
+## Accessing the data
+
+Every request hitting those routes will now be logged. You can access that data using the `PageviewCounter\Models\Pageview` model. It has 3 scopes to help you prepare the data for display.
+
+```php
+Pageview::daily()->get(); // Returns the number of views grouped by date and path.
+
+/*
+Illuminate\Database\Eloquent\Collection {
+    all: [
+        PageviewCounter\Models\Pageview {
+            views: 156,
+            path: "/",
+            date: "2024-07-18",
+        },
+        PageviewCounter\Models\Pageview {
+            views: 68,
+            path: "about",
+            date: "2024-07-18",
+        }
+        PageviewCounter\Models\Pageview {
+            views: 289,
+            path: "/",
+            date: "2024-07-17",
+        },
+        PageviewCounter\Models\Pageview {
+            views: 32,
+            path: "about",
+            date: "2024-07-17",
+        }
+    ],
+}
+*/
+```
+
+```php
+Pageview::withoutBots()->get(); // Exclude most popular bots by user-agent
+
+/*
+Shorthand for: 
+
+$query->where('useragent', 'not like', '%bot%')
+    ->where('useragent', 'not like', '%python-requests%')
+    ->where('useragent', 'not like', '%http%')
+    ->where('useragent', 'not like', '%node-fetch%')
+    ->where('useragent', 'not like', '%postman%')
+    ->where('useragent', 'not like', '%curl%')
+*/
+```
+
+```php
+Pageview::uniqueVisitors()->get(); // Returns the count of unique visitors, grouped by date
+
+/*
+Illuminate\Database\Eloquent\Collection {
+    all: [
+        PageviewCounter\Models\Pageview {
+            unique_visitors: 176,
+            date: "2024-07-18",
+        },
+        PageviewCounter\Models\Pageview {
+            unique_visitors: 302,
+            date: "2024-07-17",
+        }
+    ],
+}
+*/
+```

composer.json

@@ -0,0 +1,25 @@
+{
+    "name": "voidgraphics/laravel-pageview-counter",
+    "description": "A stupid simple analytics tool to keep track of page views",
+    "autoload": {
+        "psr-4": {
+            "PageviewCounter\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Adrien Leloup",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "laravel/framework": "^11.0"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "PageviewCounter\\ServiceProvider"
+            ]
+        }
+    }
+}

database/migrations/0001_01_01_000000_create_pageviews_table.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('pageviews', function (Blueprint $table) {
+            $table->id();
+            $table->string('path');
+            $table->string('method', 12);
+            $table->text('useragent');
+            $table->string('visitorid');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('pageviews');
+    }
+};

src/Middleware/LogRequest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace PageviewCounter\Middleware;
+
+use PageviewCounter\Models\Pageview;
+use Illuminate\Http\Request;
+use Closure;
+
+class LogRequest
+{
+    public function handle(Request $request, Closure $next)
+    {
+        // Make it an after middleware
+        $response = $next($request);
+ 
+        try {
+            Pageview::create([
+                'path' => $request->path(),
+                'method' => $request->method(),
+                'useragent' => $request->userAgent(),
+                'visitorid' => crypt($request->ip(), config('app.key'))
+            ]);
+            
+            return $response;
+        } catch (Error $e) {
+            report($e);
+            return $response;
+        }
+    }
+}

src/Models/Pageview.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace PageviewCounter\Models;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+class Pageview extends Model
+{
+    protected $guarded = [];
+
+    public function scopeDaily(Builder $query): Builder
+    {
+        return $query->selectRaw('COUNT(*) views, path, DATE(created_at) date')
+            ->groupBy(['date', 'path'])
+            ->orderBy('date', 'desc');
+    }
+
+    public function scopeWithoutBots(Builder $query): Builder
+    {
+        return $query->where('useragent', 'not like', '%bot%')
+            ->where('useragent', 'not like', '%python-requests%')
+            ->where('useragent', 'not like', '%http%')
+            ->where('useragent', 'not like', '%node-fetch%')
+            ->where('useragent', 'not like', '%postman%')
+            ->where('useragent', 'not like', '%curl%');
+    }
+
+    public function scopeUniqueVisitors(Builder $query): Builder
+    {
+        return $query->selectRaw('COUNT(DISTINCT visitorid) unique_visitors, DATE(created_at) date')
+                ->groupBy(['date'])
+                ->orderBy('date', 'desc');
+    }
+}

src/ServiceProvider.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace PageviewCounter;
+
+use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
+
+class ServiceProvider extends LaravelServiceProvider
+{
+    /**
+     * Bootstrap any package services.
+     */
+    public function boot(): void
+    {
+        $this->publishesMigrations([
+            __DIR__.'/../database/migrations' => database_path('migrations'),
+        ], 'pageview-counter-migrations');
+    }
+}