cleanup language files and update readme

jeremykenedy · jeremykenedy · commit fa5b7b43263a · 2018-01-20T13:46:50.000-08:00
diff --git a/README.md b/README.md
@@ -110,8 +110,8 @@ twostep
 Example to start recording page views using middlware in `web.php`:
 
 ```php
-Route::group(['middleware' => ['auth', 'twostep']], function () {
-    Route::get('/', 'WelcomeController@welcome')->name('welcome');
+Route::group(['middleware' => ['twostep']], function () {
+    Route::get('/home', 'HomeController@index')->name('home');
 });
 ```
 
@@ -121,26 +121,74 @@ Route::group(['middleware' => ['auth', 'twostep']], function () {
 * ```/verification/resend```
 
 ### Screenshots
-![Verification Page](...)
-![Locked Page](...)
-![Verification Email](...)
+![Verification Page](https://s3-us-west-2.amazonaws.com/github-project-images/laravel2step/1-verification-page.jpeg)
+![Resent Email Modal](https://s3-us-west-2.amazonaws.com/github-project-images/laravel2step/2-verification-email-resent.jpeg)
+![Lock Warning Modal](https://s3-us-west-2.amazonaws.com/github-project-images/laravel2step/3-lock-warning.jpeg)
+![Locked Page](https://s3-us-west-2.amazonaws.com/github-project-images/laravel2step/4-lock-screen.jpeg)
+![Verification Email](https://s3-us-west-2.amazonaws.com/github-project-images/laravel2step/5-verification-email.jpeg)
 
 ### File Tree
 
 ```
- ...
+└── laravel2step
+    ├── .gitignore
+    ├── LICENSE
+    ├── README.md
+    ├── composer.json
+    └── src
+        ├── .env.example
+        ├── Laravel2stepServiceProvider.php
+        ├── app
+        │   ├── Http
+        │   │   ├── Controllers
+        │   │   │   └── TwoStepController.php
+        │   │   └── Middleware
+        │   │       └── Laravel2step.php
+        │   ├── Models
+        │   │   └── TwoStepAuth.php
+        │   ├── Notifications
+        │   │   └── SendVerificationCodeEmail.php
+        │   └── Traits
+        │       └── Laravel2StepTrait.php
+        ├── config
+        │   └── laravel2step.php
+        ├── database
+        │   └── migrations
+        │       └── 2017_12_09_070937_create_two_step_auth_table.php
+        ├── public
+        │   └── css
+        │       ├── app.css
+        │       └── app.min.css
+        ├── resources
+        │   ├── assets
+        │   │   └── scss
+        │   │       ├── _animations.scss
+        │   │       ├── _mixins.scss
+        │   │       ├── _modals.scss
+        │   │       ├── _variables.scss
+        │   │       ├── _verification.scss
+        │   │       └── app.scss
+        │   ├── lang
+        │   │   └── en
+        │   │       └── laravel-verification.php
+        │   └── views
+        │       ├── layouts
+        │       │   └── app.blade.php
+        │       ├── partials
+        │       ├── scripts
+        │       │   └── input-parsing-auto-stepper.blade.php
+        │       └── twostep
+        │           ├── exceeded.blade.php
+        │           └── verification.blade.php
+        └── routes
+            └── web.php
 
 ```
 
 * Tree command can be installed using brew: `brew install tree`
 * File tree generated using command `tree -a -I '.git|node_modules|vendor|storage|tests`
 
 ### Future
-* Readme
-* Screenshots
-* Language file cleanup.
-* Cleanup Service provider file.
-* Cleanup doc blocks.
 * Have more configurable options via the config file to run to env file. For:
     * Optional compiled CSS/JS
     * Optional use of modals/alerts in front end with optional sweetalert2.js
diff --git a/src/app/Http/Controllers/TwoStepController.php b/src/app/Http/Controllers/TwoStepController.php
@@ -184,16 +184,17 @@ public function verify(Request $request)
      * Resend the validation code triggered by user
      *
      * @return \Illuminate\Http\Response
-     *
      */
     public function resend()
     {
         $twoStepAuth = $this->_twoStepAuth;
         $this->sendVerificationCodeNotification($twoStepAuth);
 
+
+
         $returnData = [
-            'title' => 'Success!',
-            'message' => 'Verification Email Sent!',
+            'title' => trans('laravel2step::laravel-verification.verificationEmailSuccess'),
+            'message' => trans('laravel2step::laravel-verification.verificationEmailSentMsg'),
         ];
 
         return response()->json($returnData, 200);
diff --git a/src/app/Http/Middleware/Laravel2step.php b/src/app/Http/Middleware/Laravel2step.php
@@ -16,6 +16,7 @@ class Laravel2step
      *
      * @param Request $request
      * @param \Closure $response
+     *
      * @return mixed
      */
     public function handle($request, Closure $next)
diff --git a/src/app/Traits/Laravel2StepTrait.php b/src/app/Traits/Laravel2StepTrait.php
@@ -65,7 +65,9 @@ private function checkTimeSinceVerified($twoStepAuth)
 
     /**
      * Reset TwoStepAuth collection item and code
+     *
      * @param collection $twoStepAuth
+     *
      * @return collection
      */
     private function resetAuthStatus($twoStepAuth)
@@ -155,8 +157,7 @@ protected function exceededTimeParser($time)
     }
 
     /**
-     * Check if time since account lock has expired and return true
-     * if account verification can be reset
+     * Check if time since account lock has expired and return true if account verification can be reset
      *
      * @param datetime $time
      *
diff --git a/src/resources/lang/en/laravel-verification.php b/src/resources/lang/en/laravel-verification.php
@@ -7,29 +7,37 @@
     | Laravel 2 Step Verification Language Lines
     |--------------------------------------------------------------------------
     */
-    'title'                     => '2-Step Verification',
-    'subtitle'                  => 'Verification Required',
-    'titleFailed'               => 'Verification Failed',
-    'titlePassed'               => 'Good news everyone!',
-
-    'inputAlt1'                 => 'Code Input 1',
-    'inputAlt2'                 => 'Code Input 2',
-    'inputAlt3'                 => 'Code Input 3',
-    'inputAlt4'                 => 'Code Input 4',
-
-    'verifyButton'              => 'Verify',
-    'attemptsRemaining'         => 'Attempt Remaining|Attempts Remaining',
-    'missingCode'               => 'Didn\'t receive verification code?',
-
-
-    'exceededTitle'             => 'Verification Attempts Exceeded',
-    'lockedUntil'               => 'Account Locked Until:',
-    'tryAgainIn'                => 'Try again in',
-    'returnButton'              => 'Return Home',
-
-    'verificationEmailSubject'  => 'Verification Required',
-    'verificationEmailGreeting' => 'Hello :username',
-    'verificationEmailMessage'  => 'Your account 2-step verification code is:',
-    'verificationEmailButton'   => 'Verify Now',
+    'title'                         => '2-Step Verification',
+    'subtitle'                      => 'Verification Required',
+    'titleFailed'                   => 'Verification Failed',
+    'titlePassed'                   => 'Good news everyone!',
+
+    'inputAlt1'                     => 'Code Input 1',
+    'inputAlt2'                     => 'Code Input 2',
+    'inputAlt3'                     => 'Code Input 3',
+    'inputAlt4'                     => 'Code Input 4',
+
+    'verifyButton'                  => 'Verify',
+    'attemptsRemaining'             => 'Attempt Remaining|Attempts Remaining',
+    'missingCode'                   => 'Didn\'t receive verification code?',
+
+    'exceededTitle'                 => 'Verification Attempts Exceeded',
+    'lockedUntil'                   => 'Account Locked Until:',
+    'tryAgainIn'                    => 'Try again in',
+    'returnButton'                  => 'Return Home',
+
+    'verificationEmailSubject'      => 'Verification Required',
+    'verificationEmailGreeting'     => 'Hello :username',
+    'verificationEmailMessage'      => 'Your account 2-step verification code is:',
+    'verificationEmailButton'       => 'Verify Now',
+
+    'verificationEmailSuccess'      => 'Success!',
+    'verificationEmailSentMsg'      => 'Verification Email Sent!',
+
+    'verificationWarningTitle'      => 'Warning!',
+    'verificationWarningMessage'    => 'This is your last attempt before your account locks for :hours hours.',
+
+    'verificationLockedTitle'       => 'Doh!',
+    'verificationLockedMessage'     => 'Account Locked!',
 
 ];
diff --git a/src/resources/views/layouts/app.blade.php b/src/resources/views/layouts/app.blade.php
@@ -11,7 +11,7 @@
         <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
 
         {{-- Local Option --}}
-        {{-- <link rel="stylesheet" type="text/css" href="{{ asset('css/app.css') }}"> --}}
+        <link rel="stylesheet" type="text/css" href="{{ asset('css/app.css') }}">
 
         {{-- Package Styles --}}
         <link rel="stylesheet" type="text/css" href="{{ asset('css/laravel2step/app.css') }}">
diff --git a/src/resources/views/twostep/verification.blade.php b/src/resources/views/twostep/verification.blade.php
@@ -137,6 +137,11 @@
 
 @section('foot')
 
+    @php
+        $minutesToExpire = config('laravel2step.laravel2stepExceededCountdownMinutes');
+        $hoursToExpire = $minutesToExpire / 60;
+    @endphp
+
     <script type="text/javascript" src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
 
     @include('laravel2step::scripts.input-parsing-auto-stepper');
@@ -175,17 +180,17 @@
                             case 0:
                                 submitTrigger.addClass('btn-danger');
                                 swal(
-                                  'Doh!',
-                                  'Account Locked!',
+                                  "{{ trans('laravel2step::laravel-verification.verificationLockedTitle') }}",
+                                  "{{ trans('laravel2step::laravel-verification.verificationLockedMessage') }}",
                                   'error'
                                 );
                                 break;
 
                             case 1:
                                 submitTrigger.addClass('btn-danger');
                                 swal(
-                                  'Warning!',
-                                  'This is your last attempt before your account locks for 24 hours.',
+                                  "{{ trans('laravel2step::laravel-verification.verificationWarningTitle') }}",
+                                  "{{ trans('laravel2step::laravel-verification.verificationWarningMessage', ['hours' => $hoursToExpire, 'minutes' => $minutesToExpire,]) }}",
                                   'error'
                                 );
                                 break;

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ class Laravel2step`
`16`	`16`	`*`
`17`	`17`	`* @param Request $request`
`18`	`18`	`* @param \Closure $response`
	`19`	`+ *`
`19`	`20`	`* @return mixed`
`20`	`21`	`*/`
`21`	`22`	`public function handle($request, Closure $next)`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,9 @@ private function checkTimeSinceVerified($twoStepAuth)`
`65`	`65`
`66`	`66`	`/**`
`67`	`67`	`* Reset TwoStepAuth collection item and code`
	`68`	`+ *`
`68`	`69`	`* @param collection $twoStepAuth`
	`70`	`+ *`
`69`	`71`	`* @return collection`
`70`	`72`	`*/`
`71`	`73`	`private function resetAuthStatus($twoStepAuth)`
`@@ -155,8 +157,7 @@ protected function exceededTimeParser($time)`
`155`	`157`	`}`
`156`	`158`
`157`	`159`	`/**`
`158`		`- * Check if time since account lock has expired and return true`
`159`		`- * if account verification can be reset`
	`160`	`+ * Check if time since account lock has expired and return true if account verification can be reset`
`160`	`161`	`*`
`161`	`162`	`* @param datetime $time`
`162`	`163`	`*`