Merge pull request #6 from sashaaro/fix

rename wrong naming class

Author: joostfaassen

README.md

@@ -6,9 +6,9 @@ Allows switching the `UserProvider` at Runtime using environment variables.
 Dynamic UserProvider that supports multiple backends based on environment variables.
 
 To override which should provider configuration as array for runtime
-```FlexAuth\AuthFlexTypeProviderInterface```
+```FlexAuth\FlexAuthTypeProviderInterface```
 
-Using ```FlexAuth\AuthFlexTypeProviderFactory::fromEnv('FLEX_AUTH'')``` and define env variables in format
+Using ```FlexAuth\FlexAuthTypeProviderFactory::fromEnv('FLEX_AUTH'')``` and define env variables in format
 `type?param1=value1&param2=value2&param3=value3`
 
 Example define environment variable
@@ -33,7 +33,7 @@ FLEX_AUTH_ENTITY_PROPERTY=username
 
 Dynamically flex type provider example.
 ```php
-class MyAuthFlexTypeProvider implements AuthFlexTypeProviderInterface {
+class MyFlexAuthTypeProvider implements FlexAuthTypeProviderInterface {
     protected $className = \App\Entities\User::class; // can be change in runtime
     protected $propery = 'id';
 

composer.json

@@ -10,7 +10,7 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "GeneratedHydratorTest\\": "tests/FlexAuthTest"
+      "FlexAuthTest\\": "tests"
     }
   },
   "require": {

src/AuthFlexTypeCallbackProvider.php src/FlexAuthTypeCallbackProvider.phpsrc/AuthFlexTypeCallbackProvider.php renamed to src/FlexAuthTypeCallbackProvider.php

@@ -3,10 +3,10 @@
 namespace FlexAuth;
 
 /**
- * Class AuthFlexTypeCallbackProvider
+ * Class FlexAuthTypeCallbackProvider
  * @author Aleksandr Arofikin <sashaaro@gmail.com>
  */
-class AuthFlexTypeCallbackProvider implements AuthFlexTypeProviderInterface
+class FlexAuthTypeCallbackProvider implements FlexAuthTypeProviderInterface
 {
     /** @var callable */
     private $callback;

src/AuthFlexTypeProviderFactory.php src/FlexAuthTypeProviderFactory.phpsrc/AuthFlexTypeProviderFactory.php renamed to src/FlexAuthTypeProviderFactory.php

@@ -3,14 +3,14 @@
 namespace FlexAuth;
 
 /**
- * Class AuthFlexTypeProviderFactory
+ * Class FlexAuthTypeProviderFactory
  * @author Aleksandr Arofikin <sashaaro@gmail.com>
  */
-class AuthFlexTypeProviderFactory
+class FlexAuthTypeProviderFactory
 {
     public static function fromEnv(string $envVarName)
     {
-        return new AuthFlexTypeCallbackProvider(function () use($envVarName) {
+        return new FlexAuthTypeCallbackProvider(function () use($envVarName) {
             return self::resolveParamsFromEnv($envVarName);
         });
     }

src/AuthFlexTypeProviderInterface.php src/FlexAuthTypeProviderInterface.phpsrc/AuthFlexTypeProviderInterface.php renamed to src/FlexAuthTypeProviderInterface.php

@@ -3,10 +3,10 @@
 namespace FlexAuth;
 
 /**
- * Interface AuthFlexTypeProviderInterface
+ * Interface FlexAuthTypeProviderInterface
  * @author Aleksandr Arofikin <sashaaro@gmail.com>
  */
-interface AuthFlexTypeProviderInterface
+interface FlexAuthTypeProviderInterface
 {
     /**
      * Provider configuration for runtime which to pass to UserProviderFactoryInterface::create as params

src/Security/FlexAuthPasswordEncoder.php

@@ -2,7 +2,7 @@
 
 namespace FlexAuth\Security;
 
-use FlexAuth\AuthFlexTypeProviderInterface;
+use FlexAuth\FlexAuthTypeProviderInterface;
 use Symfony\Component\Security\Core\Encoder\Argon2iPasswordEncoder;
 use Symfony\Component\Security\Core\Encoder\BCryptPasswordEncoder;
 use Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface;
@@ -15,7 +15,7 @@
  */
 class FlexAuthPasswordEncoder implements PasswordEncoderInterface
 {
-    /** @var AuthFlexTypeProviderInterface */
+    /** @var FlexAuthTypeProviderInterface */
     protected $flexAuthTypeProvider;
 
     private $encoders = [
@@ -26,7 +26,7 @@ class FlexAuthPasswordEncoder implements PasswordEncoderInterface
         'plain' => PlaintextPasswordEncoder::class
     ];
 
-    public function __construct(AuthFlexTypeProviderInterface $flexAuthTypeProvider)
+    public function __construct(FlexAuthTypeProviderInterface $flexAuthTypeProvider)
     {
         $this->flexAuthTypeProvider = $flexAuthTypeProvider;
     }

src/Type/JWT/FlexTypeJWTEncoder.php

@@ -3,20 +3,20 @@
 namespace FlexAuth\Type\JWT;
 
 use Firebase\JWT\JWT;
-use FlexAuth\AuthFlexTypeProviderInterface;
+use FlexAuth\FlexAuthTypeProviderInterface;
 
 /**
  * Class FlexTypeJWTEncoder
  * @author Aleksandr Arofikin <sashaaro@gmail.com>
  */
 class FlexTypeJWTEncoder implements EnableJWTEncoderInterface
 {
-    /** @var AuthFlexTypeProviderInterface */
-    private $authFlexTypeProvider;
+    /** @var FlexAuthTypeProviderInterface */
+    private $flexAuthTypeProvider;
 
-    public function __construct(AuthFlexTypeProviderInterface $authFlexTypeProvider)
+    public function __construct(FlexAuthTypeProviderInterface $flexAuthTypeProvider)
     {
-        $this->authFlexTypeProvider = $authFlexTypeProvider;
+        $this->flexAuthTypeProvider = $flexAuthTypeProvider;
     }
 
     public function encode(array $data)
@@ -31,21 +31,21 @@ public function decode($token)
 
     public function isEnabled(): bool
     {
-        $params = $this->authFlexTypeProvider->provide();
+        $params = $this->flexAuthTypeProvider->provide();
 
         return $params['type'] === JWTUserProviderFactory::TYPE;
     }
 
     private function getAlgorithm()
     {
-        $params = $this->authFlexTypeProvider->provide();
+        $params = $this->flexAuthTypeProvider->provide();
 
         return array_key_exists('algo', $params) ? $params['algo'] : 'RS256';
     }
 
     private function getPrivateKey()
     {
-        $params = $this->authFlexTypeProvider->provide();
+        $params = $this->flexAuthTypeProvider->provide();
         $privateKey = $params['private_key'];
 
         $isFilePath = substr($privateKey, 0, 1) === '@';
@@ -66,7 +66,7 @@ private function getPrivateKey()
 
     private function getPublicKey()
     {
-        $params = $this->authFlexTypeProvider->provide();
+        $params = $this->flexAuthTypeProvider->provide();
 
         $publicKey = $params['public_key'];
         $isFilePath = substr($publicKey, 0, 1) === '@';

src/Type/JWT/JWTTokenAuthenticator.php

@@ -2,7 +2,7 @@
 
 namespace FlexAuth\Type\JWT;
 
-use FlexAuth\AuthFlexTypeProviderInterface;
+use FlexAuth\FlexAuthTypeProviderInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
@@ -25,18 +25,18 @@ class JWTTokenAuthenticator extends AbstractGuardAuthenticator
     private $JWTUserFactory;
     /** @var JWTEncoderInterface */
     private $JWTEncoder;
-    /** @var AuthFlexTypeProviderInterface */
-    private $authFlexTypeProvider;
+    /** @var FlexAuthTypeProviderInterface */
+    private $flexAuthTypeProvider;
 
     public function __construct(
         JWTUserFactoryInterface $JWTUserFactory,
         JWTEncoderInterface $JWTEncoder,
-        AuthFlexTypeProviderInterface $authFlexTypeProvider
+        FlexAuthTypeProviderInterface $flexAuthTypeProvider
     )
     {
         $this->JWTUserFactory = $JWTUserFactory;
         $this->JWTEncoder = $JWTEncoder;
-        $this->authFlexTypeProvider = $authFlexTypeProvider;
+        $this->flexAuthTypeProvider = $flexAuthTypeProvider;
     }
 
     public function supports(Request $request)
@@ -65,7 +65,7 @@ public function getCredentials(Request $request)
 
     public function createTokenFromUser(UserInterface $user): string
     {
-        $params = $this->authFlexTypeProvider->provide();
+        $params = $this->flexAuthTypeProvider->provide();
         $userField = $params['user_field'] ?? 'username';
         $roleField = $params['role_field'] ?? 'permissions';
 
@@ -83,11 +83,11 @@ public function getUser($credentialsToken, UserProviderInterface $userProvider)
     {
         if (!is_string($credentialsToken)) {
             throw new \InvalidArgumentException(
-                sprintf('The first argument of the "%s()" method must be string.', __METHOD__, __CLASS__)
+                sprintf('The first argument of the "%s::%s()" method must be string.', __CLASS__, __METHOD__)
             );
         }
 
-        $params = $this->authFlexTypeProvider->provide();
+        $params = $this->flexAuthTypeProvider->provide();
         $userField = $params['user_field'] ?? 'username';
         $roleField = $params['role_field'] ?? 'permissions';
 

src/UserProviderFactory.php

@@ -16,11 +16,11 @@ class UserProviderFactory
     /** @var UserProviderFactoryInterface[] */
     protected $factories = [];
 
-    protected $authFlexTypeProvider;
+    protected $flexAuthTypeProvider;
 
-    public function __construct(AuthFlexTypeProviderInterface $authFlexTypeProvider)
+    public function __construct(FlexAuthTypeProviderInterface $flexAuthTypeProvider)
     {
-        $this->authFlexTypeProvider = $authFlexTypeProvider;
+        $this->flexAuthTypeProvider = $flexAuthTypeProvider;
     }
 
     public function addType($typeKey, UserProviderFactoryInterface $userFactory)
@@ -64,7 +64,7 @@ public function create(): UserProviderInterface
      */
     private function resolveTypeAndParams()
     {
-        $flexAuthData = $this->authFlexTypeProvider->provide();
+        $flexAuthData = $this->flexAuthTypeProvider->provide();
 
         $allowTypes = array_keys($this->factories);
 

tests/AuthenticationTest.php

@@ -22,7 +22,7 @@ class AuthenticationTest extends TestCase
 {
     public function testAuthenticate() {
         $envName = 'FLEX_AUTH';
-        $typeProvider = \FlexAuth\AuthFlexTypeProviderFactory::fromEnv($envName);
+        $typeProvider = \FlexAuth\FlexAuthTypeProviderFactory::fromEnv($envName);
 
         $userFactory = new \FlexAuth\UserProviderFactory($typeProvider);
         $userFactory->addType(MemoryUserProviderFactory::TYPE, new MemoryUserProviderFactory());