module CalendarioApi
Módulo Único do uso da API de Feriados/Cidades
Constants
- VERSION
Public Class Methods
busca_cidades()
click to toggle source
Faz busca na API pelas cidades
@return [CidadeResposta] uma coleção de cidades do Brasil
# File lib/calendario_api.rb, line 42 def self.busca_cidades CidadeConsulta.new.busca end
busca_feriados(hash_params = {})
click to toggle source
Faz busca na API pelos feriados
@param hash_params 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
@return [FeriadoResposta] uma coleção de Feriados que condizem
com os parâmetros da busca
@raise [TokenInvalido] caso não envie um token, ou este seja inválido @note a busca por cidade e estado é inclusiva, isto é, se estiver
vazia, não virá Feriados Estaduais ou Municipais.
@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
# 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