Ability to provide a lookup table to fetch the remote address. (jamesmills#13)

* Added the ability to lookup within any attribute on the request helper, by any key.

* Updated README and configuration description

Author: amandiobm

README.md

@@ -118,6 +118,10 @@ By default, the timezone will be overwritten at each login with the current user
 
 By default, the date format will be `jS F Y g:i:a`. To override this configuration, you just need to change the `format` property inside the configuration file `config/timezone.php` for the desired format.
 
+### Lookup Array
+
+This lookup array configuration makes it possible to find the remote address of the user in any attribute inside the Laravel `request` helper, by any key. Having in mind when the key is found inside the attribute, that key will be used. By default, we use the `server` attribute with the key `REMOTE_ADDR`. To override this configuration, you just need to change the `lookup` property inside the configuration file `config/timezone.php` for the desired lookup.
+
 ### Underlying GeoIp Package
 
 If you wish to customise the underlying `torann/geoip` package you can publish the config file by using the command below.

src/Listeners/Auth/UpdateUsersTimezone.php

@@ -15,7 +15,8 @@ class UpdateUsersTimezone
      */
     public function handle(Login $event)
     {
-        $geoip_info = geoip()->getLocation(request()->server->get('REMOTE_ADDR', null));
+        $ip = $this->getFromLookup();
+        $geoip_info = geoip()->getLocation($ip);
 
         if (auth()->user()->timezone != $geoip_info['timezone']) {
             if (config('timezone.overwrite') == true || auth()->user()->timezone == null) {
@@ -31,4 +32,45 @@ public function handle(Login $event)
             }
         }
     }
+
+    /**
+     * @return mixed
+     */
+    public function getFromLookup()
+    {
+        $result = null;
+
+        foreach (config('timezone.lookup') as $type => $keys) {
+            if (empty($keys)) {
+                continue;
+            }
+
+            $result = $this->lookup($type, $keys);
+
+            if (is_null($result)) {
+                continue;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param $type
+     * @param $keys
+     * @return string|null
+     */
+    public function lookup($type, $keys)
+    {
+        $value = null;
+
+        foreach ($keys as $key) {
+            if (!request()->$type->has($key)) {
+                continue;
+            }
+            $value = request()->$type->get($key);
+        }
+
+        return $value;
+    }
 }

src/config/timezone.php

@@ -40,4 +40,23 @@
 
     'format' => 'jS F Y g:i:a',
 
+    /*
+    |--------------------------------------------------------------------------
+    | Lookup Array
+    |--------------------------------------------------------------------------
+    |
+    | Here you may configure the lookup array whom it will be used to fetch the user remote address.
+    | When a key is found inside the lookup array that key it will be used.
+    |
+    */
+
+    'lookup' => [
+        'server' => [
+            'REMOTE_ADDR',
+        ],
+        'headers' => [
+
+        ],
+    ],
+
 ];