br_nfe 2.1.0 → 2.1.1

data/lib/br_nfe/service/concerns/values_ts/service_v1.rb

@@ -0,0 +1,319 @@
+module BrNfe
+	module Service
+		module Concerns
+			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
+						BrNfe.true_values.include?(value) ? '1' : '2'
+					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).br_nfe_escape_html
+					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.to_f.round(2) if value.present?
+					end
+
+					# Código de item da lista de serviço
+					# Se um serviço for por exemplo: 107 deve ser enviado no formato
+					# 1.07
+					#
+					def ts_item_lista_servico value
+						return if value.blank?
+						number_only = BrNfe::Helper.only_number(value).max_size(4).to_i.to_s
+						number_only.reverse.scan(/.{1,2}/).join('.').reverse
+					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% = 1.00
+					#  25,5% = 25.5
+					#  100% = 100.0000 ou 100
+					#
+					def ts_aliquota value
+						value_monetary(value, 4)
+					end
+
+					# Discriminação do conteúdo da NFS-e
+					#
+					def ts_discriminacao value
+						"#{value}".max_size(2_000).remove_accents.br_nfe_escape_html
+					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).ljust(8, '0') if value.present?
+					end
+
+					# E-mail
+					#
+					def ts_email value
+						"#{value}".max_size(80)
+					end
+
+					# Telefone
+					#
+					def ts_telefone value
+						BrNfe::Helper.only_number(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 value
+						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
+end

data/lib/br_nfe/service/destinatario.rb

@@ -0,0 +1,7 @@
+module BrNfe
+	module Service
+		class Destinatario  < BrNfe::Person			
+			validate :validar_endereco			
+		end
+	end
+end

data/lib/br_nfe/service/emitente.rb

@@ -0,0 +1,8 @@
+module BrNfe
+	module Service
+		class Emitente  < BrNfe::Person
+			validates :inscricao_municipal, :natureza_operacao, presence: true
+			validate  :validar_endereco
+		end
+	end
+end

data/lib/br_nfe/service/intermediario.rb

@@ -1,17 +1,6 @@
 module BrNfe
 	module Service
-		class Intermediario  < BrNfe::ActiveModelBase
-			
-			attr_accessor :cpf_cnpj
-			attr_accessor :inscricao_municipal
-			attr_accessor :razao_social
-
-			validates :cpf_cnpj, :razao_social, presence: true
-
-			def razao_social
-				"#{@razao_social}".to_valid_format_nf
-			end
-			
+		class Intermediario  < BrNfe::Person
 		end
 	end
 end

data/lib/br_nfe/service/item.rb

@@ -36,34 +36,34 @@ module BrNfe
 			# Ex: se a aliquita for 7.5% então o valor setado no campo é 0.075
 			#
 			# <b>Tipo: </b> _Float_
-			attr_accessor :iss_tax_rate
+			attr_accessor :iss_aliquota
 
 			# Valor unitário do item
 			# Refere-se ao valor separado de cada serviço prestado
 			#
 			# <b>Tipo: </b> _Float_
-			attr_accessor :unit_value
+			attr_accessor :valor_unitario
 
 			# Quantidade prestada de serviços do item
 			#
 			# <b>Tipo: </b> _Float_
-			attr_accessor :quantity
+			attr_accessor :quantidade
 
 			# Valor total cobrado do item
 			#
 			# <b>Tipo: </b> _Float_
-			attr_accessor :total_value
+			attr_accessor :valor_total
 
 			
 			def default_values
 				{
-					quantity: 1.0,
+					quantidade: 1.0,
 				}
 			end
 
 
-			def total_value
-				@total_value || (quantity.to_f * unit_value.to_f)
+			def valor_total
+				@valor_total || (quantidade.to_f * valor_unitario.to_f)
 			end
 		end
 	end

data/lib/br_nfe/service/response/build/base.rb

@@ -0,0 +1,166 @@
+#encoding UTF-8
+module BrNfe
+	module Service
+		module Response
+			module Build
+				class Base  < BrNfe::ActiveModelBase
+					# 1: A resposta da requisição soap
+					attr_accessor :savon_response
+					
+					# 2: Um array com o caminho inicial padrão da requisição de retorno
+					attr_accessor :keys_root_path
+
+					# 3: 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
+
+					# 4: Codificação original do XML de resposta para que seja convertido 
+					#    para UTF-8
+					attr_accessor :xml_encode
+
+					##############################################################################################################
+					#######################   CAMINHOS PARA ENCONTRAR OS VALORES NA RESPOSTA DA REQUISIÇÃO   #####################
+						#                                                                     Caminho para encontrar
+						attr_accessor :lot_number_path                                     # o numero do lote
+						attr_accessor :message_errors_path                                 # local para encontrar as mensagens de erro
+						attr_accessor :message_code_key                                    # chave que representa o codigo do erro
+						attr_accessor :message_msg_key                                     # chave que representa a mensagem do erro
+						attr_accessor :message_solution_key                                # chave que representa a solução do erro
+						
+						def default_values
+							super.merge({
+								message_code_key:     :codigo,
+								message_msg_key:      :mensagem,
+								message_solution_key: :correcao,
+							})
+						end
+					#######################   FIM DA DEFINIÇÃO DOS CAMINHOS   ############################
+					######################################################################################
+					
+					def response
+						raise "O método #response deve ser implementado na classe #{self.class}"
+					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(
+								body_converted_to_xml
+							).deep_transform_keys!{|k| k.to_s.underscore.to_sym}
+						else
+							@savon_body = savon_response.try(:body) || {}
+						end
+					end
+
+					# Converte o body da requisição em XML (String)
+					# Isso é necessário quando dentro do body vem a resposta com outro XML
+					#
+					# <b>Tipo de retorno: </b> _String_
+					#
+					def body_converted_to_xml
+						@body_converted_to_xml ||= canonicalize("#{find_value_for_keys(savon_response.try(:body), body_xml_path)}".encode(xml_encode).force_encoding('UTF-8'))
+					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) if msg.present? }
+						elsif _messages.present?
+							messages << _messages
+						end
+						messages.uniq
+					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 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
+
+					
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/service/response/build/cancelamento.rb

