br_nfe 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e77a5cbdff4cafded676663364ef6f68055f3b
-  data.tar.gz: d0c49b3af3527a18a4d26c55659a69304cfdd11d
+  metadata.gz: 80696ac8940bce0f2a47e9bb39a4961cff396b4e
+  data.tar.gz: d42098edc7c7d84d6f2c6ea4a093816bbfd70b07
 SHA512:
-  metadata.gz: 7977655fcf845fb598ec32104ba446c616de4373fd4e8e753b03fa40c046e939f32055ef0a89cbfccb5171c27c1a42107b9d366534f610a8570040e1ec7989e5
-  data.tar.gz: 288138b94569b0d53a03d6cf2fdcce21b765369ad01587fc56f9326c4ceba11aefb7b5887e2c2859f524b7eda0085870fa37196e642891373704ae6ffd9465f6
+  metadata.gz: 2c9e451fcfa2ab498018eba404fd9659d9e03aa4a581249392906180725ecbe0a3c5cc3184fff5f3d11518481f1c6b889e7cc83b8231397306b723b8a4f3eb5c
+  data.tar.gz: f638d8c8e123db5f5bbc84ac5e2230730eaa89628e47bf7045bd2669f704e6aac9396944a45e7b7e273cb890c66492a5474040802d3c1821a839bb4f9626e5e3

data/Gemfile.lock

@@ -2,8 +2,8 @@ PATH
   remote: .
   specs:
     br_nfe (2.2.0)
-      activemodel (~> 4)
-      activesupport (~> 4)
+      activemodel (~> 4.2)
+      activesupport (~> 4.2)
       nokogiri (~> 1.6)
       rake (~> 10)
       savon (~> 2.11)
@@ -149,7 +149,7 @@ GEM
       wasabi (~> 3.4)
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
-    signer (1.4.3)
+    signer (1.5.0)
       nokogiri (>= 1.5.1)
     simplecov (0.10.0)
       docile (~> 1.1.0)
@@ -164,7 +164,7 @@ GEM
       railties (>= 3.1)
       slim (~> 3.0)
     slop (3.6.0)
-    socksify (1.7.0)
+    socksify (1.7.1)
     sprockets (3.2.0)
       rack (~> 1.0)
     sprockets-rails (2.3.2)

data/br_nfe.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |gem|
 	gem.required_ruby_version = ['~> 2.1', '~> 2.2', '~> 2.3']
 
 	gem.add_dependency "rake", '~> 10'
-	gem.add_dependency "activesupport", '~> 4'
-	gem.add_dependency "activemodel",   '~> 4'
+	gem.add_dependency "activesupport", '~> 4.2'
+	gem.add_dependency "activemodel",   '~> 4.2'
 	gem.add_dependency "nokogiri", "~> 1.6"
 	gem.add_dependency "savon", "~> 2.11"
 	gem.add_dependency "signer", "~> 1.4"

data/lib/br_nfe.rb

@@ -200,25 +200,6 @@ module BrNfe
 				autoload :IcmsUfDestino
 			end
 		end
-		module Gateway
-			extend ActiveSupport::Autoload
-			autoload :Base
-			autoload :WebServiceAM
-			autoload :WebServiceBA
-			autoload :WebServiceCE
-			autoload :WebServiceGO
-			autoload :WebServiceMG
-			autoload :WebServiceMS
-			autoload :WebServiceMT
-			autoload :WebServicePE
-			autoload :WebServicePR
-			autoload :WebServiceRS
-			autoload :WebServiceSP
-			autoload :WebServiceSVAN
-			autoload :WebServiceSvcAN
-			autoload :WebServiceSvcRS
-			autoload :WebServiceSVRS
-		end
 
 		module Evento
 			extend ActiveSupport::Autoload
@@ -250,6 +231,7 @@ module BrNfe
 			autoload :NfeConsultaProtocolo
 			autoload :NfeInutilizacao
 			autoload :NfeStatusServico
+			autoload :NfeRecepcaoEvento
 			autoload :Event
 			module Build
 				extend ActiveSupport::Autoload
@@ -259,8 +241,20 @@ module BrNfe
 				autoload :NfeConsultaProtocolo
 				autoload :NfeInutilizacao
 				autoload :NfeStatusServico
+				autoload :NfeRecepcaoEvento
 			end
 		end
