brcobranca_sicredi_400 1.0

data/lib/brcobranca/boleto/hsbc.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Brcobranca
+  module Boleto
+    # Banco HSBC
+    class Hsbc < Base
+      validates_inclusion_of :carteira, in: %w[CNR CSB], message: 'não existente para este banco.'
+      validates_length_of :agencia, maximum: 4, message: 'deve ser menor ou igual a 4 dígitos.'
+      validates_length_of :nosso_numero, maximum: 13, message: 'deve ser menor ou igual a 13 dígitos.'
+      validates_length_of :conta_corrente, maximum: 7, message: 'deve ser menor ou igual a 7 dígitos.'
+
+      # Nova instancia do Hsbc
+      # @param (see Brcobranca::Boleto::Base#initialize)
+      def initialize(campos = {})
+        campos = { carteira: 'CNR' }.merge!(campos)
+        super(campos)
+      end
+
+      # Codigo do banco emissor (3 dígitos sempre)
+      #
+      # @return [String] 3 caracteres numéricos.
+      def banco
+        '399'
+      end
+
+      # Número seqüencial utilizado para identificar o boleto.
+      # @return [String] 13 caracteres numéricos.
+      def nosso_numero=(valor)
+        @nosso_numero = valor.to_s.rjust(13, '0') if valor
+      end
+
+      # Nosso número para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.nosso_numero_boleto #=> "0000000004042847"
+      def nosso_numero_boleto
+        case carteira
+        when 'CNR'
+          if data_vencimento.is_a?(Date)
+            self.codigo_servico = '4'
+            dia = data_vencimento.day.to_s.rjust(2, '0')
+            mes = data_vencimento.month.to_s.rjust(2, '0')
+            ano = data_vencimento.year.to_s[2..3]
+            data = "#{dia}#{mes}#{ano}"
+
+            parte_1 = "#{nosso_numero}#{nosso_numero.modulo11(mapeamento: { 10 => 0 })}#{codigo_servico}"
+            soma = parte_1.to_i + conta_corrente.to_i + data.to_i
+            "#{parte_1}#{soma.to_s.modulo11(mapeamento: { 10 => 0 })}"
+          else
+            errors.add(:data_vencimento, 'não é uma data.')
+            raise Brcobranca::BoletoInvalido, self
+          end
+        when 'CSB'
+          @nosso_numero
+        else
+          raise Brcobranca::NaoImplementado, 'Tipo de carteira não implementado.'
+          # TODO: - Verificar outras carteiras.
+          # self.codigo_servico = "5"
+          # parte_1 = "#{self.nosso_numero}#{self.nosso_numero.modulo11(mapeamento: { 10 => 0 })}#{self.codigo_servico}"
+          # soma = parte_1.to_i + self.conta_corrente.to_i
+          # numero = "#{parte_1}#{soma.to_s.modulo11(mapeamento: { 10 => 0 })}"
+          # numero
+        end
+      end
+
+      # Número do convênio/contrato do cliente para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.agencia_conta_boleto #=> "0061900"
+      def agencia_conta_boleto
+        conta_corrente
+      end
+
+      # Segunda parte do código de barras.
+      #
+      # Montagem é baseada no tipo de carteira e na presença da data de vencimento<br/>
+      # <b>OBS:</b> Somente as carteiras <b>CNR/CSB</b> estão implementadas.<br/>
+      #
+      # @return [String] 25 caracteres numéricos.
+      # @raise  [Brcobranca::NaoImplementado] Caso a carteira informada não for CNR/CSB.
+      def codigo_barras_segunda_parte
+        case carteira
+        when 'CNR'
+          dias_julianos = data_vencimento.to_juliano
+          "#{conta_corrente}#{nosso_numero}#{dias_julianos}2"
+        when 'CSB'
+          raise Brcobranca::NaoImplementado, 'Nosso número não definido.' unless @nosso_numero
+
+          "#{nosso_numero}#{agencia}#{conta_corrente}001"
+        else
+          raise Brcobranca::NaoImplementado, 'Tipo de carteira não implementado.'
+        end
+      end
+    end
+  end
+end

