br_nfe 1.1.0 → 2.0.0

data/lib/br_nfe/endereco.rb

@@ -13,7 +13,7 @@ module BrNfe
 		attr_accessor :complemento
 		attr_accessor :bairro
 		attr_accessor :nome_municipio
-		attr_accessor :codigo_municipio
+		attr_accessor :codigo_municipio # IBGE
 		attr_accessor :uf
 		attr_accessor :cep
 		attr_accessor :codigo_pais # defaul: 1058 (Brasil)
@@ -21,6 +21,12 @@ module BrNfe
 
 		validates :logradouro, :numero, :bairro, :codigo_municipio, :uf, :cep, presence: true
 
+		def is_present?
+			logradouro.present? || numero.present? || complemento.present? || 
+			bairro.present? || nome_municipio.present? || codigo_municipio.present? || 
+			cep.present?
+		end
+
 		def logradouro
 			"#{@logradouro}".to_valid_format_nf
 		end

data/lib/br_nfe/helper/have_rps.rb

@@ -16,7 +16,7 @@ module BrNfe
 			
 		protected
 
-			def validar_rps
+			def validate_rps
 				if rps.invalid?
 					rps.errors.full_messages.map{|msg| errors.add(:rps, msg) }
 				end

data/lib/br_nfe/helper/values_ts/service_v1.rb

