nfe_reader 1.0.4 → 1.0.5

data/lib/nfe_reader/header.rb

@@ -1,129 +1,132 @@
 # encoding: UTF-8
 module Nfe
-  # Identificação da Nota Fiscal eletrônica
-  class Header
-    attr_reader :state, :city, :sample_number, :operation, :number,
-      :model, :emission, :emission_kind, :out, :out_time, :serie, :kind,
-      :environment, :finality, :version, :payment, :process, :digit,
-      :orientation, :emission_date, :destiny_code, :final_consumer,
-      :consumer_presence, :contingency_date, :contingency_justification,
-      :documents
+  module Reader
+    # Identificação da Nota Fiscal eletrônica
+    class Header
+      include ::AttributeHelper
 
-    # == Fields Values
-    #
-    # cUF: 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, 3-Rio Grande do Sul, 50-Mato Grosso do Sul,
-    #      51-Mato Grosso, 52-Goiás, 53-DistritoFederal
-    #
-    # mod: 55 - NF-e, 65 - NFC-e
-    #
-    # indPag: 0 - Vista, 1 - Prazo, 2 - Outros
-    #
-    # tpNF: 0 - Entrada, 1 - Saida
-    #
-    # tpAmb: 1 - Producao, 2 - Homologacao
-    #
-    # finNFe: 1 - Normal, 
-    #         2 - Complementar, 
-    #         3 - Ajuste,
-    #         4 - Devolução/Retorno.
-    #
-    # tpEmis: 1 - Normal, 2 - Contingência FS, 3 - Contingência SCAN, 4 - Contingência FS-DA
-    #
-    # tpImp: 1 - Retrato, 
-    #        2 - Paisagem,
-    #        3 - DANFE Simplificado,
-    #        4 - DANFE NFC-e,
-    #        5 - DANFE NFC-e em mensagem eletrônica (o envio de
-    #            mensagem eletrônica pode ser feita de forma simultânea
-    #            com a impressão do DANFE; usar o tpImp=5 quando
-    #            esta for a única forma de disponibilização do DANFE).
-    #
-    # procEmit:  0 - emissão de NF-e com aplicativo do contribuinte,
-    #            1 - emissão de NF-e avulsa pelo Fisco,
-    #            2 - emissão de NF-e avulsa, pelo site,
-    #            3 - emissão NF-e pelo contribuinte com aplicativo fornecido pelo Fisco,
-    #
-    #  idDest: 1 - Operação interna,
-    #          2 - Operação interestadual,
-    #          3 - Operação com exterior
-    #
-    # indFinal: 0 - Não,
-    #           1 - Consumidor final
-    #
-    # indPres: 0 - Não se aplica (por exemplo, Nota Fiscal complementar
-    #              ou de ajuste);
-    #          1 - Operação presencial;
-    #          2 - Operação não presencial, pela Internet;
-    #          3 - Operação não presencial, Teleatendimento;
-    #          4 - NFC-e em operação com entrega a domicílio;
-    #          9 - Operação não presencial, outros.
+      attr_reader :state, :city, :sample_number, :operation, :number,
+        :model, :emission, :emission_kind, :out, :out_time, :serie, :kind,
+        :environment, :finality, :version, :payment, :process, :digit,
+        :orientation, :emission_date, :destiny_code, :final_consumer,
+        :consumer_presence, :contingency_date, :contingency_justification,
+        :documents
 