data/lib/brcobranca/boleto/itau.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Brcobranca
+  module Boleto
+    # Banco Itaú
+    class Itau < Base
+      # Usado somente em carteiras especiais com registro para complementar o número do cocumento
+      attr_reader :seu_numero
+
+      validates_length_of :agencia, maximum: 4, message: 'deve ser menor ou igual a 4 dígitos.'
+      validates_length_of :convenio, maximum: 5, message: 'deve ser menor ou igual a 5 dígitos.'
+      validates_length_of :nosso_numero, maximum: 8, message: 'deve ser menor ou igual a 8 dígitos.'
+      validates_length_of :conta_corrente, maximum: 5, message: 'deve ser menor ou igual a 5 dígitos.'
+      with_options if: :usa_seu_numero? do |v|
+        v.validates_length_of :seu_numero, maximum: 7, message: 'deve ser menor ou igual a 7 dígitos.'
+      end
+      # Nova instancia do Itau
+      # @param (see Brcobranca::Boleto::Base#initialize)
+      def initialize(campos = {})
+        campos = { carteira: '175' }.merge!(campos)
+        super(campos)
+      end
+
+      # Codigo do banco emissor (3 dígitos sempre)
+      #
+      # @return [String] 3 caracteres numéricos.
+      def banco
+        '341'
+      end
+
+      # Número do convênio/contrato do cliente junto ao banco.
+      # @return [String] 5 caracteres numéricos.
+      def convenio=(valor)
+        @convenio = valor.to_s.rjust(5, '0') if valor
+      end
+
+      # Conta corrente
+      # @return [String] 5 caracteres numéricos.
+      def conta_corrente=(valor)
+        @conta_corrente = valor.to_s.rjust(5, '0') if valor
+      end
+
+      # Número seqüencial utilizado para identificar o boleto.
+      # @return [String] 8 caracteres numéricos.
+      def nosso_numero=(valor)
+        @nosso_numero = valor.to_s.rjust(8, '0') if valor
+      end
+
+      # Número seqüencial utilizado para identificar o boleto.
+      # @return [String] 7 caracteres numéricos.
+      def seu_numero=(valor)
+        @seu_numero = valor.to_s.rjust(7, '0') if valor
+      end
+
+      def usa_seu_numero?
+        %w[198 106 107 122 142 143 195 196].include?(carteira.to_s)
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # Para a grande maioria das carteiras, são considerados para a obtenção do DAC/DV, os dados
+      # "AGENCIA(sem DAC/DV)/CONTA(sem DAC/DV)/CARTEIRA/NOSSO NUMERO", calculado pelo criterio do Modulo 10.<br/>
+      # A excecao, estão as carteiras 112, 126, 131, 146, 150 e 168 cuja obtenção esta baseada apenas nos
+      # dados "CARTEIRA/NOSSO NUMERO".
+      #
+      # @return [String] 1 caracteres numéricos.
+      def nosso_numero_dv
+        if %w[112 126 131 146 150 168].include?(carteira)
+          "#{carteira}#{nosso_numero}".modulo10
+        else
+          "#{agencia}#{conta_corrente}#{carteira}#{nosso_numero}".modulo10
+        end
+      end
+
+      # Calcula o dígito verificador para conta corrente do Itau.
+      # Retorna apenas o dígito verificador da conta ou nil caso seja impossível calcular.
+      def agencia_conta_corrente_dv
+        "#{agencia}#{conta_corrente}".modulo10
+      end
+
+      # Nosso número para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.nosso_numero_boleto #=> "175/12345678-4"
+      def nosso_numero_boleto
+        "#{carteira}/#{nosso_numero}-#{nosso_numero_dv}"
+      end
+
+      # Agência + conta corrente do cliente para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.agencia_conta_boleto #=> "0811 / 53678-8"
+      def agencia_conta_boleto
+        "#{agencia} / #{conta_corrente}-#{agencia_conta_corrente_dv}"
+      end
+
+      # Segunda parte do código de barras.
+      #
+      # CARTEIRAS 198, 106, 107,122, 142, 143, 195 e 196<br/>
+      # 01 a 03 | 03 | 9(3) | Código do Banco na Câmara de Compensação = ‘341’<br/>
+      # 04 a 04 | 01 | 9(1) | Código da Moeda = '9'<br/>
+      # 05 a 05 | 01 | 9(1) | DAC do Código de Barras MOD 11-2a9<br/>
+      # 06 a 09 | 04 | 9(04) | Fator de Vencimento<br/>
+      # 10 a 19 | 10 | 9(08) | V(2) Valor<br/>
+      # 20 a 22 | 03 | 9(3) | Carteira<br/>
+      # 23 a 30 | 08 | 9(8) | Nosso Número<br/>
+      # 31 a 37 | 07 | 9(7) | Seu Número (Número do Documento)<br/>
+      # 38 a 42 | 05 | 9(5) | Código do Cliente (fornecido pelo Banco)<br/>
+      # 43 a 43 | 01 | 9(1) | DAC dos campos acima (posições 20 a 42) MOD 10<br/>
+      # 44 a 44 | 01 | 9(1) | Zero<br/>
+      #
+      # DEMAIS CARTEIRAS<br/>
+      # 01 a 03 | 03 | 9(03) | Código do Banco na Câmara de Compensação = '341'<br/>
+      # 04 a 04 | 01 | 9(01) | Código da Moeda = '9'<br/>
+      # 05 a 05 | 01 | 9(01) | DAC código de Barras MOD 11-2a9<br/>
+      # 06 a 09 | 04 | 9(04) | Fator de Vencimento<br/>
+      # 10 a 19 | 10 | 9(08)V(2) | Valor<br/>
+      # 20 a 22 | 03 | 9(03) | Carteira<br/>
+      # 23 a 30 | 08 | 9(08) | Nosso Número<br/>
+      # 31 a 31 | 01 | 9(01) | DAC [Agência /Conta/Carteira/Nosso Número] MOD 10<br/>
+      # 32 a 35 | 04 | 9(04) | N.º da Agência cedente<br/>
+      # 36 a 40 | 05 | 9(05) | N.º da Conta Corrente<br/>
+      # 41 a 41 | 01 | 9(01) | DAC [Agência/Conta Corrente] MOD 10<br/>
+      # 42 a 44 | 03 | 9(03) | Zeros<br/>
+      #
+      # @return [String] 25 caracteres numéricos.
+      def codigo_barras_segunda_parte
+        case carteira.to_i
+        when 198, 106, 107, 122, 142, 143, 195, 196
+          dv = "#{carteira}#{nosso_numero}#{seu_numero}#{convenio}".modulo10
+          "#{carteira}#{nosso_numero}#{seu_numero}#{convenio}#{dv}0"
+        else
+          "#{carteira}#{nosso_numero}#{nosso_numero_dv}#{agencia}#{conta_corrente}#{agencia_conta_corrente_dv}000"
+        end
+      end
+    end
+  end
+end

