Merge pull request #2 from rootinc/handlecallback-login-route

v0.4.0

Author: danieltjewett

README.md

@@ -13,24 +13,24 @@ Route::get('/login/azurecallback', '\RootInc\LaravelAzureMiddleware\Azure@azurec
 
 3. In our `App\Http\Kernel.php` add `'azure' => \RootInc\LaravelAzureMiddleware\Azure::class,` most likely to the `$routeMiddleware` array.
 4. In our `.env` add `TENANT_ID, CLIENT_ID, CLIENT_SECRET and RESOURCE`.  We can get these values/read more here: https://portal.azure.com/
-5. Add the `azure` middleware to your route groups (or wherever) and enjoy :tada:
-6. If you need custom callbacks, see #Extended Installation.
+5. Add the `azure` middleware to your route groups on any routes that needs protected by auth and enjoy :tada:
+6. If you need custom callbacks, see [Extended Installation](#extended-installation).
 
 ## Routing
 
 `Route::get('/login/azure', '\RootInc\LaravelAzureMiddleware\Azure@azure');` First parameter can be wherever you want to route the azure login.  Change as you would like.
 
 `Route::get('/login/azurecallback', '\RootInc\LaravelAzureMiddleware\Azure@azurecallback');` First parameter can be whatever you want to route after your callback.  Change as you would like.
 
-## Front End
+### Front End
 
 It's best to have an Office 365 button on our login webpage that routes to `/login/azure` (or whatever you renamed it to).  This can be as simple as an anchor tag like this `<a href="/login/azure" class="officeButton"></a>` 
 
 ## Extended Installation
 
-The out-of-the-box implementation let's you login users.  However, let's say we would like to store this user into a database.  There are two callbacks that are recommended to extend from the Azure class called `success` and `fail`. The following provides information on how to extend the Root Laravel Azure Middleware Library:
+The out-of-the-box implementation let's you login users.  However, let's say we would like to store this user into a database  There are two callbacks that are recommended to extend from the Azure class called `success` and `fail`. The following provides information on how to extend the Root Laravel Azure Middleware Library:
 
-1. To get started (assuming we've followed the #Normal Installation directions), create a file called `AppAzure.php` in the `App\Http\Middleware` folder.  You can either do this through `artisan` or manually.
+1. To get started (assuming we've followed the [Normal Installation](#normal-installation) directions), create a file called `AppAzure.php` in the `App\Http\Middleware` folder.  You can either do this through `artisan` or manually.
 2. Add this as a starting point in this file:
 
 ```php
@@ -71,9 +71,67 @@ Route::get('/login/azurecallback', '\App\Http\Middleware\AppAzure@azurecallback'
 
 4. Finally, update `Kernel.php`'s `azure` key to be `'azure' => \App\Http\Middleware\AppAzure::class,`
 
+### Callback on Every Handshake
+
+As of v0.4.0, we added a callback after every successful handle (handshake).  The default is to simply call the `$next` closure.  However, let's say we want to store a Singleton of a user.  Here's an example of how to go about that:
+
+```php
+<?php
+
+namespace App\Http\Middleware;
+
+use Closure;
+
+use RootInc\LaravelAzureMiddleware\Azure as Azure;
+
+use App\User;
+
+class AppAzure extends Azure
+{
+    protected function handlecallback($request, Closure $next, $access_token, $refresh_token)
+    {
+        $user_id = $request->session()->get('user_id');
+
+        if ($user_id)
+        {
+            $user = User::find($user_id);
+
+            \App::singleton('user', function() use($user){
+                return $user;
+            });
+        }
+
+        return parent::handlecallback($request, $next, $access_token, $refresh_token);
+    }
+}
+```
+
+Building off of our previous example from [Extended Installation](#extended-installation), we have a `user_id` set in the session.  We can use this id to query against the user model.  Once we have the user model, we can setup the singleton to return the user.  The callback should call the closure, `$next($request);` and return it.  In our case, the default implementation redirects to `/`, so we call the parent here.
+
+#### Different Login Route
+
+As of v0.4.0, we added the ability to change the `$login_route` in the middelware.  Building off [Extended Installation](#extended-installation), in our `AppAzure` class, we can simply set `$login_route` to whatever.  For example:
+
+```php
+<?php
+
+namespace App\Http\Middleware;
+
+use RootInc\LaravelAzureMiddleware\Azure as Azure;
+
+class AppAzure extends Azure
+{
+    protected $login_route = "/";
+}
+```
+
+The above would now set `$login_route` to `/` or root.
+
 ## Contributing
 
-TODO
+Thank you for considering contributing to the Laravel Azure Middleware! To encourage active collaboration, we encourage pull requests, not just issues.
+
+If you file an issue, the issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a issue is to make it easy for yourself - and others - to replicate the bug and develop a fix.
 
 ## License
 

src/Azure.php

@@ -11,6 +11,8 @@
 
 class Azure
 {
+    protected $login_route = "/login";
+
     protected $baseUrl = "https://login.microsoftonline.com/";
     protected $route = "/oauth2/";
 
@@ -27,9 +29,14 @@ public function handle($request, Closure $next)
         $access_token = $request->session()->get('_rootinc_azure_access_token');
         $refresh_token = $request->session()->get('_rootinc_azure_refresh_token');
 
+        if (env("APP_ENV") === "testing")
+        {
+            return $this->handlecallback($request, $next, $access_token, $refresh_token);
+        }
+
         if (!$access_token || !$refresh_token)
         {
-            return redirect("/login");
+            return redirect($this->$login_route);
         }
 
         $client = new Client();
@@ -52,7 +59,7 @@ public function handle($request, Closure $next)
         $request->session()->put('_rootinc_azure_access_token', $contents->access_token);
         $request->session()->put('_rootinc_azure_refresh_token', $contents->refresh_token);
 
-        return $next($request);
+        return $this->handlecallback($request, $next, $access_token, $refresh_token);
     }
 
     public function azure(Request $request)
@@ -100,4 +107,9 @@ protected function fail(Request $request, RequestExcpetion $e)
     {
         return implode("", explode(PHP_EOL,$e->getMessage()));
     }
+
+    protected function handlecallback($request, Closure $next, $access_token, $refresh_token)
+    {
+        return $next($request);
+    }
 }