br_nfe 2.1.0 → 2.1.1

data/lib/br_nfe/constants.rb

@@ -0,0 +1,33 @@
+module BrNfe
+	module Constants
+		CODIGO_IBGE_UF = [
+			'11', #  Rondônia
+			'12', #  Acre
+			'13', #  Amazonas
+			'14', #  Roraima
+			'15', #  Pará
+			'16', #  Amapá
+			'17', #  Tocantins
+			'21', #  Maranhão
+			'22', #  Piauí
+			'23', #  Ceará
+			'24', #  Rio Grande do Norte
+			'25', #  Paraíba
+			'26', #  Pernambuco
+			'27', #  Alagoas
+			'28', #  Sergipe
+			'29', #  Bahia
+			'31', #  Minas Gerais
+			'32', #  Espírito Santo
+			'33', #  Rio de Janeiro
+			'35', #  São Paulo
+			'41', #  Paraná
+			'42', #  Santa Catarina
+			'43', #  Rio Grande do Sul
+			'50', #  Mato Grosso do Sul
+			'51', #  Mato Grosso
+			'52', #  Goiás
+			'53', #  Distrito Federal	
+		]	
+	end
+end

data/lib/br_nfe/endereco.rb

@@ -15,11 +15,21 @@ module BrNfe
 		attr_accessor :nome_municipio
 		attr_accessor :codigo_municipio # IBGE
 		attr_accessor :uf
+		attr_accessor :codigo_ibge_uf
 		attr_accessor :cep
 		attr_accessor :codigo_pais # defaul: 1058 (Brasil)
 		attr_accessor :nome_pais   # defaul: BRASIL
 
+		# 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.
+		#
+		def codigo_ibge_uf
+			@codigo_ibge_uf || "#{codigo_municipio}"[0..1]
+		end
+
 		validates :logradouro, :numero, :bairro, :codigo_municipio, :uf, :cep, presence: true
+		validates :codigo_ibge_uf, inclusion: {in: BrNfe::Constants::CODIGO_IBGE_UF}, allow_blank: true
 
 		def is_present?
 			logradouro.present? || numero.present? || complemento.present? || 

data/lib/br_nfe/helper/string_methods.rb

@@ -1,6 +1,10 @@
 # -*- encoding: utf-8 -*-
 module BrNfe
 	module StringMethods
+
+		def br_nfe_escape_html
+			CGI::escapeHTML(self)
+		end
 		 
 		def to_valid_format_nf
 			remove_accents.upcase

data/lib/br_nfe/{emitente.rb → person.rb}

@@ -1,24 +1,28 @@
 module BrNfe
-	class Emitente  < BrNfe::ActiveModelBase
-		include BrNfe::Helper::HaveAddress
+	class Person  < BrNfe::ActiveModelBase
+		include BrNfe::Association::HaveAddress
 		
 		# Obrigatórios
-		attr_accessor :cnpj
-		attr_accessor :inscricao_municipal
+		attr_accessor :cpf_cnpj
+		alias_attribute :cpf,  :cpf_cnpj
+		alias_attribute :cnpj, :cpf_cnpj
 		attr_accessor :razao_social
-		attr_accessor :natureza_operacao
 
 		#Não obrigatórios
 		attr_accessor :nome_fantasia
 		attr_accessor :telefone
 		attr_accessor :email
+		
 		attr_accessor :regime_especial_tributacao
+		attr_accessor :natureza_operacao
+		attr_accessor :inscricao_municipal
+		attr_accessor :inscricao_estadual
+		attr_accessor :inscricao_suframa
 		attr_accessor :optante_simples_nacional
 		attr_accessor :incentivo_fiscal
 
 
-		validates :inscricao_municipal, :natureza_operacao, :cnpj, :razao_social, presence: true
-		validate :validar_endereco
+		validates :cpf_cnpj, :razao_social, presence: true
 		
 		def razao_social
 			"#{@razao_social}".to_valid_format_nf

