added ip address to login events

src/Auth/JWTGuard.php

@@ -422,13 +422,13 @@ public function issueAccessToken(JWTAuthenticatable $user): JWT
      */
     public function login(array $credentials = []): JWTGuardContract
     {
-        $this->dispatchEvent(new LoginAttempt($credentials));
+        $this->dispatchEvent(new LoginAttempt($credentials, $this->getRequest()->ip()));
 
         $user = $this->getProvider()->retrieveByCredentials($credentials);
 
         if ($this->isInvalidUser($user, $credentials)) {
             $this
-                ->dispatchEvent(new FailedLoginAttempt($credentials))
+                ->dispatchEvent(new FailedLoginAttempt($credentials, $this->getRequest()->ip()))
                 ->setAccessToken(null)
                 ->user = null;
 
@@ -439,7 +439,7 @@ public function login(array $credentials = []): JWTGuardContract
             ->setAccessToken($this->issueAccessToken($user))
             ->setUser($user);
 
-        $this->dispatchEvent(new Login($this->user(), $this->getAccessToken(), $credentials));
+        $this->dispatchEvent(new Login($this->user(), $this->getAccessToken(), $this->getRequest()->ip()));
 
         return $this;
     }

src/Events/FailedLoginAttempt.php

@@ -7,8 +7,9 @@
  *
  * @package SPie\LaravelJWT\Events
  */
-final class FailedLoginAttempt implements Event
+final class FailedLoginAttempt implements Event, IpAddressable
 {
+    use IpAddress;
 
     /**
      * @var array
@@ -18,11 +19,13 @@ final class FailedLoginAttempt implements Event
     /**
      * FailedLoginAttempt constructor.
      *
-     * @param array $credentials
+     * @param array       $credentials
+     * @param string|null $ipAddress
      */
-    public function __construct(array $credentials)
+    public function __construct(array $credentials, string $ipAddress = null)
     {
         $this->credentials = $credentials;
+        $this->ipAddress = $ipAddress;
     }
 
     /**

src/Events/IpAddress.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace SPie\LaravelJWT\Events;
+
+/**
+ * Trait IpAddress
+ *
+ * @package SPie\LaravelJWT\Events
+ */
+trait IpAddress
+{
+    /**
+     * @var string|null
+     */
+    private $ipAddress;
+
+    /**
+     * @return string|null
+     */
+    public function getIpAddress(): ?string
+    {
+        return $this->ipAddress;
+    }
+}

src/Events/IpAddressable.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace SPie\LaravelJWT\Events;
+
+/**
+ * Interface IpAddressable
+ *
+ * @package SPie\LaravelJWT\Events
+ */
+interface IpAddressable
+{
+    /**
+     * @return string|null
+     */
+    public function getIpAddress(): ?string;
+}

src/Events/Login.php

@@ -10,8 +10,9 @@
  *
  * @package SPie\LaravelJWT\Events
  */
-final class Login implements Event
+final class Login implements Event, IpAddressable
 {
+    use IpAddress;
 
     /**
      * @var JWTAuthenticatable
@@ -23,23 +24,18 @@ final class Login implements Event
      */
     private $accessToken;
 
-    /**
-     * @var array
-     */
-    private $credentials;
-
     /**
      * LoginEvent constructor.
      *
      * @param JWTAuthenticatable $user
      * @param JWT                $accessToken
-     * @param array              $credentials
+     * @param string|null        $ipAddress
      */
-    public function __construct(JWTAuthenticatable $user, JWT $accessToken, array $credentials = [])
+    public function __construct(JWTAuthenticatable $user, JWT $accessToken, string $ipAddress = null)
     {
         $this->user = $user;
         $this->accessToken = $accessToken;
-        $this->credentials = $credentials;
+        $this->ipAddress = $ipAddress;
     }
 
     /**
@@ -57,12 +53,4 @@ public function getAccessToken(): JWT
     {
         return $this->accessToken;
     }
-
-    /**
-     * @return array
-     */
-    public function getCredentials(): array
-    {
-        return $this->credentials;
-    }
 }

src/Events/LoginAttempt.php

@@ -7,8 +7,9 @@
  *
  * @package SPie\LaravelJWT\Events
  */
-final class LoginAttempt implements Event
+final class LoginAttempt implements Event, IpAddressable
 {
+    use IpAddress;
 
     /**
      * @var array
@@ -18,11 +19,13 @@ final class LoginAttempt implements Event
     /**
      * LoginAttempt constructor.
      *
-     * @param array $credentials
+     * @param array       $credentials
+     * @param string|null $ipAddress
      */
-    public function __construct(array $credentials)
+    public function __construct(array $credentials, string $ipAddress = null)
     {
         $this->credentials = $credentials;
+        $this->ipAddress = $ipAddress;
     }
 
     /**

tests/RequestHelper.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace SPie\LaravelJWT\Test;
+
+use Illuminate\Http\Request;
+use Mockery as m;
+use Mockery\MockInterface;
+
+/**
+ * Trait RequestHelper
+ *
+ * @package SPie\LaravelJWT\Test
+ */
+trait RequestHelper
+{
+    //region Mocks
+
+    /**
+     * @return Request|MockInterface
+     */
+    private function createRequest(): Request
+    {
+        return m::mock(Request::class)
+            ->shouldAllowMockingProtectedMethods()
+            ->makePartial();
+    }
+
+    /**
+     * @param Request|MockInterface $request
+     * @param string|null           $ipAddress
+     *
+     * @return $this
+     */
+    private function mockRequestIp(MockInterface $request, ?string $ipAddress)
+    {
+        $request
+            ->shouldReceive('ip')
+            ->andReturn($ipAddress);
+
+        return $this;
+    }
+
+    //endregion
+}

tests/Unit/FailedLoginAttemptTest.php

@@ -18,9 +18,21 @@ final class FailedLoginAttemptTest extends TestCase
      */
     public function testConstruct(): void
     {
-        $credentials = [
-            $this->getFaker()->uuid => $this->getFaker()->uuid,
-        ];
+        $credentials = [$this->getFaker()->uuid => $this->getFaker()->uuid];
+        $ipAddress = $this->getFaker()->ipv4;
+
+        $failedLoginAttempt = new FailedLoginAttempt($credentials, $ipAddress);
+
+        $this->assertEquals($credentials, $failedLoginAttempt->getCredentials());
+        $this->assertEquals($ipAddress, $failedLoginAttempt->getIpAddress());
+    }
+
+    /**
+     * @return void
+     */
+    public function testConstructWithoutOptionalParameters(): void
+    {
+        $credentials = [$this->getFaker()->uuid => $this->getFaker()->uuid];
 
         $this->assertEquals($credentials, (new FailedLoginAttempt($credentials))->getCredentials());
     }