br_boleto 2.1.0 → 2.2.0

data/lib/br_boleto/boleto/santander.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+module BrBoleto
+	module Boleto
+		# Implementação de emissão de boleto bancário pelo Banco Santander.
+		#
+		# === Documentação Implementada
+		#
+		# A documentação na qual essa implementação foi baseada está localizada na pasta
+		# 'documentacoes_dos_boletos/bradesco' dentro dessa biblioteca.
+		class Santander < Base
+			def conta_class
+				BrBoleto::Conta::Santander
+			end
+
+			#################  VALIDAÇÕES DINÂMICAS  #################
+				def valid_numero_documento_maximum
+					12
+				end
+
+				def valid_carteira_inclusion
+					%w[101 102 121]
+				end
+				
+				# Tamanho máximo para o codigo_cedente/Convênio
+				def valid_convenio_maximum 
+					7
+				end				
+
+				# Tamanho máximo de uma conta corrente no Banco Santander
+				def valid_conta_corrente_maximum 
+					9
+				end
+
+				# codigo_cedente/Convênio deve ser obrigatório
+				def valid_convenio_required
+					true
+				end
+			##########################################################
+
+			# Conforme descrito na documentação, o valor que deve constar em local do pagamento é
+			# "PAGÁVEL PREFERENCIALMENTE NAS AGÊNCIAS DO BANCO SANTANDER"
+			def default_values
+				super.merge({
+					:local_pagamento   => 'PAGÁVEL PREFERENCIALMENTE NAS AGÊNCIAS DO BANCO SANTANDER'
+				})
+			end
+
+			# Nosso Número descrito na documentação (Pag. 36).
+			# Número do Documento com 12 (onze) caracteres + digito.
+			# Exemplo: 999999999999-D
+			def nosso_numero
+				"#{numero_documento}-#{digito_verificador_nosso_numero}"
+			end
+
+			# Para o cálculo do dígito, será necessário acrescentar o Nosso Número (número do documento), 
+			# e aplicar o módulo 11, com fatores de 2 a 9 com resto 0.
+			def digito_verificador_nosso_numero
+				BrBoleto::Calculos::Modulo11FatorDe2a9RestoZero.new("#{numero_documento}")
+			end
+
+			#  === Código de barras do banco
+			#     __________________________________________________________________
+			#    | Posição  | Tamanho | Descrição                                   |
+			#    |----------|---------|---------------------------------------------|
+			#    | 20       |  01     | Fixo 9                                      |
+			#    | 21-27    |  07     | Código do cedente padrão Santander          |
+			#    | 28-40    |  13     | Nosso Número (Num. Documeto + DV)           |
+			#    | 41       |  01     | IOF (somente para seguradoras)              |
+			#    | 42-44    |  03     | Carteira de cobrança                        |
+			#    -------------------------------------------------------------------
+			#
+			def codigo_de_barras_do_banco
+				"9#{conta.convenio}#{numero_documento}#{digito_verificador_nosso_numero}0#{conta.carteira}"
+			end
+		end
+	end
+end

