nfe_reader 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9577a7166d1dfbba0ad7b57254dd3eb94cfccd4
+  data.tar.gz: 6a2d44a5c5a7cbcbdd500d6641d53bfe0f19dee1
+SHA512:
+  metadata.gz: 62c5560f41f0a6b05e52b5f742b4a0c5398ebb943ec4ac50f6eca6b88e1c5c9d593c20dbf216ec0101f45c1bc2ff54ef433c8ffb312860e6d7e0cb13735a564a
+  data.tar.gz: a18eaccdafd49ffd652bba05c0fdc50d57ed98aaa218441b9545794317d575b5402286be2e447fc9f3db4cc230531136fcd8b1d516158e742dac071663a4a900

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+runner.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nfe-reader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eduardo Becker
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+## Nfe::Reader ##
+
+Gem to open Brazilian NF-e XML and convert to Ruby classes.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nfe-reader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nfe-reader
+
+### Dependencies
+
+* nokogiri
+
+### Usage
+
+Open the xml file and import to Nfe::Reader:
+
+```ruby
+file = File.open('sample-nfe.xml')
+nfe = Nfe::Reader::Base.new(file)
+```
+
+### Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nfe-reader/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task default: :test
+
+desc 'Run the tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/nfe_reader/authorization.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+module Nfe
+  # Pessoas Autorizadas para obter XML
+  class Authorization
+    attr_reader :cnpj, :cpf
+
+    def initialize(attrs = {})
+      @cnpj = attrs[:CNPJ]
+      @cpf = attrs[:CPF]
+    end
+  end
+end

data/lib/nfe_reader/carrier.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+module Nfe
+  class Carrier
+    attr_reader :cnpj, :cpf, :name, :ie, :address, :city, :state
+
+    def initialize(attrs = {})
+      @cnpj = attrs[:CNPJ]
+      @cpf = attrs[:CPF]
+      @name = attrs[:xNome]
+      @ie = attrs[:IE]
+      @address = attrs[:xEnder]
+      @city = attrs[:xMun]
+      @state = attrs[:UF]
+    end
+  end
+end

data/lib/nfe_reader/collection/duplicate.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+module Nfe
+  class Duplicate
+    attr_reader :number, :expiration, :value
+
+    def initialize(attrs = {})
+      @number = attrs[:nDup]
+      @expiration = attrs[:dVenc]
+      @value = attrs[:vDup]
+    end
+  end
+end

data/lib/nfe_reader/collection.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+module Nfe
+  # Mapeia as Cobrancas
+  class Collection
+    attr_reader :number, :value, :descont, :value_net, :duplicates
+    
+    def initialize(attrs = {})
+      if attrs[:fat]
+        @number = attrs[:fat][:nFat]
+        @value = attrs[:fat][:vOrig]
+        @descont = attrs[:fat][:vDesc]
+        @value_net = attrs[:fat][:vLiq]
+      end
+
+      @duplicates = set_duplicates(attrs[:dup])
+    end
+  
+    def set_duplicates(attrs = {})
+      duplicates = []
+      
+      return duplicates unless attrs
+
+      if attrs.is_a? Array
+        attrs.each do |d|
+          duplicates << Nfe::Duplicate.new(d)
+        end
+      else
+         duplicates << Nfe::Duplicate.new(attrs)
+      end
+
+      duplicates
+    end
+  end
+end

