boleto_bancario 0.0.1.beta → 0.0.2

data/lib/boleto_bancario/core/boleto.rb

@@ -12,10 +12,7 @@ module BoletoBancario
       # * Internacionalização;
       # * Nomes das classes para serem manipuladas;
       #
-      include ActiveModel::Validations
-      include ActiveModel::Conversion
-      extend  ActiveModel::Naming
-      extend  ActiveModel::Translation
+      include ActiveModel::Model
 
       # Nome/Razão social que aparece no campo 'Cedente' no boleto.
       #
@@ -84,20 +81,10 @@ module BoletoBancario
       #
       attr_accessor :agencia
 
-      # Dígito da agência. Campo auto explicativo.
-      # Alguns bancos tem o agência, enquanto outros não possuem.
-      #
-      attr_accessor :digito_agencia
-
       # Número da Conta corrente. Campo auto explicativo.
       #
       attr_accessor :conta_corrente
 
-      # Dígito da conta corrente. Campo auto explicativo.
-      # Alguns bancos tem o dígito da conta corrente outros não.
-      #
-      attr_accessor :digito_conta_corrente
-
       # Código da moeda. Campo auto explicativo.
       # Padrão '9' (Real).
       #
@@ -168,24 +155,46 @@ module BoletoBancario
       #
       attr_accessor :local_pagamento
 
-      # O que falta:
+      # Aceitar após o vencimento.
+      # Nessa gem utilizamos o campo aceite como Boolean.
+      # Obviamente, true para 'S' e false/nil para 'N'.
+      #
+      attr_accessor :aceite
+
+      # Campos de instruções.
+      # São permitidas até seis linhas de instruções a serem mostradas no boleto
+
+      attr_accessor :instrucoes1,
+                    :instrucoes2,
+                    :instrucoes3,
+                    :instrucoes4,
+                    :instrucoes5,
+                    :instrucoes6
+
+      # Caminho do logo do banco.
+      #
+      attr_accessor :logo
+
+      # Tamanho maximo do valor do documento do boleto.
+      # Acredito que não existirá valor de documento nesse valor,
+      # <b>porém a biblioteca precisa manter a consistência</b>.
+      #
+      # No código de barras o valor do documento precisa
+      # ter um tamanho de 8 caracteres para os reais (acrescentando zeros à esquerda),
+      # e 2 caracteres nos centavos (acrescentando zeros à esquerda).
+      #
+      # @return [Float] 99999999.99
       #
-      # Logo
-      # Formatacao documento (CPF/CNPJ)
-      # Aceite
-      # Instruções
-      # Código de barras como imagem (usar a gem Barby)
-      # Data do vencimento formatado
-      # Data do documento
-      # Data do documento formatado
-      # Data do processamento
-      # Data do processamento formatado
+      def self.valor_documento_tamanho_maximo
+        99999999.99
+      end
 
       # Validações de todos os boletos
       #
       validates :carteira, :valor_documento, :numero_documento, :data_vencimento, presence: true
       validates :cedente, :endereco_cedente, presence: true
       validates :sacado,  :documento_sacado, presence: true
+      validates :valor_documento, numericality: { less_than_or_equal_to: ->(object) { object.class.valor_documento_tamanho_maximo } }
       validate :data_vencimento_deve_ser_uma_data
 
       # Passing the attributes as Hash or block
@@ -197,7 +206,6 @@ module BoletoBancario
       # @option options [String] :documento_cedente
       # @option options [String] :endereco_cedente
       # @option options [String] :conta_corrente
-      # @option options [String] :digito_conta_corrente
       # @option options [String] :agencia
       # @option options [Date]   :data_vencimento
       # @option options [String] :numero_documento
@@ -253,6 +261,7 @@ module BoletoBancario
       #     bradesco.especie           = 'outra_especie_que_nao_seja_em_reais'
       #     bradesco.especie_documento = 'outra_especie_do_documento'
       #     bradesco.data_documento    = Date.tomorrow
+      #     bradesco.aceite            = false
       #   end
       #
       # @return [Hash] Código da Moeda sendo '9' (real). Espécie sendo 'R$' (real).
@@ -263,7 +272,8 @@ module BoletoBancario
           :especie           => 'R$',
           :especie_documento => 'DM',
           :local_pagamento   => 'PAGÁVEL EM QUALQUER BANCO ATÉ O VENCIMENTO',
