cnab240_bancoabc 1.1.0

data/lib/cnab240/bancoabc/services/parse_line.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CNAB240
+  module BancoABC
+    module Services
+      class ParseLine
+        HEADER = "0"
+        REGISTERT = "1"
+        REGISTERU = "2"
+        TRAILLER = "9"
+
+        def self.call(line, type)
+          return CNAB240::BancoABC::Entities::Header.new(line) if type == HEADER
+          return CNAB240::BancoABC::Entities::RegisterT.new(line) if type == REGISTERT
+          return CNAB240::BancoABC::Entities::RegisterU.new(line) if type == REGISTERU
+          return CNAB240::BancoABC::Entities::Trailler.new(line) if type == TRAILLER
+        end
+      end
+    end
+  end
+end

data/lib/cnab240/bancoabc/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CNAB240
+  module BancoABC
+    # When updating version, keep in mind Semantic Versioning http://semver.org/
+    # TL;DR; (Major.Minor.Patch)
+    # Releases before 1.0.0 are in active development and can change anytime
+    # 1.0.0 and up is indication and declaration of a stable public API
+    # Major - Incremented for incompatible changes with previous release (or big enough new features)
+    # Minor - Incremented for new backwards-compatible features + deprecations
+    # Patch - Incremented for backwards-compatible bug fixes
+    VERSION = "1.1.0"
+  end
+end

data/lib/cnab240_bancoabc.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "cnab240/bancoabc/version"
+require "cnab240/bancoabc/ocorrencias"
+
+require "cnab240/bancoabc/services/parse_line"
+
+require "cnab240/bancoabc/entities/base"
+require "cnab240/bancoabc/entities/header_builder"
+require "cnab240/bancoabc/entities/header_lote_builder"
+require "cnab240/bancoabc/entities/header"
+require "cnab240/bancoabc/entities/register_p"
+require "cnab240/bancoabc/entities/register_q"
+require "cnab240/bancoabc/entities/register_r"
+require "cnab240/bancoabc/entities/register_s"
+require "cnab240/bancoabc/entities/register_t"
+require "cnab240/bancoabc/entities/register_u"
+require "cnab240/bancoabc/entities/trailler_builder"
+require "cnab240/bancoabc/entities/trailler"
+require "cnab240/bancoabc/entities/trailler_lote_builder"
+
+module CNAB240
+  module BancoABC
+  end
+end

data/spec/cnab240/bancoabc/entities/base_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: false
+
+require "spec_helper"
+
+describe CNAB240::BancoABC::Entities::Base do
+  describe "#header?" do
+    subject { described_class.new.header? }
+
+    it { expect(subject).to be_falsey }
+  end
+
+  describe "#trailler?" do
+    subject { described_class.new.trailler? }
+
+    it { expect(subject).to be_falsey }
+  end
+
+  describe "#register?" do
+    subject { described_class.new.register? }
+
+    it { expect(subject).to be_falsey }
+  end
+
+  describe "#white_space" do
+    subject { described_class.new.send(:white_space, 3) }
+
+    it { expect(subject).to eq("   ") }
+  end
+
+  describe "#prepend_zero" do
+    subject { described_class.new.send(:prepend_zero, data, range) }
+
+    context "when data is null" do
+      let(:data) { nil }
+      let(:range) { 2 }
+
+      it { expect(subject).to eq("  ") }
+    end
+
+    context "when data has the same length as range" do
+      let(:data) { "10" }
+      let(:range) { 2 }
+
+      it { expect(subject).to eq(data) }
+    end
+
+    context "when data has the length greater than range" do
+      let(:data) { "101" }
+      let(:range) { 2 }
+
+      it { expect(subject).to eq(data) }
+    end
+
+    context "when range has the length greater than data" do
+      let(:data) { "10" }
+      let(:range) { 3 }
+
+      it { expect(subject).to eq("#{data}") }
+    end
+  end
+
+  describe "#append_space" do
+    subject { described_class.new.send(:append_space, data, range) }
+
+    context "when data is null" do
+      let(:data) { nil }
+      let(:range) { 2 }
+
+      it { expect(subject).to eq("  ") }
+    end
+
+    context "when data has the same length as range" do
+      let(:data) { "10" }
+      let(:range) { 2 }
+
+      it { expect(subject).to eq(data) }
+    end
+
+    context "when data has the length greater than range" do
+      let(:data) { "101" }
+      let(:range) { 2 }
+
+      it { expect(subject).to eq("10") }
+    end
+
+    context "when range has the length greater than data" do
+      let(:data) { "10" }
+      let(:range) { 3 }
+
+      it { expect(subject).to eq("#{data} ") }
+    end
+  end
+end