data/lib/br_boleto/conta/banco_brasil.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+module BrBoleto
+	module Conta
+		class BancoBrasil < BrBoleto::Conta::Base
+
+			# MODALIDADE CARTEIRA:
+			#      _________________________________________________________________
+			#     | Carteira  | Descrição                                          |
+			#     |   11      | Cobrança Simples - Com Registro                    |
+			#     |   12      | Cobrança Indexada - Com Registro                   |
+			#     |   15      | Cobrança de Prêmios de Seguro - Com Registro       |
+			#     |   16      | Cobranca Simples                                   |
+			#     |   17      | Cobranca Direta Especial - Com Registro            |
+			#     |   18      | Cobranca Simples  (Nosso Número 11 Dígitos)        |
+			#     |   31      | Cobrança Caucionada/Vinculada - Com Registro       |
+			#     |   51      | Cobrança Descontada - Com Registro                 |
+			#     -----------------------------------------------------------------
+
+			# VARIAÇÃO DA CARTEIRA
+			# O Banco do Brasil utiliza carteiras de cobrança com variações iniciando em 01 até 99 + dígito verificador, exceto aquelas em que o DV seja igual a X.
+			# Normalmente as empresas utilizam uma única variação (019), porém podem ter outras variações, dependendo da necessidade.
+			# Consultar a agência quando necessitar dessa informação para fins de configuração do sistema, pois o cadastramento é a a cargo da agência.
+			attr_accessor :variacao_carteira
+
+			###############################  VALIDAÇÕES DINÂMICAS ###############################
+				# Variação da Carteira
+				attr_accessor :valid_variacao_carteira_required
+
+				validates :variacao_carteira, custom_length: { maximum: 3 }
+				validates :variacao_carteira, presence: true, if: :valid_variacao_carteira_required
+			#####################################################################################
+
+			def default_values
+				super.merge({
+					carteira:                      '18', 			 
+					variacao_carteira:             '019', 			 
+					valid_carteira_required:       true, # <- Validação dinâmica que a modalidade é obrigatória
+					valid_carteira_length:         2,    # <- Validação dinâmica que a modalidade deve ter 2 digitos
+					valid_carteira_inclusion:      carteiras_suportadas, # <- Validação dinâmica de valores aceitos para a modalidade
+					codigo_carteira:               '1',   # Cobrança Simples
+					valid_codigo_carteira_length:   1,    # <- Validação dinâmica que a modalidade deve ter 1 digito
+					valid_conta_corrente_required: true,  # <- Validação dinâmica que a conta_corrente é obrigatória
+					valid_conta_corrente_maximum:  8,     # <- Validação que a conta_corrente deve ter no máximo 8 digitos
+					valid_convenio_required:       true,  # <- Validação que a convenio deve ter obrigatório
+					# valid_convenio_maximum:        8,     # <- Validação que a convenio deve ter no máximo 8 digitos
+				})
+			end
+
+			def codigo_banco
+				'001'
+			end
+
+			# Dígito do código do banco descrito na documentação
+			def codigo_banco_dv
+				'9'
+			end
+
+			def nome_banco
+				@nome_banco ||= 'BANCO DO BRASIL S.A.'
+			end
+
+			def versao_layout_arquivo_cnab_240
+				'083'
+			end
+
+			def versao_layout_lote_cnab_240
+				'042'
+			end
+
+			# Carteiras suportadas
+			def carteiras_suportadas
+				%w[11 12 15 16 17 18 31 51]
+			end
+
+			def variacao_carteira
+				"#{@variacao_carteira}".rjust(3, '0') if @variacao_carteira.present?
+			end
+
+			def agencia_dv
+				# utilizando a agencia com 4 digitos
+				# para calcular o digito
+				@agencia_dv ||= BrBoleto::Calculos::Modulo11FatorDe9a2RestoX.new(agencia).to_s
+			end
+
+			def conta_corrente_dv
+				@conta_corrente_dv ||= BrBoleto::Calculos::Modulo11FatorDe9a2RestoX.new(conta_corrente).to_s
+			end
+
+			# Campo Agência / Código do Cedente
+			# @return [String] Agência com 4 caracteres - digito da agência / Conta de Cobrança com 8 caracteres - Digito da Conta
+			# Exemplo: 9999-D / 99999999-D
+			def agencia_codigo_cedente
+				"#{agencia}-#{agencia_dv} / #{conta_corrente}-#{conta_corrente_dv}"
+			end
+
+			# Código da Carteira
+			def equivalent_tipo_cobranca_400
+				{
+					'5' => '8', # Cobrança BBVendor
+					'7' => '7', # Cobrança Direta Especial
+				}
+			end
+
+			# Código Movimento da Remessa CNAB400
+			def equivalent_codigo_movimento_remessa_400
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'01'   =>   '01' ,     # Registro de títulos
+					'02'   =>   '02' ,     # Solicitação de baixa
+					'03'   =>   '03' ,     # Pedido de débito em conta
+					'04'   =>   '04' ,     # Concessão de abatimento
+					'05'   =>   '05' ,     # Cancelamento de abatimento
+					'06'   =>   '06' ,     # Alteração de vencimento de título
+					'22'   =>   '07' ,     # Alteração do número de controle do participante
+					'21'   =>   '08' ,     # Alteração do número do titulo dado pelo cedente
+					'09'   =>   '09' ,     # Instrução para protestar 
+					'10'   =>   '10' ,     # Instrução para sustar protesto
+					'11'   =>   '11' ,     # Instrução para dispensar juros
+					'24'   =>   '12' ,     # Alteração de nome e endereço do Sacado
+					'12'   =>   '16' ,     # Alterar Juros de Mora
+					'31'   =>   '31' ,     # Conceder desconto
+					'32'   =>   '32' ,     # Não conceder desconto
+					'33'   =>   '33' ,     # Retificar dados da concessão de desconto
+					'34'   =>   '34' ,     # Alterar data para concessão de desconto
+					'35'   =>   '35' ,     # Cobrar multa 
+					'36'   =>   '36' ,     # Dispensar multa 
+					'37'   =>   '37' ,     # Dispensar indexador
+					'38'   =>   '38' ,     # Dispensar prazo limite de recebimento
+					'39'   =>   '39' ,     # Alterar prazo limite de recebimento
+					'40'   =>   '40' ,     # Alterar carteira/modalidade
+				}
+			end
+
+			# Espécie do Título
+			def equivalent_especie_titulo_400
+				#  Padrão    Código para  
+				{# da GEM     o Banco
+					'01'    =>   '10' , #  Cheque
+					'02'    =>   '01' , #  Duplicata Mercantil
+					'04'    =>   '12' , #  Duplicata de Serviço
+					'07'    =>   '08' , #  Letra de Câmbio
+					'12'    =>   '02' , #  Nota Promissória
+					'16'    =>   '03' , #  Nota de Seguro
+					'17'    =>   '05' , #  Recibo
+					'19'    =>   '13' , #  Nota de Débito
+					'20'    =>   '15' , #  Apólice de Seguro
+					'26'    =>   '09' , #  Warrant
+					'27'    =>   '26' , #  Dívida Ativa de Estado
+					'28'    =>   '27' , #  Dívida Ativa de Município
+					'29'    =>   '25' , #  Dívida Ativa da União
+					'99'    =>   '99' , #  Outros
+				}
+			end
+		end
+	end
+end

