conectiva-boleto_bancario 0.0.2.beta

data/boleto_bancario.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/boleto_bancario/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tomas D'Stefano", "Conectiva Consultoria"]
+  gem.email         = ["code@conectivaconsultoria.com.br"]
+  gem.description   = %q{Emissão de Boletos Bancários em Ruby}
+  gem.summary       = %q{Emissão de Boletos Bancários em Ruby}
+  gem.homepage      = "https://github.com/conectiva/boleto_bancario"
+
+  gem.files         = `git ls-files`.split($\).reject { |f| File.extname(f) == '.pdf' }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "conectiva-boleto_bancario"
+  gem.require_paths = ["lib"]
+  gem.version       = BoletoBancario::VERSION
+
+  gem.add_dependency "activesupport", "~> 4"
+  gem.add_dependency "activemodel", "~> 4"
+  gem.add_development_dependency "rspec", "~> 2"
+  gem.add_development_dependency "valid_attribute", "~> 1.3"
+  gem.add_development_dependency "pry", "~> 0.9"
+  gem.add_development_dependency "simplecov", "~> 0.2"
+  gem.add_development_dependency "simplecov-html", "~> 0.7"
+end

data/lib/boleto_bancario.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+require 'boleto_bancario/version'
+require 'active_model'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/string'
+
+# Copyright (C) 2012 Tomás D'Stefano <http://successoft.com>
+#
+# @author Tomás D'Stefano <tomas_stefano@successoft.com>
+#
+# == Boleto Bancário
+#
+# Emissão de Boletos Bancários em Ruby. Simples e principalmente, flexível.
+#
+# Essa biblioteca é baseada em outras <b>ótimas</b> bibliotecas.
+# Recomendo analisar muito bem cada solução!
+#
+# * Novo Gateway de Pagamentos da Locaweb: http://www.locaweb.com.br/produtos/gateway-pagamento.html
+# * Brcobranca: https://github.com/kivanio/brcobranca
+# * Boleto Php: http://boletophp.com.br
+# * Stella Caelum: http://stella.caelum.com.br
+#
+# === Coreuições
+#
+# Você pode contribuir de N formas. Seguem elas:
+#
+# * Homologando os boletos junto aos bancos (Super importante!!! :] ).
+# * Fornecendo documentações mais atualizadas dos Bancos.
+# * Escrevendo novos formatos (PDF, PNG), e me avisando para divulgar no Readme.
+# * Refatorando código!! (Sempre bem vindo!)
+# * Fornecendo Feedback construtivo! (Sempre bem vindo!)
+#
+# === Instalação via Rubygems
+#
+#   gem install boleto_bancario
+#
+# === Instalar via Bundler
+#
+# Coloque no Gemfile:
+#
+#   gem 'boleto_bancario'
+#
+# Depois de colocar no Gemfile:
+#
+#   bundle install
+#
+module BoletoBancario
+  # Modulo responsável por guardar todas as regras dos campos de
+  # todos os Boletos Bancários. <b>Contribuicões com novas documentações dos
+  # bancos e homologação dos boletos são extremamente bem vindas!</b>
+  #
+  # Esse módulo também é responsável por guardar todas as regras de validação dos boletos e
+  # contém a forma de chamar os objetos necessários para renderização
+  # dos formatos (pdf, html, etc) e internacionalização dos boletos (caso
+  # você precise mudar os nomes dos campos nos boletos)
+  #
+  module Core
+    autoload :Boleto,      'boleto_bancario/core/boleto'
+    autoload :BancoBrasil, 'boleto_bancario/core/banco_brasil'
+    autoload :Banrisul,    'boleto_bancario/core/banrisul'
+    autoload :Bradesco,    'boleto_bancario/core/bradesco'
+    autoload :Itau,        'boleto_bancario/core/itau'
+    autoload :Santander,   'boleto_bancario/core/santander'
+  end
+
+  # Módulo que possui classes que realizam os cálculos dos campos que serão mostrados nos boletos.
+  #
+  module Calculos
+    autoload :FatorVencimento,             'boleto_bancario/calculos/fator_vencimento'
+    autoload :FatoresDeMultiplicacao,      'boleto_bancario/calculos/fatores_de_multiplicacao'
+    autoload :LinhaDigitavel,              'boleto_bancario/calculos/linha_digitavel'
+    autoload :Modulo10,                    'boleto_bancario/calculos/modulo10'
+    autoload :Modulo11,                    'boleto_bancario/calculos/modulo11'
+    autoload :Modulo11FatorDe2a9,          'boleto_bancario/calculos/modulo11_fator_de2a9'
+    autoload :Modulo11FatorDe2a9RestoZero, 'boleto_bancario/calculos/modulo11_fator_de2a9_resto_zero'
+    autoload :Modulo11FatorDe2a7,          'boleto_bancario/calculos/modulo11_fator_de2a7'
+    autoload :Modulo11FatorDe9a2RestoX,    'boleto_bancario/calculos/modulo11_fator_de9a2_resto_x'
+    autoload :ModuloNumeroDeControle,      'boleto_bancario/calculos/modulo_numero_de_controle'
+    autoload :Digitos,                     'boleto_bancario/calculos/digitos'
+  end
+
+  include Core
+end

data/lib/boleto_bancario/calculos/digitos.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'active_support/core_ext/enumerable'
+
+module BoletoBancario
+  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/boleto_bancario/calculos/fator_vencimento.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+module BoletoBancario
+  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:
+    #
+    #    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
+      attr_reader :base_date
+      # @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"
+      #
+      def initialize(expiration_date, base_date = Date.new(1997, 10, 7))
+        @base_date       = base_date
+        @expiration_date = expiration_date
+
+        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(4, '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
+      end
+    end
+  end
+end

data/lib/boleto_bancario/calculos/fatores_de_multiplicacao.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+module BoletoBancario
+  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
+    #
+    #    BoletoBancario::Calculos::FatoresDeMultiplicacao.new(123, fatores: [2, 1])
+    #    # => [1, 2, 6]
+    #
+    #    BoletoBancario::Calculos::FatoresDeMultiplicacao.new(123, fatores: [2, 3, 4, 5, 6, 7, 8, 9])
+    #    # => [4, 6, 6]
+    #
+    #    BoletoBancario::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/boleto_bancario/calculos/linha_digitavel.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+require 'active_support/core_ext/object'
+
+module BoletoBancario
+  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