br_boleto 0.1.0

data/lib/br_boleto/core/sicoob.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+module BrBoleto
+  module Core
+    # Implementação de emissão de boleto bancário pelo Banco Sicoob.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/sicoob' dentro dessa biblioteca.
+    #
+    # === Código da Carteira
+    #
+    #   '1' - Cobrança SEM registro
+    #   '9' - Cobrança COM registro
+    #
+    class Sicoob < Boleto
+      # Tamanho máximo de uma agência no Banco Sicoob.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 4
+      #
+      def self.tamanho_maximo_agencia
+        4
+      end
+
+      # Tamanho máximo do codigo cedente no Banco Sicoob.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 7
+      #
+      def self.tamanho_maximo_codigo_cedente
+        7
+      end
+
+      # Tamanho máximo do numero do documento no Boleto.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 6
+      #
+      def self.tamanho_maximo_numero_documento
+        7
+      end
+
+      # <b>Carteiras suportadas.</b>
+      #
+      # <b>Método criado para validar se a carteira informada é suportada.</b>
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[1 3]
+      end
+
+      # Validações para os campos abaixo:
+      #
+      # * Agencia
+      # * Codigo Cedente
+      # * Número do documento
+      #
+      # Se você quiser sobrescrever os metodos, <b>ficará a sua responsabilidade.</b>
+      # Basta você sobrescrever os métodos de validação:
+      #
+      #    class Sicoob < BrBoleto::Core::Sicoob
+      #       def self.tamanho_maximo_agencia
+      #         6
+      #       end
+      #
+      #       def self.tamanho_maximo_codigo_cedente
+      #         9
+      #       end
+      #
+      #       def self.tamanho_maximo_numero_documento
+      #         10
+      #       end
+      #    end
+      #
+      # Obs.: Mudar as regras de validação podem influenciar na emissão do boleto em si.
+      # Talvez você precise analisar o efeito no #codigo_de_barras e na #linha_digitável (ambos podem ser
+      # sobreescritos também).
+      #
+      validates :agencia, :codigo_cedente, presence: true
+
+      validates :agencia,          length: { maximum: tamanho_maximo_agencia          }, if: :deve_validar_agencia?
+      validates :codigo_cedente,   length: { maximum: tamanho_maximo_codigo_cedente   }, if: :deve_validar_codigo_cedente?
+      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
+
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
+
+      # @return [String] 4 caracteres
+      #
+      def agencia
+        @agencia.to_s.rjust(4, '0') if @agencia.present?
+      end
+
+      # @return [String] 7 caracteres
+      # O Código do cedente é o mesmo que o codigo do beneficiário
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(7, '0') if @codigo_cedente.present?
+      end
+
+      # @return [String] 6 caracteres
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(7, '0') if @numero_documento.present?
+      end
+
+      # @return [String] Código do Banco descrito na documentação.
+      #
+      def codigo_banco
+        '756'
+      end
+
+      # @return [String] Dígito do código do banco descrito na documentação.
+      #
+      def digito_codigo_banco
+        '0'
+      end
+
+      # Campo Agência / Código do Cedente
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia} / #{codigo_cedente}"
+      end
+
+      # O nosso número descrino na documentação é formado pelo dois ultimos digitos do ano autal e
+      # por outros 6 digitos que o clinte usara para numerar os documentos, assim sendo composto por 8 dígitos.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}-#{digito_verificador_nosso_numero}"
+      end
+
+   
+      #  === Código de barras do banco
+      #
+      #     ___________________________________________________________
+      #    | Posição | Tamanho | Descrição                             |
+      #    |---------|---------|---------------------------------------|
+      #    | 20 - 20 |    01   | Código da carteira                    |
+      #    | 21 - 24 |    04   | Código da agência                     |
+      #    | 25 - 26 |    02   | Código da modalidade de cobrança (01) |
+      #    | 27 - 33 |    07   | Código do Cedente                     |
+      #    | 34 - 41 |    08   | Nosso Número do título                |
+      #    | 42 - 44 |    03   | Número da Parcela do Título (001)     |
+      #    |___________________________________________________________|
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        "#{carteira}#{agencia}#{modalidade_cobranca}#{codigo_cedente}#{nosso_numero.gsub('-','')}#{parcelas}"
+      end
+
+      def digito_verificador_nosso_numero
+        BrBoleto::Calculos::Modulo11Fator3197.new("#{agencia}#{codigo_cedente.rjust(10, '0')}#{numero_documento}")
+      end
+
+      def modalidade_cobranca
+        '01'
+      end
+
+      def parcelas
+        '001'
+      end
+    end
+  end
+end

data/lib/br_boleto/version.rb

@@ -0,0 +1,8 @@
+module BrBoleto
+	module Version
+		MAJOR = 0 #inclui alterações de API e pode quebrar compatibilidade com versões anteriores
+		MINOR = 1 #inclui novas funcionalidades, sem quebrar APIs existentes
+		PATCH = 0 #corrige bugs ou traz melhorias em implementações já existentes
+		CURRENT = "#{MAJOR}.#{MINOR}.#{PATCH}"
+	end
+end