data/lib/br_boleto/conta/itau.rb

@@ -87,7 +87,7 @@ module BrBoleto
 			# @return [String] Agência com 4 caracteres  / Conta de Cobrança com 5 caracteres - Digito da Conta
 			# Exemplo: 9999 / 99999-D
 			def agencia_codigo_cedente
-				"#{agencia} / #{conta_corrente}-#{conta_corrente_dv}"
+				"#{agencia}/#{conta_corrente}-#{conta_corrente_dv}"
 			end
 
       	# Carteiras suportadas
@@ -175,9 +175,14 @@ module BrBoleto
 					})
 			end
 
-			# Código para Multa
+			# Código para Multa, que representa a isenção de juros e multa deve ser '0'
+			# Diferentemente do padrão da FEBRABAN que é '3'
+			# Ou seja, se passar o código 3 deve considerar '0'
 			def equivalent_codigo_multa
-				super.merge({ '0' => '0' }) # NÃO REGISTRA A MULTA
+				super.merge({ '3' => '0','0' => '0' }) # NÃO REGISTRA A MULTA
+			end
+			def default_codigo_multa
+				'0'
 			end
 
 			# Codigo da carteira de acordo com a documentacao o Itau (Pag. 18, Nota 5)

data/lib/br_boleto/conta/santander.rb

