br_nfe 1.1.0 → 2.0.0

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

@@ -0,0 +1,185 @@
+module BrNfe
+	module Response
+		module Service
+			class Default  < BrNfe::ActiveModelBase
+				
+				# Array contendo as mensagens de erros
+				# No array pode conter Hash (com :codigo, :mensagem e :correcao)
+				# mas também pode conter mensagens de texto puro
+				#
+				# <b>Tipo de retorno: </b> _Array_
+				#
+				attr_accessor :error_messages
+				
+				# Array contendo as notas fiscais encontradas no xml de retorno.
+				# Utillizado em algumas requisições onde pode ser que retorne algum XML de NFe
+				# É um Array contendo objetos da classe BrNfe::Response::Service::NotaFiscal
+				#
+				# <b>Tipo de retorno: </b> _Array_
+				#
+				attr_accessor :notas_fiscais
+
+				# Número do protocolo de recebimento do XML
+				# Setado normalmente quando é enviado um lote RPS
+				# para processamento.
+				# O valor desse atributo é utilizado para posteriormente
+				# fazer a consulta para saber se o RPS já foi processado
+				#
+				# <b>Tipo de retorno: </b> _Integer_ ou _String_
+				#
+				attr_accessor :protocolo
+				
+				# Data/Data hora do recebimento do XML pelo orgão emissor
+				# Nesse atrubuto pe setado a data/hora na qual o orgão emissor
+				# recebeu o XML que foi enviado.
+				# também é nesse atributo que é setado a data/hora do processamento
+				# da NF-e (nos casos de consulta)
+				#
+				# <b>Tipo de retorno: </b> _DateTime_
+				#
+				attr_accessor :data_recebimento
+				
+				# Número do lote RPS
+				# Nesse atributo é setado o número do lote RPS
+				# quando o mesmo for retornado na resposta
+				#
+				# <b>Tipo de retorno: </b> _Integer_
+				#
+				attr_accessor :numero_lote
+				
+				# XML original da resposta
+				# Contém todo o XML Envelope da resposta SOAP
+				#
+				# <b>Tipo de retorno: </b> _String_ XML
+				#
+				attr_accessor :original_xml
+
+				# Data e hora do cancelamento da NF-e
+				# utilizado apenas para o Cancelamento da NF
+				#
+				# <b>Tipo de retorno: </b> _DateTime_
+				#
+				attr_accessor :cancelation_date_time
+
+				# Status possíveis
+				# [:success, :falied, :soap_error, :http_error, :unknown_error]
+				#
+				# <b>Tipo de retorno: </b> _Hash_
+				#
+				attr_accessor :status
+
+				# Código da situação do lote RPS
+				# Utilizado para saber se o Lote RPS já foi processado
+				# e se foi processado com sucesso ou teve algum erro
+				#
+				# <b>Tipo de retorno: </b> _Integer_ ou _String_
+				#
+				attr_accessor :situation
+				def situation
+					@situation ||= get_situation_by_message_codes if error_messages.present?
+					@situation
+				end
+
+				def situation_unreceived_code_errors
+					@situation_unreceived_code_errors ||= []
+					@situation_unreceived_code_errors+['E4']
+				end
+				def situation_unreceived_code_errors=(value)
+					@situation_unreceived_code_errors = [value].flatten
+				end
+
+				def situation_unprocessed_code_errors
+					@situation_unprocessed_code_errors ||= []
+					@situation_unprocessed_code_errors+['E92']
+				end
+				def situation_unprocessed_code_errors=(value)
+					@situation_unprocessed_code_errors = [value].flatten
+				end
+
+				def situation_success_code_errors
+					@situation_success_code_errors ||= []
+					@situation_success_code_errors#+[]
+				end
+				def situation_success_code_errors=(value)
+					@situation_success_code_errors = [value].flatten
+				end
+
+				# Como alguns orgãos emissores (como a Betha) não tem a capacidade
+				# de programar para colocar o codigo da situação em determinados momentos
+				# e simplesmente colocam uma mensagem de erro na resposta sem setar a situação
+				# foi necessário construir esse método para que a partir dos códigos das mensagens
+				# seja possível distinguir qual a situação atual do lote enviado.
+				# Por exemplo: Quando retornar o erro com código 'E92' quer dizer que a situação
+				# do lote é :unprocessed. Equivalente ao código de situação 2
+				#
+				# <b>Tipo de retorno: </b> _Symbol_
+				#
+				def get_situation_by_message_codes
+					if (situation_unprocessed_code_errors & message_codes).any?
+						:unprocessed
+					elsif (situation_unreceived_code_errors & message_codes).any?
+						:unreceived
+					elsif (situation_success_code_errors & message_codes).any?
+						:success
+					elsif message_codes.any?
+						:error
+					end				
+				end
+
+				def initialize(attributes = {})
+					self.notas_fiscais  = [] # Para poder utilizar o <<
+					self.error_messages = [] # Para poder utilizar o <<
+					super
+				end
+				
+				def notas_fiscais
+					@notas_fiscais = [@notas_fiscais].flatten # Para retornar sempre um vetor
+				end
+
+				def error_messages
+					@error_messages = [@error_messages].flatten
+				end
+
+				# Método para saber se a conexão com a prefeitura foi mal-sucedida.
+				# Caso ocorra algum erro na requisição irá retornar true.
+				#
+				# <b>Tipo de retorno: </b> _Boolean_
+				#
+				def unsuccessful_request?
+					status.in?([:soap_error, :http_error, :unknown_error])
+				end
+
+				# Método para saber se a conexão com a prefeitura foi bem-sucedida.
+				# Caso a requisição ocorra certo e não apresente nenhuma exception
+				# irá retornar true.
+				#
+				# <b>Tipo de retorno: </b> _Boolean_
+				#
+				def successful_request?
+					!unsuccessful_request?
+				end
+
+				def success?
+					status == :success
+				end
+
+				def status
+					@status ||= get_status
+				end
+
+				def get_status
+					error_messages.blank? ? :success : :falied
+				end
+
+				# Retorna um array apenas com os códigos das mensagens de erro.
+				# Sempre retornar o código no formato de String.
+				#
+				# <b>Tipo de retorno: </b> _Array_
+				#
+				def message_codes
+					@message_codes ||= error_messages.select{|msg| msg.is_a?(Hash)}.map{|msg| msg[:code].try(:to_s) }
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/{servico/response → response/service}/nota_fiscal.rb