+
+		module Reader
+			extend ActiveSupport::Autoload
+			autoload :Nfe			
+			autoload :Emitente
+			autoload :Destinatario
+			autoload :Transporte
+			autoload :EnderecoRetiradaEntrega
+			autoload :Fatura
+			autoload :Item
+		end
 	end
 
 
@@ -360,11 +354,19 @@ module BrNfe
 		mattr_accessor :transportador_product_class
 		@@transportador_product_class = BrNfe::Product::Nfe::Transporte::Transportador
 		
+		def self.load_settings
+			settings = {}
+			Dir[BrNfe.root+'/lib/config/settings/**/*.{yml}'].each do |file_path|
+				settings.deep_merge! YAML.load(File.open(file_path)).deep_symbolize_keys!
+			end
+			settings
+		end
+		mattr_accessor :settings
+		@@settings = BrNfe.load_settings
 	
 	def self.setup
 		yield self
 	end
-
 	######################### END CONFIGURAÇÕES #########################
 
 	include Helper

data/lib/br_nfe/base.rb

@@ -27,10 +27,6 @@ module BrNfe
 			false
 		end
 
-		def ssl_request?
-			false
-		end
-
 		def env
 			@env ||= :production
 		end
@@ -59,8 +55,9 @@ module BrNfe
 		end
 
 		# Deve conter o LINK do webservice a ser chamado
+		# TODO: Remover método quando reconfigurar a emissão das notas de serviço
 		#
-		def wsdl
+		def url_wsdl
 			raise "Não implementado."
 		end
 
@@ -167,29 +164,20 @@ module BrNfe
 			:v1
 		end
 
-		# Versão da requisição SSL caso o servidor necessite de autenticação SSL
-		# Valores possíveis: [:TLSv1_2, :TLSv1_1, :TLSv1, :SSLv3, :SSLv23]
-		# Default: :SSLv3
-		def ssl_version
-			:SSLv3
+		def client_wsdl_params
+			{
+				wsdl:             url_wsdl,
+				log:              BrNfe.client_wsdl_log,
+				pretty_print_xml: BrNfe.client_wsdl_pretty_print_xml,
+				ssl_verify_mode:  :none
+			}
 		end
 
 		# Cliente WSDL utilizado para fazer a requisição.
 		# Utilizando a gem savon.
 		# Veja mais detalhes em http://savonrb.com/version2/client.html
 		def client_wsdl
-			@client_wsdl ||= Savon.client do |global|
-				global.wsdl             wsdl
-				global.log              BrNfe.client_wsdl_log
-				global.pretty_print_xml BrNfe.client_wsdl_pretty_print_xml
-				global.ssl_verify_mode  :none
-				if ssl_request?
-					global.ssl_version           ssl_version
-					global.ssl_cert              certificate
-					global.ssl_cert_key          certificate_key
-					global.ssl_cert_key_password certificate_pkcs12_password
-				end
-			end
+			@client_wsdl ||= Savon.client client_wsdl_params
 		end
 
 		# Caso não tenha o certificate_pkcs12 salvo em arquivo, pode setar a string do certificate_pkcs12 direto pelo atributo certificate_pkcs12_value

data/lib/br_nfe/constants.rb

@@ -72,7 +72,5 @@ module BrNfe
 		NFE_SITUATION_CANCELED  = %w[101 151 218]
 		NFE_SITUATION_DENIED    = %w[110 205 301 302 303]
 		NFE_SITUATION_DRAFT     = %w[105 106 108 109 137 142]
-
-
 	end
 end

data/lib/br_nfe/endereco.rb

@@ -20,6 +20,10 @@ module BrNfe
 		attr_accessor :codigo_pais # defaul: 1058 (Brasil)
 		attr_accessor :nome_pais   # defaul: BRASIL
 
+		# Descrição do endereço. Utilizado para a leitura da NF-e quando a pessoa 
+		# possui um unico campo com todos os dados do endereço
+		attr_accessor :descricao
+
 		# Código IBGE do Estado (UF)
 		# Caso não seja setado um valor no atributo, irá pegar os primeiros 2
 		# dígitos do código IBGE do município.

data/lib/br_nfe/person.rb

@@ -13,6 +13,7 @@ module BrNfe
 		delegate :nome_municipio,  :nome_municipio=,   to: :endereco, prefix: :endereco
 		delegate :codigo_ibge_uf,  :codigo_ibge_uf=,   to: :endereco, prefix: :endereco
 		delegate :codigo_municipio,:codigo_municipio=, to: :endereco, prefix: :endereco
