Class: FocusNfe::Recursos::Base

Inherits:

Object

• Object
• FocusNfe::Recursos::Base

Defined in:

lib/focus_nfe/recursos/base.rb

Overview

Base dos recursos da API. Guarda a HTTP::Connection e o caminho_base declarado por cada recurso, e oferece os utilitários compartilhados pelos mixins de comportamento (Concerns::Emitivel, Concerns::Consultavel, Concerns::Cancelavel, …): montagem do caminho por referência e validação client-side da ref.

Direct Known Subclasses

Backups, Ceps, Cfops, Cnaes, Cnpjs, Cte, CteOs, CtesRecebidas, Dce, EmailsBloqueados, Empresas, Mdfe, Municipios, Ncms, Nfce, Nfcom, Nfe, NfesRecebidas, Nfgas, Nfse, NfseNacional, NfsesNacionaisRecebidas, Webhooks

Constant Summary

REFERENCIA =

Returns formato aceito para a ref (alfanumérico, hífen ou underscore).

Returns:

• (Regexp) —

  formato aceito para a ref (alfanumérico, hífen ou underscore)

/\A[\w-]+\z/

Class Method Summary

• .caminho_base(valor = nil) ⇒ String^?

  Declara (ou lê) o caminho base do recurso, sem o prefixo /v2.

• .caminho_base_previa(valor = nil) ⇒ String^?

  Declara (ou lê) o caminho da prévia do recurso, sem o prefixo /v2.

Instance Method Summary

• #caminho_base ⇒ String^?

  Caminho base declarado pela classe do recurso.

• #caminho_base_previa ⇒ String^?

  Caminho de prévia declarado pela classe do recurso.

• #initialize(connection) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(connection) ⇒ Base

Returns a new instance of Base.

Parameters:

• connection (FocusNfe::HTTP::Connection) —

  conexão do cliente

# File 'lib/focus_nfe/recursos/base.rb', line 38

def initialize(connection)
  @connection = connection
end

Class Method Details

.caminho_base(valor = nil) ⇒ String^?

Declara (ou lê) o caminho base do recurso, sem o prefixo /v2.

Parameters:

• valor (String, nil) (defaults to: nil) —

  caminho a declarar; omitido apenas lê o atual

Returns:

• (String, nil) —

  caminho base efetivo da classe

# File 'lib/focus_nfe/recursos/base.rb', line 20

def caminho_base(valor = nil)
  @caminho_base = valor unless valor.nil?
  @caminho_base
end

.caminho_base_previa(valor = nil) ⇒ String^?

Declara (ou lê) o caminho da prévia do recurso, sem o prefixo /v2. Usado por Concerns::Visualizavel; cada documento com prévia o declara (ex.: "nfe/danfe").

Parameters:

• valor (String, nil) (defaults to: nil) —

  caminho a declarar; omitido apenas lê o atual

Returns:

• (String, nil) —

  caminho de prévia efetivo da classe

# File 'lib/focus_nfe/recursos/base.rb', line 31

def caminho_base_previa(valor = nil)
  @caminho_base_previa = valor unless valor.nil?
  @caminho_base_previa
end

Instance Method Details

#caminho_base ⇒ String^?

Returns caminho base declarado pela classe do recurso.

Returns:

• (String, nil) —

  caminho base declarado pela classe do recurso

# File 'lib/focus_nfe/recursos/base.rb', line 43

def caminho_base
  self.class.caminho_base
end

#caminho_base_previa ⇒ String^?

Returns caminho de prévia declarado pela classe do recurso.

Returns:

• (String, nil) —

  caminho de prévia declarado pela classe do recurso

# File 'lib/focus_nfe/recursos/base.rb', line 48

def caminho_base_previa
  self.class.caminho_base_previa
end