Merge pull request #1 from rappasoft/develop

v1.0.0

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: rappasoft

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
     - name: Ask a question
-      url: https://github.com/:vendor_slug/:package_slug/discussions/new?category=q-a
+      url: https://github.com/rappasoft/laravel-authentication-log/discussions/new?category=q-a
       about: Ask the community for help
     - name: Request a feature
-      url: https://github.com/:vendor_slug/:package_slug/discussions/new?category=ideas
+      url: https://github.com/rappasoft/laravel-authentication-log/discussions/new?category=ideas
       about: Share ideas for new features
     - name: Report a bug
-      url: https://github.com/:vendor_slug/:package_slug/issues/new
+      url: https://github.com/rappasoft/laravel-authentication-log/issues/new
       about: Report a reproducable bug

.github/SECURITY.md

@@ -1,3 +1,3 @@
 # Security Policy
 
-If you discover any security related issues, please email author@domain.com instead of using the issue tracker.
+If you discover any security related issues, please email rappa819@gmail.com instead of using the issue tracker.

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `Laravel Authentication Log` will be documented in this file.
 
-## 1.0.0 - 202X-XX-XX
+## 1.0.0 - 2021-09-30
 
-- initial release
+- Initial Release

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <author@domain.com>
+Copyright (c) Anthony Rappa <rappa819@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,64 +1,265 @@
-# :package_description
+![Package Logo](https://banners.beyondco.de/Laravel%20Authentication%20Log.png?theme=dark&packageManager=composer+require&packageName=rappasoft%2Flaravel-authentication-log&pattern=hideout&style=style_1&description=Log+user+authentication+details+and+send+new+device+notifications.&md=1&showWatermark=0&fontSize=100px&images=lock-closed)
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/run-tests?label=tests)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/:vendor_slug/:package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/rappasoft/laravel-authentication-log.svg?style=flat-square)](https://packagist.org/packages/rappasoft/laravel-authentication-log)
+[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/rappasoft/laravel-authentication-log/run-tests?label=tests)](https://github.com/rappasoft/laravel-authentication-log/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/rappasoft/laravel-authentication-log/Check%20&%20fix%20styling?label=code%20style)](https://github.com/rappasoft/laravel-authentication-log/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/rappasoft/laravel-authentication-log.svg?style=flat-square)](https://packagist.org/packages/rappasoft/laravel-authentication-log)
 
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
-
-1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
-3. Remove this block of text.
-4. Have fun creating your package.
-5. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+Laravel Authentication Log is a package which tracks your user's authentication information such as login/logout time, IP, Browser, Location, etc. as well as sends out notifications via mail, slack, or sms for new devices and failed logins.
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require rappasoft/laravel-authentication-log
+```
+
+If you want the location features you must also install `torann/geoip`:
+
+```bash
+composer require torann/geoip
 ```
 
 You can publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag=":package_slug-migrations"
+php artisan vendor:publish --provider="Rappasoft\LaravelAuthenticationLog\LaravelAuthenticationLogServiceProvider" --tag="authentication-log-migrations"
 php artisan migrate
 ```
 
+You can publish the view/email files with:
+```bash
+php artisan vendor:publish --provider="Rappasoft\LaravelAuthenticationLog\LaravelAuthenticationLogServiceProvider" --tag="authentication-log-views"
+```
+
 You can publish the config file with:
 ```bash
-php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag=":package_slug-config"
+php artisan vendor:publish --provider="Rappasoft\LaravelAuthenticationLog\LaravelAuthenticationLogServiceProvider" --tag="authentication-log-config"
 ```
 
 This is the contents of the published config file:
 
 ```php
 return [
+    // The database table name
+    // You can change this if the database keys get too long for your driver
+    'table_name' => 'authentication_log',
+
+    'notifications' => [
+        'new-device' => [
+            // Send the NewDevice notification
+            'enabled' => env('NEW_DEVICE_NOTIFICATION', true),
+
+            // Use torann/geoip to attempt to get a location
+            'location' => true,
+
+            // The Notification class to send
+            'template' => \Rappasoft\LaravelAuthenticationLog\Notifications\NewDevice::class,
+        ],
+        'failed-login' => [
+            // Send the FailedLogin notification
+            'enabled' => env('FAILED_LOGIN_NOTIFICATION', false),
+
+            // Use torann/geoip to attempt to get a location
+            'location' => true,
+
+            // The Notification class to send
+            'template' => \Rappasoft\LaravelAuthenticationLog\Notifications\FailedLogin::class,
+        ],
+    ],
+
+    // When the clean-up command is run, delete old logs greater than `purge` days
+    // Don't schedule the clean-up command if you want to keep logs forever.
+    'purge' => 365,
 ];
 ```
 
+If you installed `torann/geoip` you should also publish that config file to set your defaults:
+
+```
+php artisan vendor:publish --provider="Torann\GeoIP\GeoIPServiceProvider" --tag=config
+```
+
+## Configuration
+
+You must add the `AuthenticationLoggable` and `Notifiable` traits to the models you want to track.
+
+```php
+use Illuminate\Notifications\Notifiable;
+use Rappasoft\LaravelAuthenticationLog\Traits\AuthenticationLoggable;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class User extends Authenticatable
+{
+    use Notifiable, AuthenticationLoggable;
+}
+```
+
+The package will listen for Laravel's Login, Logout, Failed, and OtherDeviceLogout events.
+
 ## Usage
 
+Get all authentication logs for the user:
+```php
+User::find(1)->authentications;
+```
+
+Get the user's last login information:
+```php
+User::find(1)->lastLoginAt();
+
+User::find(1)->lastSuccessfulLoginAt();
+
+User::find(1)->lastLoginIp();
+
+User::find(1)->lastSuccessfulLoginIp();
+```
+
+Get the user's previous login time & IP address (ignoring the current login):
+```php
+auth()->user()->previousLoginAt();
+
+auth()->user()->previousLoginIp();
+```
+
+### Notifications
+
+Notifications may be sent on the `mail`, `nexmo`, and `slack` channels but by **default notify via email**.
+
+You may define a `notifyAuthenticationLogVia` method  on your authenticatable models to determine which channels the notification should be delivered on:
+
+```php
+public function notifyAuthenticationLogVia()
+{
+    return ['nexmo', 'mail', 'slack'];
+}
+```
+
+You must install the [Slack](https://laravel.com/docs/8.x/notifications#routing-slack-notifications) and [Nexmo](https://laravel.com/docs/8.x/notifications#routing-sms-notifications) drivers to use those routes and follow their documentation on setting it up for your specific authenticatable models.
+
+#### New Device Notifications
+
+Enabled by default, they use the `\Rappasoft\LaravelAuthenticationLog\Notifications\NewDevice` class which can be overridden in the config file.
+
+#### Failed Login Notifications
+
+Disabled by default, they use the `\Rappasoft\LaravelAuthenticationLog\Notifications\FailedLogin` class which can be overridden in the config file.
+
+#### Location
+
+If the `torann/geoip` package is installed, it will attempt to include location information to the notifications by default.
+
+You can turn this off within the configuration for each template.
+
+**Note:** By default when working locally, no location will be recorded because it will send back the `default address` from the `geoip` config file. You can override this behavior in the email templates.
+
+## Purging Old Logs
+
+You may clear the old authentication log records using the `authentication-log:purge` Artisan command:
+
+```
+php artisan authentication-log:purge
+```
+
+Records that are older than the number of days specified in the `purge` option in your `config/authentication-log.php` will be deleted.
+
 ```php
-$skeleton = new VendorName\Skeleton();
-echo $skeleton->echoPhrase('Hello, VendorName!');
+'purge' => 365,
 ```
 
+You can also schedule the command at an interval:
+
+```php
+$schedule->command('authentication-log:purge')->monthly();
+```
+
+## Displaying The Log
+
+You can set up your own views and paginate the logs using the user relationship as normal, or if you also use my [Livewire Tables](https://github.com/rappasoft/laravel-livewire-tables) plugin then here is an example table:
+
+**Note:** This example uses the `jenssegers/agent` package which is included by default with Laravel Jetstream as well as `jamesmills/laravel-timezone` for displaying timezones in the users local timezone. Both are optional, modify the table to fit your needs.
+
+```php
+<?php
+
+namespace App\Http\Livewire;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Builder;
+use Jenssegers\Agent\Agent;
+use Rappasoft\LaravelLivewireTables\DataTableComponent;
+use Rappasoft\LaravelLivewireTables\Views\Column;
+use Rappasoft\LaravelAuthenticationLog\Models\AuthenticationLog as Log;
+
+class AuthenticationLog extends DataTableComponent
+{
+    public string $defaultSortColumn = 'login_at';
+    public string $defaultSortDirection = 'desc';
+    public string $tableName = 'authentication-log-table';
+
+    public User $user;
+
+    public function mount(User $user)
+    {
+        if (! auth()->user() || ! auth()->user()->isAdmin()) {
+            $this->redirectRoute('frontend.index');
+        }
+
+        $this->user = $user;
+    }
+
+    public function columns(): array
+    {
+        return [
+            Column::make('IP Address', 'ip_address')
+                ->searchable(),
+            Column::make('Browser', 'user_agent')
+                ->searchable()
+                ->format(function($value) {
+                    $agent = tap(new Agent, fn($agent) => $agent->setUserAgent($value));
+                    return $agent->platform() . ' - ' . $agent->browser();
+                }),
+            Column::make('Location')
+                ->searchable(function (Builder $query, $searchTerm) {
+                    $query->orWhere('location->city', 'like', '%'.$searchTerm.'%')
+                        ->orWhere('location->state', 'like', '%'.$searchTerm.'%')
+                        ->orWhere('location->state_name', 'like', '%'.$searchTerm.'%')
+                        ->orWhere('location->postal_code', 'like', '%'.$searchTerm.'%');
+                })
+                ->format(fn($value) => $value['default'] === false ? $value['city'] . ', ' . $value['state'] : '-'),
+            Column::make('Login At')
+                ->sortable()
+                ->format(fn($value) => $value ? timezone()->convertToLocal($value) : '-'),
+            Column::make('Login Successful')
+                ->sortable()
+                ->format(fn($value) => $value === true ? 'Yes' : 'No'),
+            Column::make('Logout At')
+                ->sortable()
+                ->format(fn($value) => $value ? timezone()->convertToLocal($value) : '-'),
+            Column::make('Cleared By User')
+                ->sortable()
+                ->format(fn($value) => $value === true ? 'Yes' : 'No'),
+        ];
+    }
+
+    public function query(): Builder
+    {
+        return Log::query()
+            ->where('authenticatable_type', User::class)
+            ->where('authenticatable_id', $this->user->id);
+    }
+}
+```
+
+```html
+<livewire:authentication-log :user="$user" />
+```
+
+Example:
+
+![Example Log Table](https://imgur.com/B4DlN4W.png)
+
 ## Testing
 
 ```bash
@@ -79,7 +280,8 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Anthony Rappa](https://github.com/rappasoft)
+- [yadahan/laravel-authentication-log](https://github.com/yadahan/laravel-authentication-log)
 - [All Contributors](../../contributors)
 
 ## License