data/lib/brcobranca/boleto/safra.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Brcobranca
+  module Boleto
+    # Banco Safra
+    class Safra < Base
+      # <b>REQUERIDO</b>: Dígito da Agência
+      attr_accessor :agencia_dv
+      # <b>REQUERIDO</b>: Dígito da conta
+      attr_accessor :conta_corrente_dv
+
+      validates_presence_of :agencia_dv, :conta_corrente_dv, message: 'não pode estar em branco.'
+      validates_length_of :agencia, maximum: 4, message: 'deve ser menor ou igual a 4 dígitos.'
+      validates_length_of :nosso_numero, maximum: 8, message: 'deve ser menor ou igual a 8 dígitos.'
+      validates_length_of :conta_corrente, maximum: 8, message: 'deve ser menor ou igual a 8 dígitos.'
+      validates_length_of :agencia_dv, is: 1, message: 'deve ser igual a 1 dígitos.'
+      validates_length_of :conta_corrente_dv, is: 1, message: 'deve ser igual a 1 dígitos.'
+
+      # Codigo do banco emissor (3 dígitos sempre)
+      #
+      # @return [String] 3 caracteres numéricos.
+      def banco
+        '422'
+      end
+
+      # Agência
+      #
+      # @return [String] 4 caracteres numéricos.
+      def agencia=(valor)
+        @agencia = valor.to_s.rjust(4, '0') if valor
+      end
+
+      # Conta corrente
+      # @return [String] 8 caracteres numéricos.
+      def conta_corrente=(valor)
+        @conta_corrente = valor.to_s.rjust(8, '0') if valor
+      end
+
+      # Número seqüencial utilizado para identificar o boleto.
+      # @return [String] 8 caracteres numéricos.
+      def nosso_numero=(valor)
+        @nosso_numero = valor.to_s.rjust(8, '0') if valor
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # @return [String] 1 caracteres numéricos.
+      def nosso_numero_dv
+        nosso_numero.modulo11(
+          reverse: false,
+          mapeamento: { 10 => 0, 11 => 1 }
+        ) { |total| 11 - (total % 11) }
+      end
+
+      # Nosso número para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.nosso_numero_boleto #=> "175/12345678-4"
+      def nosso_numero_boleto
+        "#{nosso_numero}-#{nosso_numero_dv}"
+      end
+
+      # Agência + conta corrente do cliente para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.agencia_conta_boleto #=> "08111 / 536788"
+      def agencia_conta_boleto
+        "#{agencia}#{agencia_dv} / #{conta_corrente}#{conta_corrente_dv}"
+      end
+
+      # Segunda parte do código de barras.
+      #
+      # ORMATAÇÃO DO CÓDIGO DE BARRAS - COBRANÇA REGISTRADA
+      # Campo
+      # Significado
+      #
+      # Formato
+      # Posições
+      # Conteúdo
+      # DE
+      #
+      # ATÉ
+      # Banco
+      # Banco Beneficiário do boleto
+      # 9 (03)
+      # 1
+      # 3
+      # 422
+      # Moeda
+      # Código da moeda
+      # 9 (01)
+      # 4
+      # 4
+      # 9 = real
+      # DAC
+      # DAC - Dígito de auto conferência
+      # 9 (01)
+      # 5
+      # 5
+      # Dígito de auto conferência
+      # Fator de Vencimento
+      # Data de vencimento do título
+      # 9(04)
+      # 6
+      # 9
+      # DV
+      # Valor
+      # Valor do boleto
+      # 9 (10)
+      # 10
+      # 19
+      # Valor do Boleto com zeros a esquerda
+      # Campo Livre
+      # Sistema
+      # 9 (01)
+      # 20
+      # 20
+      # 7 = Dígito do Bco Safra
+      # Campo Livre
+      # Agência
+      # 9 (05)
+      # 21
+      # 25
+      # (05) Agência do cliente Safra
+      # Campo Livre
+      # Cliente
+      # 9 (09)
+      # 26
+      # 34
+      # No da conta
+      # Campo Livre
+      # Nosso Número
+      # 9 (09)
+      # 35
+      # 43
+      # Nosso Número
+      # Campo Livre
+      # Tipo cobrança
+      # 9 (01)
+      #
+      # 44
+      # 44
+      #
+      # 2 = cobrança registrada
+      #
+      # @return [String] 25 caracteres numéricos.
+      def codigo_barras_segunda_parte
+        "7#{agencia}#{agencia_dv}#{conta_corrente}#{conta_corrente_dv}#{nosso_numero}#{nosso_numero_dv}2"
+      end
+    end
+  end
+end

