br_boleto 0.1.0 → 1.0.0

data/lib/br_boleto/remessa/cnab240/helper/segmento_s.rb

@@ -0,0 +1,193 @@
+module BrBoleto
+	module Remessa
+		module Cnab240
+			module Helper
+				module SegmentoS
+					# Monta o registro segmento S do arquivo
+					#
+					# @param pagamento [BrBoleto::Remessa::Pagamento]
+					#   objeto contendo os detalhes do boleto (valor, vencimento, sacado, etc)
+					# @param nr_lote [Integer]
+					#   numero do lote que o segmento esta inserido
+					# @param sequencial [Integer]
+					#   numero sequencial do registro no lote
+					#
+					# @return [String]
+					#
+					def monta_segmento_s(pagamento, nr_lote, sequencial)
+						segmento_s = ''
+						segmento_s << segmento_s_posicao_001_a_003 
+						segmento_s << segmento_s_posicao_004_a_007(nr_lote)
+						segmento_s << segmento_s_posicao_008_a_008
+						segmento_s << segmento_s_posicao_009_a_013(sequencial)
+						segmento_s << segmento_s_posicao_014_a_014
+						segmento_s << segmento_s_posicao_015_a_015
+						segmento_s << segmento_s_posicao_016_a_017
+						segmento_s << segmento_s_posicao_018_a_018(pagamento)
+						if pagamento.tipo_impressao == '3'
+							segmento_s << segmento_s_tipo_impressao_3(pagamento)
+						else
+							segmento_s << segmento_s_tipo_impressao_1_ou_2(pagamento)
+						end
+						segmento_s.upcase
+					end
+
+					# Código do banco
+					# 3 posições
+					#
+					def segmento_s_posicao_001_a_003 
+						codigo_banco
+					end
+
+					# Lote de Serviço: Número seqüencial para identificar univocamente um lote de serviço. 
+					# Criado e controlado pelo responsável pela geração magnética dos dados contidos no arquivo.
+					# Preencher com '0001' para o primeiro lote do arquivo. 
+					# Para os demais: número do lote anterior acrescido de 1. O número não poderá ser repetido dentro do arquivo.
+					# 4 posições
+					#
+					def segmento_s_posicao_004_a_007(numero_do_lote)
+						numero_do_lote.to_s.rjust(4, '0')
+					end
+
+					# Tipo do registro -> Padrão 3
+					# 1 posição
+					#
+					def segmento_s_posicao_008_a_008
+						'3'
+					end
+
+					# Nº Sequencial do Registro no Lote
+					# 5 posições
+					#
+					def segmento_s_posicao_009_a_013(sequencial)
+						sequencial.to_s.rjust(5, '0')
+					end
+
+					# Cód. Segmento do Registro Detalhe
+					# 1 posição
+					#
+					def segmento_s_posicao_014_a_014
+						'S'
+					end
+
+					# Uso Exclusivo FEBRABAN/CNAB 
+					# 1 posição
+					#
+					def segmento_s_posicao_015_a_015
+						' '
+					end
+
+					# Código de Movimento Remessa - 01 = Entrada de Titulos
+					# 2 posições
+					#
+					def segmento_s_posicao_016_a_017
+						'01'
+					end
+
+					# Tipo de impressão
+					#     1 - Frente do Bloqueto
+					#     2 - Verso do Bloauqto
+					#     3 - Corpo de instruções da Ficha de Complansação
+					# 1 posição
+					#
+					def segmento_s_posicao_018_a_018(pagamento)
+						"#{pagamento.tipo_impressao}".adjust_size_to(1)
+					end
+
+				###########     TIPO DE IMPRESÃO 1 OU 2 ################
+					def segmento_s_tipo_impressao_1_ou_2(pagamento)
+						segmento = ''
+						segmento << segmento_s_posicao_019_a_020_tipo_impressao_1_ou_2(pagamento)
+						segmento << segmento_s_posicao_021_a_160_tipo_impressao_1_ou_2(pagamento)
+						segmento << segmento_s_posicao_161_a_162_tipo_impressao_1_ou_2(pagamento)
+						segmento << segmento_s_posicao_163_a_240_tipo_impressao_1_ou_2
+						segmento
+					end
+					# Numero da Linha a ser impressa
+					# 2 posições
+					#
+					def segmento_s_posicao_019_a_020_tipo_impressao_1_ou_2(pagamento)
+						'01'
+					end
+					# Mensagem a ser impresas
+					# 140 posições
+					#
+					def segmento_s_posicao_021_a_160_tipo_impressao_1_ou_2(pagamento)
+						''.rjust(140, ' ')
+					end
+
+					# Tipo de caractere a ser impresso
+					#     '01' = Normal
+					#     '02' = Itálico
+					#     '03' = Normal Negrito
+					#     '04' = Itálico Negrito
+					# 2 posições
+					def segmento_s_posicao_161_a_162_tipo_impressao_1_ou_2(pagamento)
+						'01'
+					end
+
+					# Uso exclusivo
+					# 78 posições
+					def segmento_s_posicao_163_a_240_tipo_impressao_1_ou_2
+						''.rjust(78, ' ')
+					end
+
+				########################################################
+				############## TIPO DE IMPRESSÃO 3 #####################
+					def segmento_s_tipo_impressao_3(pagamento)
+						segmento = ''
+						segmento << segmento_s_posicao_019_a_058_tipo_impressao_3(pagamento)
+						segmento << segmento_s_posicao_059_a_098_tipo_impressao_3(pagamento)
+						segmento << segmento_s_posicao_099_a_138_tipo_impressao_3(pagamento)
+						segmento << segmento_s_posicao_139_a_178_tipo_impressao_3(pagamento)
+						segmento << segmento_s_posicao_179_a_218_tipo_impressao_3(pagamento)
+						segmento << segmento_s_posicao_219_a_240_tipo_impressao_3
+						segmento
+					end
+					# Informação 5
+					# 40 posições
+					#
+					def segmento_s_posicao_019_a_058_tipo_impressao_3(pagamento)
+						''.rjust(40, ' ')
+					end
+
+					# Informação 6
+					# 40 posições
+					#
+					def segmento_s_posicao_059_a_098_tipo_impressao_3(pagamento)
+						''.rjust(40, ' ')
+					end
+
+					# Informação 7
+					# 40 posições
+					#
+					def segmento_s_posicao_099_a_138_tipo_impressao_3(pagamento)
+						''.rjust(40, ' ')
+					end
+
+					# Informação 8
+					# 40 posições
+					#
+					def segmento_s_posicao_139_a_178_tipo_impressao_3(pagamento)
+						''.rjust(40, ' ')
+					end
+
+					# Informação 9
+					# 40 posições
+					#
+					def segmento_s_posicao_179_a_218_tipo_impressao_3(pagamento)
+						''.rjust(40, ' ')
+					end
+					
+					# Uso exclusivo
+					# 78 posições
+					def segmento_s_posicao_219_a_240_tipo_impressao_3
+						''.rjust(22, ' ')
+					end
+				########################################################
+
+				end
+			end
+		end
+	end
+end

