Module: CalendarioApi

Defined in:
lib/calendario_api.rb,
lib/calendario_api/cidade.rb,
lib/calendario_api/feriado.rb,
lib/calendario_api/version.rb,
lib/calendario_api/feriado_params.rb,
lib/calendario_api/cidade_consulta.rb,
lib/calendario_api/cidade_resposta.rb,
lib/calendario_api/feriado_consulta.rb,
lib/calendario_api/feriado_resposta.rb

Overview

Módulo Único do uso da API de Feriados/Cidades

Defined Under Namespace

Classes: Cidade, CidadeConsulta, CidadeResposta, Error, Feriado, FeriadoConsulta, FeriadoParams, FeriadoResposta, LimiteUltrapassado, TokenInvalido

Constant Summary collapse

VERSION =
"0.1.0"

Class Method Summary collapse

Class Method Details

.busca_cidadesCidadeResposta

Faz busca na API pelas cidades

Returns:


42
43
44
# File 'lib/calendario_api.rb', line 42

def self.busca_cidades
  CidadeConsulta.new.busca
end

.busca_feriados(hash_params = {}) ⇒ FeriadoResposta

TODO:

Permitir a busca através do código IBGE da cidade

TODO:

Acionar a exceção correta quando o limite de cidades foi ultrapassado

TODO:

Aplicar Validação dos parâmetros antes de fazer a requisição

Note:

a busca por cidade e estado é inclusiva, isto é, se estiver vazia, não virá Feriados Estaduais ou Municipais.

Faz busca na API pelos feriados

Parameters:

  • hash_params (Hash) (defaults to: {})

    os parâmetros da busca na API. token: (Obrigatório) Token de acesso a API de feriados ano: Ano dos feriados, padrão: ano atual estado: Estado em que se extrairá os feriados Estaduais cidade: Cidade em que se extrairá os feriados Municipais

Returns:

  • (FeriadoResposta)

    uma coleção de Feriados que condizem com os parâmetros da busca

Raises:

  • (TokenInvalido)

    caso não envie um token, ou este seja inválido


32
33
34
35
36
37
# File 'lib/calendario_api.rb', line 32

def self.busca_feriados(hash_params = {})
  params = FeriadoParams.new hash_params
  FeriadoConsulta.new(params.token).busca_por_parametros(
    params.ano, params.estado, params.cidade
  )
end