@@ -0,0 +1,62 @@
+#encoding UTF-8
+module BrNfe
+	module Service
+		module Response
+			module Build
+				class Cancelamento  < Base
+					##############################################################################################################
+					#######################   CAMINHOS PARA ENCONTRAR OS VALORES NA RESPOSTA DA REQUISIÇÃO   #####################
+					attr_accessor :codigo_cancelamento_path
+					def codigo_cancelamento_path
+						@codigo_cancelamento_path ||= []
+					end
+					attr_accessor :data_hora_cancelamento_path
+					def data_hora_cancelamento_path
+						@data_hora_cancelamento_path ||= []
+					end
+					attr_accessor :numero_nfs_path
+					def numero_nfs_path
+						@numero_nfs_path ||= []
+					end
+					#######################   FIM DA DEFINIÇÃO DOS CAMINHOS   ############################
+					######################################################################################
+					
+					def response
+						@response ||= BrNfe::Service::Response::Cancelamento.new({
+							original_xml:     savon_response.xml.force_encoding('UTF-8'),
+							error_messages:   get_message_for_path(message_errors_path),
+							codigo_cancelamento:    get_codigo_cancelamento,
+							data_hora_cancelamento: get_data_hora_cancelamento,
+							numero_nfs:             get_numero_nfs,
+						})
+					end
+
+					# Método utilizado para pegar o valor da data e hora de cancelmaento
+					#
+					# <b>Tipo de retorno: </b> _DateTime_ OU _Nil_ OU _String_
+					#
+					def get_codigo_cancelamento
+						find_value_for_keys(savon_body, path_with_root(codigo_cancelamento_path)) if codigo_cancelamento_path.present?
+					end
+
+					# Método utilizado para pegar o código do cancelamento
+					#
+					# <b>Tipo de retorno: </b> _String_ OU _Integer_
+					#
+					def get_data_hora_cancelamento
+						find_value_for_keys(savon_body, path_with_root(data_hora_cancelamento_path)) if data_hora_cancelamento_path.present?
+					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_numero_nfs
+						find_value_for_keys(savon_body, path_with_root(numero_nfs_path)) if numero_nfs_path.present?
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/service/response/build/consulta_lote_rps.rb

@@ -0,0 +1,25 @@
+#encoding UTF-8
+module BrNfe
+	module Service
+		module Response
+			module Build
+				class ConsultaLoteRps  < BrNfe::Service::Response::Build::InvoiceBuild
+					def default_values
+						super.merge({
+							message_errors_path: [:consultar_lote_rps_resposta, :lista_mensagem_retorno, :mensagem_retorno],
+							invoices_path:       [:consultar_lote_rps_resposta, :lista_nfse, :comp_nfse],
+						})
+					end
+
+					def response
+						@response ||= BrNfe::Service::Response::ConsultaLoteRps.new({
+							original_xml:     savon_response.xml.force_encoding('UTF-8'),
+							error_messages:   get_message_for_path(message_errors_path),
+							notas_fiscais:    get_invoices,
+						})
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/service/response/build/consulta_nfs_por_rps.rb

@@ -0,0 +1,25 @@
+#encoding UTF-8
+module BrNfe
+	module Service
+		module Response
+			module Build
+				class ConsultaNfsPorRps  < BrNfe::Service::Response::Build::InvoiceBuild
+					def default_values
+						super.merge({
+							message_errors_path: [:consultar_nfse_rps_resposta, :lista_mensagem_retorno, :mensagem_retorno],
+							invoices_path:       [:consultar_nfse_rps_resposta, :compl_nfse],
+						})
+					end
+
+					def response
+						@response ||= BrNfe::Service::Response::ConsultaNfsPorRps.new({
+							original_xml:     savon_response.xml.force_encoding('UTF-8'),
+							error_messages:   get_message_for_path(message_errors_path),
+							notas_fiscais:    get_invoices,
+						})
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/service/response/build/consulta_nfse.rb

@@ -0,0 +1,24 @@
+#encoding UTF-8
+module BrNfe
+	module Service
+		module Response
+			module Build
+				class ConsultaNfse  < BrNfe::Service::Response::Build::InvoiceBuild
+					def default_values
+						super.merge({
+							message_errors_path: [:consultar_nfse_resposta, :lista_mensagem_retorno, :mensagem_retorno],
+							invoices_path:       [:consultar_nfse_resposta, :lista_nfse, :compl_nfse]
+						})
+					end
+					def response
+						@response ||= BrNfe::Service::Response::ConsultaNfse.new({
+							original_xml:     savon_response.xml.force_encoding('UTF-8'),
+							error_messages:   get_message_for_path(message_errors_path),
+							notas_fiscais:    get_invoices,
+						})
+					end
+				end
+			end
+		end
+	end
+end