data/lib/br_boleto/remessa/cnab240/helper/trailer_arquivo.rb

@@ -0,0 +1,88 @@
+module BrBoleto
+	module Remessa
+		module Cnab240
+			module Helper
+				module TrailerArquivo
+
+					# Monta o registro trailer do arquivo
+					#
+					# @param nro_lotes [Integer]
+					#   numero de lotes no arquivo
+					# @param sequencial [Integer]
+					#   numero de registros(linhas) no arquivo
+					#
+					# @return [String]
+					#
+					def monta_trailer_arquivo(nro_lotes, sequencial)
+						trailer_arquivo =  ''                                               # CAMPO              TAMANHO
+						trailer_arquivo << trailer_arquivo_posicao_001_a_003                 # Código banco          3
+						trailer_arquivo << trailer_arquivo_posicao_004_a_007(nro_lotes)     # Lote Serviço          4
+						trailer_arquivo << trailer_arquivo_posicao_008_a_008                # Tipo registro         1
+						trailer_arquivo << trailer_arquivo_posicao_009_a_017                # Exclusivo             9
+						trailer_arquivo << trailer_arquivo_posicao_018_a_023(nro_lotes)     # Qtd. Lotes            6
+						trailer_arquivo << trailer_arquivo_posicao_024_a_029(sequencial)    # Qtd. Registros        6
+						trailer_arquivo << trailer_arquivo_posicao_030_a_035                # Qtde Contas           6
+						trailer_arquivo << trailer_arquivo_posicao_036_a_240                # Exclusivo            205
+						trailer_arquivo.upcase                                               
+					end
+					
+					# Código do banco
+					# 3 posições
+					#
+					def trailer_arquivo_posicao_001_a_003 
+						codigo_banco
+					end
+
+					# Lote de Serviço -> Padrão 9999
+					# 4 posições
+					#
+					def trailer_arquivo_posicao_004_a_007(nro_lotes)
+						'9999'
+					end
+
+					# Tipo do registro -> Padrão 9
+					# 1 posição
+					#
+					def trailer_arquivo_posicao_008_a_008
+						'9'
+					end
+
+					# Uso Exclusivo FEBRABAN/CNAB
+					# 9 posições
+					#
+					def trailer_arquivo_posicao_009_a_017
+						''.rjust(9, ' ')
+					end
+
+					# Quantidade de Lotes do Arquivo
+					# 6 posições
+					#
+					def trailer_arquivo_posicao_018_a_023(nro_lotes)
+						nro_lotes.to_s.rjust(6, '0')
+					end
+
+					# Quantidade de Registros do Arquivo
+					# 6 posições
+					#
+					def trailer_arquivo_posicao_024_a_029(sequencial)
+						sequencial.to_s.rjust(6, '0')
+					end
+
+					# Qtde de Contas p/ Conc. (Lotes)
+					# 6 posições
+					#
+					def trailer_arquivo_posicao_030_a_035
+						''.rjust(6, ' ')
+					end
+
+					# Uso Exclusivo FEBRABAN/CNAB
+					# 205 posições
+					#
+					def trailer_arquivo_posicao_036_a_240
+						''.rjust(205, ' ')
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_boleto/remessa/cnab240/helper/trailer_lote.rb