@@ -0,0 +1,313 @@
+module BrNfe
+	module Helper
+		module ValuesTs
+			module ServiceV1
+				
+				# Número da Nota Fiscal de Serviço Eletrônica,
+				# formado pelo ano com 04 (quatro) dígitos e um
+				# número seqüencial com 11 posições – Formato
+				# AAAANNNNNNNNNNN.
+				#
+				def ts_numero_nfse value
+					BrNfe::Helper.only_number(value).max_size(15)
+				end
+
+				# Código de verificação do número da nota
+				#
+				def ts_codigo_verificacao value
+					"#{value}".max_size(9)
+				end
+
+				# Código de status do RPS
+				# 1 – Normal
+				# 2 – Cancelado
+				#
+				def ts_status_rps value
+					BrNfe::Helper.only_number(value).max_size(1)
+				end
+
+				# Código de status do NFS-e
+				# 1 – Normal
+				# 2 – Cancelado
+				#
+				def ts_status_nfse value
+					BrNfe::Helper.only_number(value).max_size(1)
+				end
+
+				# Código de natureza da operação
+				# 1 – Tributação no município
+				# 2 - Tributação fora do município
+				# 3 - Isenção
+				# 4 - Imune
+				# 5 –Exigibilidade suspensa por decisão judicial
+				# 6 – Exigibilidade suspensa por procedimento administrativo
+				#
+				def ts_natureza_operacao value
+					BrNfe::Helper.only_number(value).max_size(2)
+				end
+
+				# Código de identificação do regime especial de tributação
+				#  1 – Microempresa municipal
+				#  2 - Estimativa
+				#  3 – Sociedade de profissionais
+				#  4 – Cooperativa
+				#
+				def ts_regime_especial_tributacao value
+					BrNfe::Helper.only_number(value).max_size(2)
+				end
+
+				# Identificação de Sim/Não
+				#  1 - Sim
+				#  2 - Não
+				#
+				def ts_sim_nao value
+					value_true_false(value)
+				end
+
+				# Quantidade de RPS do Lote
+				#
+				def ts_quantidade_rps value
+					BrNfe::Helper.only_number(value).max_size(4)
+				end
+
+				# Número do RPS
+				#
+				def ts_numero_rps value
+					BrNfe::Helper.only_number(value).max_size(15)
+				end
+
+				# Número de série do RPS
+				#
+				def ts_serie_rps value
+					"#{value}".max_size(5)
+				end
+
+				# Código de tipo de RPS
+				#  1 - RPS
+				#  2 – Nota Fiscal Conjugada (Mista)
+				#  3 – Cupom
+				#
+				def ts_tipo_rps value
+					BrNfe::Helper.only_number(value).max_size(1)
+				end
+
+				# Informações adicionais ao documento.
+				#
+				def ts_outras_informacoes value
+					"#{value}".max_size(255)
+				end
+
+				# Valor monetário.
+				#  Formato: 0.00 (ponto separando casa decimal)
+				#  Ex: 1.234,56 = 1234.56
+				#  1.000,00 = 1000.00
+				#  1.000,00 = 1000
+				#
+				def ts_valor value
+					"#{value_monetary(value, 2)}".max_size(17)
+				end
+
+				# Código de item da lista de serviço
+				#
+				def ts_item_lista_servico value
+					BrNfe::Helper.only_number(value).max_size(5).rjust(4, '0')
+				end
+
+				# Código CNAE
+				#
+				def ts_codigo_cnae value
+					BrNfe::Helper.only_number(value).max_size(7)
+				end
+
+				# Código de Tributação
+				#
+				def ts_codigo_tributacao value
+					"#{value}".max_size(20)
+				end
+
+				# Alíquota. Valor percentual.
+				#  Formato: 0.0000
+				#  Ex: 1% = 0.01
+				#  25,5% = 0.255
+				#  100% = 1.0000 ou 1
+				#
+				def ts_aliquota value
+					"#{value_monetary(value, 4)}".max_size(9)
+				end
+
+				# Discriminação do conteúdo da NFS-e
+				#
+				def ts_discriminacao value
+					"#{value}".max_size(2_000).remove_accents
+				end
+
+				# Código de identificação do município conforme tabela do IBGE
+				#
+				def ts_codigo_municipio_ibge value
+					BrNfe::Helper.only_number(value).max_size(7)
+				end
+
+				# Número de inscrição municipal
+				#
+				def ts_inscricao_municipal value
+					"#{value}".max_size(15)
+				end
+
+				# Razão Social do contribuinte
+				#
+				def ts_razao_social value
+					"#{value}".max_size(115)
+				end
+
+				# Nome fantasia
+				#
+				def ts_nome_fantasia value
+					"#{value}".max_size(60)
+				end
+
+				# Número CNPJ
+				#
+				def ts_cnpj value
+					"#{BrNfe::Helper::CpfCnpj.new(value).sem_formatacao}".max_size(14)
+				end
+
+				# Endereço / rua
+				#
+				def ts_endereco value
+					"#{value}".max_size(125)
+				end
+
+				# Número do endereço
+				#
+				def ts_numero_endereco value
+					"#{value}".max_size(10)
+				end
+
+				# Complemento de endereço
+				#
+				def ts_complemento_endereco value
+					"#{value}".max_size(60)
+				end
+
+				# Bairro
+				#
+				def ts_bairro value
+					"#{value}".max_size(60)
+				end
+
+				# Sigla da unidade federativa
+				#
+				def ts_uf value
+					"#{value}".max_size(2)
+				end
+
+				# Número do CEP
+				#
+				def ts_cep value
+					BrNfe::Helper.only_number(value).max_size(8)
+				end
+
+				# E-mail
+				#
+				def ts_email value
+					"#{value}".max_size(80)
+				end
+
+				# Telefone
+				#
+				def ts_telefone value
+					"#{value}".max_size(11)
+				end
+
+				# Número CPF
+				#
+				def ts_cpf value
+					"#{BrNfe::Helper::CpfCnpj.new(value).sem_formatacao}".max_size(11)
+				end
+
+				# Indicador de uso de CPF ou CNPJ
+				#  1 – CPF
+				#  2 – CNPJ
+				#  3 – Não Informado
+				#
+				def ts_indicacao_cpf_cnpj
+					BrNfe::Helper.only_number(value).max_size(1)
+				end
+
+				# Código de Obra
+				#
+				def ts_codigo_obra value
+					"#{value}".max_size(15)
+				end
+
+				# Código ART
+				#
+				def ts_art value
+					"#{value}".max_size(15)
+				end
+
+				# Número do Lote de RPS
+				#
+				def ts_numero_lote value
+					BrNfe::Helper.only_number(value).max_size(15)
+				end
+
+				# Número do protocolo de recebimento do RPS
+				#
+				def ts_numero_protocolo value
+					"#{value}".max_size(50)
+				end
+
+				# Código de situação de lote de RPS
+				#  1 – Não Recebido
+				#  2 – Não Processado
+				#  3 – Processado com Erro
+				#  4 – Processado com Sucesso
+				#
+				def ts_situacao_lote_rps value
+					BrNfe::Helper.only_number(value).max_size(1)
+				end
+
+				# Código de mensagem de retorno de serviço.
+				#
+				def ts_codigo_mensagem_alerta value
+					"#{value}".max_size(4)
+				end
+
+				# Descrição da mensagem de retorno de serviço.
+				#
+				def ts_descricao_mensagem_alerta value
+					"#{value}".max_size(200)
+				end
+
+				# Código de cancelamento com base na tabela de Erros e alertas.
+				#
+				def ts_codigo_cancelamento_nfse value
+					"#{value}".max_size(4)
+				end
+
+				# Atributo de identificação da tag a ser assinada no documento XML
+				#
+				def ts_id_tag value
+					"#{value}".max_size(255)
+				end
+
+				# Atributo do formato Datetime
+				# Não está identificado na documentação porém é utilizado
+				# para identificar valores Datetime
+				#
+				def ts_datetime value
+					value_date_time(value)
+				end
+
+				# Atributo do formato Date
+				# Não está identificado na documentação porém é utilizado
+				# para identificar valores Date
+				#
+				def ts_date value
+					value_date(value)
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/response/service/build_response.rb