-          :data_documento    => Date.today
+          :data_documento    => Date.today,
+          :aceite            => true
         }
       end
 
@@ -336,7 +346,17 @@ module BoletoBancario
       # @return [String] Precisa retornar 10 dígitos para o código de barras (incluindo os centavos).
       #
       def valor_formatado_para_codigo_de_barras
-        valor_documento.to_s.gsub(/\,|\./, '').rjust(10, '0')
+        valor_documento_formatado = (Integer(valor_documento.to_f * 100) / Float(100))
+        real, centavos            = valor_documento_formatado.to_s.split(/\./)
+        "#{real.rjust(8, '0')}#{centavos.ljust(2, '0')}"
+      end
+
+      # Força a carteira a retornar o valor como string
+      #
+      # @return [String]
+      #
+      def carteira
+        @carteira.to_s if @carteira.present?
       end
 
       # Embora o padrão seja mostrar o número da carteira no boleto,
@@ -349,6 +369,19 @@ module BoletoBancario
         carteira
       end
 
+      # Se o aceite for 'true', retorna 'S'.
+      # Retorna 'N', caso contrário.
+      #
+      # @return [String]
+      #
+      def aceite_formatado
+        if @aceite.present?
+          'S'
+        else
+          'N'
+        end
+      end
+
       # Fator de vencimento que é calculado a partir de uma data base.
       # Veja <b>FatorVencimento</b> para mais detalhes.
       #
@@ -469,7 +502,7 @@ module BoletoBancario
         false
       end
 
-      # Métodos usado para verificar se deve realizar a validação de tamanho do campo 'agência'.
+      # Método usado para verificar se deve realizar a validação de tamanho do campo 'agência'.
       # <b>Sobrescreva esse método na subclasse, caso você mesmo queira fazer as validações</b>.
       #
       # @return [True]
@@ -478,7 +511,7 @@ module BoletoBancario
         true
       end
 
-      # Métodos usado para verificar se deve realizar a validação de tamanho do campo 'agência'.
+      # Método usado para verificar se deve realizar a validação de tamanho do campo 'conta_corrente'.
       # <b>Sobrescreva esse método na subclasse, caso você mesmo queira fazer as validações</b>.
       #
       # @return [True]
@@ -487,7 +520,7 @@ module BoletoBancario
         true
       end
 
-      # Métodos usado para verificar se deve realizar a validação de tamanho do campo 'codigo_cedente'.
+      # Método usado para verificar se deve realizar a validação de tamanho do campo 'codigo_cedente'.
       # <b>Sobrescreva esse método na subclasse, caso você mesmo queira fazer as validações</b>.
       #
       # @return [True]
@@ -496,7 +529,7 @@ module BoletoBancario
         true
       end
 
-      # Métodos usado para verificar se deve realizar a validação de tamanho do campo 'numero_documento'.
+      # Método usado para verificar se deve realizar a validação de tamanho do campo 'numero_documento'.
       # <b>Sobrescreva esse método na subclasse, caso você mesmo queira fazer as validações</b>.
       #
       # @return [True]
@@ -505,7 +538,7 @@ module BoletoBancario
         true
       end
 
-      # Métodos usado para verificar se deve realizar a validação de tamanho do campo 'carteira'.
+      # Método usado para verificar se deve realizar a validação do campo 'carteira'.
       # <b>Sobrescreva esse método na subclasse, caso você mesmo queira fazer as validações</b>.
       #
       # @return [True]
@@ -522,4 +555,4 @@ module BoletoBancario
       end
     end
   end
-end
+end

data/lib/boleto_bancario/core/bradesco.rb

@@ -42,7 +42,7 @@ module BoletoBancario
     #    Bradesco.new do |boleto|
     #      boleto.conta_corrente   = '89755'
     #      boleto.agencia          = '0097'
-    #      boleto.carteira         = '198'
+    #      boleto.carteira         = '03'
     #      boleto.numero_documento = '12345678'
     #      boleto.codigo_cedente   = '909014'
     #    end
@@ -112,29 +112,26 @@ module BoletoBancario
         11
       end
 
-      # Tamanho máximo da carteira.
-      # O tamanho máximo é justamente 2 porque no código de barras só é permitido 2 posições para este campo.
+      # <b>Carteiras suportadas.</b>
       #
