boleto_bancario 0.0.1.beta → 1.0.0

data/lib/boleto_bancario/core/banrisul.rb

@@ -0,0 +1,182 @@
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário do Banrisul.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/banrisul' dentro dessa biblioteca.
+    #
+    # === Contrato das classes de emissão de boletos
+    #
+    # Para ver o "<b>contrato</b>" da Emissão de Boletos (geração de código de barras, linha digitável, etc) veja
+    # a classe BoletoBancario::Core::Boleto.
+    #
+    # === Carteiras Suportadas
+    #
+    # 00 - CCB sem registro
+    # 08 - CCB com registro
+    #
+    # === Usage
+    #
+    #    class BoletoBanrisul < BoletoBancario::Banrisul
+    #    end
+    #
+    #    boleto = BoletoBanrisul.new do |boleto|
+    #      boleto.numero_documento      = 22832563
+    #      boleto.agencia               = 100
+    #      boleto.data_vencimento       = Date.parse('2004-07-04')
+    #      boleto.codigo_cedente        = "0000001"
+    #      boleto.valor_documento       = 5.0
+    #    end
+    #
+    class Banrisul < Boleto
+      # Tamanho máximo de uma agência no Banrisul (sem número de controle).
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 3
+      #
+      def self.maximo_agencia
+        3
+      end
+
+      # Tamanho máximo do código cedente.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 4
+      #
+      def self.maximo_codigo_cedente
+        7
+      end
+
+      # Tamanho máximo do número do documento.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 8
+      #
+      def self.maximo_numero_documento
+        8
+      end
+
+      # <b>Carteiras suportadas.</b>
+      #
+      # <b>Método criado para validar se a carteira informada é suportada.</b>
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[00 08]
+      end
+
+      validates :agencia, :digito_agencia, :codigo_cedente, :digito_codigo_cedente, presence: true
+
+      validates :agencia,               length: { maximum: maximo_agencia          }, if: :deve_validar_agencia?
+      validates :codigo_cedente,        length: { maximum: maximo_codigo_cedente   }, if: :deve_validar_codigo_cedente?
+      validates :numero_documento,      length: { maximum: maximo_numero_documento }, if: :deve_validar_numero_documento?
+
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
+
+      # @return [String] 3 caracteres
+      #
+      def agencia
+        @agencia.to_s.rjust(3, '0') if @agencia.present?
+      end
+
+      # @return [String] 8 caracteres
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(8, '0') if @numero_documento.present?
+      end
+
+      # @return [String] 7 caracteres
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(7, '0') if @codigo_cedente.present?
+      end
+
+      # @return [String] 2 caracteres
+      #
+      def carteira
+        @carteira.to_s.rjust(2, '0') if @carteira.present?
+      end
+
+      # @return [String] Código do Banco descrito na documentação.
+      #
+      def codigo_banco
+        '041'
+      end
+
+      # Dígito do código do banco. Precisa mostrar esse dígito no boleto.
+      #
+      # @return [String] Dígito do código do banco descrito na documentação.
+      #
+      def digito_codigo_banco
+        '8'
+      end
+
+      # Dígito do código da agência. Precisa mostrar esse dígito no boleto.
+      #
+      # @return [String] Dígito da agência calculado apartir do ModuloNumeroDeControle.
+      #
+      def digito_agencia
+        ModuloNumeroDeControle.new(agencia)
+      end
+
+      # Dígito do código do cedente. Precisa mostrar esse dígito no boleto.
+      #
+      # @return [String] Dígito do código do cedente calculado apartir do ModuloNumeroDeControle.
+      #
+      def digito_codigo_cedente
+        ModuloNumeroDeControle.new(codigo_cedente)
+      end
+
+      # Retorna a Agencia, digito da agencia, código do cedente e o dígito do código do cedente.
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia}.#{digito_agencia} #{codigo_cedente}.#{digito_codigo_cedente}"
+      end
+
+      # Retorna o número do documento com seu número de controle.
+      #
+      # Para mais detalhes do cálculo, veja a classe ModuloNumeroDeControle.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}.#{ModuloNumeroDeControle.new(numero_documento)}"
+      end
+
+      #  === Código de barras do banco
+      #
+      #     ________________________________________________________________________________________________
+      #    | Posição | Tamanho | Descrição                                                                 |
+      #    |---------|---------|---------------------------------------------------------------------------|
+      #    | 20      |  01     | Tipo da cobrança do produto (mais detalhes veja #tipo_da_cobranca)        |
+      #    | 21      |  01     | Constante '1'                                                             |
+      #    | 22-24   |  03     | Agência (sem número de controle)                                          |
+      #    | 25-31   |  07     | Código do Cedente (sem número de controle)                                |
+      #    | 32-39   |  08     | Nosso número (número do documento sem número de controle)                 |
+      #    | 40-42   |  03     | Constante '041'                                                           |
+      #    | 43-44   |  02     | Duplo Dígito referente às posições 20 a 42 (módulo do numero de controle) |
+      #    ------------------------------------------------------------------------------------------------|
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{tipo_da_cobranca}1#{agencia}#{codigo_cedente}#{numero_documento}041"
+        "#{codigo}#{ModuloNumeroDeControle.new(codigo)}"
+      end
+
+      # Tipo da cobranca do boleto
+      #
+      # "1" Cobrança Normal, Fichário emitido pelo BANRISUL.
+      # "2" Cobrança Direta, Fichário emitido pelo CLIENTE.
+      #
+      # @return [String]
+      #
+      def tipo_da_cobranca
+        "2"
+      end
+    end
+  end
+end

