Lottando cercando di creare un'interfaccia per i servizi di tipo Janrain

Question

Lottando cercando di creare un'interfaccia per i servizi di tipo Janrain

#1 da (2 voti)

1

Stiamo usando Janrain nella nostra app, ma devo creare un'interfaccia per rendere questo servizio facilmente sostituibile (perché Janrain è così personalizzato !, tuttavia ha cose comuni in Oauth)

Tuttavia, ho difficoltà a cercare di raggiungere questo obiettivo.

Quello che non voglio è avere, nel mio servizio UserManager principale, un JanrainClientInterface , dovrebbe essere neutrale.

Dobbiamo utilizzare entrambe le API Entity e Access di Janrain:

interface OauthProviderInterface {

    public function getAccessToken(array $params);

    public function getAuthorizationCode(array $params);

    public function getCreationToken(array $params);

    public function getVerificationCode(array $params);

    public function useVerificationCode($verificationCode);

    public function authenticate(array $params);

    public function linkAccount(array $params);

    public function register(array $params); // registerNative in janrain API

    public function registerNativeTraditional(array $params);

    public function token(array $params);

    public function sendVerificationEmail(array $params);

    public function sendPasswordRecoveryEmail(array $params);
}

interface AuthenticationProviderInterface {

    public function authenticate($username, $password); // AuthNativeTraditional in Janrain API
}

Queste sono più o meno le chiamate API che userò. Mi chiedo se abbia senso quello che sto cercando di fare, e come potrei avvicinarmi a questo.

design interfaces php

posta JorgeeFG 12.03.2018 - 14:58

fonte

1 risposta

Leggi altre domande sui tag design interfaces php

Oggetti dati per ogni livello (oggetti DTO vs Entità vs Risposta) I segnali / eventi sono l'unico modo per modificare una vista da un'altra?

score 2 · Answer 1

Non so se ho fatto del bene, ma alla fine mi sono inventato questo:

Queste sono interfacce specifiche di Janrain:

interface JanrainAuthenticationInterface {

    public function getAccessToken(array $params);

    public function getAuthorizationCode(array $params);

    public function getCreationToken(array $params);

    public function getVerificationCode(array $params);

    public function useVerificationCode($verificationCode);

    public function authNative(array $params);

    public function authNativeTraditional(array $params);

    public function linkAccount(array $params);

    public function registerNative(array $params);

    public function registerNativeTraditional(array $params);

    public function token(array $params);

    public function verifyEmailNative($params);

    public function forgotPasswordNative($params);
}

interface JanrainEntityInterface {

    public function count($entityType, $filter = '');

    public function create(array $params);

    public function bulkCreate(array $params);

    public function delete($uuid, array $params = []);

    public function deleteById($id, array $params = []);

    public function deleteByAttribute($attributeKey, $attributeValue, array $params);

    public function bulkDelete(array $params);

    public function find(array $params);

    public function purge($entityType, $commit = false);

    public function replace($uuid, array $params);

    public function replaceById($id, array $params);

    public function replaceByAttribute($attributeKey, $attributeValue, array $params);

    public function update($uuid, array $params);

    public function updateById($id, array $params);

    public function updateByAttribute($attributeKey, $attributeValue, array $params);
}


interface JanrainClientInterface extends JanrainEntityInterface, JanrainAuthenticationInterface {

    public function getCurrentLocale();
    public function setCurrentLocale($localeName);
    public function getLocales();
}

Queste sono interfacce agnostiche del provider:

interface AuthenticationProviderInterface {

    public function authenticate($username, $password);
}


interface OauthProviderInterface {

    public function getAccessToken(array $params);

    public function getAuthorizationCode(array $params);

    public function getCreationToken(array $params);

    public function getVerificationCode(array $params);

    public function useVerificationCode($verificationCode);

    public function authenticate(array $params);

    public function linkAccount(array $params);

    public function register(array $params);

    public function registerNativeTraditional(array $params);

    public function token(array $params);

}

interface UserEmailerInterface {

    public function sendVerificationEmail($userId, array $extraParams = []);

    public function sendPasswordRecoveryEmail($userId, array $extraParams = []);
}

interface UserProviderInterface {

    public function count($entityType, $filter = '');

    public function create(array $params);

    public function bulkCreate(array $params);

    public function delete($uuid, array $params = []);

    public function deleteById($id, array $params = []);

    public function deleteByAttribute($attributeKey, $attributeValue, array $params);

    public function bulkDelete(array $params);

    public function find(array $params);

    public function purge($entityType, $commit = false);

    public function replace($uuid, array $params);

    public function replaceById($id, array $params);

    public function replaceByAttribute($attributeKey, $attributeValue, array $params);

    public function update($uuid, array $params);

    public function updateById($id, array $params);

    public function updateByAttribute($attributeKey, $attributeValue, array $params);
}

Poi ci sono quattro servizi Janrain che implementano le interfacce agnostiche del provider, ad esempio:

class JanrainAuthenticationProvider implements AuthenticationProviderInterface {

    protected $janrainClient;

    public function __construct(JanrainClientInterface $janrainClient) {
        $this->janrainClient = $janrainClient;
    }

    public function authenticate($username, $password) {
        $params = [
            'signInEmailAddress' => $username,
            'currentPassword' => $password,
        ];
        return $this->janrainClient->authNativeTraditional($params);
    }
}

Quindi JanrainClient implementa JanrainClientInterface .

Quello che faccio è, è una specie di facciata nei precedenti quattro servizi, che trasmette tutte le chiamate a JanrainClient , con poca logica.

Quindi, UserManager (Application Service, che descrive i casi d'uso) ha un costruttore dove inserisco questi quattro servizi usando le interfacce agnostiche del provider:

class UserManager {

    /** @var UserProviderInterface */
    protected $userProvider;
    /** @var AuthenticationProviderInterface */
    protected $authenticationProvider;
    /** @var OauthProviderInterface */
    protected $oauthProvider;
    /** @var UserEmailerInterface */
    protected $userEmailer;

    /**
     * UserManager constructor.
     * @param UserProviderInterface $userProvider
     * @param AuthenticationProviderInterface $authenticationProvider
     * @param OauthProviderInterface $oauthProvider
     * @param UserEmailerInterface $userEmailer
     */
    public function __construct(
        UserProviderInterface $userProvider,
        AuthenticationProviderInterface $authenticationProvider,
        OauthProviderInterface $oauthProvider,
        UserEmailerInterface $userEmailer
    ) {
        $this->userProvider = $userProvider;
        $this->authenticationProvider = $authenticationProvider;
        $this->oauthProvider = $oauthProvider;
        $this->userEmailer = $userEmailer;
    }


    public function getUserBy($criteria) {
        // TODO: Implement
    }

    public function doTraditionalLogin($username, $password) {
        $response = $this->authenticationProvider->authenticate($username, $password);
        return $response;
    }
}