data/spec/cnab240/bancoabc/entities/header_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: false
+
+require "spec_helper"
+
+describe CNAB240::BancoABC::Entities::Header do
+  let(:codigo_do_banco) { 3.times.map { rand(10) }.join }
+  let(:lote_servico) { 4.times.map { rand(10) }.join }
+  let(:tipo_servico) { 1.times.map { rand(10) }.join }
+  let(:uso_exclusivo_febraban_1) { 9.times.map { rand(10) }.join }
+  let(:tipo_inscricao_da_empresa) { 1.times.map { rand(10) }.join }
+  let(:numero_inscricao_da_empresa) { 14.times.map { rand(10) }.join }
+  let(:codigo_identificacao_empresa_banco) { 40.times.map { rand(10) }.join }
+  let(:nome_empresa) { 30.times.map { rand(10) }.join }
+  let(:nome_banco) { 30.times.map { rand(10) }.join }
+  let(:uso_exclusivo_febraban_2) { 10.times.map { rand(10) }.join }
+  let(:codigo_retorno) { 1.times.map { rand(10) }.join }
+  let(:data_geracao) { 8.times.map { rand(10) }.join }
+  let(:hora_geracao) { 6.times.map { rand(10) }.join }
+  let(:numero_sequencial) { 6.times.map { rand(10) }.join }
+  let(:numero_versao_layout) { 3.times.map { rand(10) }.join }
+  let(:desidade_gravacao_arquivo) { 5.times.map { rand(10) }.join }
+  let(:uso_reservado_banco) { 20.times.map { rand(10) }.join }
+  let(:uso_reservado_empresa) { 20.times.map { rand(10) }.join }
+  let(:uso_exclusivo_febraban_3) { 28.times.map { rand(10) }.join }
+
+  let(:line) do
+    codigo_do_banco + lote_servico + tipo_servico + uso_exclusivo_febraban_1 + tipo_inscricao_da_empresa +
+      numero_inscricao_da_empresa + codigo_identificacao_empresa_banco + nome_empresa + nome_banco + uso_exclusivo_febraban_2 +
+      codigo_retorno + data_geracao + hora_geracao + numero_sequencial + numero_versao_layout + desidade_gravacao_arquivo +
+      uso_reservado_banco + uso_reservado_empresa + uso_exclusivo_febraban_3
+  end
+
+  describe "#header?" do
+    subject { described_class.new(line).header? }
+
+    it { expect(subject).to be_truthy }
+  end
+
+  describe "#data" do
+    subject { described_class.new(line).data }
+
+    it { expect(subject).to eq({
+      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
+end

data/spec/cnab240/bancoabc/entities/register_p_spec.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: false
+
+require "spec_helper"
+
+describe CNAB240::BancoABC::Entities::RegisterP do
+  describe "#register?" do
+    subject { described_class.new.register? }
+
+    it { expect(subject).to be_truthy }
+  end
+
+  describe "#codigo_banco" do
+    subject { described_class.new.codigo_banco(2) }
+
+    it { expect(subject).to eq("2  ") }
+  end
+
+  describe "#lote_servico" do
+    subject { described_class.new.lote_servico(2) }
+
+    it { expect(subject).to eq("2   ") }
+  end
+
+  describe "#tipo_registro" do
+    subject { described_class.new.tipo_registro(2) }
+
+    it { expect(subject).to eq("2") }
+  end
+
+  describe "#numero_registro" do
+    subject { described_class.new.numero_registro(2) }
+
+    it { expect(subject).to eq("00002") }
+  end
+
+  describe "#segmento" do
+    subject { described_class.new.segmento }
+
+    it { expect(subject).to eq("P") }
+  end
+
+  describe "#cnab" do
+    subject { described_class.new.cnab("1") }
+
+    it { expect(subject).to eq("1") }
+  end
+
+  describe "#codigo_movimento" do
+    subject { described_class.new.codigo_movimento("1") }
+
+    it { expect(subject).to eq("1 ") }
+  end
+
+  describe "#direcionamento_cobranca" do
+    subject { described_class.new.direcionamento_cobranca(23) }
+
+    it { expect(subject).to eq("2") }
+  end
+
+  describe "#identificacao_empresa" do
+    subject { described_class.new.identificacao_empresa }
+
+    it { expect(subject).to eq("00019070022307900000") }
+  end
+
+  describe "#modalidade_cobranca" do
+    subject { described_class.new.modalidade_cobranca }
+
+    it { expect(subject).to eq("000") }
+  end
+
+  describe "#uso_exclusivo_abc" do
+    subject { described_class.new.uso_exclusivo_abc(1) }
+
+    it { expect(subject).to eq("1 ") }
+  end
+
+  describe "#modalidade_banco_cedente" do
+    subject { described_class.new.modalidade_banco_cedente(1) }
+
+    it { expect(subject).to eq("1  ") }
+  end
+
+  describe "#identificacao_do_titulo" do
+    subject { described_class.new.identificacao_do_titulo(1234567) }
+
+    it { expect(subject).to eq("1234567    ") }
+  end
+
+  describe "#carteira" do
+    subject { described_class.new.carteira(1234567) }
+
+    it { expect(subject).to eq("1") }
+  end
+
+  describe "#cadastramento" do
+    subject { described_class.new.cadastramento("P") }
+
+    it { expect(subject).to eq("P") }
+  end
+
+  describe "#documento" do
+    subject { described_class.new.documento("D") }
+
+    it { expect(subject).to eq("D") }
+  end
+
+  describe "#dist_boleto" do
+    subject { described_class.new.dist_boleto("B") }
+
+    it { expect(subject).to eq("B") }
+  end
+
+  describe "#numero_documento" do
+    subject { described_class.new.numero_documento("987654321") }
+
+    it { expect(subject).to eq("987654321      ") }
+  end
+
+  describe "#emissao_boleto" do
+    subject { described_class.new.emissao_boleto("B") }
+
+    it { expect(subject).to eq("B") }
+  end
+
+  describe "#data_vencimento" do
+    subject { described_class.new.data_vencimento("987654321") }
+
+    it { expect(subject).to eq("98765432") }
+  end
+
+  describe "#valor_titulo" do
+    subject { described_class.new.valor_titulo("987654321") }
+
+    it { expect(subject).to eq("000000987654321") }
+  end
+
+  describe "#agencia" do
+    subject { described_class.new.agencia("987654321") }
+
+    it { expect(subject).to eq("98765") }
+  end
+
+  describe "#digito_verificador" do
+    subject { described_class.new.digito_verificador("98765") }
+
+    it { expect(subject).to eq("9") }
+  end
+
+  describe "#especie_titulo" do
+    subject { described_class.new.especie_titulo("98765") }
+
+    it { expect(subject).to eq("98") }
+  end
+
+  describe "#aceite" do
+    subject { described_class.new.aceite }
+
+    it { expect(subject).to eq("N") }
+  end
+
+  describe "#data_emissao" do
+    subject { described_class.new.data_emissao(82108431331244) }
+
+    it { expect(subject).to eq("82108431") }
+  end
+
+  describe "#codigo_juros_mora" do
+    subject { described_class.new.codigo_juros_mora(82108431331244) }
+
+    it { expect(subject).to eq("8") }
+  end
+
+  describe "#data_juros_mora" do
+    subject { described_class.new.data_juros_mora(82108431331244) }
+
+    it { expect(subject).to eq("82108431") }
+  end
+
+  describe "#juros_mora" do
+    subject { described_class.new.juros_mora(82108431331244) }
+
+    it { expect(subject).to eq("082108431331244") }
+  end
+
+  describe "#cod_desconto" do
+    subject { described_class.new.cod_desconto(82) }
+
+    it { expect(subject).to eq("8") }
+  end
+
+  describe "#data_desconto" do
+    subject { described_class.new.data_desconto(82) }
+
+    it { expect(subject).to eq("82      ") }
+  end
+
+  describe "#valor_desconto" do
+    subject { described_class.new.valor_desconto(820123) }
+
+    it { expect(subject).to eq("000000000820123") }
+  end
+
+  describe "#valor_iof" do
+    subject { described_class.new.valor_iof(820123) }
+
+    it { expect(subject).to eq("000000000820123") }
+  end
+
+  describe "#valor_abatimento" do
+    subject { described_class.new.valor_abatimento(820123) }
+
+    it { expect(subject).to eq("000000000820123") }
+  end
+
+  describe "#uso_empresa_cedente" do
+    subject { described_class.new.uso_empresa_cedente(820123) }
+
+    it { expect(subject).to eq("820123                   ") }
+  end
+
+  describe "#codigo_protesto" do
+    subject { described_class.new.codigo_protesto(codigo_protesto) }
+
+    context "when instrucao type is Protestar" do
+      let(:codigo_protesto) { 1 }
+
+      it { expect(subject).to eq("1") }
+    end
+
+    context "when protestar_titulos flag is true" do
+      let(:codigo_protesto) { 1 }
+
+      it { expect(subject).to eq("1") }
+    end
+
+    context "when protestar_titulos flag is false and instrucao type is not Protestar" do
+      let(:codigo_protesto) { 3 }
+
+      it { expect(subject).to eq("3") }
+    end
+  end
+
+  describe "#prazo_protesto" do
+    subject { described_class.new.prazo_protesto(dias_protesto, codigo_protesto) }
+
+    context "when codigo protesto is dias corridos" do
+      let(:codigo_protesto) { 1 }
+      let(:dias_protesto) { 10 }
+
+      it { expect(subject).to eq("10") }
+    end
+
+    context "when codigo protesto is dias úteis" do
+      let(:codigo_protesto) { 2 }
+      let(:dias_protesto) { 5 }
+
+      it { expect(subject).to eq("05") }
+    end
+
+    context "when codigo protesto is isento" do
+      let(:codigo_protesto) { 3 }
+      let(:dias_protesto) { 15 }
+
+      it { expect(subject).to eq("00") }
+    end
+  end
+
+  describe "#codigo_baixa_devolucao" do
+    subject { described_class.new.codigo_baixa_devolucao }
+
+    it { expect(subject).to eq("2") }
+  end
+
+  describe "#prazo_baixa_devolucao" do
+    subject { described_class.new.prazo_baixa_devolucao }
+
+    it { expect(subject).to eq("000") }
+  end
+
+  describe "#codigo_moeda" do
+    subject { described_class.new.codigo_moeda(31234) }
+
+    it { expect(subject).to eq("31") }
+  end
+
+  describe "#numero_contrato" do
+    subject { described_class.new.numero_contrato(31234) }
+
+    it { expect(subject).to eq("31234     ") }
+  end
+
+  describe "#uso_livre" do
+    subject { described_class.new.uso_livre(31234) }
+
+    it { expect(subject).to eq("3") }
+  end
+end

data/spec/cnab240/bancoabc/entities/register_q_spec.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: false
+
+require "spec_helper"
+
+describe CNAB240::BancoABC::Entities::RegisterQ do
+  describe "#register?" do
+    subject { described_class.new.register? }
+
+    it { expect(subject).to be_truthy }
+  end
+
+  describe "#codigo_banco" do
+    subject { described_class.new.codigo_banco(2) }
+
+    it { expect(subject).to eq("2  ") }
+  end
+
+  describe "#lote_servico" do
+    subject { described_class.new.lote_servico(2) }
+
+    it { expect(subject).to eq("2   ") }
+  end
+
+  describe "#tipo_registro" do
+    subject { described_class.new.tipo_registro(2) }
+
+    it { expect(subject).to eq("2") }
+  end
+
+  describe "#numero_registro" do
+    subject { described_class.new.numero_registro(2) }
+
+    it { expect(subject).to eq("00002") }
+  end
+
+  describe "#segmento" do
+    subject { described_class.new.segmento }
+
+    it { expect(subject).to eq("Q") }
+  end
+
+  describe "#cnab" do
+    subject { described_class.new.cnab("1") }
+
+    it { expect(subject).to eq("1") }
+  end
+
+  describe "#codigo_movimento" do
+    subject { described_class.new.codigo_movimento("1") }
+
+    it { expect(subject).to eq("1 ") }
+  end
+
+  describe "#uso_livre" do
+    subject { described_class.new.uso_livre(31234) }
+
+    it { expect(subject).to eq("31234   ") }
+  end
+
+  describe "#tipo_inscricao" do
+    subject { described_class.new.tipo_inscricao(31234) }
+
+    it { expect(subject).to eq("3") }
+  end
+
+  describe "#numero_inscricao" do
+    subject { described_class.new.numero_inscricao(31234) }
+
+    it { expect(subject).to eq("000000000031234") }
+  end
+
+  describe "#nome" do
+    subject { described_class.new.nome(31234) }
+
+    it { expect(subject).to eq("31234                                   ") }
+  end
+
+  describe "#endereco" do
+    subject { described_class.new.endereco(31234) }
+
+    it { expect(subject).to eq("31234                                   ") }
+  end
+
+  describe "#bairro" do
+    subject { described_class.new.bairro(31234) }
+
+    it { expect(subject).to eq("31234          ") }
+  end
+
+  describe "#cep" do
+    subject { described_class.new.cep(31233242342344) }
+
+    it { expect(subject).to eq("31233") }
+  end
+
+  describe "#sufixo_cep" do
+    subject { described_class.new.sufixo_cep(2341) }
+
+    it { expect(subject).to eq("234") }
+  end
+
+  describe "#cidade" do
+    subject { described_class.new.cidade("RIO CLARO") }
+
+    it { expect(subject).to eq("RIO CLARO      ") }
+  end
+
+  describe "#cidade" do
+    subject { described_class.new.uf("SPF") }
+
+    it { expect(subject).to eq("SP") }
+  end
+
+  describe "#uf" do
+    subject { described_class.new.uf("SPF") }
+
+    it { expect(subject).to eq("SP") }
+  end
+
+  describe "#tipo_inscricao_sac" do
+    subject { described_class.new.tipo_inscricao_sac("SPF") }
+
+    it { expect(subject).to eq("S") }
+  end
+
+  describe "#numero_inscricao_sac" do
+    subject { described_class.new.numero_inscricao_sac("SP12312314123123F") }
+
+    it { expect(subject).to eq("SP12312314123123F") }
+  end
+
+  describe "#nome_sac" do
+    subject { described_class.new.nome_sac("SP12312314123123F") }
+
+    it { expect(subject).to eq("SP12312314123123F                       ") }
+  end
+
+  describe "#banco_correspondente" do
+    subject { described_class.new.banco_correspondente }
+
+    it { expect(subject).to eq("000") }
+  end
+
+  describe "#nosso_numero_banco" do
+    subject { described_class.new.nosso_numero_banco(13948129038) }
+
+    it { expect(subject).to eq("13948129038         ") }
+  end
+end