boleto_bancario 0.0.1.beta → 0.0.2

data/lib/boleto_bancario/core/hsbc.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo Banco HSBC.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/hsbc' dentro dessa biblioteca.
+    #
+    # === Carteiras
+    #      ______________________________________________
+    #     | Carteira | Descrição               | Produto |
+    #     |    CNR   | Cobrança não Registrada |    2    |
+    #     |______________________________________________|
+    #
+    class Hsbc < Boleto
+      # 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] 7
+      #
+      def self.tamanho_maximo_codigo_cedente
+        7
+      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] 13
+      #
+      def self.tamanho_maximo_numero_documento
+        13
+      end
+
+      # <b>Carteiras suportadas.</b>
+      # <b>Método criado para validar se a carteira informada é suportada.</b>
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[CNR]
+      end
+
+      # Validações para os campos abaixo:
+      #
+      # * Conta Corrente
+      # * 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 Hsbc < BoletoBancario::Core::Hsbc
+      #       def self.tamanho_maximo_codigo_cedente
+      #         5
+      #       end
+      #
+      #       def self.tamanho_maximo_numero_documento
+      #         10
+      #       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 :codigo_cedente, presence: true
+
+      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] 7 caracteres
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(7, '0') if @codigo_cedente.present?
+      end
+
+      # @return [String] 13 caracteres
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(13, '0') if @numero_documento.present?
+      end
+
+      def produto
+        '2'
+      end
+
+      # @return [String] Código do Banco descrito na documentação.
+      #
+      def codigo_banco
+        '399'
+      end
+
+      # @return [String] Não possui dígito do código do banco.
+      #
+      def digito_codigo_banco
+        '9'
+      end
+
+      # Campo Agência / Código do Cedente
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{codigo_cedente}"
+      end
+
+      # Nosso numero calculado pelo Tipo Identificador 4 descrito na documentação
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}#{nosso_numero_dv_1}#{tipo_identificador}#{nosso_numero_dv_2}"
+      end
+
+      def nosso_numero_dv_1
+        Modulo11FatorDe9a2.new(numero_documento)
+      end
+
+      def tipo_identificador
+        4
+      end
+
+      def nosso_numero_dv_2
+        soma = "#{numero_documento}#{nosso_numero_dv_1}#{tipo_identificador}".to_i
+        soma += codigo_cedente.to_i
+        soma += data_vencimento_para_calculo.to_i
+
+        Modulo11FatorDe9a2.new(soma)
+      end
+
+      # Data do vencimento para ser usada no calculo do segundto dígito identificador do nosso numero
+      #
+      # Exemplo: 18/03/2015 => 180315
+      #
+      # @return [String]
+      #
+      def data_vencimento_para_calculo
+        @data_vencimento.strftime('%d%m%y') if @data_vencimento.present?
+      end
+
+      #  === Código de barras do banco
+      #
+      #     _______________________________________________________________________________________
+      #    | Posição  | Tamanho | Descrição                                                        |
+      #    |----------|---------|------------------------------------------------------------------|
+      #    | 20 - 26  |   07    | Código do Cedente                                                |
+      #    | 27 - 39  |   13    | Código do Documento                                              |
+      #    | 40 - 43  |   04    | Data de Vencimento no Formato Juliano.                           |
+      #    | 44 – 44  |   01    | Código do Produto CNR, número 2.                                 |
+      #    |_______________________________________________________________________________________|
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        "#{codigo_cedente}#{numero_documento}#{data_vencimento_formato_juliano}#{produto}"
+      end
+
+      # Data do vencimento no formato Juliano composta por 4 dígitos
+      #
+      # @return [String]
+      #
+      def data_vencimento_formato_juliano
+        "#{@data_vencimento.yday.to_s.rjust(3, '0')}#{@data_vencimento.year.to_s.last}" if @data_vencimento.present?
+      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/real.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo Banco Real.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/real' dentro dessa biblioteca.
+    #
+    # Cobrança sem registro:
+    #   Nosso número: 13 dígitos
+    #   Código da Agência: 4 dígitos
+    #   Número da Conta: 7 dígitos
+    #
+    # === Código da Carteira
+    #
+    #   '00' - Carteira do convênio
+    #   '20' - Cobrança Simples
+    #   '31' - Cobrança Câmbio
+    #   '42' - Cobrança Caucionada
+    #   '47' - Cobr. Caucionada Crédito Imobiliário
+    #   '85' - Cobrança Partilhada
+    #
+    class Real < Boleto
+      # Tamanho máximo de uma agência no Banco Real.
+      # <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 da conta corrente no Boleto.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 7
+      #
+      def self.tamanho_maximo_conta_corrente
+        7
+      end
+
+      # Tamanho máximo do numero do documento no Boleto.
+      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
+      #
+      # @return [Fixnum] 13
+      #
+      def self.tamanho_maximo_numero_documento
+        13
+      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 20 31 42 47 85]
+      end
+
+      # Validações para os campos abaixo:
+      #
+      # * Agencia
+      # * Conta Corrente
+      # * 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 Real < BoletoBancario::Core::Real
+      #       def self.tamanho_maximo_agencia
+      #         6
+      #       end
+      #
+      #       def self.tamanho_maximo_conta_corrente
+      #         9
+      #       end
+      #
+      #       def self.tamanho_maximo_numero_documento
+      #         10
+      #       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, :conta_corrente, presence: true
+
+      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, 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] 7 caracteres
+      #
+      def conta_corrente
+        @conta_corrente.to_s.rjust(7, '0') if @conta_corrente.present?
+      end
+
+      # @return [String] 13 caracteres
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(13, '0') if @numero_documento.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
+        '356'
+      end
+
+      # @return [String] Dígito do código do banco descrito na documentação.
+      #
+      def digito_codigo_banco
+        '5'
+      end
+
+      # Campo Agência/Código Cedente
+      #
+      # @return [String] Campo descrito na documentação.
+      #
+      def agencia_codigo_cedente
+        "#{agencia}/#{conta_corrente}/#{cobranca_dv}"
+      end
+
+      # Cálculo do Digito verificador da Cobrança
+      #   Nosso Número + Agência + Conta Corrente
+      #   Calculado atravez do modulo 10
+      #
+      # @return [String]
+      #
+      def cobranca_dv
+        Modulo10.new("#{nosso_numero}#{agencia}#{conta_corrente}")
+      end
+
+      # O nosso numero é o mesmo numero que o cliente informa para o numero do documento
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}"
+      end
+
+      #  === Código de barras do banco
+      #     ____________________________________________________
+      #    | Posição | Tamanho | Descrição                      |
+      #    |---------|---------|--------------------------------|
+      #    | 20 – 23 |   04    | Agencia                        |
+      #    | 24 – 30 |   07    | Conta corrente                 |
+      #    | 31 – 31 |   01    | Digito verificador da cobrança |
+      #    | 32 – 44 |   13    | Nosso numero                   |
+      #    |____________________________________________________|
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        "#{agencia}#{conta_corrente}#{cobranca_dv}#{nosso_numero}"
+      end
+    end
+  end
+end

