br_boleto 0.1.0

data/lib/br_boleto/calculos/digitos.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'active_support/core_ext/enumerable'
+
+module BrBoleto
+  module Calculos
+    # Classe responsável por lidar com os dígitos dos módulos.
+    #
+    class Digitos
+      # @param [Integer] number Número que servirá para os cálculo com os dígitos desse número.
+      #
+      def initialize(number)
+        @number = number
+      end
+
+      # Soma cada dígito do número passado no #initialize.
+      # Alguns bancos requerem esse tipo estranho de cálculo em alguns módulos.
+      # @return [Fixnum] Resultado da soma de cada dígito.
+      #
+      # @example
+      #
+      #    Digitos.new(12).sum
+      #    # => 3
+      #
+      #    Digitos.new(2244).sum
+      #    # => 12
+      #
+      #    Digitos.new(90123451).sum
+      #    # => 25
+      #
+      def sum
+        @number.to_s.split('').collect { |number| number.to_i }.sum
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/fator_vencimento.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+module BrBoleto
+  module Calculos
+    # Classe responsável pelo cálculo de Fator de Vencimento do boleto bancário.
+    #
+    # === Descricão
+    #
+    # Conforme Carta-circular 002926 do Banco Central do Brasil, de 24/07/2000, recomenda-se a indicação do Fator de Vencimento no Código de Barras.
+    # A partir de 02/04/2001, o Banco acolhedor/recebedor não será mais responsável por eventuais diferenças de recebimento de BOLETOs fora do prazo,
+    # ou sem a indicação do fator de vencimento.
+    #
+    # === Forma para obtenção do Fator de Vencimento
+    #
+    # Calcula-se <b>o número de dias corridos</b> entre a data base (<b>“Fixada” em 07/10/1997</b>) e a do vencimento desejado:
+    # Alguns bancos dizem para Fazer o seguinte Cálculo: ((data de vencimento) - (03/07/2000) + 1000)
+    # Porém esse cálculo é a mesma coisa que fazer: ((data de vencimento) - (07/10/1997))
+    #
+    #    Vencimento desejado:   04/07/2000
+    #    Data base          : - 07/10/1997
+    #    # => 1001
+    #
+    # === Atenção
+    #
+    # Caso ocorra divergência entre a data impressa no campo “data de vencimento” e a constante no código de barras,
+    # o recebimento se dará da seguinte forma:
+    #
+    # * Quando pago por sistemas eletrônicos (Home-Banking, Auto-Atendimento, Internet, SISPAG, telefone, etc.), prevalecerá à representada no “código de barras”;
+    # * Quando quitado na rede de agências, diretamente no caixa, será considerada a data impressa no campo “vencimento” do BOLETO.
+    #
+    # @return [String] retorna o resultado do cálculo. <b>Deve conter 4 dígitos</b>.
+    #
+    # @example
+    #
+    #    FatorVencimento.new(Date.parse("2012-12-02"))
+    #    #=> "5535"
+    #
+    #    FatorVencimento.new(Date.parse("1997-10-08"))
+    #    #=> "0001"
+    #
+    #    FatorVencimento.new(Date.parse("2012-12-16"))
+    #    #=> "5549"
+    #
+    #    FatorVencimento.new(Date.parse("2014-12-15"))
+    #    #=> "6278"
+    #
+    
+    
+    class FatorVencimento < String
+      
+      # A base é des de quando será subtraido a data de validade
+      attr_accessor :base_date
+      def base_date
+        @base_date || Date.new(1997, 10, 7)
+      end
+
+      # @param [Date] expiration_date
+      # @param [Date] base_date
+      # @return [String] retorna o resultado do cálculo. <b>Deve conter 4 dígitos</b>.
+      # @example
+      #    FatorVencimento.new(Date.parse("2012-09-02"))
+      #    #=> "5444"
+      #
+      #    FatorVencimento.new(Date.parse("1999-10-01"))
+      #    #=> "0724"
+      #
+      #    FatorVencimento.new(Date.parse("2022-12-16"))
+      #    #=> "9201"
+      #
+
+      #########################################################
+      ############ OPÇÃO PARA CUSTOMIZAÇÃO DO CÁLCULO #########
+      ############# MODIFIQUE APENAS SE TIVER CERTEZA #########
+      #########################################################
+        # Caso algum dia mude a forma do cálculo da data base, os valores do cálculo
+        # poderão ser passados por parâmetro. Dia 22/02/2025 a diferença terá 5 números
+        # Mas até lá não se sabe o que irá mudar
+        attr_accessor :subtracao
+        # Caso necessite subtratir o resultado entre a diferença do (vencimento - data_base) 
+        def subtracao
+          @subtracao || 0
+        end
+
+        # Caso necessite somar o resultado entre a diferença do (vencimento - data_base) 
+        attr_accessor :soma
+        def soma
+          @soma || 0
+        end
+
+        # Caso necessite modificar o número de caracteres de retorno
+        attr_accessor :quantidade_de_caracteres
+        def quantidade_de_caracteres
+          @quantidade_de_caracteres || 4
+        end
+      #########################################################
+
+      def initialize(expiration_date, options={})
+        @expiration_date = expiration_date
+        self.base_date = options[:base_date]          
+        self.subtracao = options[:subtracao]          
+        self.soma      = options[:soma]     
+        self.quantidade_de_caracteres   = options[:quantidade_de_caracteres]        
+
+        if @expiration_date.present?
+          super(calculate)
+        end
+      end
+
+     
+
+      # Cálculo da data de vencimento com a data base.
+      #
+      # @return [String] exatamente 4 dígitos
+      #
+      def calculate
+        expiration_date_minus_base_date.to_s.rjust(quantidade_de_caracteres, '0')
+      end
+
+      # @api private
+      #
+      # Cálculo da data de vencimento com a data base.
+      # Chamando #to_i para não retornar um Float.
+      # @return [Integer] diff between this two dates.
+      #
+      def expiration_date_minus_base_date
+        ((@expiration_date - base_date).to_i+soma)-subtracao
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/fatores_de_multiplicacao.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+module BrBoleto
+  module Calculos
+    # Classe responsável por multiplicar cada dígito pelos fatores de multiplicação passado como argumento.
+    #
+    # Imagine que temos o número <b>'2468'</b> e os fatores de multiplicação <b>[2, 1]</b>.
+    #
+    # Será calculado da seguinte maneira:
+    #
+    #      2   4   6   8
+    #      *   *   *   * ===> Multiplicação
+    #      1   2   1   2
+    #
+    #      #=> [2,  8,  6,  16]
+    #
+    # Você pode passar outros fatores de multiplicação se você precisar.
+    # Por exemplo, dado o número '1234567890' e os fatores de multiplicação: <b>[2, 3, 4, 5, 6, 7, 8, 9]</b>.
+    # Será calculado da seguinte maneira:
+    #
+    #      1   2    3   4   5   6   7   8   9   0
+    #      *   *    *   *   *   *   *   *   *   *
+    #      3   2    9   8   7   6   5   4   3   2
+    #
+    #      #=> [3,  4,  27, 32, 35, 36, 35, 32, 27,  0]
+    #
+    # @param  [String] O número que será usado para multiplicar cada dígito.
+    # @param [Hash] Os fatores de multiplicação que irão ser calculados na ordem reversa.
+    #
+    # @example Calculo
+    #
+    #    BrBoleto::Calculos::FatoresDeMultiplicacao.new(123, fatores: [2, 1])
+    #    # => [1, 2, 6]
+    #
+    #    BrBoleto::Calculos::FatoresDeMultiplicacao.new(123, fatores: [2, 3, 4, 5, 6, 7, 8, 9])
+    #    # => [4, 6, 6]
+    #
+    #    BrBoleto::Calculos::FatoresDeMultiplicacao.new(809070608090, fatores: [9, 8, 7, 6, 5, 4, 3, 2])
+    #    # => [48, 0, 72, 0, 14, 0, 24, 0, 48, 0, 72, 0]
+    #
+    class FatoresDeMultiplicacao < Array
+      # @param [String || Integer] number
+      # @param [Hash] options
+      # @option options [Array] :fatores
+      # @return [Array]
+      # @example
+      #
+      #    FatoresDeMultiplicacao.new(12, fatores: [2, 1])
+      #    # => [1, 4]
+      #
+      #    FatoresDeMultiplicacao.new(1864, fatores: [2, 3, 4, 5, 6, 7, 8, 9])
+      #    # => [5, 32, 18, 8]
+      #
+      def initialize(number, options)
+        @number  = number.to_s.reverse.split('')
+        @factors = options.fetch(:fatores).cycle.take(@number.size)
+        super(calculate)
+      end
+
+      # Para cada número realiza a multiplicação para cada dígito.
+      # @return [Array]
+      #
+      def calculate
+        @number.collect.each_with_index { |n, index| n.to_i * @factors[index] }.reverse
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/linha_digitavel.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+require 'active_support/core_ext/object'
+
+module BrBoleto
+  module Calculos
+    # Representação numérica do código de barras, mais conhecida como linha digitável! :p
+    #
+    # A representação numérica do código de barras é composta, por cinco campos.
+    # Sendo os três primeiros campos, amarrados por DAC's (dígitos verificadores),
+    # todos calculados pelo módulo 10.
+    #
+    # <b>OBS.:</b> Para mais detalhes deste cálculo, veja a descrição em Modulo10.
+    #
+    # === Linha Digitável
+    #
+    # A linha digitável contêm exatamente 47 posições nessa sequência:
+    #
+    #       _____________________________________________________________________________________________________________
+    #      |Campo | Posição  | Tamanho | Descrição                                                                      |
+    #      |------|----------|---------|--------------------------------------------------------------------------------|
+    #      | 1º   | 01-03    |  03     | Código do banco (posições 1 a 3 do código de barras)                           |
+    #      |      | 04       |  01     | Código da moeda (posição 4 do código de barras)                                |
+    #      |      | 05-09    |  5      | Cinco primeiras posições do campo livre (posições 20 a 24 do código de barras) |
+    #      |      | 10       |  1      | Dígito verificador do primeiro campo (Módulo10)                                |
+    #      |------------------------------------------------------------------------------------------------------------|
+    #      | 2º   | 11-20    |  10     | 6º a 15º posições do campo livre (posições 25 a 34 do código de barras)        |
+    #      |      | 21       |  01     | Dígito verificador do segundo campo  (Módulo10)                                |
+    #      |------------------------------------------------------------------------------------------------------------|
+    #      | 3º   | 22-31    |  10     | 16º a 25º posições do campo livre (posições 35 a 44 do código de barras)       |
+    #      |      | 32       |  01     | Dígito verificador do terceiro campo  (Módulo10)                               |
+    #      |------------------------------------------------------------------------------------------------------------|
+    #      | 4º   | 33       |  01     | Dígito verificador do código de barras (posição 5 do código de barras)         |
+    #      |------------------------------------------------------------------------------------------------------------|
+    #      | 5ª   | 34-37    |  04     | Fator de vencimento (posições 6 a 9 do código de barras)                       |
+    #      |      | 38-47    |  10     | Valor nominal do documento (posições 10 a 19 do código de barras)              |
+    #      -------------------------------------------------------------------------------------------------------------|
+    #
+    # @return [String] Contêm a representação numérica do código de barras formatado com pontos e espaços.
+    #
+    # @example
+    #
+    #     LinhaDigitavel.new('34196166700000123451091234567880057123457000')
+    #     # => '34191.09123 34567.880058 71234.570001 6 16670000012345'
+    #
+    #     LinhaDigitavel.new('99991101200000350007772130530150081897500000')
+    #     # => '99997.77213 30530.150082 18975.000003 1 10120000035000'
+    #
+    #     LinhaDigitavel.new('39998100100000311551111122222500546666666001')
+    #     # => '39991.11119 22222.500542 66666.660015 8 10010000031155'
+    #
+    class LinhaDigitavel < String
+      attr_reader :codigo_de_barras
+      # @param [String] codigo_de_barras Código de Barras de 44 posições
+      # @return [String]
+      #
+      # Representação numérica do código de barras
+      #
+      # @example
+      #
+      #     LinhaDigitavel.new('34196166700000123451091234567880057123457000')
+      #     # => '34191.09123 34567.880058 71234.570001 6 16670000012345'
+      #
+      #     LinhaDigitavel.new('99991101200000350007772130530150081897500000')
+      #     # => '99997.77213 30530.150082 18975.000003 1 10120000035000'
+      #
+      #     LinhaDigitavel.new('39998100100000311551111122222500546666666001')
+      #     # => '39991.11119 22222.500542 66666.660015 8 10010000031155'
+      #
+      #     # Retorna uma String vazia caso o código de barras esteja vazio.
+      #     LinhaDigitavel.new('')
+      #     # => ''
+      #
+      #     # Retorna uma String vazia caso o código de barras esteja vazio.
+      #     LinhaDigitavel.new(nil)
+      #     # => ''
+      #
+      #     # Retorna uma String vazia caso o código de barras seja menor que 44 posições.
+      #     LinhaDigitavel.new('123456789')
+      #     # => ''
+      #
+      #     # Retorna uma String vazia caso o código de barras seja maior que 44 posições.
+      #     LinhaDigitavel.new('12345678901234567890123456789012345678901234567890')
+      #     # => ''
+      #
+      def initialize(codigo_de_barras)
+        @codigo_de_barras  = codigo_de_barras.to_s
+
+        if @codigo_de_barras.present? and @codigo_de_barras.size == 44
+          super(representacao_numerica_do_codigo_de_barras)
+        else
+          super('')
+        end
+      end
+
+      # @return [String] Retorna todos os campos da linha digitável pegando as posições exatas do código de barras.
+      #
+      def representacao_numerica_do_codigo_de_barras
+        "#{primeiro_campo} #{segundo_campo} #{terceiro_campo} #{quarto_campo} #{quinto_campo}"
+      end
+
+      # @api private
+      #
+      # Retorna o primeiro campo da linha digitável com seu respectivo dígito verificador.
+      #
+      # @return [String]
+      #
+      def primeiro_campo
+        primeiro_campo_sem_digito = "#{codigo_de_barras[0..3]}#{codigo_de_barras[19..23]}"
+        digito_verificador        = Modulo10.new(primeiro_campo_sem_digito)
+        "#{primeiro_campo_sem_digito}#{digito_verificador}".gsub(/^(.{5})(.{5})/, '\1.\2')
+      end
+
+      # @api private
+      #
+      # Retorna o segundo campo da linha digitável com seu respectivo dígito verificador.
+      #
+      # @return [String]
+      #
+      def segundo_campo
+        segundo_campo_sem_digito = "#{codigo_de_barras[24..33]}"
+        digito_verificador       = Modulo10.new(segundo_campo_sem_digito)
+        "#{segundo_campo_sem_digito}#{digito_verificador}".gsub(/(.{5})(.{6})/, '\1.\2')
+      end
+
+      # @api private
+      #
+      # Retorna o terceiro campo da linha digitável com seu respectivo dígito verificador.
+      #
+      # @return [String]
+      #
+      def terceiro_campo
+        terceiro_campo_sem_digito = "#{codigo_de_barras[34..46]}"
+        digito_verificador        = Modulo10.new(terceiro_campo_sem_digito)
+        "#{terceiro_campo_sem_digito}#{digito_verificador}".gsub(/(.{5})(.{6})/, '\1.\2')
+      end
+
+      # @api private
+      #
+      # Retorna o dígito verificador do código de barras (posição 5 do código de barras)
+      #
+      # @return [String]
+      #
+      def quarto_campo
+        "#{codigo_de_barras[4]}"
+      end
+
+      # @api private
+      #
+      # Retorna o quinto e último campo da linha digitável.
+      #
+      # @return [String]
+      #
+      def quinto_campo
+        "#{codigo_de_barras[5..8]}#{codigo_de_barras[9..18]}"
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/modulo10.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+module BrBoleto
+  module Calculos
+    # === Cálculo do Modulo 10
+    #
+    # === Passos
+    #
+    # 1) Multiplica-se cada algarismo do campo pela seqüência de multiplicadores <b>2, 1, 2, 1, 2, 1 ...</b>, posicionados da direita para a esquerda.
+    #
+    # 2) Some individualmente, os algarismos dos resultados dos produtos, obtendo-se o total (N).
+    #
+    # 3) Divida o total encontrado (N) por 10, e determine o resto da divisão como MOD 10 (N).
+    #
+    # 4) Encontre o DAC através da seguinte expressão:
+    #
+    #    DAC = 10 - Mod 10 (n)
+    #
+    # <b>OBS.:</b> Se o resultado do passo 4 for 10, considere o DAC = 0.
+    #
+    # ==== Exemplos
+    #
+    # Considerando-se a seguinte representação numérica <b>'12345'</b>.
+    #
+    # 1) Multiplicando a seqüência de multiplicadores:
+    #
+    #      1     2     3     4     5
+    #      *     *     *     *     *  ===> Multiplicação.
+    #      2     1     2     1     2
+    #
+    # 2) Some, individualmente:
+    #
+    #      2  +  2  +  6  +  4   + 1 + 0 (Veja a observação abaixo explicando o '1' + '0').
+    #      # => 15
+    #
+    # <b>OBS.:</b>: Resultado da soma que possua 2 digitos deve somar cada dígito.
+    # Exemplos: 10 -> 1 + 0. 11 -> 1 + 1, 28 -> 2 + 8, etc.
+    #
+    # 3) Divida o total encontrado por 10, a fim de determinar o resto da divisão:
+    #
+    #      15 % 10
+    #      # => 5
+    #
+    # 4) Calculando o DAC:
+    #
+    #      10 - 5
+    #      # => 5 =======> Resultado final retornado.
+    #
+    class Modulo10 < String
+      # @param [String ou Integer] number (Corresponde ao número a ser calculado pelo Módulo 10)
+      # @return [String]
+      # @example
+      #
+      #    BrBoleto::Calculos::Modulo10.new(1233)
+      #    # => "6"
+      #
+      #    BrBoleto::Calculos::Modulo10.new(4411)
+      #    # => "5"
+      #
+      #    BrBoleto::Calculos::Modulo10.new('9000')
+      #    # => "1"
+      #
+      #    BrBoleto::Calculos::Modulo10.new('6789')
+      #    # => "2"
+      #
+      def initialize(number)
+        @number  = number
+        super(calculate.to_s)
+      end
+
+      # @return [String] Resultado final do cálculo do módulo 10.
+      #
+      def calculate
+        sum_total = FatoresDeMultiplicacao.new(@number, fatores: [2, 1]).collect do |result_of_each_sum|
+          Digitos.new(result_of_each_sum).sum
+        end.sum
+        total = 10 - (sum_total % 10)
+
+        return 0 if total.equal?(10)
+        total
+      end
+    end
+  end
+end