~ Initial work

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: Modern McGuire

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: Ask a question
-    url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
+    url: https://github.com/Modern McGuire/laravel-otp/discussions/new?category=q-a
     about: Ask the community for help
   - name: Request a feature
-    url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
+    url: https://github.com/Modern McGuire/laravel-otp/discussions/new?category=ideas
     about: Share ideas for new features
   - name: Report a security issue
-    url: https://github.com/:vendor_name/:package_name/security/policy
+    url: https://github.com/Modern McGuire/laravel-otp/security/policy
     about: Learn how to notify us for sensitive bugs

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `laravel-otp` will be documented in this file.

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <author@domain.com>
+Copyright (c) Modern McGuire <ben@modernmcguire.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,24 +1,15 @@
-# :package_description
-
-[![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/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+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)
-<!--delete-->
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
-
-1. Press the "Use this 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. Have fun creating your package.
-4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-<!--/delete-->
+# OTP generation through multiple drivers for Laravel
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/modernmcguire/laravel-otp.svg?style=flat-square)](https://packagist.org/packages/modernmcguire/laravel-otp)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/modernmcguire/laravel-otp/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/modernmcguire/laravel-otp/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/modernmcguire/laravel-otp/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/modernmcguire/laravel-otp/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/modernmcguire/laravel-otp.svg?style=flat-square)](https://packagist.org/packages/modernmcguire/laravel-otp)
+
 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)
+[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-otp.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-otp)
 
 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).
 
@@ -29,42 +20,59 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
 You can install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require modernmcguire/laravel-otp
 ```
 
 You can publish and run the migrations with:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-migrations"
+php artisan vendor:publish --tag="laravel-otp-migrations"
 php artisan migrate
 ```
 
 You can publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-config"
-```
-
-This is the contents of the published config file:
-
-```php
-return [
-];
+php artisan vendor:publish --tag="laravel-otp-config"
 ```
 
 Optionally, you can publish the views using
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-views"
+php artisan vendor:publish --tag="laravel-otp-views"
 ```
 
-## Usage
+## Config
+
+The package has multiple drivers to choose from. You can set the driver in the config file or in your env.
 
 ```php
-$variable = new VendorName\Skeleton();
-echo $variable->echoPhrase('Hello, VendorName!');
+'default_driver' => env('OTP_DRIVER', 'email'),
 ```
 
+> Note: Currently the only one that is setup properly is the email driver.
+
+## Usage
+
+1. Run Migrations
+2. Apply the `HandlesOTP` trait to your User model
+3. Set `two_factor_enabled` to true on the user
+4. Login!
+
+You will be redirected to a page to enter your OTP code.
+
+## Database
+
+New database fields will be added to your users table.
+
+
+| Field                 | Description                            |
+|-----------------------|----------------------------------------|
+| two_factor_enabled    | Whether two factor authentication is enabled |
+| otp_secret            | The OTP code to match against           |
+| otp_secret_expires_at | The time the OTP code expires (default: 5 minutes) |
+
+
 ## Testing
 
 ```bash
@@ -85,7 +93,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Ben Miller](https://github.com/modernben)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -1,24 +1,24 @@
 {
-    "name": ":vendor_slug/:package_slug",
-    "description": ":package_description",
+    "name": "modernmcguire/laravel-otp",
+    "description": "OTP generation through multiple drivers for Laravel",
     "keywords": [
-        ":vendor_name",
+        "Modern McGuire",
         "laravel",
-        ":package_slug"
+        "laravel-otp"
     ],
-    "homepage": "https://github.com/:vendor_slug/:package_slug",
+    "homepage": "https://github.com/modernmcguire/laravel-otp",
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": "author@domain.com",
+            "name": "Ben Miller",
+            "email": "ben@modernmcguire.com",
             "role": "Developer"
         }
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0"
+        "illuminate/contracts": "^10.0",
+        "spatie/laravel-package-tools": "^1.14.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",
@@ -30,24 +30,23 @@
         "pestphp/pest-plugin-laravel": "^2.0",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan-deprecation-rules": "^1.0",
-        "phpstan/phpstan-phpunit": "^1.0",
-        "spatie/laravel-ray": "^1.26"
+        "phpstan/phpstan-phpunit": "^1.0"
     },
     "autoload": {
         "psr-4": {
-            "VendorName\\Skeleton\\": "src/",
-            "VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
+            "ModernMcGuire\\LaravelOtp\\": "src/",
+            "ModernMcGuire\\LaravelOtp\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "VendorName\\Skeleton\\Tests\\": "tests/",
+            "ModernMcGuire\\LaravelOtp\\Tests\\": "tests/",
             "Workbench\\App\\": "workbench/app/"
         }
     },
     "scripts": {
         "post-autoload-dump": "@composer run prepare",
-        "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+        "clear": "@php vendor/bin/testbench package:purge-laravel-otp --ansi",
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "build": [
             "@composer run prepare",
@@ -73,13 +72,16 @@
     "extra": {
         "laravel": {
             "providers": [
-                "VendorName\\Skeleton\\SkeletonServiceProvider"
+                "ModernMcGuire\\LaravelOtp\\LaravelOtpServiceProvider"
             ],
             "aliases": {
-                "Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
+                "LaravelOtp": "ModernMcGuire\\LaravelOtp\\Facades\\LaravelOtp"
             }
         }
     },
+    "suggest": {
+        "pragmarx/google2fa-laravel": "For use with the Google2FA driver"
+    },
     "minimum-stability": "dev",
     "prefer-stable": true
 }

config/laravel-otp.php

@@ -0,0 +1,25 @@
+<?php
+
+use ModernMcGuire\LaravelOtp\Mail\SendOTPMail;
+
+return [
+    /**
+     * The driver to use for sending the OTP
+     * Supported: "email"
+     * Default: "email"
+
+     */
+    'default_driver' => env('OTP_DRIVER', 'email'),
+
+    'drivers' => [
+        'email' => [
+            'mailable_class' => SendOTPMail::class,
+        ],
+    ],
+
+    /**
+     * The amount of minutes the OTP is valid for
+     * Default: 5
+     */
+    'otp_expiry' => env('OTP_EXPIRY', 5),
+];