@@ -1,6 +1,6 @@
 module BrNfe
-	module Servico
-		module Response
+	module Response
+		module Service
 			class NotaFiscal < BrNfe::ActiveModelBase
 				include BrNfe::Helper::HaveIntermediario
 				include BrNfe::Helper::HaveDestinatario
@@ -11,6 +11,7 @@ module BrNfe
 				attr_accessor :codigo_verificacao
 				attr_accessor :data_emissao
 				attr_accessor :url_nf
+				attr_accessor :xml_nf
 				
 				#identificacao do rps
 				attr_accessor :rps_numero
@@ -27,23 +28,23 @@ module BrNfe
 				
 				# dados dos serviços
 				attr_accessor :item_lista_servico
-				attr_accessor :codigo_cnae
-				attr_accessor :discriminacao
+				attr_accessor :cnae_code
+				attr_accessor :description
 				attr_accessor :codigo_municipio
 
 				#Valores dos serviços
-				attr_accessor :valor_servicos
-				attr_accessor :valor_deducoes
+				attr_accessor :total_services
+				attr_accessor :deductions
 				attr_accessor :valor_pis
 				attr_accessor :valor_cofins
 				attr_accessor :valor_inss
 				attr_accessor :valor_ir
 				attr_accessor :valor_csll
-				attr_accessor :iss_retido
+				attr_accessor :iss_retained
 				attr_accessor :outras_retencoes
-				attr_accessor :valor_iss
-				attr_accessor :base_calculo
-				attr_accessor :aliquota
+				attr_accessor :total_iss
+				attr_accessor :base_calculation
+				attr_accessor :iss_tax_rate
 				attr_accessor :valor_liquido # v2
 				attr_accessor :desconto_condicionado # v2
 				attr_accessor :desconto_incondicionado # v2

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