data/lib/nfe_reader/customer.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+module Nfe
+  # Identificação do Destinatário da Nota Fiscal eletrônica
+  class Customer
+    attr_reader :cnpj, :cpf, :name, :state_registration, :email,
+      :suframa, :phone, :address, :number, :neighborhood, :city_code,
+      :city, :state, :country_code, :country, :complement, :foreign_code,
+      :cep, :city_registration, :state_registration_code
+
+    # == Fields Values
+    #
+    # indIEDest: 1 - Contribuinte ICMS (informar a IE do destinatário),
+    #            2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS,
+    #            9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual
+
+    def initialize(attrs = {})
+      @cnpj = attrs[:CNPJ]
+      @cpf = attrs[:CPF]
+
+      # Razão Social ou nome do destinatário
+      @name = attrs[:xNome]
+      # Inscrição Estadual do Destinatário
+      @state_registration = attrs[:IE]
+      # Inscrição na SUFRAMA
+      @suframa = attrs[:ISUF]
+      # Inscrição Municipal do Tomador do Serviço
+      @city_registration = attrs[:IM]
+      # Indicador da IE do Destinatário
+      @state_registration_code = attrs[:indIEDest]
+      # Email
+      @email = attrs[:email]
+      # Identificação do destinatário no caso de comprador estrangeiro
+      @foreign_code = attrs[:idEstrangeiro]
+
+      # Address
+      if attrs[:enderDest]
+        # Logradouro
+        @address = attrs[:enderDest][:xLgr]
+        # Numero
+        @number = attrs[:enderDest][:nro]
+        # Complemento
+        @complement = attrs[:enderDest][:xCpl]
+        # Bairro
+        @neighborhood = attrs[:enderDest][:xBairro]
+        # Código do município
+        @city_code = attrs[:enderDest][:cMun]
+        # Nome do município
+        @city = attrs[:enderDest][:xMun]
+        # Sigla da UF
+        @state = attrs[:enderDest][:UF]
+        # Código do CEP
+        @zip_code = attrs[:enderDest][:CEP]
+        # Codigo Pais
+        @country_code = attrs[:enderDest][:cPais]
+        # Nome do Pais
+        @country = attrs[:enderDest][:xPais]
+        # Telefone
+        @phone = attrs[:enderDest][:fone]
+      end
+    end
+  end
+end

data/lib/nfe_reader/delivery.rb

@@ -0,0 +1,20 @@
+# Local de Entrega
+module Nfe
+  # Identificação do Local de Entrega
+  class Delivery
+    attr_reader :cnpj, :cpf, :address, :number, :complement,
+      :neighborhood, :city_code, :city, :state
+
+    def initialize(attrs = {})
+      @cnpj = attrs[:CNPJ]
+      @cpf = attrs[:CPF]
+      @address = attrs[:xLgr]
+      @number = attrs[:nro]
+      @complement = attrs[:xCpl]
+      @neighborhood = attrs[:xBairro]
+      @city_code = attrs[:cMun]
+      @city = attrs[:xMun]
+      @state = attrs[:UF]
+    end
+  end
+end

data/lib/nfe_reader/document.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+module Nfe
+  # Documento Fiscal Referenciado
+  class Document
+    attr_reader :key, :nfe_state, :nfe_year, :nfe_cnpj, :nfe_model,
+      :nfe_serie, :nfe_number, :farmer_state, :farmer_year, :farmer_cnpj,
+      :farmer_cpf, :farmer_ie, :farmer_model, :farmer_serie, :farmer_number,
+      :cte_key, :ecf_model, :ecf_number, :ecf_operation
+
+    # == Fields Values
+    # mod:
+    #  refNF: 01 - modelo 01
+    #  refNFP: 04 - NF de Produtor,
+    #          01 - NF (v2.0)
+    #  refECF: 2B - Cupom Fiscal emitido por máquina registradora (não ECF),
+    #          2C - Cupom Fiscal PDV,
+    #          2D - Cupom Fiscal (emitido por ECF) (v2.0)
+
+    def initialize(attrs = {})
+      # Chave da NF-e
+      @key = attrs[:refNFe]
+
+      # Referencia uma NF-e
+      if attrs[:refNF]
+        # Estado
+        @nfe_state = attrs[:refNF][:cUF]
+        # Ano e mes
+        @nfe_year = attrs[:refNF][:AAMM]
+        # CNPJ do emitente
+        @nfe_cnpj = attrs[:refNF][:CNPJ]
+        # Modelo do Documento Fiscal
+        @nfe_model = attrs[:refNF][:mod]
+        # Serie Documento Fiscal
+        @nfe_serie = attrs[:refNF][:serie]
+        # Numero Documento Fiscal
+        @nfe_number = attrs[:refNF][:nNF]
+      end
+
+      # NF de Produtor Rural
+      if attrs[:refNFP]
+        # Estado
+        @farmer_state = attrs[:refNFP][:cUF]
+        # Ano e mes
+        @farmer_year = attrs[:refNFP][:AAMM]
+        # CNPJ do emitente
+        @farmer_cnpj = attrs[:refNFP][:CNPJ]
+        # CPF do emitente
+        @farmer_cpf = attrs[:refNFP][:CPF]
+        # IE do emitente
+        @farmer_ie = attrs[:refNFP][:IE]
+        # Modelo do Documento Fiscal
+        @farmer_model = attrs[:refNFP][:mod]
+        # Serie Documento Fiscal
+        @farmer_serie = attrs[:refNFP][:serie]
+        # Numero Documento Fiscal
+        @farmer_number = attrs[:refNFP][:nNF]
+      end
+
+      # CT-e
+      @cte_key = attrs[:refCTe]
+
+      # Referencia uma ECF
+      if attrs[:refECF]
+        # Modelo do Documento Fiscal
+        @ecf_model = attrs[:refECF][:mod]
+        # Número de ordem sequencial do ECF
+        @ecf_number = attrs[:refECF][:nECF]
+        # Número do Contador de Ordem de Operação
+        @ecf_operation = attrs[:refECF][:nCOO]
+      end
+    end
+  end
+end

