cnab_rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9668b76dddf165eb9f41fc2ef951f86b99f7f6a79fcc2b11ab1b522b316917b6
-  data.tar.gz: 6b6ecc7e01022ebbff08954eaa6e43400b63599d97a9c19e71170f19a4817522
+  metadata.gz: d125b4600942c6b69ac39a1258d3f16e08e7365a46bd613e4bdcf3e520f33a11
+  data.tar.gz: c06a22ec4306e80703e7f8b712ac9bb96d419ef341be462c8b31cfc8091cd29a
 SHA512:
-  metadata.gz: 3a182e807ec9acd97b4178875b286a3171cb1bcf716a562fb40161b3813df7589668ed5463ef49e60da5347b79e08cbfe1135e2f73e68481b582ccdb00179707
-  data.tar.gz: bb3a3d765ec2c4c1e0fd4da07fe13284b2cccb9cc9a613f5cbf2f4cb6140bfa79d6ba410a46c6dde5c09e4a5b6487742c6cb4ea2793cfb2ec956c12c4ea2f88c
+  metadata.gz: cc2df7ccf2bc907830033a59d68d47acda402fb38a7b81808b399381453cf947e46df5fc742d5dd5a231eefe8b3bcc57a3555b53acaa243bb2a8ed5f9fdbe65e
+  data.tar.gz: b9fbd01403a202db938b1351e6e723c45cf073e88efa9c6908dfe62f858afb095ec557254d5b7d2d877a104a06fd3046bc47e422e607adc6b8f7aa25cde9fb30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cnab_rb (0.1.0)
+    cnab_rb (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,6 @@
 # CnabRb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cnab_rb`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Project to create and read CNAB files
 
 ## Installation
 
@@ -22,7 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Read return files:
+
+```ruby
+require 'cnab_rb'
+
+factory = CnabRb::Return::ReturnFactory.new
+file = factory.make_return('path/to/file.ret')
+
+file.details.each do |detail|
+  received_amount = detail.net_amount
+  is_write_off = detail.is_write_off
+  our_number = detail.our_number
+  
+  if is_write_off && received_amount
+    # your title is paid
+  end
+end
+```
 
 ## Development
 

data/lib/cnab_rb.rb

@@ -20,10 +20,9 @@ module CnabRb
     module Cnab240
       module Generic
         module Return
-          autoload :SegmentA, 'cnab_rb/layouts/cnab240/generic/segment_a'
-          autoload :SegmentT, 'cnab_rb/layouts/cnab240/generic/segment_t'
-          autoload :SegmentU, 'cnab_rb/layouts/cnab240/generic/segment_u'
-          autoload :SegmentW, 'cnab_rb/layouts/cnab240/generic/segment_w'
+          autoload :SegmentT, 'cnab_rb/layouts/cnab240/generic/return/segment_t'
+          autoload :SegmentU, 'cnab_rb/layouts/cnab240/generic/return/segment_u'
+          autoload :SegmentW, 'cnab_rb/layouts/cnab240/generic/return/segment_w'
         end
 
         autoload :HeaderFile, 'cnab_rb/layouts/cnab240/generic/header_file'
@@ -36,6 +35,13 @@ module CnabRb
   end
 
   module Return
+    module Cnab240
+      autoload :GenericReturn, 'cnab_rb/return/cnab240/generic_return'
+      autoload :Batch, 'cnab_rb/return/cnab240/batch'
+      autoload :Detail, 'cnab_rb/return/cnab240/detail'
+      autoload :CaixaReturn, 'cnab_rb/return/cnab240/caixa_return'
+    end
+
     autoload :ReturnFactory, 'cnab_rb/return/return_factory'
   end
 end

data/lib/cnab_rb/format/field.rb

@@ -36,8 +36,8 @@ module CnabRb::Format
     def decode(value)
       decoded = @picture.decode(value)
 
-      unless @date_format.nil?
-        DateTime.strptime(decoded.to_s, @date_format)
+      unless @date_format.nil? || decoded == 0
+        DateTime.strptime(decoded.to_s.rjust(length, '0'), @date_format)
       else
         decoded
       end

data/lib/cnab_rb/format/file.rb

@@ -15,10 +15,14 @@ module CnabRb::Format
     def decode(text)
       @lines = text.split(LINE_BREAK).map do |line_text|
         layout = get_line_layout(line_text)
-        line = Line.new(layout)
-        line.decode(line_text)
-        line
+        unless layout.nil?
+          line = Line.new(layout)
+          line.decode(line_text)
+          line
+        end
       end
+
+      @lines = @lines.filter {|n| !n.nil?}
     end
 
     def get_line_layout(line_text)

data/lib/cnab_rb/format/line.rb

@@ -45,5 +45,9 @@ module CnabRb::Format
 
       return false
     end
+
+    def field_exists(field_name)
+      @attributes.key? field_name.to_sym
+    end
   end
 end

data/lib/cnab_rb/format/picture.rb

@@ -9,7 +9,6 @@ module CnabRb::Format
           length_decimal = length_decimal.to_i
         end
 
-
         if 'X' == type
           @format = PictureFormats::Text.new(length)
         elsif ('9' == type and length_decimal.nil?)

data/lib/cnab_rb/format/picture_formats/float.rb

@@ -24,7 +24,7 @@ module CnabRb::Format::PictureFormats
     end
 
     def length
-      @length_left + @length_right
+      @format_left.length + @length_right
     end
   end
 end

data/lib/cnab_rb/layouts/cnab240/generic/header_batch.rb

@@ -1,5 +1,5 @@
 module CnabRb::Layouts::Cnab240::Generic
-  class HeaderFile < CnabRb::Layouts::Layout
+  class HeaderBatch < CnabRb::Layouts::Layout
     def init_fields
       field :bank_code,
         # codigo_banco

data/lib/cnab_rb/layouts/cnab240/generic/header_file.rb

@@ -164,10 +164,10 @@ module CnabRb::Layouts::Cnab240::Generic
         # Número seqüencial adotado e controlado pelo responsável pela geração do arquivo para ordenar a
         # disposição dos arquivos encaminhados.
         # Evoluir um número seqüencial a cada header de arquivo.
-        pos: [158, 163],
+        pos: 158..163,
         picture: '9(6)'
 
-      file :layout_version,
+      field :layout_version,
         # Código adotado pela FEBRABAN para identificar qual a versão de layout do arquivo encaminhado. O
         # código é composto de:
         # Versão = 2 dígitos
@@ -177,7 +177,7 @@ module CnabRb::Layouts::Cnab240::Generic
         picture: '9(3)',
         default: '030'
 
-      file :density_file,
+      field :density_file,
         # Densidade de gravação (bpi), do arquivo encaminhado. Pode ser:
         # 1600 BPI
         # 6250 BPI
@@ -201,7 +201,7 @@ module CnabRb::Layouts::Cnab240::Generic
         picture: 'X(20)',
         default: 'REMESSA-PRODUCAO'
 
-      field :exclusive_use_febraban_2,
+      field :exclusive_use_febraban_3,
         # Texto de observações destinado para uso exclusivo da FEBRABAN. Preencher com Brancos.
         pos: 212..240,
         picture: 'X(29)',

data/lib/cnab_rb/layouts/cnab240/generic/return/segment_t.rb

@@ -36,7 +36,7 @@ module CnabRb::Layouts::Cnab240::Generic::Return
         pos: 16..17,
         picture: '9(2)'
 
-      field :mantainer_agency,
+      field :agency,
         # agencia_mantenedora
         pos: 18..22,
         picture: '9(5)'

data/lib/cnab_rb/layouts/layout.rb

@@ -29,7 +29,7 @@ module CnabRb::Layouts
       end
 
       if expected_line_length != actual_line_length
-        raise CnabRb::Error.new("Invalid layout length, expected #{expected_line_length}, actual #{actual_line_length}")
+        raise CnabRb::Error.new("Invalid layout length, expected #{expected_line_length}, actual #{actual_line_length}, layout: #{self.class}")
       end
     end
 

data/lib/cnab_rb/return/cnab240/batch.rb

@@ -0,0 +1,41 @@
+module CnabRb::Return::Cnab240
+  class Batch
+    attr_accessor :segments, :header, :trailer
+
+    def initialize
+      @segments = []
+    end
+
+    def details
+      unless @details.nil?
+        return @details
+      end
+
+      lastDetail = nil
+      @details = []
+
+      @segments.each do |s|
+        if s.segment_code == 'T'
+          lastDetail = Detail.new
+          @details << lastDetail
+        end
+
+        unless lastDetail.nil?
+          if s.segment_code == 'T'
+            lastDetail.segment_t = s
+          end
+
+          if s.segment_code == 'U'
+            lastDetail.segment_u = s
+          end
+
+          if s.segment_code == 'W'
+            lastDetail.segment_w = s
+          end
+        end
+      end
+
+      @details
+    end
+  end
+end

data/lib/cnab_rb/return/cnab240/caixa_return.rb

@@ -1,4 +1,4 @@
 module CnabRb::Return::Cnab240
-  class CaixaReturn < Cnab::Return::Cnab240::GenericReturn
+  class CaixaReturn < CnabRb::Return::Cnab240::GenericReturn
   end
 end

data/lib/cnab_rb/return/cnab240/detail.rb

@@ -0,0 +1,103 @@
+module CnabRb::Return::Cnab240
+  class Detail
+    attr_accessor :segment_t, :segment_u, :segment_w
+
+    def is_write_off
+      [6, 9, 17, 25].include?(@segment_t.movement_code)
+    end
+
+    def is_rejected_write_off
+      [3, 26, 30].include?(@segment_t.movement_code)
+    end
+
+    def movement_code
+      @segment_t.movement_code
+    end
+
+    def net_amount
+      @segment_u.net_amount
+    end
+
+    def title_amount
+      @segment_t.title_amount
+    end
+
+    def paid_amount
+      @segment_u.paid_amount
+    end
+
+    def tax_amount
+      @segment_t.tax_amount
+    end
+
+    def iof_amount
+      @segment_u.iof_amount
+    end
+
+    def discount_amount
+      @segment_u.discount_amount
+    end
+
+    def abatement_amount
+      @segment_u.abatement_amount
+    end
+
+    def other_expenses_amount
+      @segment_u.other_expenses_amount
+    end
+
+    def other_credits_amount
+      @segment_u.other_credits_amount
+    end
+
+    def document_number
+      @segment_t.document_number
+    end
+
+    def our_number
+      @segment_t.our_number
+    end
+
+    def due_date
+      @segment_t.due_date
+    end
+
+    def credit_date
+      @segment_u.credit_date
+    end
+
+    def fine_amount
+      @segment_u.additions_amount
+    end
+
+    def ocurrency_date
+      @segment_u.ocurrency_date
+    end
+
+    def wallet_code
+      if @segment_t.field_exists(:wallet_code)
+        @segment_t.wallet_code
+      end
+    end
+
+    def agency
+      @segment_t.agency
+    end
+
+    def agency_cd
+      @segment_t.agency_cd
+    end
+
+    def collector_agency
+      @segment_t.collector_agency
+    end
+
+    def collector_agency_cd
+      @segment_t.collector_agency_cd
+    end
+
+    def sequential_number
+      @segment_t.sequential_number_batch
+    end
+  end
+end

data/lib/cnab_rb/return/cnab240/generic_return.rb

@@ -1,4 +1,96 @@
 module CnabRb::Return::Cnab240
-  class GenericReturn < Cnab::Format::File
+  class GenericReturn < CnabRb::Format::File
+    def get_line_layout(line_text)
+      registry_type_table = {
+        '0' => :header_file,
+        '1' => :header_batch,
+        '3' => :segment,
+        '5' => :trailer_batch,
+        '9' => :trailer_file
+      }
+
+      registry_type = registry_type_table[line_text[7, 1]]
+      segment_code = line_text[13, 1]
+
+      unless registry_type.nil?
+        if :segment == registry_type
+          method_name = "segment_#{segment_code.downcase}_layout"
+        else
+          method_name = "#{registry_type}_layout"
+        end
+
+        if respond_to?(method_name)
+          send(method_name)
+        end
+      end
+    end
+
+    def header_file_layout
+      CnabRb::Layouts::Cnab240::Generic::HeaderFile.new
+    end
+
+    def header_batch_layout
+      CnabRb::Layouts::Cnab240::Generic::HeaderBatch.new
+    end
+
+    def segment_t_layout
+      CnabRb::Layouts::Cnab240::Generic::Return::SegmentT.new
+    end
+
+    def segment_u_layout
+      CnabRb::Layouts::Cnab240::Generic::Return::SegmentU.new
+    end
+
+    def segment_w_layout
+      CnabRb::Layouts::Cnab240::Generic::Return::SegmentW.new
+    end
+
+    def trailer_batch_layout
+      CnabRb::Layouts::Cnab240::Generic::TrailerBatch.new
+    end
+
+    def trailer_file_layout
+      CnabRb::Layouts::Cnab240::Generic::TrailerFile.new
+    end
+
+    def batches
+      unless @batches.nil?
+        return @batches
+      end
+
+      lastBatch = nil
+      @batches = []
+
+      @lines.each do |line|
+        if line.registry_type == 1
+          lastBatch = Batch.new
+          @batches.push(lastBatch)
+        end
+
+        unless lastBatch.nil?
+          if line.registry_type == 1
+            lastBatch.header = line
+          end
+
+          if line.registry_type == 3
+            lastBatch.segments << line
+          end
+
+          if line.registry_type == 5
+            lastBatch.trailer = line
+          end
+        end
+      end
+
+      @batches
+    end
+
+    def details
+      unless @details.nil?
+        return @details
+      end
+
+      @details = batches.map{|b| b.details}.flatten
+    end
   end
 end

data/lib/cnab_rb/return/return_factory.rb

@@ -2,7 +2,7 @@ module CnabRb::Return
   class ReturnFactory
     def make_return(file_name)
       first_line = File.open(file_name, &:readline)
-      format = first_line.gsub(/(\r|\n)$/, '').length
+      format = first_line.gsub(/(\r|\n)/, '').length
       bank_code = first_line[0, 3]
       method = "make_cnab#{format}_#{bank_code}"
 
@@ -14,6 +14,9 @@ module CnabRb::Return
     end
 
     def make_cnab240_104(file_name)
+      file = CnabRb::Return::Cnab240::CaixaReturn.new
+      file.decode(File.read(file_name))
+      file
     end
   end
 end

data/lib/cnab_rb/version.rb

@@ -1,3 +1,3 @@
 module CnabRb
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cnab_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Anderson Danilo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,14 +81,15 @@ files:
 - lib/cnab_rb/format/picture_formats/text.rb
 - lib/cnab_rb/layouts/cnab240/generic/header_batch.rb
 - lib/cnab_rb/layouts/cnab240/generic/header_file.rb
-- lib/cnab_rb/layouts/cnab240/generic/return/segment_a.rb
 - lib/cnab_rb/layouts/cnab240/generic/return/segment_t.rb
 - lib/cnab_rb/layouts/cnab240/generic/return/segment_u.rb
 - lib/cnab_rb/layouts/cnab240/generic/return/segment_w.rb
 - lib/cnab_rb/layouts/cnab240/generic/trailer_batch.rb
 - lib/cnab_rb/layouts/cnab240/generic/trailer_file.rb
 - lib/cnab_rb/layouts/layout.rb
+- lib/cnab_rb/return/cnab240/batch.rb
 - lib/cnab_rb/return/cnab240/caixa_return.rb
+- lib/cnab_rb/return/cnab240/detail.rb
 - lib/cnab_rb/return/cnab240/generic_return.rb
 - lib/cnab_rb/return/return_factory.rb
 - lib/cnab_rb/version.rb

data/lib/cnab_rb/layouts/cnab240/generic/return/segment_a.rb

@@ -1,163 +0,0 @@
-module CnabRb::Layouts::Cnab240::Generic::Return
-  class SegmentA < CnabRb::Layouts::Layout
-    def init_fields
-      field :bank_code,
-        # codigo_banco
-        pos: 1..3,
-        picture: '9(3)'
-
-      field :service_batch,
-        # lote_servico
-        pos: 4..7,
-        picture: '9(4)'
-
-      field :registry_type,
-        # tipo_registro
-        pos: 8..8,
-        picture: '9(1)',
-        default: '3'
-
-      field :sequential_number_batch,
-        # numero_sequencial_lote
-        pos: 9..13,
-        picture: '9(5)'
-
-      field :segment_code,
-        # codigo_segmento
-        pos: 14..14,
-        picture: 'X(1)',
-        default: 'A'
-
-      field :movement_type,
-        # tipo_movimento
-        pos: 15..15,
-        picture: '9(1)',
-        default: ''
-
-      field :movement_instruction_code,
-        # codigo_instrucao_movimento
-        pos: 16..17,
-        picture: '9(2)'
-
-      field :centering_chamber,
-        # camara_centralizadora
-        pos: 18..20,
-        picture: '9(3)'
-
-      field :favored_bank,
-        # banco_favorecido
-        pos: 21..23,
-        picture: '9(3)'
-
-      field :favored_agency,
-        # agencia_favorecido
-        pos: 24..28,
-        picture: '9(5)'
-
-      field :favored_agency_cd,
-        # agencia_dv_favorecido
-        pos: 29..29,
-        picture: 'X(1)'
-
-      field :favored_account,
-        # conta_favorecido
-        pos: 30..41,
-        picture: '9(12)'
-
-      field :favored_account_cd,
-        # conta_dv_favorecido
-        pos: 42..42,
-        picture: 'X(1)'
-
-      field :favored_agency_account_cd,
-        # agencia_conta_dv_favorecido
-        pos: 43..43,
-        picture: 'X(1)'
-
-      field :favored_name,
-        # nome_favorecido
-        pos: 44..73,
-        picture: 'X(30)'
-
-      field :document_number,
-        # numero_documento
-        pos: 74..93,
-        picture: 'X(20)'
-
-      field :payment_date,
-        # data_pagamento
-        pos: 94..101,
-        picture: '9(8)',
-        date_format: '%d%m%Y'
-
-      field :currency_code,
-        # tipo_moeda
-        pos: 102..104,
-        picture: 'X(3)',
-        default: 'BRL'
-
-      field :coin_quantity,
-        # quantidade_moeda
-        pos: 105..119,
-        picture: '9(10)V9(5)'
-
-      field :payment_amount,
-        # valor_pagamento
-        pos: 120..134,
-        picture: '9(13)V9(2)'
-
-      field :our_number,
-        # nosso_numero
-        pos: 135..154,
-        picture: 'X(20)'
-
-      field :real_date,
-        # data_real
-        pos: 155..162,
-        picture: '9(8)',
-        date_format: '%d%m%Y'
-
-      field :real_amount,
-        # valor_real
-        pos: 163..177,
-        picture: '9(13)V9(2)'
-
-      field :information_2,
-        # informacao_2
-        pos: 178..217,
-        picture: 'X(40)'
-
-      field :document_finality,
-        # finalidade_doc
-        pos: 218..219,
-        picture: 'X(2)'
-
-      field :ted_finality,
-        # finalidade_ted
-        pos: 220..224,
-        picture: 'X(5)'
-
-      field :complementary_finality,
-        # finalidade_complementar
-        pos: 225..226,
-        picture: 'X(2)'
-
-      field :exclusive_use_febraban_1,
-        # uso_exclusivo_febraban
-        pos: 227..229,
-        picture: 'X(3)',
-        default: ''
-
-      field :notice,
-        # aviso
-        pos: 230..230,
-        picture: '9(1)'
-
-      field :ocurrences,
-        # ocorencias
-        pos: 231..240,
-        picture: 'X(10)',
-        default: ''
-    end
-  end
-end