@@ -0,0 +1,93 @@
+module BrNfe
+	module Service
+		module Response
+			module Paths
+				module Base
+					# Caminho referente ao caminho do número do lote
+					def lot_number_path; [] end
+					
+					# Caminho para encontrar o número do protocolo
+					def protocol_path; [] end
+					
+					# Caminho para encontrar a data de recebimento do lote/rps/nfe
+					def received_date_path; [] end
+
+					# Caminho para encontrar a situação
+					def situation_path; [] end
+					
+					# Chaves para formatar a situação do Lote RPS
+					def situation_key_values
+						{
+							'1' =>  :unreceived, # Não Recebido
+							'2' =>  :unprocessed,# Não Processado
+							'3' =>  :error,      # Processado com Erro
+							'4' =>  :success,    # Processado com Sucesso
+						}
+					end
+					
+					# Caminho para encontrar a data e hora do cancelamento da nF
+					def cancelation_date_time_path; [] end
+					
+					def message_errors_path; [] end
+					def message_code_key;     :codigo   end
+					def message_msg_key;      :mensagem end
+					def message_solution_key; :correcao end
+
+					# Caminho referente ao caminho onde se encontra as notas fiscais
+					# poderá encontrar apenas uma ou várias
+					def invoices_path; [] end
+					
+					# Demais caminhos para encontrar os dados da NF-e
+					def invoice_numero_nf_path;               [] end
+					def invoice_codigo_verificacao_path;      [] end
+					def invoice_data_emissao_path;            [] end
+					def invoice_url_nf_path;                  [] end
+					def invoice_rps_numero_path;              [] end
+					def invoice_rps_serie_path;               [] end
+					def invoice_rps_tipo_path;                [] end
+					def invoice_rps_situacao_path;            [] end
+					def invoice_rps_substituido_numero_path;  [] end
+					def invoice_rps_substituido_serie_path;   [] end
+					def invoice_rps_substituido_tipo_path;    [] end
+					def invoice_data_emissao_rps_path;        [] end
+					def invoice_competencia_path;             [] end
+					def invoice_outras_informacoes_path;      [] end
+					def invoice_item_lista_servico_path;      [] end
+					def invoice_cnae_code_path;               [] end
+					def invoice_description_path;             [] end
+					def invoice_codigo_municipio_path;        [] end
+					def invoice_total_services_path;          [] end
+					def invoice_deductions_path;              [] end
+					def invoice_valor_pis_path;               [] end
+					def invoice_valor_cofins_path;            [] end
+					def invoice_valor_inss_path;              [] end
+					def invoice_valor_ir_path;                [] end
+					def invoice_valor_csll_path;              [] end
+					def invoice_iss_retained_path;            [] end
+					def invoice_outras_retencoes_path;        [] end
+					def invoice_total_iss_path;               [] end
+					def invoice_base_calculation_path;        [] end
+					def invoice_iss_tax_rate_path;            [] end
+					def invoice_valor_liquido_path;           [] end
+					def invoice_desconto_condicionado_path;   [] end
+					def invoice_desconto_incondicionado_path; [] end
+					def invoice_responsavel_retencao_path;    [] end
+					def invoice_numero_processo_path;         [] end
+					def invoice_municipio_incidencia_path;    [] end
+					def invoice_orgao_gerador_municipio_path; [] end
+					def invoice_orgao_gerador_uf_path;        [] end
+					def invoice_cancelamento_codigo_path;     [] end
+					def invoice_cancelamento_numero_nf_path;  [] end
+					def invoice_cancelamento_cnpj_path;       [] end
+					def invoice_cancelamento_municipio_path;  [] end
+					def invoice_cancelamento_sucesso_path;    [] end
+					def invoice_cancelamento_data_hora_path;  [] end
+					def invoice_nfe_substituidora_path;       [] end
+					def invoice_codigo_obra_path;             [] end
+					def invoice_codigo_art_path;              [] end
+					def invoice_cancelamento_inscricao_municipal_path; [] end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/response/service/paths/v1/servico_cancelar_nfse_resposta.rb

