Add localizations/translations (#15)

* added translations

Co-authored-by: Niek de Melker <[email protected]>
Co-authored-by: Claudio Dekker <[email protected]>

Author: claudiodekker

resources/lang/en/validation.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'pwned' => ':attribute was found in at least :num prior security incident(s). Please choose a more secure password.',
+];

src/Api/FakeApiGateway.php

@@ -2,6 +2,7 @@
 
 namespace Ubient\PwnedPasswords\Api;
 
+use RuntimeException;
 use Ubient\PwnedPasswords\Contracts\ApiGateway;
 
 class FakeApiGateway implements ApiGateway
@@ -15,7 +16,7 @@ class FakeApiGateway implements ApiGateway
     public function search(string $password): int
     {
         if ($password === 'password1') {
-            throw new \RuntimeException('Simulated network connectivity issue.');
+            throw new RuntimeException('Simulated network connectivity issue.');
         }
 
         return collect([

src/Api/PwnedPasswordsGateway.php

@@ -3,6 +3,7 @@
 namespace Ubient\PwnedPasswords\Api;
 
 use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\Exception\GuzzleException;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 use RuntimeException;
@@ -37,8 +38,8 @@ public function search(string $password): int
      * and the value is the amount of times the password was pwned.
      *
      * @param  string $hashPrefix
-     * @throws RuntimeException
      * @return Collection
+     * @throws RuntimeException|GuzzleException
      */
     protected function fetchHashes(string $hashPrefix): Collection
     {

src/PwnedPasswordsServiceProvider.php

@@ -14,9 +14,15 @@ class PwnedPasswordsServiceProvider extends ServiceProvider
 {
     public function boot()
     {
-        Validator::extend('pwned', Pwned::class, Pwned::VALIDATION_ERROR_MESSAGE);
+        $this->publishes([__DIR__.'/../resources/lang' => resource_path('lang/vendor/pwned-passwords')], 'lang');
+        $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'PwnedPasswords');
+
+        Validator::extend('pwned', Pwned::class);
         Validator::replacer('pwned', function ($message, $attribute, $rule, $parameters) {
-            return str_replace(':num', array_shift($parameters) ?? 1, $message);
+            return trans('PwnedPasswords::validation.pwned', [
+                'attribute' => $attribute,
+                'num' => array_shift($parameters) ?? 1,
+            ]);
         });
     }
 

src/Rules/Pwned.php

@@ -9,11 +9,6 @@
 
 class Pwned implements Rule
 {
-    /**
-     * The validation error message.
-     */
-    const VALIDATION_ERROR_MESSAGE = ':attribute was found in at least :num prior security incident(s). Please choose a more secure password.';
-
     /**
      * @var ApiGateway
      */
@@ -43,7 +38,7 @@ public function __construct(int $threshold = 1)
      * @param  mixed  $value
      * @return bool
      */
-    public function passes($attribute, $value)
+    public function passes($attribute, $value): bool
     {
         try {
             return $this->gateway->search($value) < $this->threshold;
@@ -61,7 +56,7 @@ public function passes($attribute, $value)
      * @param $parameters
      * @return bool
      */
-    public function validate($attribute, $value, $parameters)
+    public function validate($attribute, $value, $parameters): bool
     {
         $this->threshold = (int) (array_shift($parameters) ?? 1);
 
@@ -73,8 +68,8 @@ public function validate($attribute, $value, $parameters)
      *
      * @return string
      */
-    public function message()
+    public function message(): string
     {
-        return str_replace(':num', $this->threshold, self::VALIDATION_ERROR_MESSAGE);
+        return trans('PwnedPasswords::validation.pwned', ['num' => $this->threshold]);
     }
 }

tests/Feature/PwnedPasswordsServiceProviderTest.php

@@ -12,10 +12,13 @@ class PwnedPasswordsServiceProviderTest extends TestCase
     /** @test */
     public function it_should_register_the_validation_error_message_for_our_pwned_rule_with_the_validator(): void
     {
-        $errorMessage = Validator::make(['attribute' => 'P@ssw0rd'], ['attribute' => 'pwned:23'])->errors()->first();
+        $errorMessage = Validator::make(
+            ['password' => 'P@ssw0rd'],
+            ['password' => 'pwned:23']
+        )->errors()->first();
 
         $this->assertEquals(
-            'attribute was found in at least 23 prior security incident(s). Please choose a more secure password.',
+            'password was found in at least 23 prior security incident(s). Please choose a more secure password.',
             $errorMessage
         );
     }

tests/Feature/PwnedTest.php

@@ -87,11 +87,10 @@ public function passwords_that_are_pwned_and_are_above_the_threshold_should_be_r
     /** @test */
     public function it_should_show_the_validation_error_message_when_used_as_a_rule_object(): void
     {
-        $validator = Validator::make(['my-password' => 'P@ssw0rd'], [
-            'my-password' => new Pwned(75),
-        ]);
-
-        $errorMessage = $validator->errors()->first();
+        $errorMessage = Validator::make(
+            ['my-password' => 'P@ssw0rd'],
+            ['my-password' => new Pwned(75)]
+        )->errors()->first();
 
         $this->assertEquals(
             'my-password was found in at least 75 prior security incident(s). Please choose a more secure password.',
@@ -100,7 +99,21 @@ public function it_should_show_the_validation_error_message_when_used_as_a_rule_
     }
 
     /** @test */
-    public function it_should_pass_the_validation_when_a_network_error_occurs_during_lookup()
+    public function it_should_show_the_validation_error_message_when_used_as_a_string(): void
+    {
+        $errorMessage = Validator::make(
+            ['attr' => 'P@ssw0rd'],
+            ['attr' => 'pwned:75']
+        )->errors()->first();
+
+        $this->assertEquals(
+            'attr was found in at least 75 prior security incident(s). Please choose a more secure password.',
+            $errorMessage
+        );
+    }
+
+    /** @test */
+    public function it_should_pass_the_validation_when_a_network_error_occurs_during_lookup(): void
     {
         config([
             'logging.default' => 'test',