+		delegate :descricao,       :descricao=,        to: :endereco, prefix: :endereco
 		
 		# Obrigatórios
 		attr_accessor :cpf_cnpj

data/lib/br_nfe/product/destinatario.rb

@@ -27,6 +27,9 @@ module BrNfe
 				@indicador_ie ||= capture_indicador_ie
 				@indicador_ie.to_i
 			end
+			
+			attr_accessor :suframa
+
 			validate :validar_endereco
 
 			validates :indicador_ie, inclusion: {in: [1,2,9]}

data/lib/br_nfe/product/nf_xml_value.rb

@@ -258,7 +258,7 @@ module BrNfe
 				if evento.codigo_orgao.present?
 					evento.codigo_orgao
 				else
-					if gateway.is_a?(BrNfe::Product::Gateway::WebServiceSVAN) && evento.is_a?(BrNfe.cancelamento_product_class)
+					if gateway == :svan && evento.is_a?(BrNfe.cancelamento_product_class)
 						91
 					else
 						"#{evento.chave_nfe}"[0..1]

data/lib/br_nfe/product/nfe/cobranca/pagamento.rb

@@ -34,6 +34,19 @@ module BrNfe
 					attr_accessor :total
 					alias_attribute :vPag, :total
 
+					# TIPO DE INTEGRAÇÃO COM O CARTÃO
+					#   Tipo de Integração do processo de pagamento com o sistema de automação da empresa/ 
+					#   1 = Pagamento integrado com o sistema de automação da empresa Ex. equipamento TEF , Comercio Eletronico 
+					#   2 = Pagamento não integrado com o sistema de automação da empresa Ex: equipamento POS
+					# 
+					# <b>Type:     </b> _Float_
+					# <b>Required: </b> _Yes_
+					# <b>Exemplo:  </b> _1500.50_
+					# <b>tag:      </b> tpIntegra
+					#
+					attr_accessor :tipo_integracao
+					alias_attribute :tpIntegra, :tipo_integracao
+
 					# CNPJ da Credenciadora de cartão de crédito e/ou débito
 					# Informar o CNPJ da Credenciadora de cartão de crédito / débito
 					# 

data/lib/br_nfe/product/nota_fiscal.rb

@@ -1033,6 +1033,11 @@ module BrNfe
 					end
 				end
 