-    def initialize(attrs = {})
-      # Estado
-      @state = attrs[:cUF]
-      # Cidade
-      @city = attrs[:cMunFG]
-      # Numero Aleatorio
-      @sample_number = attrs[:cNF]
-      # Natureza Operacao
-      @operation = attrs[:natOp]
-      # Numero da Nota
-      @number = attrs[:nNF]
-      # Modelo
-      @model = attrs[:mod]
-      # Data Emissao
-      @emission = attrs[:dEmi]
-      # Tipo de Emissao
-      @emission_kind = attrs[:tpEmis]
-      # Data de Saida
-      @out = attrs[:dSaiEnt]
-      # Hora de Saida
-      @out_time = attrs[:hSaiEnt]
-      # Data de Emissao
-      @emission_date = attrs[:dhEmi]
-      # Serie
-      @serie = attrs[:serie]
-      # Tipo da Nota
-      @kind = attrs[:tpNF]
-      # Ambiente
-      @environment = attrs[:tpAmb]
-      # Finalidade
-      @finality = attrs[:finNFe]
-      # Versao aplicativo do emissor
-      @version = attrs[:verProc]
-      # Pagamento
-      @payment = attrs[:indPag]
-      # Processo de Emissao
-      @process = attrs[:procEmi]
-      # Digito Verificador
-      @digit = attrs[:cDV]
-      # Orientação da Pagina
-      @orientation = attrs[:tpImp]
-      # Codigo do Destino
-      @destiny_code = attrs[:idDest]
-      # Consumidor final
-      @final_consumer = attrs[:indFinal]
-      # Indicador de presença do comprador
-      @consumer_presence = attrs[:indPres]
+      # == Fields Values
+      #
+      # cUF: 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, 3-Rio Grande do Sul, 50-Mato Grosso do Sul,
+      #      51-Mato Grosso, 52-Goiás, 53-DistritoFederal
+      #
+      # mod: 55 - NF-e, 65 - NFC-e
+      #
+      # indPag: 0 - Vista, 1 - Prazo, 2 - Outros
+      #
+      # tpNF: 0 - Entrada, 1 - Saida
+      #
+      # tpAmb: 1 - Producao, 2 - Homologacao
+      #
+      # finNFe: 1 - Normal, 
+      #         2 - Complementar, 
+      #         3 - Ajuste,
+      #         4 - Devolução/Retorno.
+      #
+      # tpEmis: 1 - Normal, 2 - Contingência FS, 3 - Contingência SCAN, 4 - Contingência FS-DA
+      #
+      # tpImp: 1 - Retrato, 
+      #        2 - Paisagem,
+      #        3 - DANFE Simplificado,
+      #        4 - DANFE NFC-e,
+      #        5 - DANFE NFC-e em mensagem eletrônica (o envio de
+      #            mensagem eletrônica pode ser feita de forma simultânea
+      #            com a impressão do DANFE; usar o tpImp=5 quando
+      #            esta for a única forma de disponibilização do DANFE).
+      #
+      # procEmit:  0 - emissão de NF-e com aplicativo do contribuinte,
+      #            1 - emissão de NF-e avulsa pelo Fisco,
+      #            2 - emissão de NF-e avulsa, pelo site,
+      #            3 - emissão NF-e pelo contribuinte com aplicativo fornecido pelo Fisco,
+      #
+      #  idDest: 1 - Operação interna,
+      #          2 - Operação interestadual,
+      #          3 - Operação com exterior
+      #
+      # indFinal: 0 - Não,
+      #           1 - Consumidor final
+      #
+      # indPres: 0 - Não se aplica (por exemplo, Nota Fiscal complementar
+      #              ou de ajuste);
+      #          1 - Operação presencial;
+      #          2 - Operação não presencial, pela Internet;
+      #          3 - Operação não presencial, Teleatendimento;
+      #          4 - NFC-e em operação com entrega a domicílio;
+      #          9 - Operação não presencial, outros.
 
-      # Contigencia
-      @contingency_date = attrs[:dhCont]
-      @contingency_justification = attrs[:xJust]
+      def initialize(attrs = {})
+        # Estado
+        @state = attrs[:cUF]
+        # Cidade
+        @city = attrs[:cMunFG]
+        # Numero Aleatorio
+        @sample_number = attrs[:cNF]
+        # Natureza Operacao
+        @operation = attrs[:natOp]
+        # Numero da Nota
+        @number = attrs[:nNF]
+        # Modelo
+        @model = attrs[:mod]
+        # Data Emissao
+        @emission = attrs[:dEmi]
+        # Tipo de Emissao
+        @emission_kind = attrs[:tpEmis]
+        # Data de Saida
+        @out = attrs[:dSaiEnt]
+        # Hora de Saida
+        @out_time = attrs[:hSaiEnt]
+        # Data de Emissao
+        @emission_date = attrs[:dhEmi]
+        # Serie
+        @serie = attrs[:serie]
+        # Tipo da Nota
+        @kind = attrs[:tpNF]
+        # Ambiente
+        @environment = attrs[:tpAmb]
+        # Finalidade
+        @finality = attrs[:finNFe]
+        # Versao aplicativo do emissor
+        @version = attrs[:verProc]
+        # Pagamento
+        @payment = attrs[:indPag]
+        # Processo de Emissao
+        @process = attrs[:procEmi]
+        # Digito Verificador
+        @digit = attrs[:cDV]
+        # Orientação da Pagina
+        @orientation = attrs[:tpImp]
+        # Codigo do Destino
+        @destiny_code = attrs[:idDest]
+        # Consumidor final
+        @final_consumer = attrs[:indFinal]
+        # Indicador de presença do comprador
+        @consumer_presence = attrs[:indPres]
 
