nfe_reader 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e774c8870d885012e9766d7414e929602371814
-  data.tar.gz: 9560d73f3be52d68614849708bc60d58d2b7ee1c
+  metadata.gz: b0a6ea021f20cf8869fb72b69dc09f308b4459b2
+  data.tar.gz: 8fd34ca62a8976705aaa417b5aa01b67f006d260
 SHA512:
-  metadata.gz: adeda4aa09c7718a6dc5738dca02dfce761629d9f8ca45baf511c09248540b5dc8921c264595a300638d6914c79914c1d0fb332d1c5ab11629f972f80eafda07
-  data.tar.gz: 006d0e2d8dfa36543cbb00706b7d4c7fd33b33c8e296c907a38070b610a77512c12f71dd6cd7a74bc53a1aad90f45010847ba2fcdf1ca97c229ae07dbdb8e1a8
+  metadata.gz: eecac3227082e880243211a0897a3517420719a76772b4b343d7c14386496c399ec6b570c5f90068f38c9b9f69ea2d5a09e47dda1a1e83ebad4d05ec698559c3
+  data.tar.gz: a0372bd094fd2cae68d5071b98a9875f20ae30cc1afce35043e6be1ae3a77891688ff7c4484b2a4461e4263801c60ae7268fd4ff65067f973a1e1278f957073b

data/README.md

@@ -26,9 +26,18 @@ Open the xml file and import to Nfe::Reader:
 
 ```ruby
 file = File.open('sample-nfe.xml')
-nfe = Nfe::Reader::Base.new(file)
+nfe = Nfe::Reader::Nfe.new(file)
 ```
 
+You can access class attributes:
+
+```ruby
+nfe.attributes
+
+# {"version"=>"2.00", "signature"=> Hash, "enviroment"=>"1", "version_app"=>"SVRS20140825154650", "key"=>"42140979858221000155550010000483141000490912", "date"=>"2014-09-26T15:13:17", "protocol"=>"342140109891239", "digest"=>"v6ZkLNwbVB4lmk/PbND1kmr5tIY=", "status"=>"100", "description"=>"Autorizado o uso da NF-e.", "number"=>"NFe42140979858221000155550010000483141000490912"}
+```
+
+
 ### Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/nfe-reader/fork )

data/lib/helpers/attribute_helper.rb

@@ -0,0 +1,18 @@
+module AttributeHelper
+  def attributes
+    @attributes ||= attributes_to_hash
+  end
+
+  def attributes_to_hash
+    attrs = Hash.new
+
+    instance_variables.each do |var|
+      key   = var.to_s.gsub /^@/, ''
+      value = instance_variable_get(var)
+
+      attrs[key] = value if [String, Hash].include? value.class
+    end
+
+    attrs
+  end
+end

data/lib/helpers/creator_helper.rb

@@ -0,0 +1,32 @@
+module CreatorHelper
+  def create_resource(klass, attrs = {})
+    return unless attrs
+    klass.new(attrs)
+  end
+
+  def create_resources(klass, attrs = {})
+    resources = []
+
+    return resources unless attrs
+
+    attrs.each do |a|
+      resources << klass.new(a.last)
+    end
+
+    resources
+  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

data/lib/nfe_reader/authorization.rb

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

data/lib/nfe_reader/carrier.rb

@@ -1,16 +1,20 @@
 # encoding: UTF-8
 module Nfe
-  class Carrier
-    attr_reader :cnpj, :cpf, :name, :ie, :address, :city, :state
+  module Reader
+    class Carrier
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      @cnpj = attrs[:CNPJ]
-      @cpf = attrs[:CPF]
-      @name = attrs[:xNome]
-      @ie = attrs[:IE]
-      @address = attrs[:xEnder]
-      @city = attrs[:xMun]
-      @state = attrs[:UF]
+      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
 end

data/lib/nfe_reader/collection/duplicate.rb

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

data/lib/nfe_reader/collection.rb

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

data/lib/nfe_reader/customer.rb

@@ -1,61 +1,65 @@
 # 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
+  module Reader
+    # Identificação do Destinatário da Nota Fiscal eletrônica
+    class Customer
+      include ::AttributeHelper
 
-    # == 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
+      attr_reader :cnpj, :cpf, :name, :state_registration, :email,
+        :suframa, :phone, :address, :number, :neighborhood, :city_code,
+        :city, :state, :country_code, :country, :complement, :foreign_code,
+        :zip_code, :city_registration, :state_registration_code
 
-    def initialize(attrs = {})
-      @cnpj = attrs[:CNPJ]
-      @cpf = attrs[:CPF]
+      # == 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
 
-      # 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]
+      def initialize(attrs = {})
+        @cnpj = attrs[:CNPJ]
+        @cpf = attrs[:CPF]
 
-      # 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]
+        # 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

@@ -1,20 +1,24 @@
 # 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
+  module Reader
+    # Identificação do Local de Entrega
+    class Delivery
+      include ::AttributeHelper
 
-    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]
+      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
 end

data/lib/nfe_reader/document.rb

@@ -1,72 +1,76 @@
 # 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
+  module Reader
+    # Documento Fiscal Referenciado
+    class Document
+      include ::AttributeHelper
 
-    # == 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)
+      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
 
-    def initialize(attrs = {})
-      # Chave da NF-e
-      @key = attrs[:refNFe]
+      # == 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)
 
-      # 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
+      def initialize(attrs = {})
+        # Chave da NF-e
+        @key = attrs[:refNFe]
 
-      # 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
+        # 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]
+        # 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]
+        # 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

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

data/lib/nfe_reader/fiscal.rb

@@ -1,33 +1,37 @@
 # 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
+  module Reader
+    # Identificação do Fisco Emitente da NF-e
+    class Fiscal
+      include ::AttributeHelper
 
-    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]
+      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
 end