data/lib/nfe_reader/export.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+# Informações de Comércio Exterior
+module Nfe
+  class Export
+    attr_reader :state, :address
+
+    def initialize(attrs = {})
+      @state = attrs[:UFEmbarq]
+      @address = attrs[:xLocEmbarq]
+    end
+  end
+end

data/lib/nfe_reader/fiscal.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+module Nfe
+  # Identificação do Fisco Emitente da NF-e
+  class Fiscal
+    attr_reader :cnpj, :agency, :code, :name, :paid_date,
+       :phone, :state, :number, :date, :value, :repartition
+
+    def initialize(attrs = {})
+      # CNPJ emitente
+      @cnpj = attrs[:CNPJ]
+      # Órgão emitente
+      @agency = attrs[:xOrgao]
+      # Matrícula do agente do Fisco
+      @code = attrs[:matr]
+      # Nome do agente do Fisco
+      @name = attrs[:xAgente]
+      # Telefone do agente do Fisco
+      @phone = attrs[:fone]
+      # Estado
+      @state = attrs[:UF]
+      # Número do DAR(Documento de Arrecadação de Receita)
+      @number = attrs[:nDAR]
+      # Data
+      @date = attrs[:dEmi]
+      # Valor do DAR
+      @value = attrs[:vDAR]
+      # Repartição Fiscal emitente
+      @repartition = attrs[:repEmi]
+      # Data do Pagamento
+      @paid_date = attrs[:dPag]
+    end
+  end
+end

data/lib/nfe_reader/header.rb

@@ -0,0 +1,129 @@
+# 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
+
+    # == 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.
+
+    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]
+
+      # Contigencia
+      @contingency_date = attrs[:dhCont]
+      @contingency_justification = attrs[:xJust]
+
+      # Documento Fiscal Referenciado
+      @documents = []
+
+      if attrs[:NFref].is_a? Array
+        attrs[:NFref].each do |document|
+          @documents << Nfe::Document.new(document)
+        end
+      elsif attrs[:NFref].is_a? Hash
+        @documents << Nfe::Document.new(attrs[:NFref])
+      end
+
+    end
+  end
+end

data/lib/nfe_reader/information.rb

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

data/lib/nfe_reader/product/armament.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+module Nfe
+  class Armament
+    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

data/lib/nfe_reader/product/cane.rb

@@ -0,0 +1,42 @@
+module Nfe
+  class Cane
+    attr_reader :harvest, :month, :month_amount, :previous_amount, :amount,
+      :value, :deduction_value, :net_value, :days, :deductions
+
+    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]
+
+      @days = []
+      
+      if attrs[:forDia]
+        @days = to_array(attrs[:forDia])
+      end
+
+      if attrs[:deduc]
+        @deductions = to_array(attrs[:deduc])
+      end
+    end
+
+    def to_array(attrs = {})
+      array = []
+
+      if attrs.is_a? Array
+        attrs.each do |hash|
+          array << hash.map { |key, value| value }
+        end
+      else
+        array << attrs.map { |key, value| value }
+      end
+
+      array
+    end
+
+  end
+end

data/lib/nfe_reader/product/exportation.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+module Nfe
+  class Exportation
+    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

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+module Nfe
+  class Fuel
+    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