-      # Documento Fiscal Referenciado
-      @documents = []
+        # Contigencia
+        @contingency_date = attrs[:dhCont]
+        @contingency_justification = attrs[:xJust]
 
-      if attrs[:NFref].is_a? Array
-        attrs[:NFref].each do |document|
-          @documents << Nfe::Document.new(document)
+        # Documento Fiscal Referenciado
+        @documents = []
+
+        if attrs[:NFref].is_a? Array
+          attrs[:NFref].each do |document|
+            @documents << Document.new(document)
+          end
+        elsif attrs[:NFref].is_a? Hash
+          @documents << Document.new(attrs[:NFref])
         end
-      elsif attrs[:NFref].is_a? Hash
-        @documents << Nfe::Document.new(attrs[:NFref])
       end
-
     end
   end
 end

data/lib/nfe_reader/information.rb

@@ -1,38 +1,29 @@
 # encoding: UTF-8
 module Nfe
-  class Information
-    attr_reader :information, :information_taxpayer, :taxpayer_messages, :messages,
-      :references
+  module Reader
+    class Information
+      include ::AttributeHelper
+      include ::CreatorHelper
 
-    def initialize(attrs = {})
-      @information = attrs[:infAdFisco]
-      @information_taxpayer = attrs[:infCpl]
+      attr_reader :information, :information_taxpayer, :taxpayer_messages, :messages,
+        :references
 
-      if attrs[:procRef]
-        @references = to_array(attrs[:procRef])
-      end
-
-      if attrs[:obsCont]
-        @taxpayer_messages = to_array(attrs[:obsCont])
-      end
+      def initialize(attrs = {})
+        @information = attrs[:infAdFisco]
+        @information_taxpayer = attrs[:infCpl]
 
-      if attrs[:obsFisco]
-        @messages = to_array(attrs[:obsFisco])
-      end
-    end
+        if attrs[:procRef]
+          @references = to_array(attrs[:procRef])
+        end
 
-    def to_array(attrs = {})
-      array = []
+        if attrs[:obsCont]
+          @taxpayer_messages = to_array(attrs[:obsCont])
+        end
 
-      if attrs.is_a? Array
-        attrs.each do |hash|
-          array << hash.map { |key, value| value }
+        if attrs[:obsFisco]
+          @messages = to_array(attrs[:obsFisco])
         end
-      else
-        array << attrs.map { |key, value| value }
       end
-
-      array
     end
   end
 end

data/lib/nfe_reader/nfe.rb