data/lib/brcobranca/boleto/santander.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+#
+# @author Kivanio Barbosa
+# @author Ronaldo Araujo
+module Brcobranca
+  module Boleto
+    # Banco Santander
+    class Santander < Base
+      validates_presence_of :convenio, message: 'não pode estar em branco.'
+      validates_length_of :agencia, maximum: 4, message: 'deve ser menor ou igual a 4 dígitos.'
+      validates_length_of :convenio, maximum: 7, message: 'deve ser menor ou igual a 7 dígitos.'
+      validates_length_of :nosso_numero, maximum: 7, message: 'deve ser menor ou igual a 7 dígitos.'
+
+      # Nova instancia do Santander
+      # @param (see Brcobranca::Boleto::Base#initialize)
+      def initialize(campos = {})
+        campos = { carteira: '102' }.merge!(campos)
+        super(campos)
+      end
+
+      # Codigo do banco emissor (3 dígitos sempre)
+      #
+      # @return [String] 3 caracteres numéricos.
+      def banco
+        '033'
+      end
+
+      # Número da conta corrente
+      # @return [String] 9 caracteres numéricos.
+      def conta_corrente=(valor)
+        @conta_corrente = valor.to_s.rjust(9, '0') if valor
+      end
+
+      # Número do convênio/contrato do cliente junto ao banco. No Santander, é
+      # chamado de Código do Cedente.
+      # @return [String] 7 caracteres numéricos.
+      def convenio=(valor)
+        @convenio = valor.to_s.rjust(7, '0') if valor
+      end
+
+      # Número sequencial utilizado para identificar o boleto.
+      # @return [String] 7 caracteres numéricos.
+      def nosso_numero=(valor)
+        @nosso_numero = valor.to_s.rjust(7, '0') if valor
+      end
+
+      # Dígito verificador do nosso número.
+      # @return [String] 1 caracteres numéricos.
+      def nosso_numero_dv
+        nosso_numero.modulo11(
+          multiplicador: (2..9).to_a,
+          mapeamento: { 10 => 0, 11 => 0 }
+        ) { |total| 11 - (total % 11) }
+      end
+
+      # Nosso número para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.nosso_numero_boleto #=> "9000272-7"
+      def nosso_numero_boleto
+        "#{nosso_numero}-#{nosso_numero_dv}"
+      end
+
+      # Agência + codigo do cedente do cliente para exibir no boleto.
+      # @return [String]
+      # @example
+      #  boleto.agencia_conta_boleto #=> "0059/1899775"
+      def agencia_conta_boleto
+        "#{agencia}/#{convenio}"
+      end
+
+      # Segunda parte do código de barras.
+      # 9(01) | Fixo 9 <br/>
+      # 9(07) | Convenio <br/>
+      # 9(13) | Nosso Numero Com DV<br/>
+      # 9(01) | IOF somente para seguradoras<br/> Fixo 9
+      # 9(03) | Carteira de cobrança<br/>
+      #
+      # @return [String] 25 caracteres numéricos.
+      def codigo_barras_segunda_parte
+        "9#{convenio}00000#{nosso_numero}#{nosso_numero_dv}0#{carteira}"
+      end
+    end
+  end
+end

