boleto_bancario 0.0.1.beta → 1.0.0

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

data/lib/boleto_bancario/core/inter.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo Banco Inter.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/inter' 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 Banco Inter trabalha com carteira de cobrança registrada.
+    #
+    #      ___________________________________________________________________________
+    #     | Carteira | Descrição                           | Testada/Homologada     |
+    #     |   112    | Cobrança Registrada                 | Esperando Contribuição |
+    #     ----------------------------------------------------------------------------
+    #
+    class Inter < Boleto
+      # Tamanho máximo de uma conta corrente no Banco Inter.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_conta_corrente
+        10
+      end
+
+      # Tamanho máximo de uma agência no Banco Inter.
+      #
+      # @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 Banco Inter.
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[112]
+      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 Banco Inter.
+      #
+      # @return [String] '077'
+      #
+      def codigo_banco
+        '077'
+      end
+
+      # Dígito do código do banco.
+      #
+      # @return [String] '9'
+      #
+      def digito_codigo_banco
+        '9'
+      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 Banco Inter.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{agencia}#{carteira}#{numero_documento}#{conta_corrente.to_s[0, 7]}"
+        "#{codigo.ljust(25, '0')}"
+      end
+    end
+  end
+end

data/lib/boleto_bancario/core/itau.rb

@@ -180,15 +180,14 @@ module BoletoBancario
         7
       end
 
-      # Tamanho máximo da carteira.
-      # O tamanho máximo é justamente 3 porque no código de barras só é permitido 3 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] 3
+      # @return [Array]
       #
-      def self.tamanho_maximo_carteira
-        3
+      def self.carteiras_suportadas
+        %w[107 109 174 175 196 198 126 131 146 122 142 143 150 168]
       end
 
       # Campos obrigatórios
@@ -198,16 +197,15 @@ module BoletoBancario
       # * Dígito da conta corrente
       #
       validates :agencia, :conta_corrente, :digito_conta_corrente, presence: true
-      validates :digito_conta_corrente, length: { maximum: 1 }
 
-      # Validações de tamanho para os campos abaixo:
+      # Validações para os campos abaixo:
       #
       # * Número do documento
       # * Conta Corrente
       # * Agencia
       # * 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 BoletoItau < BoletoBancario::Core::Itau
@@ -222,6 +220,9 @@ module BoletoBancario
       #       def self.tamanho_maximo_numero_documento
       #         9
       #       end
+      #       def self.carteiras_suportadas
+      #         %w[107 109 174 175 196 198 126 131 146 122 142 143 150 168]
+      #       end
       #    end
       #
       # Obs.: Mudar as regras de validação podem influenciar na emissão do boleto em si.
@@ -231,7 +232,8 @@ module BoletoBancario
       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,         length: { maximum: tamanho_maximo_carteira         }, if: :deve_validar_carteira?
+
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
 
       # Campos obrigatórios e validações de tamanho para os campos:
       #
@@ -298,6 +300,14 @@ module BoletoBancario
         '7'
       end
 
+      # Dígito da conta corrente. Precisa mostrar esse dígito no boleto.
+      #
+      # @return [String] Dígito da conta corrente calculado apartir do Modulo10.
+      #
+      def digito_conta_corrente
+        Modulo10.new("#{agencia}#{conta_corrente}")
+      end
+
       # Agência, conta corrente and dígito da conta corrente formatado.
       #
       # @return [String] Campo descrito na documentação (Pag. 50).

data/lib/boleto_bancario/core/nubank.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo Nubank.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/nubank' 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 Nubank trabalha com carteira única de cobrança registrada.
+    #
+    #      ___________________________________________________________________________
+    #     | Carteira | Descrição                           | Testada/Homologada     |
+    #     |    1     | Cobrança Registrada                 | Esperando Contribuição |
+    #     ----------------------------------------------------------------------------
+    #
+    class Nubank < Boleto
+      # Tamanho máximo de uma conta corrente no Nubank.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_conta_corrente
+        10
+      end
+
+      # Tamanho máximo de uma agência no Nubank.
+      # Nubank utiliza agência fixa 0001.
+      #
+      # @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 Nubank.
+      #
+      # @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 Banco Nubank.
+      #
+      # @return [String] '260'
+      #
+      def codigo_banco
+        '260'
+      end
+
+      # Dígito do código do banco.
+      #
+      # @return [String] '0'
+      #
+      def digito_codigo_banco
+        '0'
+      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
+        "#{carteira}/#{numero_documento}-#{digito_nosso_numero}"
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # @return [String]
+      #
+      def digito_nosso_numero
+        Modulo10.new("#{carteira}#{numero_documento}")
+      end
+
+      # Segunda parte do código de barras (campo livre).
+      # 25 posições específicas do Nubank.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{carteira.to_s.rjust(1, '0')}#{numero_documento}#{agencia}#{conta_corrente.to_s[0, 9]}"
+        "#{codigo.ljust(25, '0')}"
+      end
+    end
+  end
+end