@@ -0,0 +1,75 @@
+module BrBoleto
+	module Remessa
+		module Cnab240
+			module Helper
+				module TrailerLote
+					# Monta o registro trailer do lote
+					#
+					# @param nr_lote [Integer]
+					#   numero do lote no arquivo (iterar a cada novo lote)
+					#
+					# @param nro_registros [Integer]
+					#   numero de registros(linhas) no lote (contando header e trailer)
+					#
+					# @return [String]
+					#
+					def monta_trailer_lote(lote, nr_lote, nro_registros)
+						trailer_lote = ''                                            # CAMPO                   # TAMANHO
+						trailer_lote << trailer_lote_posicao_001_a_003               # codigo banco            3
+						trailer_lote << trailer_lote_posicao_004_a_007(nr_lote)      # lote de servico         4
+						trailer_lote << trailer_lote_posicao_008_a_008               # tipo de servico         1
+						trailer_lote << trailer_lote_posicao_009_a_017               # uso exclusivo           9
+						trailer_lote << trailer_lote_posicao_018_a_023(nro_registros)# qtde de registros lote  6
+						trailer_lote << trailer_lote_posicao_024_a_240(lote, nr_lote)#                         217
+						trailer_lote.upcase
+					end
+
+					# Código do banco
+					# 3 posições
+					#
+					def trailer_lote_posicao_001_a_003 
+						codigo_banco
+					end
+
+					# Lote de Serviço: Número seqüencial para identificar univocamente um lote de serviço. 
+					# Criado e controlado pelo responsável pela geração magnética dos dados contidos no arquivo.
+					# Preencher com '0001' para o primeiro lote do arquivo. 
+					# Para os demais: número do lote anterior acrescido de 1. O número não poderá ser repetido dentro do arquivo.
+					# 4 posições
+					#
+					def trailer_lote_posicao_004_a_007(numero_do_lote)
+						numero_do_lote.to_s.rjust(4, '0')
+					end
+
+					# Tipo do registro -> Padrão 5
+					# 1 posição
+					#
+					def trailer_lote_posicao_008_a_008
+						'5'
+					end
+
+					# Uso Exclusivo FEBRABAN/CNAB
+					# 9 posições
+					#
+					def trailer_lote_posicao_009_a_017
+						''.rjust(9, ' ')
+					end
+
+					# Quantidade de Registros no Lote
+					# 6 posições
+					#
+					def trailer_lote_posicao_018_a_023(nro_registros)
+						nro_registros.to_s.rjust(6, '0')
+					end
+
+					# Complemento trailer diferente para cada banco
+					# 217 posições
+					#
+					def trailer_lote_posicao_024_a_240(lote, nr_lote)
+						complemento_trailer_lote(lote, nr_lote)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_boleto/remessa/cnab240/sicoob.rb

