Module: FocusNfe

Defined in:
lib/focus_nfe.rb,
lib/focus_nfe/client.rb,
lib/focus_nfe/errors.rb,
lib/focus_nfe/version.rb,
lib/focus_nfe/webhook.rb,
lib/focus_nfe/http/adapter.rb,
lib/focus_nfe/http/logging.rb,
lib/focus_nfe/recursos/cte.rb,
lib/focus_nfe/recursos/dce.rb,
lib/focus_nfe/recursos/nfe.rb,
lib/focus_nfe/configuration.rb,
lib/focus_nfe/http/response.rb,
lib/focus_nfe/recursos/base.rb,
lib/focus_nfe/recursos/ceps.rb,
lib/focus_nfe/recursos/mdfe.rb,
lib/focus_nfe/recursos/ncms.rb,
lib/focus_nfe/recursos/nfce.rb,
lib/focus_nfe/recursos/nfse.rb,
lib/focus_nfe/esquemas/campo.rb,
lib/focus_nfe/modelos/pagina.rb,
lib/focus_nfe/recursos/cfops.rb,
lib/focus_nfe/recursos/cnaes.rb,
lib/focus_nfe/recursos/cnpjs.rb,
lib/focus_nfe/recursos/nfcom.rb,
lib/focus_nfe/recursos/nfgas.rb,
lib/focus_nfe/http/connection.rb,
lib/focus_nfe/recursos/cte_os.rb,
lib/focus_nfe/esquemas/decimal.rb,
lib/focus_nfe/esquemas/esquema.rb,
lib/focus_nfe/recursos/backups.rb,
lib/focus_nfe/esquemas/catalogo.rb,
lib/focus_nfe/modelos/documento.rb,
lib/focus_nfe/recursos/empresas.rb,
lib/focus_nfe/recursos/webhooks.rb,
lib/focus_nfe/esquemas/validador.rb,
lib/focus_nfe/http/authentication.rb,
lib/focus_nfe/recursos/municipios.rb,
lib/focus_nfe/modelos/inutilizacao.rb,
lib/focus_nfe/http/adapters/net_http.rb,
lib/focus_nfe/recursos/nfse_nacional.rb,
lib/focus_nfe/recursos/ctes_recebidas.rb,
lib/focus_nfe/recursos/nfes_recebidas.rb,
lib/focus_nfe/recursos/concerns/baixavel.rb,
lib/focus_nfe/recursos/concerns/emitivel.rb,
lib/focus_nfe/recursos/concerns/enviavel.rb,
lib/focus_nfe/recursos/concerns/listavel.rb,
lib/focus_nfe/recursos/emails_bloqueados.rb,
lib/focus_nfe/recursos/concerns/eventavel.rb,
lib/focus_nfe/recursos/concerns/removivel.rb,
lib/focus_nfe/recursos/concerns/cancelavel.rb,
lib/focus_nfe/recursos/concerns/corrigivel.rb,
lib/focus_nfe/recursos/concerns/conciliavel.rb,
lib/focus_nfe/recursos/concerns/consultavel.rb,
lib/focus_nfe/recursos/concerns/localizavel.rb,
lib/focus_nfe/recursos/concerns/notificavel.rb,
lib/focus_nfe/recursos/concerns/inutilizavel.rb,
lib/focus_nfe/recursos/concerns/visualizavel.rb,
lib/focus_nfe/recursos/concerns/corrigivel_cte.rb,
lib/focus_nfe/recursos/concerns/baixavel_eventos.rb,
lib/focus_nfe/recursos/nfses_nacionais_recebidas.rb

Overview

Ponto de entrada da gem e fachada da configuração global (modo de empresa única): FocusNfe.configure/FocusNfe.configuration/FocusNfe.client/FocusNfe.reset_configuration! operam sobre uma Configuration memoizada no nível do módulo. Para multi-empresa, instancie Client explicitamente.

Apenas o núcleo (configuração, HTTP, cliente) é carregado no require. Os recursos de documento, os modelos e a camada de esquemas são registrados via autoload e carregados sob demanda — quem só emite um tipo de documento não paga o custo de carregar os demais.

Defined Under Namespace

Modules: Errors, Esquemas, HTTP, Modelos, Recursos, Webhook Classes: Client, Configuration, Error

Constant Summary collapse

VERSION =

Returns versão da gem.

Returns:

  • (String) —

    versão da gem

"1.0.1"

Class Method Summary collapse

Class Method Details

.client ⇒ FocusNfe::Client

Returns cliente construído a partir da config global.

Returns:

Raises:



113
114
115
 
# File 'lib/focus_nfe.rb', line 113

def client
  Client.new(configuration)
end

.configuration ⇒ FocusNfe::Configuration

Returns a configuração global, criada como default na primeira chamada.

Returns:



107
108
109
 
# File 'lib/focus_nfe.rb', line 107

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ FocusNfe::Configuration

Cede a configuração global ao bloco para ajuste, memoizando-a.

Yield Parameters:

Returns:



101
102
103
104
 
# File 'lib/focus_nfe.rb', line 101

def configure
  yield(configuration) if block_given?
  configuration
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Limpa a configuração global memoizada.



120
121
122
 
# File 'lib/focus_nfe.rb', line 120

def reset_configuration!
  @configuration = nil
end