data/lib/boleto_bancario/core/boleto.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module BoletoBancario
   module Core
     # @abstract Métodos { #codigo_banco, #digito_codigo_banco, #agencia_codigo_cedente, #nosso_numero, #codigo_de_barras_do_banco}
@@ -12,10 +13,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 +82,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 +156,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'.
       #
-      # 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
+      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
+      #
+      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 +207,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 +262,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 +273,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 +347,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 +370,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 +503,35 @@ module BoletoBancario
         false
       end
 
-      # Métodos usado para verificar se deve realizar a validação de tamanho do campo 'agência'.
+      # Renderiza o boleto em formato PDF.
+      #
+      # @return [String] Conteúdo binário do PDF
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def to_pdf
+        Renderers::PdfRenderer.new(self).render
+      end
+
+      # Renderiza o boleto em formato HTML.
+      #
+      # @return [String] Conteúdo HTML do boleto
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def to_html
+        Renderers::HtmlRenderer.new(self).render
+      end
+
+      # Renderiza o código de barras em formato PNG.
+      #
+      # @param [Hash] options Opções para o renderizador PNG
+      # @return [String] Conteúdo binário do PNG
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def to_png(options = {})
+        Renderers::PngRenderer.new(self, options).render
+      end
+
+      # 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 +540,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 +549,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 +558,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 +567,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 +584,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/c6_bank.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo C6 Bank.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/c6_bank' dentro dessa biblioteca.
+    #
+    # === Contrato das classes de emissão de boletos
+    #
+    # Para ver o "<b>contrato</b>" da Emissão de Boletos veja a classe BoletoBancario::Core::Boleto.
+    #
+    # === Carteiras suportadas
+    #
+    # O C6 Bank trabalha com carteira de cobrança registrada.
+    #
+    #      ___________________________________________________________________________
+    #     | Carteira | Descrição                           | Testada/Homologada     |
+    #     |    1     | Cobrança Registrada                 | Esperando Contribuição |
+    #     ----------------------------------------------------------------------------
+    #
+    class C6Bank < Boleto
+      # Tamanho máximo de uma conta corrente no C6 Bank.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_conta_corrente
+        10
+      end
+
+      # Tamanho máximo de uma agência no C6 Bank.
+      #
+      # @return [Integer] 4
+      #
+      def self.tamanho_maximo_agencia
+        4
+      end
+
+      # Tamanho máximo do número do documento.
+      #
+      # @return [Integer] 11
+      #
+      def self.tamanho_maximo_numero_documento
+        11
+      end
+
+      # Tamanho máximo do código do cedente.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_codigo_cedente
+        10
+      end
+
+      # Carteiras suportadas pelo C6 Bank.
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[1]
+      end
+
+      validates :agencia, :conta_corrente, presence: true
+      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
+      validates :conta_corrente, length: { maximum: tamanho_maximo_conta_corrente }, if: :deve_validar_conta_corrente?
+      validates :agencia, length: { maximum: tamanho_maximo_agencia }, if: :deve_validar_agencia?
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
+
+      # @return [String] Número do documento com 11 dígitos.
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(11, '0') if @numero_documento.present?
+      end
+
+      # @return [String] Agência com 4 dígitos.
+      #
+      def agencia
+        @agencia.to_s.rjust(4, '0') if @agencia.present?
+      end
+
+      # @return [String] Conta corrente com 10 dígitos.
+      #
+      def conta_corrente
+        @conta_corrente.to_s.rjust(10, '0') if @conta_corrente.present?
+      end
+
+      # @return [String] Código do cedente com 10 dígitos.
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(10, '0') if @codigo_cedente.present?
+      end
+
+      # Código do C6 Bank.
+      #
+      # @return [String] '336'
+      #
+      def codigo_banco
+        '336'
+      end
+
+      # Dígito do código do banco.
+      #
+      # @return [String] '5'
+      #
+      def digito_codigo_banco
+        '5'
+      end
+
+      # Dígito verificador da conta corrente.
+      #
+      # @return [String]
+      #
+      def digito_conta_corrente
+        Modulo10.new(conta_corrente.to_s)
+      end
+
+      # Agência e código do cedente formatados.
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia} / #{conta_corrente}-#{digito_conta_corrente}"
+      end
+
+      # Nosso Número formatado.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}-#{digito_nosso_numero}"
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # @return [String]
+      #
+      def digito_nosso_numero
+        Modulo11FatorDe2a9.new(numero_documento.to_s)
+      end
+
+      # Segunda parte do código de barras (campo livre).
+      # 25 posições específicas do C6 Bank.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{agencia}#{carteira.to_s.rjust(1, '0')}#{numero_documento}#{conta_corrente.to_s[0, 9]}"
+        "#{codigo.ljust(25, '0')}"
+      end
+    end
+  end
+end