-      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      # <b>Método criado para validar se a carteira informada é suportada.</b>
       #
-      # @return [Fixnum] 2
+      # @return [Array]
       #
-      def self.tamanho_maximo_carteira
-        2
+      def self.carteiras_suportadas
+        %w[03 06 09 19 21 22]
       end
 
       validates :agencia, :digito_agencia, :conta_corrente, :digito_conta_corrente, presence: true
 
-      # Validações de tamanho para os campos abaixo:
+      # Validações para os campos abaixo:
       #
       # * Agencia
-      # * Digito verificador da agencia
       # * Conta corrente
-      # * Digito verificador da conta corrente
       # * Número do documento
       # * Carteira
       #
-      # Se você quiser sobrescrever os tamanhos permitidos, ficará a sua responsabilidade.
+      # Se você quiser sobrescrever os metodos, ficará a sua responsabilidade.
       # Basta você sobrescrever os métodos de validação:
       #
       #    class Bradesco < BoletoBancario::Core::Bradesco
@@ -150,8 +147,8 @@ module BoletoBancario
       #         9
       #       end
       #
-      #       def self.tamanho_maximo_carteira
-      #         2
+      #       def self.carteiras_suportadas
+      #         %w[03 06 09 19 21 22]
       #       end
       #    end
       #
@@ -159,12 +156,11 @@ module BoletoBancario
       # Você precisará analisar o efeito no #codigo_de_barras, #nosso_numero e na
       # #linha_digitável (ambos podem ser sobreescritos também).
       #
-      validates :digito_agencia,        length: { maximum: 1  }
-      validates :digito_conta_corrente, length: { maximum: 1  }
       validates :agencia,          length: { maximum: tamanho_maximo_agencia          }, if: :deve_validar_agencia?
       validates :conta_corrente,   length: { maximum: tamanho_maximo_conta_corrente   }, if: :deve_validar_conta_corrente?
       validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
-      validates :carteira,         length: { maximum: tamanho_maximo_carteira         }, if: :deve_validar_carteira?
+
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
 
       # @return [String] 7 caracteres
       #
@@ -220,6 +216,22 @@ module BoletoBancario
         '2'
       end
 
+      # Dígito do código da agência. Precisa mostrar esse dígito no boleto.
+      #
+      # @return [String] Dígito da agência calculado usando o Modulo11FatorDe9a2.
+      #
+      def digito_agencia
+        Modulo11FatorDe9a2.new(agencia)
+      end
+
+      # Dígito da conta corrente. Precisa mostrar esse dígito no boleto.
+      #
+      # @return [String] Dígito da conta corrente calculado apartir do Modulo11FatorDe9a2.
+      #
+      def digito_conta_corrente
+        Modulo11FatorDe9a2.new(conta_corrente)
+      end
+
       # Campo preenchido com:
       #
       # - Agência com 4 caracteres - digito da agência / Conta de Cobrança com 7 caracteres - Digito da Conta

data/lib/boleto_bancario/core/caixa.rb