@@ -0,0 +1,286 @@
+#encoding UTF-8
+module BrNfe
+	module Response
+		module Service
+			class BuildResponse  < BrNfe::ActiveModelBase
+				# 1: A resposta da requisição soap
+				attr_accessor :savon_response
+				
+				# 2: O module que será incluido contendo os métodos com os
+				#    caminhos das chaves para encontrar cada valor
+				attr_accessor :module_methods
+				
+				# 3: Um array com o caminho inicial padrão da requisição de retorno
+				attr_accessor :keys_root_path
+
+				# 4: Caminho para encontrar o XML da NF-e
+				attr_accessor :nfe_xml_path				
+
+				# 5: Alguns Webservices trazem dentro do body da resposta SOAp
+				# outro XML com as informações necessárias.
+				# Quando isso aocntece é preciso converter esse XML para um HASH
+				# para que possamos encontrar os valores necessários.
+				attr_accessor :body_xml_path
+				
+				def initialize(attributes = {})
+					super(attributes)
+					include_module!
+				end
+
+				# Método utilizado para incluir módules dinâmicos
+				#
+				def include_module!
+					self.class.send(:include, module_methods) if module_methods
+				end
+
+				def response
+					@response ||= BrNfe::Response::Service::Default.new({
+						error_messages:   get_message_for_path(message_errors_path),
+						notas_fiscais:    get_invoices,
+						protocolo:        get_protocol,
+						data_recebimento: get_received_date,
+						numero_lote:      get_lot_number,
+						situation:        get_situation,
+						original_xml:     savon_response.xml.force_encoding('UTF-8'),
+						cancelation_date_time: get_cancelation_date_time
+					})
+				end
+
+				# Retorna o valor encontrado no body da resposta Savon
+				# em formato de hash
+				#
+				# <b>Tipo de retorno: </b> _Hash_
+				#
+				def savon_body
+					return @savon_body if @savon_body.present?
+					if body_xml_path.present?
+						@savon_body = Nori.new.parse(
+							find_value_for_keys(savon_response.try(:body), body_xml_path)
+						).deep_transform_keys!{|k| k.to_s.underscore.to_sym}
+					else
+						@savon_body = savon_response.try(:body) || {}
+					end
+				end
+
+				# Método utilizado para encontrar valores em um Hash
+				# passando o caminho do valor em um array onde contém as chaves
+				# ordenadas.
+				# Recebe 2 parêmntros:
+				# 1º um o hash onde contém o valor a ser encontrado
+				# 2º um array com as chaves em sequencia formando o caminho para encontrar o valor.
+				#
+				# A funcionalidade desse método funciona parecido com o `.dig` da classe Hash do
+				# Ruby 2.3.0. 
+				# A diferença é que no caso de exmeplo a seguir não apresenta uma excessão par ao usuário
+				# hash = {v1: {v2: 'valor string'}}
+				# hash.dig(:v1, :v2, :v3) <- Dá erro
+				# find_value_for_keys(hash, [:v1, :v2, :v3] <- Retorna nil e não da erro
+				#
+				# <b>Tipo de retorno: </b> _Anything_
+				#
+				def find_value_for_keys(hash, keys)
+					return if keys.blank?
+					keys = [keys] unless keys.is_a?(Array)
+					
+					result = hash
+					keys.each do |key|
+						if result.is_a?(Hash)
+							result = result[key]
+						else
+							result = nil
+							break
+						end
+					end
+					result
+				end
+
+				# Quando para encontrar o valor de uma determinada chave
+				# é necessaŕio percorer o hash de retorno dês do inicio do mesmo.
+				# Como a mensagem tem uma chave 'root' padrão e pode ser diferente 
+				# para cada orgaao emissor, é setado uma valor na variavel keys_root_path
+				# para que não seja necessário ficar setando a mesma chave em todos os 
+				# métodos utilizados para encontrar determinado valor
+				#
+				# <b>Tipo de retorno: </b> _Array_
+				#
+				def path_with_root(path)
+					return if path.blank?
+					keys_root_path + [path].flatten
+				end
+
+				# Método que retorna as mensagens de retorno da requisição
+				# Quando procurar a mensagem a mesma pode retornar em 3 formatos:
+				# Hash: Onde encontrou apenas 1 mensagem com Codigo, Mensagem e Solução
+				# Array: Onde encontrou mais de uma mensagem com Codigo, Mensagem e Solução
+				# String: Onde encontrou uma unica mensagem de texto
+				#
+				# <b>Tipo de retorno: </b> _Array_
+				#
+				def get_message_for_path(msg_path)
+					messages = []
+					_messages = find_value_for_keys(savon_body, path_with_root(msg_path) )
+					if _messages.is_a?(Hash)
+						messages << get_message_for_hash(_messages)
+					elsif _messages.is_a?(Array)
+						_messages.map{|msg| messages << get_message_for_hash(msg) }
+					elsif _messages.present?
+						messages << _messages
+					end
+					messages
+				end
+
+				# Método utilizado para quando encontrar uam mensagem que seja um HAsh,
+				# onde nesse caso a mensagem terá um codigo de erro, uma mensagem, e uma 
+				# mensagem de solução
+				#
+				# <b>Tipo de retorno: </b> _hash_
+				#
+				def get_message_for_hash(msg_hash)
+					{
+						code:     find_value_for_keys(msg_hash, message_code_key),
+						message:  find_value_for_keys(msg_hash, message_msg_key),
+						solution: find_value_for_keys(msg_hash, message_solution_key)
+					}
+				end
+
+				# Método que retorna as notas fiscais emitidas.
+				# Como pode ser que retorne mais de uma NF, a busca pela NF
+				# pode retornar um Array ou um Hash.
+				# Se retornar um array é porque existe mais de uma NFE, então é necessario
+				# percorer com um loop e instanciar cada nota com seus valores.
+				# Se retornar um Hash é porque tem apenas uma NFe, e nesse caso 
+				# irá instanciar apenas a nfe encontrada.
+				#
+				# <b>Tipo de retorno: </b> _Array_
+				#
+				def get_invoices
+					invoices = []
+					_inoices = find_value_for_keys(savon_body, path_with_root(invoices_path))
+					if _inoices.is_a?(Hash)
+						invoices << instance_invoice(_inoices)
+					elsif _inoices.is_a?(Array)
+						_inoices.map{|inv| invoices << instance_invoice(inv) }
+					end
+					invoices
+				end
+
+				# Método utilizado para pegar protocolo de solicitação de
+				# processamento do RPS.
+				# Esse protocolo é utilizado posteriormente para consultar se
+				# o RPS já foi processado
+				#
+				# <b>Tipo de retorno: </b> _String_
+				#
+				def get_protocol
+					find_value_for_keys(savon_body, path_with_root(protocol_path))
+				end
+
+				# Método utilizado para pegar a situação do RPS
+				#
+				# <b>Tipo de retorno: </b> _Symbol_
+				#
+				def get_situation
+					situation_value = find_value_for_keys(savon_body, path_with_root(situation_path))
+					situation_value = situation_key_values[situation_value.to_s.strip] if situation_value.present?
+					situation_value
+				end
+
+				# Método utilizado para pegar a data de recebimento do lote
+				#
+				# <b>Tipo de retorno: </b> _String_
+				#
+				def get_received_date
+					find_value_for_keys(savon_body, path_with_root(received_date_path))
+				end
+
+				# Método utilizado para pegar o número do lote RPS
+				#
+				# <b>Tipo de retorno: </b> _String_
+				#
+				def get_lot_number
+					find_value_for_keys(savon_body, path_with_root(lot_number_path))
+				end
+
+				# Método utilizado para pegar o XML da NF
+				# É necessário canonicalizar o document para que seja colocado os
+				# namespaces nas tags corretas. Caso contrário o XML não irá abrir.
+				#
+				# <b>Tipo de retorno: </b> _String_
+				#
+				def get_xml_nf
+					canonicalize(Nokogiri::XML.parse(canonicalize(savon_response.doc.to_s), nil, 'UTF-8').xpath(nfe_xml_path).to_xml)
+				rescue
+					savon_response.xml
+				end
+
+				# Método utilizado para pegar o valor da data e hora de cancelmaento
+				# Só é utilizado para cancelar a NF-e
+				#
+				# <b>Tipo de retorno: </b> _DateTime_ OU _Nil_ OU _String_
+				#
+				def get_cancelation_date_time
+					find_value_for_keys(savon_body, path_with_root(cancelation_date_time_path)) if cancelation_date_time_path.present?
+				end
+
+				# Método responsável por instanciar a nota fiscal de acordo com o hash 
+				#   passado por parêmetro
+				# O parâmetro recebido deve ser o Hash representado pelo tipo de dados tcCompNfse(do manual NFS-e v1)
+				#
+				def instance_invoice(invoice_hash)
+					BrNfe::Response::Service::NotaFiscal.new({
+						xml_nf:                           get_xml_nf.force_encoding('UTF-8'),
+						numero_nf:                        find_value_for_keys(invoice_hash, invoice_numero_nf_path                       ),
+						codigo_verificacao:               find_value_for_keys(invoice_hash, invoice_codigo_verificacao_path              ),
+						data_emissao:                     find_value_for_keys(invoice_hash, invoice_data_emissao_path                    ),
+						url_nf:                           find_value_for_keys(invoice_hash, invoice_url_nf_path                          ),
+						rps_numero:                       find_value_for_keys(invoice_hash, invoice_rps_numero_path                      ),
+						rps_serie:                        find_value_for_keys(invoice_hash, invoice_rps_serie_path                       ),
+						rps_tipo:                         find_value_for_keys(invoice_hash, invoice_rps_tipo_path                        ),
+						rps_situacao:                     find_value_for_keys(invoice_hash, invoice_rps_situacao_path                    ),
+						rps_substituido_numero:           find_value_for_keys(invoice_hash, invoice_rps_substituido_numero_path          ),
+						rps_substituido_serie:            find_value_for_keys(invoice_hash, invoice_rps_substituido_serie_path           ),
+						rps_substituido_tipo:             find_value_for_keys(invoice_hash, invoice_rps_substituido_tipo_path            ),
+						data_emissao_rps:                 find_value_for_keys(invoice_hash, invoice_data_emissao_rps_path                ),
+						competencia:                      find_value_for_keys(invoice_hash, invoice_competencia_path                     ),
+						outras_informacoes:               find_value_for_keys(invoice_hash, invoice_outras_informacoes_path              ),
+						item_lista_servico:               find_value_for_keys(invoice_hash, invoice_item_lista_servico_path              ),
+						cnae_code:                        find_value_for_keys(invoice_hash, invoice_cnae_code_path                       ),
+						description:                      find_value_for_keys(invoice_hash, invoice_description_path                     ),
+						codigo_municipio:                 find_value_for_keys(invoice_hash, invoice_codigo_municipio_path                ),
+						total_services:                   find_value_for_keys(invoice_hash, invoice_total_services_path                  ),
+						deductions:                       find_value_for_keys(invoice_hash, invoice_deductions_path                      ),
+						valor_pis:                        find_value_for_keys(invoice_hash, invoice_valor_pis_path                       ),
+						valor_cofins:                     find_value_for_keys(invoice_hash, invoice_valor_cofins_path                    ),
+						valor_inss:                       find_value_for_keys(invoice_hash, invoice_valor_inss_path                      ),
+						valor_ir:                         find_value_for_keys(invoice_hash, invoice_valor_ir_path                        ),
+						valor_csll:                       find_value_for_keys(invoice_hash, invoice_valor_csll_path                      ),
+						iss_retained:                     find_value_for_keys(invoice_hash, invoice_iss_retained_path                    ),
+						outras_retencoes:                 find_value_for_keys(invoice_hash, invoice_outras_retencoes_path                ),
+						total_iss:                        find_value_for_keys(invoice_hash, invoice_total_iss_path                       ),
+						base_calculation:                 find_value_for_keys(invoice_hash, invoice_base_calculation_path                ),
+						iss_tax_rate:                     find_value_for_keys(invoice_hash, invoice_iss_tax_rate_path                    ),
+						valor_liquido:                    find_value_for_keys(invoice_hash, invoice_valor_liquido_path                   ),
+						desconto_condicionado:            find_value_for_keys(invoice_hash, invoice_desconto_condicionado_path           ),
+						desconto_incondicionado:          find_value_for_keys(invoice_hash, invoice_desconto_incondicionado_path         ),
+						responsavel_retencao:             find_value_for_keys(invoice_hash, invoice_responsavel_retencao_path            ),
+						numero_processo:                  find_value_for_keys(invoice_hash, invoice_numero_processo_path                 ),
+						municipio_incidencia:             find_value_for_keys(invoice_hash, invoice_municipio_incidencia_path            ),
+						orgao_gerador_municipio:          find_value_for_keys(invoice_hash, invoice_orgao_gerador_municipio_path         ),
+						orgao_gerador_uf:                 find_value_for_keys(invoice_hash, invoice_orgao_gerador_uf_path                ),
+						cancelamento_codigo:              find_value_for_keys(invoice_hash, invoice_cancelamento_codigo_path             ),
+						cancelamento_numero_nf:           find_value_for_keys(invoice_hash, invoice_cancelamento_numero_nf_path          ),
+						cancelamento_cnpj:                find_value_for_keys(invoice_hash, invoice_cancelamento_cnpj_path               ),
+						cancelamento_inscricao_municipal: find_value_for_keys(invoice_hash, invoice_cancelamento_inscricao_municipal_path),
+						cancelamento_municipio:           find_value_for_keys(invoice_hash, invoice_cancelamento_municipio_path          ),
+						cancelamento_sucesso:             find_value_for_keys(invoice_hash, invoice_cancelamento_sucesso_path            ),
+						cancelamento_data_hora:           find_value_for_keys(invoice_hash, invoice_cancelamento_data_hora_path          ),
+						nfe_substituidora:                find_value_for_keys(invoice_hash, invoice_nfe_substituidora_path               ),
+						codigo_obra:                      find_value_for_keys(invoice_hash, invoice_codigo_obra_path                     ),
+						codigo_art:                       find_value_for_keys(invoice_hash, invoice_codigo_art_path                      )
+					})
+				end
+
+			end
+		end
+	end
+end