data/lib/br_nfe/product/base.rb

@@ -0,0 +1,82 @@
+module BrNfe
+	module Product
+		class Base < BrNfe::Base
+			include ValueNf
+
+			def certificado_obrigatorio?
+				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
+			#
+			# <b>Tipo de retorno: </b> _Object (Gateway::Base ou derivados)_
+			#
+			def gateway
+				case ibge_code_of_issuer_uf
+				when '12', '27', '16', '53', '32', '25', '33', '24', '43', '11', '14', '42', '28', '17'
+					BrNfe::Product::Gateway::WebServiceSVRS.new({env: env})
+				end
+			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.
+			#
+			# <b>Tipo de retorno: </b> _String_
+			#
+			def url_xmlns
+				raise "O método #url_xmlns deve ser implementar em cada operação"
+			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
+			#
+			# <b>Tipo de retorno: </b> _Symbol_
+			#
+			def gateway_xml_version
+				raise "O método #gateway_xml_version deve ser implementar em cada operação"
+			end
+
+			# Versão do XML utilizado na requisição.
+			# Como a versão do XML pode divergir para cada estado/servidor e serviço,
+			# é necessário passar a versão do XML na requisição para o servidor saber qual
+			# validação aplicar e como pegar os dados.
+			# Esse método tem o intuíto de pegar a versão setada no Gateway de cada UF e serviço
+			# e transformar em uma String aplicável no XML.
+			# Exemplo:
+			#    Se a versão do xml for :v3_10
+			#    Esse método irá transformar o valor em '3.10'
+			#
+			# <b>Tipo de retorno: </b> _String_
+			#
+			def xml_version
+				"#{gateway_xml_version}".gsub('_','.').gsub(/[^\d\.]/,'')
+			end
+
+			# Declaro que o método `render_xml` irá verificar os arquivos também presentes
+			# nos diretórios especificados
+			#
+			# <b>Tipo de retorno: </b> _Array_
+			def xml_current_dir_path
+				["#{BrNfe.root}/lib/br_nfe/product/xml/#{gateway_xml_version}", "#{BrNfe.root}/lib/br_nfe/product/xml"]+super
+			end
+			
+			def request
+				client_wsdl.call(method_wsdl, xml: soap_xml)
+			end
+
+			def emitente_class
+				BrNfe.emitente_product_class
+			end
+		end
+	end
+end

data/lib/br_nfe/product/consulta_status_servico.rb

@@ -0,0 +1,35 @@
+module BrNfe
+	module Product
+		class ConsultaStatusServico < BrNfe::Product::Base
+			# URL que será setada no atribto xmlns do XML;
+			# Ex:
+			# nfeCabecMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NfeStatusServico2"
+			def url_xmlns
+				gateway.url_xmlns_status_servico
+			end
+
+			# URL do webservice para enviar as informações.
+			# Ex:
+			# https://www.sefazvirtual.fazenda.gov.br/NfeInutilizacao2/NfeInutilizacao2.asmx?wsdl
+			def wsdl
+				gateway.wsdl_status_servico
+			end
+
+			# Método SOAP que será chamado para enviar o XML
+			def method_wsdl
+				gateway.operation_status_servico
+			end
+
+			# Versão utilizada pelo webservice do  estado para determinada ação.
+			def gateway_xml_version
+				gateway.version_xml_status_servico
+			end
+
+			# XML que será enviado no body da requisição SOAP contendo as informações
+			# específicas de cada operação.
+			def xml_builder
+				render_xml 'consulta_status_servico'
+			end
+		end
+	end
+end

data/lib/br_nfe/product/emitente.rb

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

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