@@ -0,0 +1,233 @@
+# encoding: utf-8
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pela Caixa Econômica Federal.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/caixa' dentro dessa biblioteca.
+    # === Carteiras suportadas
+    #
+    # Segue abaixo as carteiras suportadas da Caixa Econômica Federal <b>seguindo a documentação</b>:
+    #
+    #      _________________________________________________________________________
+    #     | Carteira | Descrição                     | Testada/Homologada no banco  |
+    #     |    14    | Cobrança Simples com registro | Esperando Contribuição       |
+    #     |    24    | Cobrança Simples sem registro | Esperando Contribuição       |
+    #     |_________________________________________________________________________|
+    #
+    class Caixa < Boleto
+      # Tamanho máximo de uma agência na Caixa Econômica Federal.
+      # <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 código do cedente emitido 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_codigo_cedente
+        6
+      end
+
+      # <b>Carteiras suportadas.</b>
+      # <b>Método criado para validar se a carteira informada é suportada.</b>
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[14 24]
+      end
+
+      # Tamanho máximo do número do documento emitido no Boleto.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 15
+      #
+      def self.tamanho_maximo_numero_documento
+        15
+      end
+
+      # Tamanho maximo do valor do documento do boleto.
+      # O valor maximo descrito na decumentação é de 9999999.99
+      #
+      # @return [Float] 9999999.99
+      #
+      def self.valor_documento_tamanho_maximo
+        9999999.99
+      end
+
+      # Validações para os campos abaixo:
+      #
+      # * Agencia
+      # * Conta Corrente
+      # * Carteira
+      # * 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 Santander < BoletoBancario::Core::Santander
+      #       def self.tamanho_maximo_agencia
+      #         5
+      #       end
+      #
+      #       def self.tamanho_maximo_codigo_cedente
+      #         7
+      #       end
+      #
+      #       def self.tamanho_maximo_numero_documento
+      #         10
+      #       end
+      #
+      #       def self.carteiras_suportadas
+      #         %w[10 53]
+      #       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] 6 caracteres
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(6, '0') if @codigo_cedente.present?
+      end
+
+      # @return [String] 15 caracteres
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(15, '0') if @numero_documento.present?
+      end
+
+      # Formata a carteira dependendo se ela é registrada ou não.
+      #
+      # Para cobrança COM registro usar: <b>RG</b>
+      # Para Cobrança SEM registro usar: <b>SR</b>
+      #
+      # @return [String]
+      #
+      def carteira_formatada
+        if @carteira.to_s.in?(carteiras_com_registro)
+          "RG"
+        else
+          'SR'
+        end
+      end
+
+      # Retorna as carteiras com registro da Caixa Econômica Federal.
+      # <b>Você pode sobrescrever esse método na subclasse caso exista mais
+      # carteiras com registro na Caixa Econômica Federal.</b>
+      #
+      # @return [Array]
+      #
+      def carteiras_com_registro
+        %w(14)
+      end
+
+      def tipo_cobranca
+        carteira.first if carteira.present?
+      end
+
+      def identificador_de_emissao
+        carteira.last if carteira.present?
+      end
+
+      # @return [String] Código do Banco descrito na documentação.
+      #
+      def codigo_banco
+        '104'
+      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 (Número fornecido pelo Banco)
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia} / #{codigo_cedente}-#{codigo_cedente_dv}"
+      end
+
+      def codigo_cedente_dv
+        Modulo11FatorDe2a9RestoZero.new(codigo_cedente)
+      end
+
+      # Mostra o campo nosso número calculando o dígito verificador do nosso número.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{carteira}#{numero_documento}-#{nosso_numero_dv}"
+      end
+
+      def nosso_numero_dv
+        Modulo11FatorDe2a9RestoZero.new("#{carteira}#{numero_documento}")
+      end
+
+      def nosso_numero_de3a5
+        nosso_numero[2..4] if nosso_numero.present?
+      end
+
+      def nosso_numero_de6a8
+        nosso_numero[5..7] if nosso_numero.present?
+      end
+
+      def nosso_numero_de9a17
+        nosso_numero[8..16] if nosso_numero.present?
+      end
+
+
+      #  === Código de barras do banco
+      #
+      #     ________________________________________________________________________________________
+      #    | Posição  | Tamanho | Descrição                                                        |
+      #    |----------|---------|------------------------------------------------------------------|
+      #    | 20 - 25  |   06    | Código do Beneficiário                                           |
+      #    | 26 - 26  |   01    | DV do Código do Beneficiário                                     |
+      #    | 27 – 29  |   03    | Nosso Número - 3ª a 5ª posição do Nosso Número                   |
+      #    | 30 – 30  |   01    | Constante 1, tipo de cobrança (1-Registrada / 2-Sem Registro)    |
+      #    | 31 – 33  |   03    | Nosso Número - 6ª a 8ª posição do Nosso Número                   |
+      #    | 34 – 34  |   01    | Constante 2, identificador de emissão do boleto (4-Beneficiário) |
+      #    | 35 – 43  |   09    | Nosso Número - 9ª a 17ª posição do Nosso Número                  |
+      #    | 44 – 44  |   01    | DV do Campo Livre                                                |
+      #    -----------------------------------------------------------------------------------------
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{codigo_cedente}#{codigo_cedente_dv}#{nosso_numero_de3a5}#{tipo_cobranca}#{nosso_numero_de6a8}"
+        codigo << "#{identificador_de_emissao}#{nosso_numero_de9a17}"
+
+        codigo_dv = Modulo11FatorDe2a9RestoZero.new(codigo)
+
+        "#{codigo}#{codigo_dv}"
+      end
+    end
+  end
+end