data/test/br_boleto/calculos/digitos_test.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'test_helper'
+
+describe BrBoleto::Calculos::Digitos do
+  (0..9).each do |number|
+		it "should return self when is #{number}" do
+			BrBoleto::Calculos::Digitos.new(number).sum.must_equal number
+		end
+	end
+	{ 11 => 2, '18' => 9, 99 => 18, '58' => 13, 112 => 4, '235' => 10 }.each do |number, expecting|
+		it "should sum the sum of the digits when is '#{number}', expecting to be '#{expecting}'" do
+			BrBoleto::Calculos::Digitos.new(number).sum.must_equal expecting
+		end
+	end
+end

data/test/br_boleto/calculos/fator_vencimento_test.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+require 'test_helper'
+
+describe BrBoleto::Calculos::FatorVencimento do
+	describe "#base_date" do
+		it "should be 1997-10-07" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2012-02-01")).base_date.must_equal Date.new(1997, 10, 7)
+		end
+	end
+
+	describe "#calculate" do
+		it 'should return an empty string when passing nil value' do
+			BrBoleto::Calculos::FatorVencimento.new(nil).must_equal ''
+		end
+
+		it 'should return an empty string when passing empty value' do
+			BrBoleto::Calculos::FatorVencimento.new('').must_equal ''
+		end
+
+		it "should calculate the days between expiration date and base date" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2012-12-2")).must_equal "5535"
+		end
+
+		it "should calculate equal to itau documentation example" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2000-07-04")).must_equal "1001"
+		end
+
+		it "should calculate equal to itau documentation last section of the docs" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2002-05-01")).must_equal "1667"
+		end
+
+		it "should calculate to the maximum date equal to itau documentation example" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2025-02-21")).must_equal "9999"
+		end
+
+		it "should calculate the days between expiration date one year ago" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2011-05-25")).must_equal "4978"
+		end
+
+		it "should calculate the days between expiration date two years ago" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2010-10-02")).must_equal "4743"
+		end
+
+		it "should calculate the days between expiration date one year from now" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2013-02-01")).must_equal "5596"
+		end
+
+		it "should calculate the days between expiration date eigth years from now" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("2020-02-01")).must_equal "8152"
+		end
+
+		it "should calculate the days between expiration date formating with 4 digits" do
+			BrBoleto::Calculos::FatorVencimento.new(Date.parse("1997-10-08")).must_equal "0001"
+		end
+	end
+end

data/test/br_boleto/calculos/fatores_de_multiplicacao_test.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require 'test_helper'
+
+describe BrBoleto::Calculos::FatoresDeMultiplicacao do
+	context 'with factors of 2 and 1' do
+		let(:factors) { [2, 1] }
+
+		context 'with one digit' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(1, fatores: factors) }
+
+			it { subject.must_equal [2] }
+		end
+
+		context 'with four digits' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(1234, fatores: factors) }
+
+			it { subject.must_equal [1, 4, 3, 8] }
+		end
+
+		context 'with five digits' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(11385, fatores: factors) }
+
+			it { subject.must_equal [2, 1, 6, 8, 10] }
+		end
+
+		context 'with ten digits' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(1234567890, fatores: factors) }
+
+			it { subject.must_equal [1, 4, 3, 8, 5, 12, 7, 16, 9, 0] }
+		end
+	end
+
+	context 'with factors of 2..9' do
+		let(:factors) { (2..9).to_a }
+
+		context 'with one digit' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(4, fatores: factors) }
+
+			it { subject.must_equal [8] }
+		end
+
+		context 'with four digits' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(1864, fatores: factors) }
+
+			it { subject.must_equal [ 5, 32, 18, 8] }
+		end
+
+		context 'with ten digits' do
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(1234567890, fatores: factors) }
+		end
+
+		context 'with bradesco documentation example' do
+			let(:bradesco_example) { '9999101200000350007772130530150081897500000' }
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(bradesco_example, fatores: factors) }
+
+			it { subject.must_equal [36, 27, 18, 81, 8, 0, 6, 10, 0, 0, 0, 0, 0, 21, 30, 0, 0, 0, 14, 63, 56, 14, 6, 15, 0, 15, 6, 0, 8, 35, 0, 0, 32, 3, 16, 81, 56, 35, 0, 0, 0, 0, 0] }
+		end
+
+		context 'with itau documentation example' do
+			let(:itau_example) { '3419166700000123451101234567880057123457000' }
+			subject { BrBoleto::Calculos::FatoresDeMultiplicacao.new(itau_example, fatores: factors) }
+
+			it { subject.must_equal [12, 12, 2, 81, 8, 42, 36, 35, 0, 0, 0, 0, 0, 7, 12, 15, 16, 15, 2, 9, 0, 7, 12, 15, 16, 15, 12, 63, 64, 56, 0, 0, 20, 21, 2, 18, 24, 28, 30, 35, 0, 0, 0] }
+		end
+	end
+end