data/lib/brcobranca/boleto/sicoob.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Brcobranca
+  module Boleto
+    # Sicoob (Bancoob)
+    class Sicoob < Base
+      validates_length_of :agencia, maximum: 4, message: 'deve ser menor ou igual a 4 dígitos.'
+      validates_length_of :conta_corrente, maximum: 8, message: 'deve ser menor ou igual a 8 dígitos.'
+      validates_length_of :nosso_numero, maximum: 7, message: 'deve ser menor ou igual a 7 dígitos.'
+      validates_length_of :convenio, maximum: 7, message: 'deve ser menor ou igual a 7 dígitos.'
+      validates_length_of :variacao, maximum: 2, message: 'deve ser menor ou igual a 2 dígitos.'
+      validates_length_of :quantidade, maximum: 3, message: 'deve ser menor ou igual a 3 dígitos.'
+
+      def initialize(campos = {})
+        campos = { carteira: '1', variacao: '01', quantidade: '001' }.merge!(campos)
+        super(campos)
+      end
+
+      # Codigo do banco emissor (3 dígitos sempre)
+      #
+      # @return [String] 3 caracteres numéricos.
+      def banco
+        '756'
+      end
+
+      # Dígito verificador do banco
+      #
+      # @return [String] 1 caractere.
+      def banco_dv
+        '0'
+      end
+
+      # Agência
+      #
+      # @return [String] 4 caracteres numéricos.
+      def agencia=(valor)
+        @agencia = valor.to_s.rjust(4, '0') if valor
+      end
+
+      # Convênio
+      #
+      # @return [String] 7 caracteres numéricos.
+      def convenio=(valor)
+        @convenio = valor.to_s.rjust(7, '0') if valor
+      end
+
+      # Número documento
+      #
+      # @return [String] 7 caracteres numéricos.
+      def nosso_numero=(valor)
+        @nosso_numero = valor.to_s.rjust(7, '0') if valor
+      end
+
+      # Quantidade
+      #
+      # @return [String] 3 caracteres numéricos.
+      def quantidade=(valor)
+        @quantidade = valor.to_s.rjust(3, '0') if valor
+      end
+
+      # Nosso número para exibição no boleto.
+      #
+      # @return [String] 8 caracteres numéricos.
+      def nosso_numero_boleto
+        "#{nosso_numero}#{nosso_numero_dv}"
+      end
+
+      # 3.13. Nosso número: Código de controle que permite ao Sicoob e à empresa identificar os dados da cobrança que deu origem ao boleto.
+      #
+      # Para o cálculo do dígito verificador do nosso número, deverá ser utilizada a fórmula abaixo:
+      # Número da Cooperativa    9(4) – vide planilha "Capa" deste arquivo
+      # Código do Cliente   9(10) – vide planilha "Capa" deste arquivo
+      # Nosso Número   9(7) – Iniciado em 1
+      #
+      # Constante para cálculo  = 3197
+      #
+      # a) Concatenar na seqüência completando com zero à esquerda.
+      #     Ex.:Número da Cooperativa  = 0001
+      #           Número do Cliente  = 1-9
+      #           Nosso Número  = 21
+      #           000100000000190000021
+      #
+      # b) Alinhar a constante com a seqüência repetindo de traz para frente.
+      #     Ex.: 000100000000190000021
+      #          319731973197319731973
+      #
+      # c) Multiplicar cada componente da seqüência com o seu correspondente da constante e somar os resultados.
+      #     Ex.: 1*7 + 1*3 + 9*1 + 2*7 + 1*3 = 36
+      #
+      # d) Calcular o Resto através do Módulo 11.
+      #     Ex.: 36/11 = 3, resto = 3
+      #
+      # e) O resto da divisão deverá ser subtraído de 11 achando assim o DV (Se o Resto for igual a 0 ou 1 então o DV é igual a 0).
+      #     Ex.: 11 – 3 = 8, então Nosso Número + DV = 21-8
+      #
+      def nosso_numero_dv
+        "#{agencia}#{convenio.rjust(10, '0')}#{nosso_numero}".modulo11(
+          reverse: false,
+          multiplicador: [3, 1, 9, 7],
+          mapeamento: { 10 => 0, 11 => 0 }
+        ) { |t| 11 - (t % 11) }
+      end
+
+      def agencia_conta_boleto
+        "#{agencia} / #{convenio}"
+      end
+
+      # Posição     Tamanho     Conteúdo
+      #    20 a 20      01                 Código da carteira de cobrança - vide planilha "Capa" deste arquivo
+      #    21 a 24      04                 Código da agência/cooperativa - verificar na planilha "Capa" deste arquivo
+      #    25 a 26      02                 Código da modalidade - verificar na planilha "Capa" deste arquivo
+      #    27 a 33      07                 Código do cedente/cliente - verificar na planilha "Capa" deste arquivo
+      #    34 a 41      08                 Nosso número do boleto
+      #    41 a 44      03                 Número da parcela a que o boleto se refere - "001" se parcela única
+      def codigo_barras_segunda_parte
+        "#{carteira}#{agencia}#{variacao}#{convenio}#{nosso_numero_boleto}#{quantidade}"
+      end
+    end
+  end
+end