@@ -0,0 +1,130 @@
+module Nfe
+  module Reader
+    class Nfe
+      include ::AttributeHelper
+
+      attr_reader :version, :number, :signature, :client, :information,
+        :header, :provider, :customer, :products, :collection, :transport,
+        :purchase, :cane, :export, :delivery, :removal,:enviroment,
+        :version_app, :key, :date, :protocol, :digest, :status, :description,
+        :total, :authorizations, :error, :trace, :fiscal
+
+      def initialize(file)
+
+        xml = file.is_a?(Nokogiri::XML::Document) ? file : Nokogiri::XML(file)
+        xml = xml.to_hash
+
+        # Versao da NFe
+        @version = xml[:nfeProc][:versao]
+        # Assinatura
+        @signature = xml[:nfeProc][:NFe][:Signature]
+
+        # Protocolo
+        if xml[:nfeProc][:protNFe]
+          protocol = xml[:nfeProc][:protNFe][:infProt]
+          
+          @enviroment = protocol[:tpAmb]
+          @version_app = protocol[:verAplic]
+          @key = protocol[:chNFe]
+          @date = protocol[:dhRecbto]
+          @protocol = protocol[:nProt]
+          @digest = protocol[:digVal]
+          @status = protocol[:cStat]
+          @description = protocol[:xMotivo]
+        end
+
+        xml = xml[:nfeProc][:NFe][:infNFe]
+
+        # Numero da Nfe
+        @number = xml[:Id]
+
+        # Identificação da Nota Fiscal eletrônica
+        @header = Header.new(xml[:ide])
+
+        # Identificação do Emitente da Nota Fiscal eletrônica
+        @provider = Provider.new(xml[:emit])
+
+        # Identificação do Fisco Emitente da NF-e
+        if xml[:avulsa]
+          @fiscal = Fiscal.new(xml[:avulsa])
+        end
+
+        # Identificação do Destinatário da Nota Fiscal eletrônica
+        @customer = Customer.new(xml[:dest])
+
+        # Informacoes Adicional
+        if xml[:infAdic]
+          @information = Information.new(xml[:infAdic])
+        end
+
+        # Detalhamento de Produtos e Serviços da NF-e
+        @products = []
+        if xml[:det].is_a? Array
+          xml[:det].each do |product|
+            @products << Product.new(product)
+          end
+        else
+          @products << Product.new(xml[:det])
+        end
+
+        # Totalizadores
+        @total = Total.new(xml[:total])
+
+        # Informacao de Pagamento
+        if xml[:cobr]
+          @collection = Collection.new(xml[:cobr])
+        end
+
+        # Transporte
+        if xml[:transp]
+          @transport = Transport.new(xml[:transp])
+        end
+
+        # Identificação do Local de Entrega
+        if xml[:retirada]
+          @removal = Removal.new(xml[:retirada])
+        end
+
+        # Identificação do Local de Retirada
+        if xml[:entrega]
+          @delivery = Delivery.new(xml[:entrega])
+        end
+
+        # Autorização para obter XML
+        @authorizations = []
+        if xml[:autXML].is_a? Array
+          xml[:autXML].each do |product|
+            @authorizations << Authorization.new(product)
+          end
+        elsif xml[:autXML].is_a? Hash
+          @authorizations << Authorization.new(xml[:autXML])
+        end
+
+        # Informacoes de Comercio Exterior
+        if xml[:exporta]
+          @export = Export.new(xml[:exporta])
+        end
+
+        # Informacoes de Compra
+        if xml[:compra]
+          @purchase = Purchase.new(xml[:compra])
+        end
+
+        # Cana de Acucar
+        if xml[:cana]
+          @cane = Cane.new(xml[:cana])
+        end
+
+      rescue => exception
+        @error = exception
+        @trace = exception.backtrace
+      ensure
+        file.close if file.respond_to? :close
+      end
+
+      def error?
+        !error.nil?
+      end
+    end
+  end
+end

data/lib/nfe_reader/product/armament.rb

@@ -1,22 +1,26 @@
 # encoding: UTF-8
 module Nfe
-  class Armament
-    attr_reader :kind, :serie, :barrel, :description
+  module Reader
+    class Armament
+      include ::AttributeHelper
 
-    # Fields Values
-    #
-    # tpArma : 0 - Uso permitido;
-    #          1 - Uso restrito;
-    #
-    def initialize(attrs = {})
-      # Tipo de Arma
-      @kind = attrs[:tpArma]
-      # Serie
-      @serie = attrs[:nSerie]
-      # Cano
-      @barrel = attrs[:nCano]
-      # Descricao
-      @description = attrs[:descr]
+      attr_reader :kind, :serie, :barrel, :description
+
+      # Fields Values
+      #
+      # tpArma : 0 - Uso permitido;
+      #          1 - Uso restrito;
+      #
+      def initialize(attrs = {})
+        # Tipo de Arma
+        @kind = attrs[:tpArma]
+        # Serie
+        @serie = attrs[:nSerie]
+        # Cano
+        @barrel = attrs[:nCano]
+        # Descricao
+        @description = attrs[:descr]
+      end
     end
   end
 end

data/lib/nfe_reader/product/cane.rb

@@ -1,42 +1,32 @@
 module Nfe
-  class Cane
-    attr_reader :harvest, :month, :month_amount, :previous_amount, :amount,
-      :value, :deduction_value, :net_value, :days, :deductions
+  module Reader
+    class Cane
+      include ::AttributeHelper
+      include ::CreatorHelper
 