data/lib/boleto_bancario/core/santander.rb

@@ -80,17 +80,6 @@ module BoletoBancario
         12
       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>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
-      #
-      # @return [Fixnum] 2
-      #
-      def self.tamanho_maximo_carteira
-        3
-      end
-
       # Tamanho máximo do código do cedente emitido no Boleto.
       # O tamanho máximo é justamente 7 porque no código de barras só é permitido 7 posições para este campo.
       #
@@ -102,14 +91,24 @@ module BoletoBancario
         7
       end
 
-      # Validações de tamanho para os campos abaixo:
+      # <b>Carteiras suportadas.</b>
+      #
+      # <b>Método criado para validar se a carteira informada é suportada.</b>
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[101 102 121]
+      end
+
+      # Validações para os campos abaixo:
       #
       # * Número do documento
       # * Conta Corrente
       # * Agencia
       # * Carteira
       #
-      # Se você quiser sobrescrever os tamanhos permitidos, <b>ficará a sua responsabilidade.</b>
+      # 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
@@ -124,6 +123,10 @@ module BoletoBancario
       #       def self.tamanho_maximo_numero_documento
       #         9
       #       end
+      #
+      #       def self.carteiras_suportadas
+      #         %w[101 102 121]
+      #       end
       #    end
       #
       # Obs.: Mudar as regras de validação podem influenciar na emissão do boleto em si.
@@ -135,7 +138,8 @@ module BoletoBancario
       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,         length: { maximum: tamanho_maximo_carteira         }, if: :deve_validar_carteira?
+
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
 
       # @return [String] 4 caracteres
       #
@@ -155,12 +159,6 @@ module BoletoBancario
         @numero_documento.to_s.rjust(12, '0') if @numero_documento.present?
       end
 
-      # @return [String] 3 caracteres
-      #
-      def carteira
-        @carteira.to_s.rjust(3, '0') if @carteira.present?
-      end
-
       # Formata a carteira dependendo se ela é registrada ou não.
       #
       # Para cobrança COM registro usar: <b>COBRANCA SIMPLES ECR</b>
@@ -206,7 +204,7 @@ module BoletoBancario
       # @return [String]
       #
       def agencia_codigo_cedente
-        "#{agencia}-#{digito_agencia} / #{codigo_cedente}"
+        "#{agencia} / #{codigo_cedente}"
       end
 
       # Mostra o campo nosso número calculando o dígito verificador do nosso número.
@@ -260,7 +258,6 @@ module BoletoBancario
       #
       # Seguradoras (Se 7% informar 7. Limitado a 9%)
       # <b>Demais clientes usar 0 (zero)</b>
-      # O padrão é zero.
       #
       # @return [String]
       #