+			##################################################################################
+			#########################  DADOS SETADOS NA LEITURA DO XML #######################
+				attr_accessor :tipo_ambiente
+				alias_attribute :tbAmb, :tipo_ambiente
+
 			def default_values
 				{
 					versao_aplicativo:   0, 

data/lib/br_nfe/product/operation/base.rb

@@ -4,6 +4,9 @@ module BrNfe
 			class Base < BrNfe::Base
 				include NfXmlValue
 
+				# Versão da NF-e que irá pegar as configurações
+				attr_accessor :nfe_version
+
 				# Serve para saber se vai usar o módo de contingência, e se usar,
 				# serve para saber qual o tipo de contingência será utilizado.
 				# Options: [:normal, :svc]
@@ -12,6 +15,17 @@ module BrNfe
 				# <b>Default: </b> _:normal_
 				#
 				attr_accessor :tipo_emissao
+				def tipo_emissao= value
+					if "#{value}" == '1'
+						@tipo_emissao = :normal 
+					elsif "#{value}" == '9'
+						@tipo_emissao = :offline_nfce
+					elsif "#{value}".in?(%w[6 7])
+						@tipo_emissao = :svc
+					else
+						@tipo_emissao = value
+					end
+				end
 
 				# Informações que devem ser informadas quando a operação for em contingência.
 				#
@@ -41,6 +55,7 @@ module BrNfe
 				def default_values
 					{
 						tipo_emissao:   :normal,
+						nfe_version:    :v3_10,
 					}
 				end
 
@@ -48,97 +63,156 @@ module BrNfe
 					true
 				end
 
-				# Para as Notas fiscais de produto a autenticação via SSL é obrigatória
-				def ssl_request?
-					true
-				end
-
-				# O Gateway é responsável de identificar o Webservice de acordo com o Estado(UF).
-				# Irá identificar o webservice através do valor do método `ibge_code_of_issuer_uf`, 
-				# na qual pode ser setado diretamente ou pego através do endereço do emissor.
-				# Para ver a lista de WebService por estado acesse: http://www.nfe.fazenda.gov.br/portal/webServices.aspx
+				# Método utilizado para saber qual Webservice será utilizado.
+				# Deve sempre retornar um symbol de acordo com as configurações dos gateways.
 				#
-				# <b>Tipo de retorno: </b> _Object (Gateway::Base ou derivados)_
+				# <b>Tipo de retorno: </b> _Symbol_
 				#
 				def gateway
 					@gateway ||= case tipo_emissao
 					when :normal
 						get_gateway_by_normal_operation
 					when :svc
-						get_gateway_by_svc_operation					
+						get_gateway_by_svc_operation
 					end
 				end
 
+				# Configurações das operações da nota fiscal de acordo com a versão.
+				#
+				def nfe_settings
+					BrNfe.settings[:nfe][nfe_version]
+				end
+
+				# Método que retorna as configurações do Servidor da Sefaz a ser utilziada.
+				# Irá retornar um Hash com as seguntes chaves:
+				#  - :operation   => Contém qual a versão do XML que é utilizado, qual o método
+				#                    da operação e a url do xmlns raiz que será adicionado no XML
+				#  - :soap_client => Contém as configurações para instanciar o client Soap com o Savon.
+				#  - :xml_paths   => Contém os caminhos com namespace para encontrar os valores dentro dos XMLS
+				#
+				# <b>Tipo de retorno: </b> _Symbol_ 
+				#
+				def gateway_settings
+					nfe_settings[:gateway][gateway]
+				end
+
+
 				# WebServices utilizados para contingência em SVC (Servidor Virtual de Contingência)
 				# Existe 2 servidores de contingência para SVC: O `SVC-AN` e `SVC-RS`
 				# Cada estado(UF) é autorizado a emitir notas em contingência em apenas 1 dos servidores.
 				# Esse método é responsável em setar qual o WebService será utilizado para cada UF.
 				#
-				# <b>Tipo de retorno: </b> _Object (::WebServiceSvcRS ou ::WebServiceSvcAN)_
+				# <b>Tipo de retorno: </b> _Hash_
 				#
 				def get_gateway_by_svc_operation
 					case ibge_code_of_issuer_uf
 					#    'AM', 'BA', 'CE', 'GO', 'MA', 'MS', 'MT', 'PA', 'PE', 'PI', 'PR'
 					when '13', '29', '23', '52', '21', '50', '51', '15', '26', '22', '41'
-						BrNfe::Product::Gateway::WebServiceSvcRS.new({env: env})
+						:svc_rs
 					else # AC, AL, AP, DF, ES, MG, PB, RJ, RN, RO, RR, RS, SC, SE, SP, TO 
-						BrNfe::Product::Gateway::WebServiceSvcAN.new({env: env})					
+						:svc_an
 					end
 				end
 
 				# Seta o WebService quando o tipo de emissão for normal para cada UF
 				#
-				# <b>Tipo de retorno: </b> _Object (Gateway::Base ou derivados)_
+				# <b>Tipo de retorno: </b> _Hash_
 				#
 				def get_gateway_by_normal_operation				
-					case ibge_code_of_issuer_uf
+					case "#{ibge_code_of_issuer_uf}"
 					when '13'
-						BrNfe::Product::Gateway::WebServiceAM.new({env: env})
+						:am
 					when '29'
-						BrNfe::Product::Gateway::WebServiceBA.new({env: env})
+						:ba
 					when '23'
-						BrNfe::Product::Gateway::WebServiceCE.new({env: env})
+						:ce
 					when '52'
-						BrNfe::Product::Gateway::WebServiceGO.new({env: env})
+						:go
 					when '31'
-						BrNfe::Product::Gateway::WebServiceMG.new({env: env})
+						:mg
 					when '50'
-						BrNfe::Product::Gateway::WebServiceMS.new({env: env})
+						:ms
 					when '51'
-						BrNfe::Product::Gateway::WebServiceMT.new({env: env})
+						:mt
 					when '26'
-						BrNfe::Product::Gateway::WebServicePE.new({env: env})
+						:pe
 					when '41'
-						BrNfe::Product::Gateway::WebServicePR.new({env: env})
+						:pr
 					when '43'
-						BrNfe::Product::Gateway::WebServiceRS.new({env: env})
+						:rs
 					when '35'
-						BrNfe::Product::Gateway::WebServiceSP.new({env: env})
-					when '21', '15', '22'
-						BrNfe::Product::Gateway::WebServiceSVAN.new({env: env})
-					else
-						BrNfe::Product::Gateway::WebServiceSVRS.new({env: env})
+						:sp
+					when '21', '15' # MA, PA
+						:svan
+					else 
+						# AC, AL, AP, ES, DF, PB, RJ, RM, RO, RR, SC, PI
+						# 12, 27, 16, 32, 53, 25, 33, 24, 11, 14, 42, 22
+						:svrs
 					end
 				end
 
+				def operation_name
+					raise NotImplementedError.new("Not implemented #operation_name in #{self}.")
+				end
+
+				# Método SOAP que será chamado para enviar o XML
+				#
+				# <b>Tipo de retorno: </b> _Symbol_
+				#
+				def method_wsdl
+					gateway_settings[:operation][operation_name][env][:operation_method]
+				end
+
 				# Valor utilizado para inserir a url do xmlns nas tags nfeCabecMsg e nfeDadosMsg.
-				# Como a url pode variar de acordo com o tipo de serviço e UF, deve ser sobrescrita
-				# na subclass de cada serviço.
+				# URL que será setada no atribto xmlns do XML;
+				# Ex:
+				#  nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NfeStatusServico2"
 				#
 				# <b>Tipo de retorno: </b> _String_
 				#
 				def url_xmlns
-					raise "O método #url_xmlns deve ser implementar em cada operação"
+					gateway_settings[:operation][operation_name][env][:url_xmlns]
 				end
 
-				# Irá retornar a versão setada de acordo com o serviço e estado.
-				# Deve ser sobrescrito para cada serviço e irá pegar a versão do XML
-				# de acordo com o Estado e Serviço, conforme descrito em: http://www.nfe.fazenda.gov.br/portal/webServices.aspx
+				# Versão utilizada pelo webservice do  estado para determinada ação.
+				# Irá retornar a versão setada de acordo com o serviço e estado conforme 
+				# descrito em: http://www.nfe.fazenda.gov.br/portal/webServices.aspx
 				#
 				# <b>Tipo de retorno: </b> _Symbol_
 				#
 				def gateway_xml_version
-					raise "O método #gateway_xml_version deve ser implementar em cada operação"
+					gateway_settings[:operation][operation_name][env][:xml_version]
+				end
+
+				# Retorna o xmlns utilizada para identificar o envelope da requisição SOAP
+				# Normalmente é http://www.w3.org/2003/05/soap-envelope
+				#
+				# <b>Tipo de retorno: </b> _String_
+				#
+				def xmlns_soap
+					gateway_settings[:operation][operation_name][env][:xmlns_soap]
+				end
+
+				# Parâmetros específicos para cada servidor de cada estado para
+				# que seja instanciado o Client WSDL savon.
+				#
+				# <b>Tipo de retorno: </b> _Hash_
+				#
+				def client_wsdl_params
+					super.merge({
+						ssl_version:           :SSLv3, # Valores possíveis: [:TLSv1_2, :TLSv1_1, :TLSv1, :SSLv3, :SSLv23]
+						ssl_cert:              certificate,
+						ssl_cert_key:          certificate_key,
+						ssl_cert_key_password: certificate_pkcs12_password,
+					}).merge(gateway_settings[:soap_client][operation_name][env])
+				end
+
+
+				# Deve conter o LINK do webservice a ser chamado
+				# TODO: Remover método
+				#
+				def url_wsdl
+					''
 				end
 
 				# Versão do XML utilizado na requisição.
@@ -206,10 +280,10 @@ module BrNfe
 					when :normal 
 						1
 					when :svc
-						if gateway.is_a?(BrNfe::Product::Gateway::WebServiceSvcAN) # SVC-AN
-							6
-						else # SVC-RS
-							7
+						if gateway == :svc_rs
+							7 # SVC-RS
+						else
+							6 # SVC-AN
 						end
 					end
 				end
@@ -243,8 +317,8 @@ module BrNfe
 
 				def get_response
 					builder = response_class_builder.new do |builder|
-						builder.savon_response = @savon_response
-						builder.operation      = self
+						builder.savon_response    = @savon_response
+						builder.operation         = self
 					end
 					builder.assign_attributes(builder_response_params)
 					builder.response