-    def initialize(attrs = {})
-      @harvest = attrs[:safra]
-      @month = attrs[:ref]
-      @month_amount = attrs[:qTotMes]
-      @previous_amount = attrs[:qTotAnt]
-      @amount = attrs[:qTotGer]
-      @value = attrs[:vFor]
-      @deduction_value = attrs[:vTotDed]
-      @net_value = attrs[:vLiqFor]
+      attr_reader :harvest, :month, :month_amount, :previous_amount, :amount,
+        :value, :deduction_value, :net_value, :days, :deductions
 
-      @days = []
-      
-      if attrs[:forDia]
-        @days = to_array(attrs[:forDia])
-      end
-
-      if attrs[:deduc]
-        @deductions = to_array(attrs[:deduc])
-      end
-    end
+      def initialize(attrs = {})
+        @harvest = attrs[:safra]
+        @month = attrs[:ref]
+        @month_amount = attrs[:qTotMes]
+        @previous_amount = attrs[:qTotAnt]
+        @amount = attrs[:qTotGer]
+        @value = attrs[:vFor]
+        @deduction_value = attrs[:vTotDed]
+        @net_value = attrs[:vLiqFor]
 
-    def to_array(attrs = {})
-      array = []
+        @days = []
+        
+        if attrs[:forDia]
+          @days = to_array(attrs[:forDia])
+        end
 
-      if attrs.is_a? Array
-        attrs.each do |hash|
-          array << hash.map { |key, value| value }
+        if attrs[:deduc]
+          @deductions = to_array(attrs[:deduc])
         end
-      else
-        array << attrs.map { |key, value| value }
       end
-
-      array
     end
-
   end
 end

data/lib/nfe_reader/product/exportation.rb

@@ -1,19 +1,23 @@
 # encoding: UTF-8
 module Nfe
-  class Exportation
-    attr_reader :drawnback, :number, :key, :amount
+  module Reader
+    class Exportation
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      # Número do ato concessório de Drawback
-      @drawnback = attrs[:nDraw]
-      
-      if attrs[:exportInd]
-        # Número do Registro de Exportação
-        @number = attrs[:exportInd][:nRE]
-        # Chave de Acesso da NF-e recebida para exportação
-        @key = attrs[:exportInd][:chNFe]
-        # Quantidade do item realmente exportado
-        @amount= attrs[:exportInd][:qExport]
+      attr_reader :drawnback, :number, :key, :amount
+
+      def initialize(attrs = {})
+        # Número do ato concessório de Drawback
+        @drawnback = attrs[:nDraw]
+        
+        if attrs[:exportInd]
+          # Número do Registro de Exportação
+          @number = attrs[:exportInd][:nRE]
+          # Chave de Acesso da NF-e recebida para exportação
+          @key = attrs[:exportInd][:chNFe]
+          # Quantidade do item realmente exportado
+          @amount= attrs[:exportInd][:qExport]
+        end
       end
     end
   end

data/lib/nfe_reader/product/fuel.rb

@@ -1,17 +1,21 @@
 # encoding: UTF-8
 module Nfe
-  class Fuel
-    attr_reader :anp, :codif, :amount, :cide_base, :cide_aliquot, :cide_value
+  module Reader
+    class Fuel
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      @anp = attrs[:cProdANP]
-      @codif = attrs[:CODIF]
-      @amount = attrs[:qTemp]
-      
-      if attrs[:CIDE]
-        @cide_base = attrs[:CIDE][:qBCprod]
-        @cide_aliquot = attrs[:CIDE][:vAliqProd]
-        @cide_value = attrs[:CIDE][:vCIDE]
+      attr_reader :anp, :codif, :amount, :cide_base, :cide_aliquot, :cide_value
+
+      def initialize(attrs = {})
+        @anp = attrs[:cProdANP]
+        @codif = attrs[:CODIF]
+        @amount = attrs[:qTemp]
+        
+        if attrs[:CIDE]
+          @cide_base = attrs[:CIDE][:qBCprod]
+          @cide_aliquot = attrs[:CIDE][:vAliqProd]
+          @cide_value = attrs[:CIDE][:vCIDE]
+        end
       end
     end
   end