adonis-ally-suap v0.1.4

Driver OAuth para o AdonisJS Ally

Este pacote implementa um driver de autenticação do SUAP para o adonis ally (Autenticador de rede social do AdonisJS)

Instalação

ATENÇÃO: Esta instalação partirá da suposição de que as instruções de instalação do Ally foram seguidas corretamente, estando este instalado e configurado.

Realize a instalação do pacote utilizando o npm ou yarn.

npm install adonis-ally-suap

ou

yarn add adonis-ally-suap

Realize a configuração do pacote com o comando:

node ace configure adonis-ally-suap

Altere o arquivo contracts\ally.ts para conter o mapeamento de autenticação do SUAP.

//Não esquecer de importar o driver e sua configuração
import { SuapDriver, SuapDriverConfig } from 'adonis-ally-suap/build/standalone'

declare module '@ioc:Adonis/Addons/Ally' {
  interface SocialProviders {
    // ... outros mapeamentos
    suap: {
      config: SuapDriverConfig
      implementation: SuapDriver
    }
  }
}

Abra o arquivo env.ts e acrescente as duas variáveis de ambiente:

export default Env.rules({
  //...
  SUAP_CLIENT_ID: Env.schema.string(),
  SUAP_CLIENT_SECRET: Env.schema.string(),
  //...
})

Acrescente estas variáveis em seu arquivo de variáveis ambiente .env:

PORT=3333
HOST=0.0.0.0
NODE_ENV=development
#...
SUAP_CLIENT_ID=...
SUAP_CLIENT_SECRET=...

Para conseguir um Client ID e um Client Secret, acesse a página da API do SUAP.

Por fim, altere o arquivo config/ally.ts, para acrescentar o driver em sua configuração:

const allyConfig: AllyConfig = {
  // ... other drivers
  suap: {
    driver: 'suap',
    clientId: Env.get('SUAP_CLIENT_ID'),
    clientSecret: Env.get('SUAP_CLIENT_SECRET'),
    callbackUrl: 'http://localhost:3333/suap/callback',
  },
}

Observe que será necessário configurar corretamente o callback para receber o retorno do SUAP, mas uma vez que a instalação esteja realizada, a documentação do ally é a mesma para qualquer autenticador OAuth.