data/test/br_boleto/calculos/linha_digitavel_test.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require 'test_helper'
+
+module BrBoleto
+	module Calculos
+		describe LinhaDigitavel do
+			context "using the Itau documentation example" do
+				subject { LinhaDigitavel.new('34196166700000123451091234567880057123457000') }
+
+				it { subject.must_equal '34191.09123 34567.880058 71234.570001 6 16670000012345' }
+			end
+
+			context "using the Bradesco documentation example" do
+				subject { LinhaDigitavel.new('99991101200000350007772130530150081897500000') }
+
+				it { subject.must_equal '99997.77213 30530.150082 18975.000003 1 10120000035000' }
+			end
+
+			context "using the HSBC documentation example" do
+				subject { LinhaDigitavel.new('39998100100000311551111122222500546666666001') }
+
+				it { subject.must_equal '39991.11119 22222.500542 66666.660015 8 10010000031155' }
+			end
+
+			context "using the Caixa documentation example" do
+				subject { LinhaDigitavel.new('10491107400000160000001100128701000901200200') }
+
+				it { subject.must_equal '10490.00118 00128.701000 09012.002003 1 10740000016000' }
+			end
+
+			describe "when 'codigo_de_barras' invalid" do
+				context "when is empty" do
+					subject { LinhaDigitavel.new('') }
+
+					it { subject.must_equal '' }
+				end
+
+				context "when nil" do
+					subject { LinhaDigitavel.new(nil) }
+
+					it { subject.must_equal '' }
+				end
+
+				context "when have less than 44 positions" do
+					subject { LinhaDigitavel.new('121212121') }
+
+					it { subject.must_equal '' }
+				end
+
+				context "when have more than 44 positions" do
+					subject { LinhaDigitavel.new('12345678901234567890123456789012345678901234567890') }
+
+					it { subject.must_equal '' }
+				end
+			end
+		end
+	end
+end

data/test/br_boleto/calculos/modulo10_test.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require 'test_helper'
+
+module BrBoleto
+	module Calculos
+		describe Modulo10 do
+			it "should accept the examples by the 'Itau documentation'" do
+				Modulo10.new('341911012').must_equal  '1'
+				Modulo10.new('3456788005').must_equal '8'
+				Modulo10.new('7123457000').must_equal '1'
+			end
+
+			it "should accept the example from Banrisul" do
+				Modulo10.new('00009274').must_equal '2'
+			end
+
+			it "returns zero when number is 0" do
+				Modulo10.new('0').must_equal '0'
+			end
+
+			it "returns zero when mod 10 is zero" do
+				Modulo10.new('99906').must_equal '0'
+			end
+
+			it "calculate when number had 1 digit" do
+				Modulo10.new('1').must_equal '8'
+			end
+
+			it "calculate when number had 2 digits" do
+				Modulo10.new('10').must_equal '9'
+			end
+
+			it "calculate when number had 3 digits" do
+				Modulo10.new('994').must_equal '4'
+			end
+
+			it "calculate when number had 5 digits" do
+				Modulo10.new('97831').must_equal '2'
+			end
+
+			it "calculate when number had 6 digits" do
+				Modulo10.new('147966').must_equal '6'
+			end
+
+			it "calculate when number had 10 digits" do
+				Modulo10.new('3456788005').must_equal '8'
+			end
+
+			it "should accept numbers too" do
+				Modulo10.new(12345).must_equal '5'
+			end
+		end
+	end
+end

data/test/br_boleto/calculos/modulo11_fator3197_test.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'test_helper'
+
+module BrBoleto
+	module Calculos
+		describe Modulo11Fator3197 do
+			context 'with Sicoob documentation example' do
+				subject { Modulo11Fator3197.new('000100000000190000021') }
+
+				it { subject.must_equal '8' }
+			end
+
+			context "quando o resultado do mod_division for 0 então deve retornar zero e não o resultado do total" do
+				subject { Modulo11Fator3197.new('123') }
+				before do
+					Modulo11Fator3197.any_instance.stubs(:mod_division).returns(0)
+					Modulo11Fator3197.any_instance.stubs(:total).returns(9)
+				end
+				it { subject.must_equal '0' }
+			end
+
+			context "quando o resultado do mod_division for 1 então deve retornar zero e não o resultado do total" do
+				subject { Modulo11Fator3197.new('123') }
+				before do
+					Modulo11Fator3197.any_instance.stubs(:mod_division).returns(1)
+					Modulo11Fator3197.any_instance.stubs(:total).returns(9)
+				end
+				it { subject.must_equal '0' }
+			end
+
+			[1..9].each do |numero|
+				context "quando o resultado do mod_division for #{numero} então deve o resultado do total" do
+					subject { Modulo11Fator3197.new('123') }
+					before do
+						Modulo11Fator3197.any_instance.stubs(:mod_division).returns(numero)
+						Modulo11Fator3197.any_instance.stubs(:total).returns(9)
+					end
+					it { subject.must_equal '9' }
+				end
+			end
+		end
+	end
+end