@@ -0,0 +1,62 @@
+module BrNfe
+	module Product
+		module Gateway
+			class Base < BrNfe::ActiveModelBase
+
+				attr_accessor :env
+
+				def env_production?; env == :production end
+
+				##########################################################################################
+				################################  NFE STATUS SERVIÇO  ####################################
+					# Serviço destinado à consulta do status do serviço prestado pelo 
+					# Portal da Secretaria de Fazenda Estadual
+					# Traduzindo: Utilizado para saber se o SEFAZ do estado está em operação
+					#
+					# O processamento do pedido de consulta de status de Serviço pode resultar em uma
+					# mensagem de erro ou retornar a situação atual do Servidor de Processamento, códigos de
+					# situação 
+					#   + 107 - Serviço em Operação
+					#   + 108 - Serviço Paralisado Temporariamente
+					#   + 109 - Serviço Paralisado sem Previsão
+					# A critério da UF o campo xObs pode ser utilizado para
+					# fornecer maiores informações ao contribuinte, como por exemplo: “manutenção programada”,
+					# “modificação de versão do aplicativo”, “previsão de retorno”, etc.
+					#
+					# Processo: síncrono.
+					# Método: nfeStatusServico
+					def wsdl_status_servico
+						raise "O método #wsdl_status_servico deve ser implementado no webservice de cada estado"
+					end
+					def operation_status_servico
+						raise "O método #operation_status_servico deve ser implementado no webservice de cada estado"
+					end
+					def version_xml_status_servico
+						raise "O método #version_xml_status_servico deve ser implementado no webservice de cada estado"
+					end
+					# URL que é adicionado nas tags Header/nfeCabecMsg e Body/nfeDadosMsg
+					def url_xmlns_status_servico
+						raise "O método #url_xmlns_status_servico deve ser implementado no webservice de cada estado"
+					end
+
+				##########################################################################################
+				################################  NFE AUTORIZAÇÃO  #######################################
+					# Serviço destinado à recepção de mensagens de lote de NF-e.
+					# Traduzindo: Serviço destinando a enviar as notas fiscais para o SEFAZ
+					#
+					# Processo: assíncrono.
+					# Método: nfeAutorizacaoLote
+					#
+					def wsdl_autorizacao
+					end
+					def operation_autorizacao
+					end
+					def version_xml_autorizacao
+					end					
+					# URL que é adicionado nas tags Header/nfeCabecMsg e Body/nfeDadosMsg
+					def url_xmlns_autorizacao
+					end
+			end
+		end
+	end
+end

data/lib/br_nfe/product/gateway/web_service_svrs.rb

@@ -0,0 +1,39 @@
+module BrNfe
+	module Product
+		module Gateway
+			class WebServiceSVRS < Base
+
+				##########################################################################################
+				################################  NFE STATUS SERVIÇO  ####################################
+					def wsdl_status_servico
+						if env_production?
+							'https://nfe.sefazrs.rs.gov.br/ws/NfeStatusServico/NfeStatusServico2.asmx?wsdl'
+						else
+							'https://nfe-homologacao.svrs.rs.gov.br/ws/NfeStatusServico/NfeStatusServico2.asmx?wsdl'
+						end
+					end
+					def operation_status_servico
+						:nfe_status_servico_nf2
+					end
+					def version_xml_status_servico
+						:v3_10
+					end
+					def url_xmlns_status_servico
+						'http://www.portalfiscal.inf.br/nfe/wsdl/NfeStatusServico2'
+					end
+
+				##########################################################################################
+				################################  NFE AUTORIZAÇÃO  #######################################
+					# def wsdl_autorizacao
+						# 'https://nfe.svrs.rs.gov.br/ws/NfeAutorizacao/NFeAutorizacao.asmx?wsdl'
+					# end
+					# def operation_autorizacao
+						# :nfe_autorizacao_lote
+					# end
+					# def version_xml_autorizacao
+						# :v3_10
+					# end
+			end
+		end
+	end
+end

data/lib/br_nfe/product/value_nf.rb

@@ -0,0 +1,9 @@
+module BrNfe
+	module Product
+		module ValueNf
+			def value_nf_tp_amb value, xml_version=:v3_10
+				value == :production ? '1' : '2'
+			end
+		end
+	end
+end

