Skip to content

Code update and refractor #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
],
"require": {
"php": "^8.0",
"illuminate/support": "^8.0|^9.0|^10.0|^11.0",
"jaybizzle/crawler-detect": "^1.2"
"illuminate/support": "^8.0|^9.0|^10.0|^11.0|^12.0",
"jaybizzle/crawler-detect": "^1.3"
},
"require-dev": {
"liip/rmt": "^1.7",
"orchestra/testbench": "^6.0|^7.0|^8.0",
"phpunit/phpunit": "^9.0"
"orchestra/testbench": "^6.0|^7.0|^8.0|^9.0",
"phpunit/phpunit": "^9.0|^10.0|^11.0"
},
"autoload": {
"psr-4": {
Expand Down
2 changes: 1 addition & 1 deletion database/factories/PageViewFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class PageViewFactory extends Factory
*
* @return array
*/
public function definition()
public function definition(): array
{
return [
'session_id' => $this->faker->word,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*
* @return void
*/
public function up()
public function up(): void
{
$tableName = config('laravel-analytics.db_prefix') . 'page_views';

Expand All @@ -21,7 +21,7 @@ public function up()
$table->string('path')->index();
$table->string('user_agent')->nullable();
$table->string('ip')->nullable();
$table->string('referer')->nullable()->index();
$table->text('referer')->nullable()->index();
$table->string('county')->nullable()->index();
$table->string('city')->nullable();
$table->string('page_model_type')->nullable();
Expand All @@ -38,7 +38,7 @@ public function up()
*
* @return void
*/
public function down()
public function down(): void
{
Schema::dropIfExists(config('laravel-analytics.db_prefix') . 'page_views');
}
Expand Down
14 changes: 14 additions & 0 deletions routes/api.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

use Illuminate\Support\Facades\Route;
use WdevRs\LaravelAnalytics\Http\Controllers\AnalyticsController;

Route::get('analytics/page-views-per-days', [AnalyticsController::class, 'getPageViewsPerDays']);
Route::get('analytics/page-views-per-path', [AnalyticsController::class, 'getPageViewsPerPaths']);

// New routes for additional analytics methods
Route::get('analytics/page-views-last-28-days', [AnalyticsController::class, 'getPageViewsLast28Days']);
Route::get('analytics/page-views-last-3-months', [AnalyticsController::class, 'getPageViewsLast3Months']);
Route::get('analytics/page-views-last-6-months', [AnalyticsController::class, 'getPageViewsLast6Months']);
Route::get('analytics/page-views-last-year', [AnalyticsController::class, 'getPageViewsLastYear']);
Route::get('analytics/page-views-custom-range', [AnalyticsController::class, 'getPageViewsCustomRange']);
2 changes: 1 addition & 1 deletion src/Analytics.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @see \WdevRs\LaravelAnalytics\LaravelAnalytics
* @see LaravelAnalytics
*/
class Analytics extends Facade
{
Expand Down
60 changes: 54 additions & 6 deletions src/Http/Controllers/AnalyticsController.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,65 @@
use Illuminate\Routing\Controller;
use Illuminate\Support\Carbon;
use WdevRs\LaravelAnalytics\Repositories\PageViewRepository;
use WdevRs\LaravelAnalytics\Tests\PageViewRepositoryTest;

class AnalyticsController extends Controller
{
public function getPageViewsPerDays(Request $request, PageViewRepository $pageViewRepository)
protected PageViewRepository $pageViewRepository;

public function __construct(PageViewRepository $pageViewRepository)
{
$this->pageViewRepository = $pageViewRepository;
}

public function getPageViewsPerDays(): JsonResponse
{
return response()->json(
$this->pageViewRepository->getByDateGroupedByDays(Carbon::today()->subDays(28))
);
}

public function getPageViewsPerPaths(): JsonResponse
{
return response()->json(
$this->pageViewRepository->getByDateGroupedByPath(Carbon::today()->subDays(28))
);
}

public function getPageViewsLast28Days(): JsonResponse
{
return $pageViewRepository->getByDateGroupedByDays(Carbon::today()->subDays(28));
return response()->json(
$this->pageViewRepository->getLast28Days()
);
}

public function getPageViewsPerPaths(Request $request, PageViewRepository $pageViewRepository)
public function getPageViewsLast3Months(): JsonResponse
{
return $pageViewRepository->getByDateGroupedByPath(Carbon::today()->subDays(28));
return response()->json(
$this->pageViewRepository->getLast3Months()
);
}

public function getPageViewsLast6Months(): JsonResponse
{
return response()->json(
$this->pageViewRepository->getLast6Months()
);
}

public function getPageViewsLastYear(): JsonResponse
{
return response()->json(
$this->pageViewRepository->getLastYear()
);
}

public function getPageViewsCustomRange(Request $request): JsonResponse
{
$startDate = Carbon::parse($request->query('start_date', now()->subMonth()));
$endDate = Carbon::parse($request->query('end_date', now()));

return response()->json(
$this->pageViewRepository->getCustomRange($startDate, $endDate)
);
}
}
}
75 changes: 38 additions & 37 deletions src/Http/Middleware/Analytics.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

namespace WdevRs\LaravelAnalytics\Http\Middleware;

use Closure;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use Closure;
use Illuminate\Support\Str;
use Jaybizzle\CrawlerDetect\CrawlerDetect;
use Throwable;
Expand All @@ -17,53 +17,54 @@ public function handle(Request $request, Closure $next)
$response = $next($request);

try {
if (!$request->isMethod('GET')) {
if (!$this->shouldTrack($request)) {
return $response;
}

if ($request->isJson()) {
return $response;
}

$userAgent = $request->userAgent();
$this->storePageView($request);
} catch (Throwable $e) {
report($e);
}

if (is_null($userAgent)) {
return $response;
}
return $response;
}

/** @var CrawlerDetect $crawlerDetect */
$crawlerDetect = app(CrawlerDetect::class);
private function shouldTrack(Request $request): bool
{
if (!$request->isMethod('GET') || $request->isJson()) {
return false;
}

if ($crawlerDetect->isCrawler($userAgent)) {
return $response;
}
$userAgent = $request->userAgent();
if (is_null($userAgent) || app(CrawlerDetect::class)->isCrawler($userAgent)) {
return false;
}

/** @var PageView $pageView */
$pageView = PageView::make([
'session_id' => session()->getId(),
'path' => $request->path(),
'user_agent' => Str::substr($userAgent, 0, 255),
'ip' => $request->headers->get('X-Forwarded-For') ? $request->headers->get('X-Forwarded-For') : $request->ip(),
'referer' => $request->headers->get('referer'),
]);
return true;
}

$parameters = $request->route()?->parameters();
$model = null;
private function storePageView(Request $request): void
{
$pageView = new PageView([
'session_id' => session()->getId(),
'path' => $request->path(),
'user_agent' => Str::limit($request->userAgent(), 255),
'ip' => $request->header('X-Forwarded-For', $request->ip()),
'referer' => $request->header('referer'),
]);

if (!is_null($parameters)) {
$model = reset($parameters);
}
if ($model = $this->getRouteModel($request)) {
$pageView->pageModel()->associate($model);
}

if (is_a($model, Model::class)) {
$pageView->pageModel()->associate($model);
}
$pageView->save();
}

$pageView->save();
private function getRouteModel(Request $request): ?Model
{
$parameters = $request->route()?->parameters();
$model = $parameters ? reset($parameters) : null;

return $response;
} catch (Throwable $e) {
report($e);
return $response;
}
return $model instanceof Model ? $model : null;
}
}
23 changes: 0 additions & 23 deletions src/LaravelAnalytics.php

This file was deleted.

33 changes: 10 additions & 23 deletions src/LaravelAnalyticsServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@
namespace WdevRs\LaravelAnalytics;

use Illuminate\Support\ServiceProvider;
use WdevRs\LaravelAnalytics\Repositories\PageViewRepository;

class LaravelAnalyticsServiceProvider extends ServiceProvider
{
/**
* Bootstrap the application services.
*/
public function boot()
public function boot(): void
{
/*
* Optional methods to load your package assets
*/
// $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'laravel-analytics');
// $this->loadViewsFrom(__DIR__.'/../resources/views', 'laravel-analytics');
// Load package migrations
$this->loadMigrationsFrom(__DIR__.'/../database/migrations');
// $this->loadRoutesFrom(__DIR__.'/routes.php');

// Load package routes
$this->loadRoutesFrom(__DIR__.'/../routes/api.php');

if ($this->app->runningInConsole()) {
$this->publishes([
Expand All @@ -29,32 +28,20 @@ public function boot()
__DIR__.'/../resources/js/components' => resource_path('js/vendor/laravel-analytics/components'),
], 'components');

// Publishing assets.
/*$this->publishes([
__DIR__.'/../resources/assets' => public_path('vendor/laravel-analytics'),
], 'assets');*/

// Publishing the translation files.
/*$this->publishes([
__DIR__.'/../resources/lang' => resource_path('lang/vendor/laravel-analytics'),
], 'lang');*/

// Registering package commands.
// $this->commands([]);
}
}

/**
* Register the application services.
*/
public function register()
public function register(): void
{
// Automatically apply the package configuration
$this->mergeConfigFrom(__DIR__.'/../config/laravel-analytics.php', 'laravel-analytics');

// Register the main class to use with the facade
$this->app->singleton('laravel-analytics', function () {
return new LaravelAnalytics;
//Add methods to get data through Analytics facade
$this->app->singleton('analytics', function ($app) {
return $app->make(PageViewRepository::class);
});
}
}
Loading