Objetivo.ConteudoOnline.Cliente 1.2.0

Objetivo - Conteúdo On-line Cliente

Pacote para facilitar o uso da API para acessar dados e arquivos, referentes ao Conteúdo On-line.

Último release

Release 1.2.0

• refactor: Incluindo filtro de regime
• refactor: Incluindo filtro de aula por nomes
• refactor: Complementando publicação e teste
• doc: Repassando descrição das propriedades dos filtros

Configuração

Para pode usar os recursos do pacote, são necessárias 4 (quatro) configurações:

• URL: (OBRIGATÓRIO) Informar a URL da API que irá ser carregada.
• Chave Pública: (OBRIGATÓRIO) Informar a chave pública de acesso a API.
• Autorização: (OBRIGATÓRIO) Informar a autorização de acesso a API.
• É produção: (OBRIGATÓRIO) Informar se a API está rodando em ambiente de produção.

É um Singleton, então só precisa ser atribuído uma única vez dependendo da sua aplicação:

Objetivo.ConteudoOnline.Cliente.Config.EhProducao = true;
Objetivo.ConteudoOnline.Cliente.Config.Url = "https://api.site.com.br/pasta/";
Objetivo.ConteudoOnline.Cliente.Config.ChavePublica = "160MYEAto65UhwwrJsTtCBgVpwpj499CML4rK7y1bFpZLMudMk";
Objetivo.ConteudoOnline.Cliente.Config.Autorizacao = "50ZekWXqO3yqphdXd1Ztv0MWLkx4Jyhb14FbPnMD0yHBWRM68x9";

Chamando API

Um exemplo de teste de obter os dados da API.

using Xunit;
using System.Threading.Tasks;
using Objetivo.ConteudoOnline.Cliente.Servicos;
using Objetivo.ConteudoOnline.Cliente.ObjetosDeValor;

namespace Seu.Projeto.Csharp.Teste
{
    public class SobreServTeste
    {
        [Fact]
        public async Task Obter()
        {
            SobreServ serv = new();
            Sobre dados = await serv.ObterAsync();

            Assert.True(serv.EhValido());
            Assert.NotNull(dados);
        }
    }
}

Algumas chamadas precisam de parâmetros, e neste caso, há classes para mandar esses valores. Para esse exemplo, vou usar o serviço de busca do grau.

using Xunit;
using System.Linq;
using System.Threading.Tasks;
using Objetivo.ConteudoOnline.Cliente.Servicos;
using Objetivo.ConteudoOnline.Cliente.Entidades;
using Objetivo.ConteudoOnline.Cliente.ObjetosDeValor;
using Objetivo.ConteudoOnline.Cliente.Comandos.GrauCmds;

namespace Seu.Projeto.Csharp.Teste
{
    public class GrauServTeste
    {
        [Fact]
        public async Task Filtro_valido()
        {
            GrauServ serv = new();
            FiltrarGrauCmd cmd = new()
            {
                Maximo = 1,
                Pagina = 1
            };
            ResultadoBusca<Grau> res = await serv.FiltrarAsync(cmd);
            Assert.True(res.ResultadosDaPaginaAtual.Any());
            Assert.True(serv.EhValido());
            Assert.False(serv.Avisos.Notificacoes.Any());
        }

        [Fact]
        public async Task Filtro_invalido()
        {
            GrauServ serv = new();
            FiltrarGrauCmd cmd = new()
            {
                Texto = "\"um texto inválido\"",
                Maximo = 1,
                Pagina = 1
            };
            ResultadoBusca<Grau> res = await serv.FiltrarAsync(cmd);
            Assert.False(res.ResultadosDaPaginaAtual.Any());
            Assert.False(serv.EhValido());
            Assert.True(serv.Avisos.Notificacoes.Any());
        }
    }
}