data/lib/br_nfe/product/xml/soap_env.xml.slim

@@ -0,0 +1,8 @@
+soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+	soap:Header
+		nfeCabecMsg xmlns="#{url_xmlns}"
+			cUF = ibge_code_of_issuer_uf
+			versaoDados = xml_version
+	soap:Body
+		nfeDadosMsg xmlns="#{url_xmlns}"
+			= content_xml.html_safe

data/lib/br_nfe/product/xml/v3_10/XSD/consReciNFe_v3.10.xsd

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns="http://www.portalfiscal.inf.br/nfe" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.portalfiscal.inf.br/nfe" elementFormDefault="qualified" attributeFormDefault="unqualified">
+	<xs:include schemaLocation="leiauteNFe_v3.10.xsd"/>
+	<xs:element name="consReciNFe" type="TConsReciNFe">
+		<xs:annotation>
+			<xs:documentation>Schema XML de validação do Pedido de Consulta do Recido do Lote de Notas Fiscais Eletrônicas</xs:documentation>
+		</xs:annotation>
+	</xs:element>
+</xs:schema>

data/lib/br_nfe/product/xml/v3_10/XSD/consSitNFe_v3.10.xsd

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.portalfiscal.inf.br/nfe" targetNamespace="http://www.portalfiscal.inf.br/nfe" elementFormDefault="qualified" attributeFormDefault="unqualified">
+	<xs:include schemaLocation="leiauteConsSitNFe_v3.10.xsd"/>
+	<xs:element name="consSitNFe" type="TConsSitNFe">
+		<xs:annotation>
+			<xs:documentation>Schema de validação XML dp Pedido de Consulta da Situação Atual da Nota Fiscal Eletrônica</xs:documentation>
+		</xs:annotation>
+	</xs:element>
+</xs:schema>

data/lib/br_nfe/product/xml/v3_10/XSD/consStatServ_v3.10.xsd

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns="http://www.portalfiscal.inf.br/nfe" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.portalfiscal.inf.br/nfe" elementFormDefault="qualified" attributeFormDefault="unqualified">
+	<xs:include schemaLocation="leiauteConsStatServ_v3.10.xsd"/>
+	<xs:element name="consStatServ" type="TConsStatServ">
+		<xs:annotation>
+			<xs:documentation>Schema XML de validação do Pedido de Consulta do Status do Serviço</xs:documentation>
+		</xs:annotation>
+	</xs:element>
+</xs:schema>

data/lib/br_nfe/product/xml/v3_10/XSD/enviNFe_v3.10.xsd

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.portalfiscal.inf.br/nfe" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" targetNamespace="http://www.portalfiscal.inf.br/nfe" elementFormDefault="qualified" attributeFormDefault="unqualified">
+	<xs:include schemaLocation="leiauteNFe_v3.10.xsd"/>
+	<xs:element name="enviNFe" type="TEnviNFe">
+		<xs:annotation>
+			<xs:documentation>Schema XML de validação do Pedido de Concessão de Autorização da Nota Fiscal Eletrônica</xs:documentation>
+		</xs:annotation>
+	</xs:element>
+</xs:schema>

data/lib/br_nfe/product/xml/v3_10/XSD/inutNFe_v3.10.xsd

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.portalfiscal.inf.br/nfe" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" targetNamespace="http://www.portalfiscal.inf.br/nfe" elementFormDefault="qualified" attributeFormDefault="unqualified">
+	<xs:include schemaLocation="leiauteInutNFe_v3.10.xsd"/>
+	<xs:element name="inutNFe" type="TInutNFe">
+		<xs:annotation>
+			<xs:documentation>Schema XML de validação do Pedido de Inutilização de Numeração da Nota Fiscal Eletrônica</xs:documentation>
+		</xs:annotation>
+	</xs:element>
+</xs:schema>