@@ -0,0 +1,22 @@
+module BrNfe
+	module Service
+		module Response
+			module Paths
+				module V1
+					module ServicoCancelarNfseResposta
+						include BrNfe::Service::Response::Paths::Base
+						
+						# def message_alerts_path; [] end
+						def message_errors_path
+							[:cancelar_nfse_resposta, :lista_mensagem_retorno, :mensagem_retorno]
+						end
+
+						def cancelation_date_time_path
+							[:cancelar_nfse_resposta, :cancelamento, :confirmacao, :inf_confirmacao_cancelamento, :data_hora]
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/response/service/paths/v1/servico_consultar_lote_rps_resposta.rb

@@ -0,0 +1,25 @@
+module BrNfe
+	module Service
+		module Response
+			module Paths
+				module V1
+					module ServicoConsultarLoteRpsResposta
+						include BrNfe::Service::Response::Paths::Base
+						include BrNfe::Service::Response::Paths::V1::TcNfse
+
+						# def message_alerts_path; [] end
+						def message_errors_path
+							[:consultar_lote_rps_resposta, :lista_mensagem_retorno, :mensagem_retorno]
+						end
+
+						# Caminho referente ao caminho onde se encontra as notas fiscais
+						# poderá encontrar apenas uma ou várias
+						def invoices_path
+							[:consultar_lote_rps_resposta, :lista_nfse, :comp_nfse]
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/response/service/paths/v1/servico_consultar_nfse_resposta.rb

@@ -0,0 +1,25 @@
+module BrNfe
+	module Service
+		module Response
+			module Paths
+				module V1
+					module ServicoConsultarNfseResposta
+						include BrNfe::Service::Response::Paths::Base
+						include BrNfe::Service::Response::Paths::V1::TcNfse
+
+						# def message_alerts_path; [] end
+						def message_errors_path
+							[:consultar_nfse_resposta, :lista_mensagem_retorno, :mensagem_retorno]
+						end
+
+						# Caminho referente ao caminho onde se encontra as notas fiscais
+						# poderá encontrar apenas uma ou várias
+						def invoices_path
+							[:consultar_nfse_resposta, :lista_nfse, :comp_nfse]
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/response/service/paths/v1/servico_consultar_nfse_rps_resposta.rb

@@ -0,0 +1,25 @@
+module BrNfe
+	module Service
+		module Response
+			module Paths
+				module V1
+					module ServicoConsultarNfseRpsResposta
+						include BrNfe::Service::Response::Paths::Base
+						include BrNfe::Service::Response::Paths::V1::TcNfse
+
+						# def message_alerts_path; [] end
+						def message_errors_path
+							[:consultar_nfse_rps_resposta, :lista_mensagem_retorno, :mensagem_retorno]
+						end
+
+						# Caminho referente ao caminho onde se encontra as notas fiscais
+						# poderá encontrar apenas uma ou várias
+						def invoices_path
+							[:consultar_nfse_rps_resposta, :comp_nfse]
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/response/service/paths/v1/servico_consultar_situacao_lote_rps_resposta.rb

@@ -0,0 +1,31 @@
+module BrNfe
+	module Service
+		module Response
+			module Paths
+				module V1
+					module ServicoConsultarSituacaoLoteRpsResposta
+						include BrNfe::Service::Response::Paths::Base
+
+						# Caminho referente ao caminho do número do lote
+						def lot_number_path
+							[:consultar_situacao_lote_rps_resposta, :numero_lote] 
+						end
+						
+						# Caminho para encontrar o número do protocolo
+						def situation_path
+							[:consultar_situacao_lote_rps_resposta, :situacao] 
+						end
+						
+						# def message_alerts_path; [] end
+						def message_errors_path
+							[:consultar_situacao_lote_rps_resposta, :lista_mensagem_retorno, :mensagem_retorno]
+						end
+						# def message_code_key;     :codigo   end
+						# def message_msg_key;      :mensagem end
+						# def message_solution_key; :correcao end						
+					end
+				end
+			end
+		end
+	end
+end