@@ -0,0 +1,208 @@
+# encoding: utf-8
+module BrBoleto
+	module Conta
+		class Santander < BrBoleto::Conta::Base
+
+			# MODALIDADE CARTEIRA:
+			#   ___________________________________________
+			#  | Carteira | Descrição                     | 
+			#  |   101    | Cobrança Simples com registro | 
+			#  |   102    | Cobrança Simples sem registro | 
+			#  |   121    | Penhor Rápida com registro    | 
+			#  --------------------------------------------
+
+			# Código de Transmissão
+			# Consultar seu gerente para pegar esse código. Geralmente está no e-mail enviado pelo banco.
+			attr_accessor :codigo_transmissao
+
+			###############################  VALIDAÇÕES DINÂMICAS ###############################
+				# Código de Transmissão
+				attr_accessor :valid_codigo_transmissao_required
+
+				validates :codigo_transmissao, custom_length: { maximum: 20 }
+				# validates :codigo_transmissao, presence: true, if: :valid_codigo_transmissao_required
+			#####################################################################################
+
+			def default_values
+				super.merge({
+					carteira:                      '101', 			 
+					valid_carteira_required:       true, # <- Validação dinâmica que a modalidade é obrigatória
+					valid_carteira_length:         3,    # <- Validação dinâmica que a modalidade deve ter 3 digitos
+					valid_carteira_inclusion:      %w[101 102 121], # <- Validação dinâmica de valores aceitos para a modalidade
+					codigo_carteira:               '1',   # Cobrança Simples
+					valid_codigo_carteira_length:   1,    # <- Validação dinâmica que a modalidade deve ter 1 digito
+					valid_conta_corrente_required: true,  # <- Validação dinâmica que a conta_corrente é obrigatória
+					valid_conta_corrente_maximum:  9,     # <- Validação que a conta_corrente deve ter no máximo 9 digitos
+					valid_convenio_required:       true,  # <- Validação que a convenio deve ter obrigatório
+					valid_convenio_maximum:        7,     # <- Validação que a convenio deve ter no máximo 7 digitos
+				})
+			end
+
+			def codigo_banco
+				'033'
+			end
+
+			# Dígito do código do banco descrito na documentação
+			def codigo_banco_dv
+				'7'
+			end
+
+			def nome_banco
+				@nome_banco ||= 'SANTANDER'
+			end
+
+			def versao_layout_arquivo_cnab_240
+				'040'
+			end
+
+			def versao_layout_lote_cnab_240
+				'030'
+			end
+
+			def agencia_dv
+				# utilizando a agencia com 4 digitos
+				# para calcular o digito
+				@agencia_dv ||= BrBoleto::Calculos::Modulo11FatorDe2a9RestoZero.new(agencia).to_s
+			end
+
+			def conta_corrente_dv
+				@conta_corrente_dv ||= BrBoleto::Calculos::Modulo11FatorDe2a9RestoZero.new(conta_corrente).to_s
+			end
+
+			def codigo_transmissao
+				"#{@codigo_transmissao}".rjust(20, '0') if @codigo_transmissao.present?
+			end
+
+			# Campo Agência / Código do Cedente
+			# @return [String] Agência com 4 caracteres / Convênio com 7 caracteres
+			# Exemplo: 9999 / 9999999
+			def agencia_codigo_cedente
+				"#{agencia} / #{convenio}"
+			end
+
+			# Formata a carteira dependendo se ela é registrada ou não.
+			# Para cobrança COM registro usar: COBRANCA SIMPLES ECR
+			# Para Cobrança SEM registro usar: COBRANCA SIMPLES CSR
+			def carteira_formatada
+				if @carteira.to_s.in?(carteiras_com_registro)
+					"COBRANÇA SIMPLES ECR"
+				else
+					'COBRANÇA SIMPLES CSR'
+				end
+			end
+
+			# Retorna as carteiras com registro do banco Santander.
+			# Você pode sobrescrever esse método na subclasse caso exista mais
+			# carteiras com registro no Santander.
+			def carteiras_com_registro
+				%w(101 121)
+			end
+
+			# Espécie do Título :
+			def equivalent_especie_titulo_240
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'02'	 =>	'02' ,       # DM  - DUPLICATA MERCANTIL
+					'04'	 =>	'04' ,       # DS  - DUPLICATA DE SERVICO
+					'07'	 =>	'07' ,       # LC  - LETRA DE CÂMBIO
+					'12'	 =>	'12' ,       # NP  - NOTA PROMISSORIA
+					'13'	 =>	'13' ,       # NR  - NOTA PROMISSORIA RURAL
+					'17'	 =>	'17' ,       # RC  - RECIBO
+					'20'	 =>	'20' ,       # AP  - APOLICE DE SEGURO
+					'01'	 =>	'97' ,       # CH  - CHEQUE
+					'98'	 =>	'98' ,       # NPD - NOTA PROMISSORIA DIRETA
+				}
+			end
+			def equivalent_especie_titulo_400
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'02'	 =>	'01' ,       # DM  - DUPLICATA MERCANTIL
+					'04'	 =>	'06' ,       # DS  - DUPLICATA DE SERVICO
+					'07'	 =>	'07' ,       # LC  - LETRA DE CÂMBIO
+					'12'	 =>	'02' ,       # NP  - NOTA PROMISSORIA
+					'17'	 =>	'05' ,       # RC  - RECIBO
+					'20'	 =>	'03' ,       # AP  - APOLICE DE SEGURO
+				}
+			end
+
+			# Código Movimento da Remessa CNAB240
+			def equivalent_codigo_movimento_remessa_240
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'01'	 =>	'01' ,       # Entrada de título
+					'02'	 =>	'02' ,       # Pedido de baixa
+					'04'	 =>	'04' ,       # Concessão de abatimento
+					'05'	 =>	'05' ,       # Cancelamento de abatimento
+					'06'	 =>	'06' ,       # Alteração de vencimento
+					'07'	 =>	'10' ,       # Concessão de Desconto
+					'08'	 =>	'11' ,       # Cancelamento de desconto
+					'09'	 =>	'09' ,       # Pedido de Protesto
+					'10'	 =>	'18' ,       # Pedido de Sustação de Protesto
+					'21'	 =>	'07' ,       # Alteração da identificação do título na empresa
+					'22'	 =>	'08' ,       # Alteração seu número
+					'31'	 =>	'31' ,       # Alteração de outros dados
+					'41'	 =>	'98' ,       # Não Protestar
+				}
+			end
+
+			# Código Movimento da Remessa CNAB400
+			def equivalent_codigo_movimento_remessa_400
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'01'	 =>	'01' ,       # Entrada de título
+					'02'	 =>	'02' ,       # Pedido de baixa
+					'04'	 =>	'04' ,       # Concessão de abatimento
+					'05'	 =>	'05' ,       # Cancelamento de abatimento
+					'06'	 =>	'06' ,       # Alteração de vencimento
+					'21'	 =>	'07' ,       # Alteração da identificação do título na empresa
+					'22'	 =>	'08' ,       # Alteração seu número
+					'09'	 =>	'09' ,       # Pedido de Protesto
+					'10'	 =>	'18' ,       # Sustar Protesto e Baixar Título
+					'11'	 =>	'18' ,       # Sustar Protesto e Manter em Carteira
+				}
+			end
+
+			# Código de Multa
+			def equivalent_codigo_multa
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'1'    =>    '4',        # Com Multa
+					'2'    =>    '4',        # Com Multa
+					'3'    =>    '0',        # Sem Multa (Isento)
+				}
+			end
+			def default_codigo_multa
+				'0'
+			end
+
+			# Código da Carteira CNAB400
+			def equivalent_tipo_cobranca_400
+				#  Padrão    Código para    Descrição 
+				{# da GEM     o Banco
+					'1'    =>    '5',        # RÁPIDA COM REGISTRO
+					'2'    =>    '2',        # ELETRÔNICA COM REGISTRO
+					'3'    =>    '3',        # CAUCIONADA ELETRÔNICA
+					'4'    =>    '7',        # DESCONTADA ELETRÔNICA
+					'5'    =>    '4',        # COBRANÇA SEM REGISTRO
+					'6'    =>    '6',        # CAUCIONADA RAPIDA
+				}
+			end
+
+			# Código da Carteira CNAB240
+			def equivalent_tipo_cobranca_240
+				super.merge({'6' => '6' }) # 6 = Cobrança Caucionada (Rápida com Registro)
+			end
+
+			# Código para Protesto
+			def equivalent_codigo_protesto
+				super.merge({'0' => '0' }) # 0 = Não Protestar
+			end
+
+			# Código da Moeda CNAB240
+			def equivalent_codigo_moeda_240
+				super.merge({'09' => '00' }) # 00 = Real
+			end
+
+		end
+	end
+end