cnab 0.1.0 → 0.2.0

data/README.md

@@ -2,7 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/cnab.png)](http://badge.fury.io/rb/cnab) [![Build Status](https://travis-ci.org/zertico/cnab.png)](https://travis-ci.org/zertico/cnab) [![Coverage Status](https://coveralls.io/repos/zertico/cnab/badge.png?branch=master)](https://coveralls.io/r/zertico/cnab) [![Code Climate](https://codeclimate.com/github/zertico/cnab.png)](https://codeclimate.com/github/zertico/cnab)
 
-Gem used to parse return from Brazil banks in format of cnab files.
+Gem used to parse return from Brazil banks in format of cnab files. It is based on the version 08.7 of the cnab.
+Right now it has support only for Segmento T and Segmento U.
 
 ## Installation
 
@@ -20,10 +21,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+cnab = Cnab.parse('path/to/your/file')
+```
+
+This method will return the file parsed in objects.
+
+If you need to merge the segments T and U, just pass true as the optional parameter:
+
+```ruby
+cnab = Cnab.parse('path/to/your/file', true)
+```
+
+## TODO
+
+* Add support for another type of segments
 
 ## Mantainers
 [@plribeiro3000](https://github.com/plribeiro3000)
+
 [@mfbmina](https://github.com/mfbmina)
 
 ## Contributing

data/lib/cnab.rb

@@ -11,7 +11,7 @@ module Cnab
   autoload :Helper, 'cnab/helper'
   autoload :Exceptions, 'cnab/exceptions'
 
-  def self.parse(file = nil)
+  def self.parse(file = nil, merge = false)
     raise Exceptions::NoFileGiven if file.nil?
 
     File.open(file, 'rb') do |f|
@@ -24,7 +24,11 @@ module Cnab
           trailer_lote = TrailerLote::Cobranca.new(line)
           break
         end
-        detalhes << Detalhe.parse(line)
+        if merge
+          detalhes << Detalhe.merge(line, f.gets)
+        else
+          detalhes << Detalhe.parse(line)
+        end
       end
 
       trailer_arquivo = TrailerArquivo.new(f.gets)

data/lib/cnab/detalhe.rb

@@ -2,6 +2,7 @@ module Cnab
   module Detalhe
     autoload :SegmentoT, 'cnab/detalhe/segmento_t'
     autoload :SegmentoU, 'cnab/detalhe/segmento_u'
+    autoload :SegmentoTU, 'cnab/detalhe/segmento_t_u'
 
     def self.parse(line)
       case line[13]
@@ -13,5 +14,9 @@ module Cnab
           raise Exceptions::SegmentNotImplemented
       end
     end
+
+    def self.merge(line1, line2)
+      SegmentoTU.new(parse(line1), parse(line2))
+    end
   end
 end

data/lib/cnab/detalhe/segmento_t.rb

@@ -4,35 +4,37 @@ module Cnab
       include Helper
       
       def initialize(line)
-        @banco                  = line[0..2]
-        @lote                   = line[3..6]
-        @tipo_registro          = line[7..7]
-        @num_registro           = line[8..12]
-        @segmento               = line[13..13]
-        @res_cnab1              = line[14..14]
-        @cod_movimentacao       = line[15..16]
-        @agencia                = line[17..21]
-        @dv_agencia             = line[22..22]
-        @conta_corrente         = line[23..34]
-        @dv_conta               = line[35..35]
-        @dv_conta_agencia       = line[36..36]
-        @id_titulo              = line[37..56]
-        @carteira               = line[57..57]
-        @doc_cobranca           = line[58..72]
-        @vencimento             = line[73..80]
-        @valor_titulo           = line[81..95]
-        @banco_recebimento      = line[96..98]
-        @ag_recebimento         = line[99..103]
-        @dv_ag_recebimento      = line[104..104]
-        @id_titulo_empresa      = line[105..129]
-        @cod_moeda              = line[130..131]
-        @tipo_inscricao         = line[132..132]
-        @num_inscricao          = line[133..147]
-        @nome                   = line[148..187]
-        @num_contrato           = line[188..197]
-        @tarifa                 = line[198..212]
-        @motivo                 = line[213..222]
-        @res_cnab2              = line[223..239]
+        raise Exceptions::LineNotParseable unless line.size == 242
+
+        @banco                  = line[0..2].strip
+        @lote                   = line[3..6].strip
+        @tipo_registro          = line[7..7].strip
+        @num_registro           = line[8..12].strip
+        @segmento               = line[13..13].strip
+        @res_cnab1              = line[14..14].strip
+        @cod_movimentacao       = line[15..16].strip
+        @agencia                = line[17..21].strip
+        @dv_agencia             = line[22..22].strip
+        @conta_corrente         = line[23..34].strip
+        @dv_conta               = line[35..35].strip
+        @dv_conta_agencia       = line[36..36].strip
+        @id_titulo              = line[37..56].strip
+        @carteira               = line[57..57].strip
+        @doc_cobranca           = line[58..72].strip
+        @vencimento             = line[73..80].strip
+        @valor_titulo           = line[81..95].strip
+        @banco_recebimento      = line[96..98].strip
+        @ag_recebimento         = line[99..103].strip
+        @dv_ag_recebimento      = line[104..104].strip
+        @id_titulo_empresa      = line[105..129].strip
+        @cod_moeda              = line[130..131].strip
+        @tipo_inscricao         = line[132..132].strip
+        @num_inscricao          = line[133..147].strip
+        @nome                   = line[148..187].strip
+        @num_contrato           = line[188..197].strip
+        @tarifa                 = line[198..212].strip
+        @motivo                 = line[213..222].strip
+        @res_cnab2              = line[223..239].strip
       end
     end
   end

data/lib/cnab/detalhe/segmento_t_u.rb

@@ -0,0 +1,22 @@
+module Cnab
+  module Detalhe
+    class SegmentoTU
+      def initialize(segmento_t, segmento_u)
+        @segmento_t = segmento_t
+        @segmento_u = segmento_u
+      end
+
+      def method_missing(method_name)
+        return @segmento_t.send(method_name) if @segmento_t.respond_to?(method_name)
+        return @segmento_u.send(method_name) if @segmento_u.respond_to?(method_name)
+        super
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        return true if @segmento_t.respond_to?(method_name)
+        return true if @segmento_u.respond_to?(method_name)
+        super
+      end
+    end
+  end
+end

data/lib/cnab/detalhe/segmento_u.rb

@@ -4,30 +4,32 @@ module Cnab
       include Helper
       
       def initialize(line)
-        @banco                   = line[0..2]
-        @lote                    = line[3..6]
-        @tipo_registro           = line[7..7]
-        @num_registro            = line[8..12]
-        @segmento                = line[13..13]
-        @res_cnab1               = line[14..14]
-        @cod_movimentacao        = line[15..16]
-        @acrescimos              = line[17..31]
-        @valor_desconto          = line[32..46]
-        @valor_abatimento        = line[47..61]
-        @valor_iof               = line[62..76]
-        @valor_pago              = line[77..91]
-        @valor_liquido           = line[92..106]
-        @outras_despesas         = line[107..122]
-        @outros_creditos         = line[123..136]
-        @data_ocorrencia         = line[137..144]
-        @data_credito            = line[145..152]
-        @cod_ocorrencia_sacado   = line[153..156]
-        @data_ocorrencia_sacado  = line[157..164]
-        @valor_ocorrencia_sacado = line[165..179]
-        @compl_ocorrencia_sacado = line[180..209]
-        @banco_compensacao       = line[210..212]
-        @banco_enviado           = line[213..232]
-        @res_cnab2               = line[233..239]
+        raise Exceptions::LineNotParseable unless line.size == 242
+
+        @banco                   = line[0..2].strip
+        @lote                    = line[3..6].strip
+        @tipo_registro           = line[7..7].strip
+        @num_registro            = line[8..12].strip
+        @segmento                = line[13..13].strip
+        @res_cnab1               = line[14..14].strip
+        @cod_movimentacao        = line[15..16].strip
+        @acrescimos              = line[17..31].strip
+        @valor_desconto          = line[32..46].strip
+        @valor_abatimento        = line[47..61].strip
+        @valor_iof               = line[62..76].strip
+        @valor_pago              = line[77..91].strip
+        @valor_liquido           = line[92..106].strip
+        @outras_despesas         = line[107..122].strip
+        @outros_creditos         = line[123..136].strip
+        @data_ocorrencia         = line[137..144].strip
+        @data_credito            = line[145..152].strip
+        @cod_ocorrencia_sacado   = line[153..156].strip
+        @data_ocorrencia_sacado  = line[157..164].strip
+        @valor_ocorrencia_sacado = line[165..179].strip
+        @compl_ocorrencia_sacado = line[180..209].strip
+        @banco_compensacao       = line[210..212].strip
+        @banco_enviado           = line[213..232].strip
+        @res_cnab2               = line[233..239].strip
       end
     end
   end

data/lib/cnab/exceptions.rb

@@ -2,5 +2,6 @@ module Cnab
   module Exceptions
     autoload :NoFileGiven, 'cnab/exceptions/no_file_given'
     autoload :SegmentNotImplemented, 'cnab/exceptions/segment_not_implemented'
+    autoload :LineNotParseable, 'cnab/exceptions/line_not_parseable'
   end
 end

data/lib/cnab/exceptions/line_not_parseable.rb

@@ -0,0 +1,9 @@
+module Cnab
+  module Exceptions
+    class LineNotParseable < StandardError
+      def self.initialize
+        super("This line does not have the expected size!")
+      end
+    end
+  end
+end

data/lib/cnab/header_arquivo.rb

@@ -3,30 +3,32 @@ module Cnab
     include Helper
     
     def initialize(line)
-      @banco                  = line[0..2]
-      @lote                   = line[3..6]
-      @registro               = line[7..7]
-      @res_cnab1              = line[8..16]
-      @tipo_empresa           = line[17..17]
-      @num_empresa            = line[18..31]
-      @convenio               = line[32..51]
-      @agencia                = line[52..56] 
-      @dv_agencia             = line[57..57]
-      @conta_corrente         = line[58..69]
-      @dv_conta               = line[70..70]
-      @dv_conta_agencia       = line[71..71]
-      @nome_empresa           = line[72..101]
-      @nome_banco             = line[102..131]
-      @res_cnab2              = line[132..141]
-      @cod_retorno            = line[142..142]
-      @data_geracao_arq       = line[143..150]
-      @hora_geracao_arq       = line[151..156]
-      @sequencia              = line[157..162]
-      @versao                 = line[163..165]
-      @densidade              = line[166..170]
-      @res_banco              = line[171..190]
-      @res_empresa            = line[191..210]
-      @res_cnab3              = line[211..239]
+      raise Exceptions::LineNotParseable unless line.size == 242
+
+      @banco                  = line[0..2].strip
+      @lote                   = line[3..6].strip
+      @registro               = line[7..7].strip
+      @res_cnab1              = line[8..16].strip
+      @tipo_empresa           = line[17..17].strip
+      @num_empresa            = line[18..31].strip
+      @convenio               = line[32..51].strip
+      @agencia                = line[52..56].strip 
+      @dv_agencia             = line[57..57].strip
+      @conta_corrente         = line[58..69].strip
+      @dv_conta               = line[70..70].strip
+      @dv_conta_agencia       = line[71..71].strip
+      @nome_empresa           = line[72..101].strip
+      @nome_banco             = line[102..131].strip
+      @res_cnab2              = line[132..141].strip
+      @cod_retorno            = line[142..142].strip
+      @data_geracao_arq       = line[143..150].strip
+      @hora_geracao_arq       = line[151..156].strip
+      @sequencia              = line[157..162].strip
+      @versao                 = line[163..165].strip
+      @densidade              = line[166..170].strip
+      @res_banco              = line[171..190].strip
+      @res_empresa            = line[191..210].strip
+      @res_cnab3              = line[211..239].strip
     end
   end
 end

data/lib/cnab/header_lote/cobranca.rb

@@ -4,29 +4,31 @@ module Cnab
       include Helper
       
       def initialize(line)
-        @banco                  = line[0..2]
-        @lote                   = line[3..6]
-        @registro               = line[7..7]
-        @tipo_operacao          = line[8..8]
-        @tipo_servico           = line[9..10]
-        @res_cnab1              = line[11..12]
-        @layout_lote            = line[13..15]
-        @res_cnab2              = line[16..16]
-        @tipo_empresa           = line[17..17]
-        @num_empresa            = line[18..32]
-        @convenio               = line[33..52]
-        @agencia                = line[53..57] 
-        @dv_agencia             = line[58..58]
-        @conta_corrente         = line[59..70]
-        @dv_conta               = line[71..71]
-        @dv_conta_agencia       = line[72..72]
-        @nome_empresa           = line[73..102]
-        @informacao1            = line[103..142]
-        @informacao2            = line[143..182]
-        @numero_remessa         = line[183..190]
-        @data_gravacao          = line[191..198]
-        @data_credito           = line[199..206]
-        @res_cnab3              = line[207..239]
+        raise Exceptions::LineNotParseable unless line.size == 242
+
+        @banco                  = line[0..2].strip
+        @lote                   = line[3..6].strip
+        @registro               = line[7..7].strip
+        @tipo_operacao          = line[8..8].strip
+        @tipo_servico           = line[9..10].strip
+        @res_cnab1              = line[11..12].strip
+        @layout_lote            = line[13..15].strip
+        @res_cnab2              = line[16..16].strip
+        @tipo_empresa           = line[17..17].strip
+        @num_empresa            = line[18..32].strip
+        @convenio               = line[33..52].strip
+        @agencia                = line[53..57].strip 
+        @dv_agencia             = line[58..58].strip
+        @conta_corrente         = line[59..70].strip
+        @dv_conta               = line[71..71].strip
+        @dv_conta_agencia       = line[72..72].strip
+        @nome_empresa           = line[73..102].strip
+        @informacao1            = line[103..142].strip
+        @informacao2            = line[143..182].strip
+        @numero_remessa         = line[183..190].strip
+        @data_gravacao          = line[191..198].strip
+        @data_credito           = line[199..206].strip
+        @res_cnab3              = line[207..239].strip
       end
     end
   end

data/lib/cnab/helper.rb

@@ -3,5 +3,17 @@ module Cnab
     def method_missing(method)
       instance_variable_get("@#{method}")
     end
+
+    def respond_to_missing?(method_name, include_private = false)
+      return true unless instance_variable_get("@#{method_name}").nil?
+      super
+    end
+
+    def inspect
+      variables = instance_variables.map do |instance_variable|
+        "#{instance_variable.to_s.gsub('@', '')}: \"#{instance_variable_get(instance_variable)}\""
+      end.join(", ")
+      "<#{self.class.name} #{variables}>"
+    end
   end
-end
+end

data/lib/cnab/trailer_arquivo.rb

@@ -3,14 +3,16 @@ module Cnab
     include Helper
     
     def initialize(line)
-      @banco                  = line[0..2]
-      @lote                   = line[3..6]
-      @registro               = line[7..7]
-      @res_cnab1              = line[8..16]
-      @qtd_lotes              = line[17..22]
-      @qtd_registros          = line[23..28]
-      @qtd_contas             = line[29..34]
-      @res_cnab2              = line[35..239]
+      raise Exceptions::LineNotParseable unless line.size == 242
+
+      @banco                  = line[0..2].strip
+      @lote                   = line[3..6].strip
+      @registro               = line[7..7].strip
+      @res_cnab1              = line[8..16].strip
+      @qtd_lotes              = line[17..22].strip
+      @qtd_registros          = line[23..28].strip
+      @qtd_contas             = line[29..34].strip
+      @res_cnab2              = line[35..239].strip
     end
   end
 end

data/lib/cnab/trailer_lote/cobranca.rb

@@ -4,21 +4,23 @@ module Cnab
       include Helper
       
       def initialize(line)
-        @banco                    = line[0..2]
-        @lote                     = line[3..6]
-        @registro                 = line[7..7]
-        @res_cnab1                = line[8..16]
-        @qtd_registros            = line[17..22]
-        @qtd_titulos_simples      = line[23..28]
-        @valor_titulos_simples    = line[29..45]
-        @qtd_titulos_vinculada    = line[46..51]
-        @valor_titulos_simples    = line[52..68]
-        @qtd_titulos_caucionada   = line[69..74]
-        @valor_titulos_caucionada = line[75..91]
-        @qtd_titulos_descontada   = line[92..97]
-        @valor_titulos_descontada = line[98..114]
-        @num_aviso                = line[115..122]
-        @res_cnab3                = line[123..239]
+        raise Exceptions::LineNotParseable unless line.size == 242
+
+        @banco                    = line[0..2].strip
+        @lote                     = line[3..6].strip
+        @registro                 = line[7..7].strip
+        @res_cnab1                = line[8..16].strip
+        @qtd_registros            = line[17..22].strip
+        @qtd_titulos_simples      = line[23..28].strip
+        @valor_titulos_simples    = line[29..45].strip
+        @qtd_titulos_vinculada    = line[46..51].strip
+        @valor_titulos_simples    = line[52..68].strip
+        @qtd_titulos_caucionada   = line[69..74].strip
+        @valor_titulos_caucionada = line[75..91].strip
+        @qtd_titulos_descontada   = line[92..97].strip
+        @valor_titulos_descontada = line[98..114].strip
+        @num_aviso                = line[115..122].strip
+        @res_cnab3                = line[123..239].strip
       end
     end
   end

data/lib/cnab/version.rb

@@ -1,3 +1,3 @@
 module Cnab
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end