cnab240_bancoabc 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f0409fdc5a38967ab550f437467b55c42f37ab6a33a360552d3f7a35aad1f6f
+  data.tar.gz: b8d07de12a0e04dd3750fe163b91eb19ee6b474ca5211933d4cfa6eb49a01ad9
+SHA512:
+  metadata.gz: a64ad2ed9050092d0c9dfb7b946292c75234b201ff07ce41f05b044277cdf017b567c7514ad4dbd81a579c04855ce112bd13af094a7be93b38f727470b6287c8
+  data.tar.gz: dd516db0342b85b4fa41a441ea15caed352a102f77438ac54f0c4d7ab3fe098a5c1697416da6b066884e1d44e15f77ace9c5f9721e45136f48dc8caff68fde72

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# CHANGELOG
+
+## v1.1.0-20220202 - Danilo Carolino
+
+* [QC-79](https://qflash.atlassian.net/jira/software/projects/QC/boards/31?selectedIssue=QC-79)
+Reduzir uso de pipelines em projetos Ruby [Dependabot]
+* Bump Ruby version to v3.1.0
+
+## v1.0.0
+
+Features
+
+* Criar débito de Tarifa para custas de Cartório [PL #11](https://github.com/Quasar-Flash/cnab240_bancoabc/pull/11) [QCedente 1324](https://gitlab.com/quasar_flash/flash/-/issues/1324)
+
+## v0.1.0
+
+* Initial files

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 QFlash
+
+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,72 @@
+CNAB240 Banco ABC Library for Ruby
+==============
+
+Build Status
+-----------------
+
+[![cnab240_bancoabc](https://github.com/Quasar-Flash/cnab240_bancoabc/actions/workflows/ruby.yml/badge.svg)](https://github.com/Quasar-Flash/cnab240_bancoabc/actions/workflows/ruby.yml)
+[![Quality Gate Status](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=alert_status&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Coverage](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=coverage&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Maintainability Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=sqale_rating&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+
+Project Scores
+-----------------
+
+[![Bugs](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=bugs&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Code Smells](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=code_smells&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Duplicated Lines (%)](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=duplicated_lines_density&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Lines of Code](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=ncloc&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Reliability Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=reliability_rating&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Security Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=security_rating&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Technical Debt](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=sqale_index&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+[![Vulnerabilities](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_cnab240_bancoabc&metric=vulnerabilities&token=ae764c50c4edff52b7a03d970f68bc697cdc5819)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_cnab240_bancoabc)
+
+Requirements
+-----------------
+
+- Ruby: Any version (tested: 3.0.1, 2.7.3, 2.6.7, 2.5.9)
+- Bundler
+
+Problems?
+-----------------
+
+**Please do not directly email any committers with questions or problems.**  A community is best served when discussions are held in public.
+
+Searching the [issues](https://github.com/Quasar-Flash/cnab240_bancoabc/issues) for your problem is also a good idea.
+
+Contributing
+-----------------
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it;
+- Fork the project;
+- Start a feature/bugfix branch;
+- Commit and push until you are happy with your contribution;
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+License
+-----------------
+
+Please see [LICENSE](https://github.com/Quasar-Flash/cnab240_bancoabc/blob/master/LICENSE.txt) for licensing details.
+
+Maintainers
+-----------------
+
+- Cícero Caiazzo, [@caiazzo14](https://github.com/caiazzo14) / [@Quasar-Flash](https://github.com/Quasar-Flash)
+- Danilo Carolino, [@danilogco](https://github.com/danilogco) / [@Quasar-Flash](https://github.com/Quasar-Flash)
+
+Run with Docker
+-----------------
+
+The commands bellow are used to run this project in a container.
+They use the Dockerfile at the root of the project and create a volume to update the container with the code changes you make at the outside.
+
+After every change to the source code you should do a '$rake install' in the container's bash and then you can run a new console or rspec/rubocop.
+
+```bash
+# in case you didn't build the image yet
+docker build -t cnab-gem .
+# raises the container and keeps it open and running using a never closing foreground job (in this case, 'bash')
+docker run -it -v $(pwd):/cnab240_bancoabc cnab-gem bash
+```

data/Rakefile

@@ -0,0 +1,48 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+begin
+  require "rdoc/task"
+rescue LoadError
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "cnab240_bancoabc"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require "rake/testtask"
+  require "rubocop/rake_task"
+
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.options = ["--display-cop-names"]
+  end
+rescue LoadError
+  # no rspec available
+end
+
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # no rspec available
+end
+
+task default: %i[rubocop spec]

data/lib/cnab240/bancoabc/entities/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: false
+
+module CNAB240
+  module BancoABC
+    module Entities
+      class Base
+        def header?
+          false
+        end
+
+        def trailler?
+          false
+        end
+
+        def register?
+          false
+        end
+
+        private
+          def white_space(range)
+            "".center(range.to_i)
+          end
+
+          def prepend_zero(data, range)
+            return white_space(range) if data.nil?
+
+            data = data.to_s
+
+            return data if data.length == range
+
+            zeros_size = range - data.length
+            (1..zeros_size).each { data.prepend("0") }
+
+            data
+          end
+
+          def append_space(data, range)
+            return white_space(range) if data.nil?
+
+            data = data.to_s
+
+            return data if data.length == range
+            return data[0..range - 1] if data.length > range
+
+            data + white_space(range - data.length)
+          end
+      end
+    end
+  end
+end

data/lib/cnab240/bancoabc/entities/header.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+
+module CNAB240
+  module BancoABC
+    module Entities
+      class Header < Base
+        attr_reader :line
+
+        def initialize(line)
+          @line = line
+        end
+
+        def header?
+          true
+        end
+
+        def data
+          {
+            codigo_do_banco: codigo_do_banco.strip,
+            lote_servico: lote_servico.strip,
+            tipo_servico: tipo_servico.strip,
+            uso_exclusivo_febraban_1: uso_exclusivo_febraban_1.strip,
+            tipo_inscricao_da_empresa: tipo_inscricao_da_empresa.strip,
+            numero_inscricao_da_empresa: numero_inscricao_da_empresa.strip,
+            codigo_identificacao_empresa_banco: codigo_identificacao_empresa_banco.strip,
+            nome_empresa: nome_empresa.strip,
+            nome_banco: nome_banco.strip,
+            uso_exclusivo_febraban_2: uso_exclusivo_febraban_2.strip,
+            codigo_retorno: codigo_retorno.strip,
+            data_geracao: data_geracao.strip,
+            hora_geracao: hora_geracao.strip,
+            numero_sequencial: numero_sequencial.strip,
+            numero_versao_layout: numero_versao_layout.strip,
+            desidade_gravacao_arquivo: desidade_gravacao_arquivo.strip,
+            uso_reservado_banco: uso_reservado_banco.strip,
+            uso_reservado_empresa: uso_reservado_empresa.strip,
+            uso_exclusivo_febraban_3: uso_exclusivo_febraban_3.strip
+          }
+        end
+
+        def codigo_do_banco
+          line[0..2]
+        end
+
+        def lote_servico
+          line[3..6]
+        end
+
+        def tipo_servico
+          line[7]
+        end
+
+        def uso_exclusivo_febraban_1
+          line[8..16]
+        end
+
+        def tipo_inscricao_da_empresa
+          line[17]
+        end
+
+        def numero_inscricao_da_empresa
+          line[18..31]
+        end
+
+        def codigo_identificacao_empresa_banco
+          line[32..71]
+        end
+
+        def nome_empresa
+          line[72..101]
+        end
+
+        def nome_banco
+          line[102..131]
+        end
+
+        def uso_exclusivo_febraban_2
+          line[132..141]
+        end
+
+        def codigo_retorno
+          line[142]
+        end
+
+        def data_geracao
+          line[143..150]
+        end
+
+        def hora_geracao
+          line[151..156]
+        end
+
+        def numero_sequencial
+          line[157..162]
+        end
+
+        def numero_versao_layout
+          line[163..165]
+        end
+
+        def desidade_gravacao_arquivo
+          line[166..170]
+        end
+
+        def uso_reservado_banco
+          line[171..190]
+        end
+
+        def uso_reservado_empresa
+          line[191..210]
+        end
+
+        def uso_exclusivo_febraban_3
+          line[211..239]
+        end
+      end
+    end
+  end
+end

data/lib/cnab240/bancoabc/entities/header_builder.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module CNAB240
+  module BancoABC
+    module Entities
+      class HeaderBuilder < Base
+        def header?
+          true
+        end
+
+        def codigo_do_banco
+          "246"
+        end
+
+        def lote_servico
+          "0" * 4
+        end
+
+        def tipo_servico
+          "0"
+        end
+
+        def uso_exclusivo_febraban_1(data = nil)
+          append_space(data, 9)
+        end
+
+        def tipo_inscricao_da_empresa
+          "2"
+        end
+
+        def numero_inscricao_da_empresa
+          "34218965000177"
+        end
+
+        def codigo_identificacao_empresa_banco
+          "00019070022307900000"
+        end
+
+        def nome_empresa
+          "QUASAR FLASH FI EM DIREITOS CM"
+        end
+
+        def nome_banco
+          "BCO ABC BRASIL#{' ' * 16}"
+        end
+
+        def uso_exclusivo_febraban_2(data = nil)
+          append_space(data, 10)
+        end
+
+        def codigo_retorno
+          "1"
+        end
+
+        def data_geracao(date_time)
+          date_time.strftime("%d%m%Y")
+        end
+
+        def hora_geracao(date_time)
+          date_time.strftime("%H%M%S")
+        end
+
+        def numero_sequencial(date_time)
+          date = date_time.day.to_s + date_time.hour.to_s + date_time.min.to_s
+
+          prepend_zero(date, 6)
+        end
+
+        def numero_versao_layout
+          "040"
+        end
+
+        def desidade_gravacao_arquivo
+          "01600"
+        end
+
+        def uso_reservado_banco(data = nil)
+          append_space(data, 20)
+        end
+
+        def uso_reservado_empresa(data = nil)
+          append_space(data, 20)
+        end
+
+        def uso_exclusivo_febraban_3(data = nil)
+          append_space(data, 29)
+        end
+      end
+    end
+  end
+end

data/lib/cnab240/bancoabc/entities/header_lote_builder.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+
+module CNAB240
+  module BancoABC
+    module Entities
+      class HeaderLoteBuilder < Base
+        def header?
+          true
+        end
+
+        def codigo_do_banco
+          "246"
+        end
+
+        def lote_servico
+          "#{'0' * 3}1"
+        end
+
+        def tipo_registro
+          "1"
+        end
+
+        def tipo_operacao
+          "R"
+        end
+
+        def tipo_servico
+          "01"
+        end
+
+        def uso_exclusivo_cnab_1(data = nil)
+          append_space(data, 2)
+        end
+
+        def numero_versao_layout
+          "030"
+        end
+
+        def uso_exclusivo_cnab_2(data = nil)
+          append_space(data, 1)
+        end
+
+        def tipo_inscricao_empresa
+          "2"
+        end
+
+        def numero_inscricao_empresa
+          "034218965000177"
+        end
+
+        def codigo_identificacao_empresa_banco
+          "00019070022307900000"
+        end
+
+        def nome_empresa
+          "QUASAR FLASH FI EM DIREITOS CM"
+        end
+
+        def mensagem(data = nil)
+          append_space(data, 40)
+        end
+
+        def numero_remessa(date_time)
+          date = date_time.day.to_s.to_s + date_time.month.to_s.to_s + date_time.hour.to_s.to_s + date_time.min.to_s.to_s
+
+          prepend_zero(date, 8)
+        end
+
+        def data_gravacao(date_time)
+          date_time.strftime("%d%m%Y")
+        end
+
+        def data_credito
+          "0" * 8
+        end
+
+        def uso_exclusivo(data = nil)
+          append_space(data, 33)
+        end
+      end
+    end
+  end
+end

data/lib/cnab240/bancoabc/entities/register_p.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: false
+
+module CNAB240
+  module BancoABC
+    module Entities
+      class RegisterP < Base
+        def register?
+          true
+        end
+
+        def codigo_banco(data = nil)
+          append_space(data, 3)
+        end
+
+        def lote_servico(data = nil)
+          append_space(data, 4)
+        end
+
+        def tipo_registro(data = nil)
+          append_space(data, 1)
+        end
+
+        def numero_registro(data = nil)
+          prepend_zero(data, 5)
+        end
+
+        def segmento
+          "P"
+        end
+
+        def cnab(data = nil)
+          append_space(data, 1)
+        end
+
+        def codigo_movimento(data = nil)
+          append_space(data, 2)
+        end
+
+        def identificacao_empresa
+          "00019070022307900000"
+        end
+
+        def direcionamento_cobranca(data = nil)
+          append_space(data, 1)
+        end
+
+        def modalidade_cobranca
+          "0" * 3
+        end
+
+        def uso_exclusivo_abc(data = nil)
+          append_space(data, 2)
+        end
+
+        def modalidade_banco_cedente(data = nil)
+          append_space(data, 3)
+        end
+
+        def identificacao_do_titulo(data = nil)
+          append_space(data, 11)
+        end
+
+        def carteira(data = nil)
+          append_space(data, 1)
+        end
+
+        def cadastramento(data = nil)
+          append_space(data, 1)
+        end
+
+        def documento(data = nil)
+          append_space(data, 1)
+        end
+
+        def emissao_boleto(data = nil)
+          append_space(data, 1)
+        end
+
+        def dist_boleto(data = nil)
+          append_space(data, 1)
+        end
+
+        def numero_documento(data = nil)
+          append_space(data, 15)
+        end
+
+        def data_vencimento(data = nil)
+          append_space(data, 8)
+        end
+
+        def valor_titulo(data = nil)
+          prepend_zero(data, 15)
+        end
+
+        def agencia(data = nil)
+          append_space(data, 5)
+        end
+
+        def digito_verificador(data = nil)
+          append_space(data, 1)
+        end
+
+        def especie_titulo(data = nil)
+          append_space(data, 2)
+        end
+
+        def aceite
+          "N"
+        end
+
+        def data_emissao(data = nil)
+          append_space(data, 8)
+        end
+
+        def codigo_juros_mora(data = nil)
+          append_space(data, 1)
+        end
+
+        def data_juros_mora(data = nil)
+          append_space(data, 8)
+        end
+
+        def juros_mora(data = nil)
+          prepend_zero(data, 15)
+        end
+
+        def cod_desconto(data = nil)
+          append_space(data, 1)
+        end
+
+        def data_desconto(data = nil)
+          append_space(data, 8)
+        end
+
+        def valor_desconto(data = nil)
+          prepend_zero(data, 15)
+        end
+
+        def valor_iof(data = nil)
+          prepend_zero(data, 15)
+        end
+
+        def valor_abatimento(data = nil)
+          prepend_zero(data, 15)
+        end
+
+        def uso_empresa_cedente(data = nil)
+          append_space(data, 25)
+        end
+
+        def codigo_protesto(data = nil)
+          append_space(data, 1)
+        end
+
+        def prazo_protesto(data, codigo_protesto = 1)
+          return "00" if codigo_protesto.to_i == 3
+
+          prepend_zero(data, 2)
+        end
+
+        def codigo_baixa_devolucao
+          "2"
+        end
+
+        def prazo_baixa_devolucao
+          "0" * 3
+        end
+
+        def codigo_moeda(data = nil)
+          append_space(data, 2)
+        end
+
+        def numero_contrato(data = nil)
+          append_space(data, 10)
+        end
+
+        def uso_livre(data = nil)
+          append_space(data, 1)
+        end
+      end
+    end
+  end
+end