@@ -0,0 +1,246 @@
+# -*- encoding: utf-8 -*-
+module BrBoleto
+	module Remessa
+		module Cnab240
+			class Sicoob < BrBoleto::Remessa::Cnab240::Base
+				
+				#O banco siccob utiliza a combinação da carteira e modalidade para
+				# saber se é um pagamento com registro, sem registrou ou caucionada.
+				# Carteira / Modalidade  =  Tipo de pagamento
+ 				#    1     /    01       = Simples com Registro
+				#    1     /    02       = Simples sem Registro
+				#    3     /    03       = Garantia caicionada
+				# 
+				attr_accessor :modalidade_carteira
+				
+
+				attr_accessor :tipo_formulario
+				#       Tipo Formulário - 01 posição  (15 a 15):
+				#            "1" -auto-copiativo
+				#            "3" -auto-envelopável
+				#            "4" -A4 sem envelopamento
+				#            "6" -A4 sem envelopamento 3 vias
+
+				attr_accessor :parcela
+				#       Parcela - 02 posições (11 a 12) - "01" se parcela única
+
+				def convenio_obrigatorio?
+					false
+				end
+
+				validates :modalidade_carteira, :tipo_formulario, :conta_corrente, :parcela, presence: true
+				# Remessa 400 - 8 digitos
+				# Remessa 240 - 12 digitos
+				validates :conta_corrente,      length: {maximum: 12, message: 'deve ter no máximo 12 dígitos.'}
+				validates :agencia,             length: {is: 4, message: 'deve ter 4 dígitos.'}
+				validates :modalidade_carteira, length: {is: 2, message: 'deve ter 2 dígitos.'}
+
+				def default_values
+					super.merge({
+						emissao_boleto: '2',
+						distribuicao_boleto: '2',
+						especie_titulo: '02', # 02 = DM Duplicata mercantil
+						tipo_formulario: '4',
+						parcela: '01',
+						modalidade_carteira: '01',
+						forma_cadastramento: '0'
+					})
+				end
+
+				def convenio
+					"#{@convenio}".adjust_size_to(20)
+				end
+
+				def codigo_banco
+					'756'
+				end
+
+				def nome_banco
+					'SICOOB'.ljust(30, ' ')
+				end
+
+				def versao_layout_arquivo
+					'081'
+				end
+
+				def versao_layout_lote
+					'040'
+				end
+
+				def digito_agencia
+					# utilizando a agencia com 4 digitos
+					# para calcular o digito
+					BrBoleto::Calculos::Modulo11FatorDe2a9RestoZero.new(agencia).to_s
+				end
+
+				def digito_conta
+					# utilizando a conta corrente com 5 digitos
+					# para calcular o digito
+					BrBoleto::Calculos::Modulo11FatorDe2a9RestoZero.new(conta_corrente).to_s
+				end
+
+				def codigo_convenio
+					# CAMPO                TAMANHO
+					# num. convenio        20 BRANCOS
+					''.rjust(20, ' ')
+				end
+
+				def convenio_lote(lote)
+					codigo_convenio
+				end
+
+				def informacoes_da_conta
+					# CAMPO                  TAMANHO
+					# agencia                5
+					# digito agencia         1
+					# conta corrente         12
+					# digito conta           1
+					# digito agencia/conta   1
+					"#{agencia.rjust(5, '0')}#{digito_agencia}#{conta_corrente.rjust(12, '0')}#{digito_conta}".adjust_size_to(20)
+				end
+
+				def complemento_header
+					''.rjust(29, ' ')
+				end
+
+				def complemento_p(pagamento)
+					# CAMPO                   TAMANHO
+					# conta corrente          12
+					# digito conta            1
+					# digito agencia/conta    1
+					# ident. titulo no banco  20
+					"#{conta_corrente.to_s.rjust(12, '0')}#{digito_conta} #{formata_nosso_numero(pagamento.nosso_numero)}"
+				end
+
+				# Tipo de cobrança
+				# Ex: :simples, :caucionada
+				#
+				# Obs: O VALOR DESSE METODO NÃO INFLUÊNCIA NA GERAÇÃO DO BOLETO
+				# É APENAS PARA QUESTÃO DE INFORMAÇÃO CASO PRECISE PARA OUTRAS COISAS.
+				#
+				def tipo_cobranca
+					case "#{modalidade_carteira}".rjust(2, "0")
+					when '01', '02'
+						:simples
+					when '03'
+						:caucionada
+					end
+				end
+
+				# Retorna o nosso numero
+				#
+				# @return [String]
+				#
+				# Nosso Número:
+				#  - Se emissão a cargo do Cedente (vide planilha "Capa" deste arquivo):
+				#       NumTitulo - 10 posições (1 a 10)
+				#       Parcela - 02 posições (11 a 12) - "01" se parcela única
+				#       Modalidade - 02 posições (13 a 14) - vide planilha "Capa" deste arquivo
+				#       Tipo Formulário - 01 posição  (15 a 15):
+				#            "1" -auto-copiativo
+				#            "3" -auto-envelopável
+				#            "4" -A4 sem envelopamento
+				#            "6" -A4 sem envelopamento 3 vias
+				#       Em branco - 05 posições (16 a 20)
+				def formata_nosso_numero(nosso_numero)
+					"#{nosso_numero.to_s.rjust(10, '0')}#{parcela}#{modalidade_carteira}#{tipo_formulario}".adjust_size_to(20)
+				end
+
+				def complemento_trailer_lote(lote, nr_lote)
+					complemento = ''
+					complemento << complemento_trailer_lote_posicao_024_a_029(lote)
+					complemento << complemento_trailer_lote_posicao_030_a_046(lote)
+					complemento << complemento_trailer_lote_posicao_047_a_052(lote)
+					complemento << complemento_trailer_lote_posicao_053_a_069(lote)
+					complemento << complemento_trailer_lote_posicao_070_a_075(lote)
+					complemento << complemento_trailer_lote_posicao_076_a_092(lote)
+					complemento << complemento_trailer_lote_posicao_093_a_098(lote)
+					complemento << complemento_trailer_lote_posicao_099_a_115(lote)
+					complemento << complemento_trailer_lote_posicao_116_a_123(lote)
+					complemento << complemento_trailer_lote_posicao_124_a_240
+					complemento.upcase
+				end
+
+				# Quantidade de titulos de cobrança simples
+				# 6 posições
+				#
+				def complemento_trailer_lote_posicao_024_a_029(lote)
+					tipo_cobranca == :simples ? lote.pagamentos.count.to_s.rjust(6, '0') : ''.rjust(6, '0')
+				end
+
+				# Valor total dos titulos de cobrança simples
+				# 17 posições
+				#
+				def complemento_trailer_lote_posicao_030_a_046(lote)
+					if tipo_cobranca == :simples
+						BrBoleto::Helper::Number.new(lote.pagamentos.map(&:valor_documento).sum).formata_valor_monetario(17)
+					else
+						''.rjust(17, '0')
+					end
+				end
+
+				# Quantidade de titulos de cobrança Vinculada
+				# 6 posições
+				#
+				def complemento_trailer_lote_posicao_047_a_052(lote)
+					''.rjust(6, '0')
+				end
+
+				# Valor total dos titulos de cobrança Vinculada
+				# 17 posições
+				#
+				def complemento_trailer_lote_posicao_053_a_069(lote)
+					''.rjust(17, '0')
+				end
+
+
+				# Quantidade de titulos de cobrança Caucionada
+				# 6 posições
+				#
+				def complemento_trailer_lote_posicao_070_a_075(lote)
+					tipo_cobranca == :caucionada ? lote.pagamentos.count.to_s.rjust(6, '0') : ''.rjust(6, '0')
+				end
+
+				# Valor total dos titulos de cobrança Caucionada
+				# 17 posições
+				#
+				def complemento_trailer_lote_posicao_076_a_092(lote)
+					if tipo_cobranca == :caucionada
+						BrBoleto::Helper::Number.new(lote.pagamentos.map(&:valor_documento).sum).formata_valor_monetario(17)
+					else
+						''.rjust(17, '0')
+					end
+				end
+
+				# Quantidade de titulos de cobrança Descontada
+				# 6 posições
+				#
+				def complemento_trailer_lote_posicao_093_a_098(lote)
+					''.rjust(6, '0')
+				end
+
+				# Valor total dos titulos de cobrança Descontada
+				# 17 posições
+				#
+				def complemento_trailer_lote_posicao_099_a_115(lote)
+					''.rjust(17, '0')
+				end
+
+				# Número do aviso de lançamento
+				# 8 posições
+				#
+				def complemento_trailer_lote_posicao_116_a_123(lote)
+					''.rjust(8, ' ')
+				end
+
+				# Exclusivo FEBRABAN
+				# 117 posições
+				#
+				def complemento_trailer_lote_posicao_124_a_240
+					''.rjust(117, ' ')
+				end
+
+			end
+		end
+	end
+end