br_boleto 0.1.0 → 1.0.0

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

@@ -0,0 +1,186 @@
+module BrBoleto
+	module Remessa
+		module Cnab240
+			module Helper
+				module HeaderArquivo
+					# Monta o registro header do arquivo
+					#
+					# @return [String]
+					#
+					def monta_header_arquivo
+						header_arquivo = ''                                 # CAMPO                         TAMANHO
+						header_arquivo << header_arquivo_posicao_001_a_003  # codigo do banco               3
+						header_arquivo << header_arquivo_posicao_004_a_007  # lote do servico               4
+						header_arquivo << header_arquivo_posicao_008_a_008  # tipo de registro              1
+						header_arquivo << header_arquivo_posicao_009_a_017  # uso exclusivo FEBRABAN        9
+						header_arquivo << header_arquivo_posicao_018_a_018  # tipo inscricao                1
+						header_arquivo << header_arquivo_posicao_019_a_032  # numero de inscricao           14
+						header_arquivo << header_arquivo_posicao_033_a_052  # codigo do convenio no banco   20
+						header_arquivo << header_arquivo_posicao_053_a_072  # informacoes da conta          20
+						header_arquivo << header_arquivo_posicao_073_a_102  # nome da empresa               30
+						header_arquivo << header_arquivo_posicao_103_a_132  # nome do banco                 30
+						header_arquivo << header_arquivo_posicao_133_a_142  # uso exclusivo FEBRABAN        10
+						header_arquivo << header_arquivo_posicao_143_a_143  # codigo remessa                1
+						header_arquivo << header_arquivo_posicao_144_a_151  # data geracao                  8
+						header_arquivo << header_arquivo_posicao_152_a_157  # hora geracao                  6
+						header_arquivo << header_arquivo_posicao_158_a_163  # numero seq. arquivo           6
+						header_arquivo << header_arquivo_posicao_164_a_166  # num. versao                   3
+						header_arquivo << header_arquivo_posicao_167_a_171  # densidade gravacao            5
+						header_arquivo << header_arquivo_posicao_172_a_191  # Para Uso Reservado do Banco   20
+						header_arquivo << header_arquivo_posicao_192_a_211  # Para Uso Reservado da Empresa 20
+						header_arquivo << header_arquivo_posicao_212_a_240  # complemento do arquivo        29
+						header_arquivo.upcase
+					end
+					
+					# Código do banco
+					# 3 posições
+					#
+					def header_arquivo_posicao_001_a_003
+						codigo_banco
+					end
+
+					# Lote de serviço
+					# 4 posições
+					#
+					def header_arquivo_posicao_004_a_007
+						'0000'
+					end
+
+					# Tipo do registro
+					# 1 posição
+					#
+					def header_arquivo_posicao_008_a_008 
+						'0'
+					end
+
+					# Uso Exclusivo FEBRABAN / CNAB
+					# 09 posições
+					#
+					def header_arquivo_posicao_009_a_017
+						''.rjust(9, ' ') 
+					end
+
+					# Tipo de Inscrição da Empresa
+					# 1 posição
+					#
+					def header_arquivo_posicao_018_a_018
+						tipo_inscricao 
+					end
+
+					# Número de Inscrição da Empresa (CPF/CNPJ)
+					# 14 Posições
+					#
+					def header_arquivo_posicao_019_a_032
+						documento_cedente.to_s.rjust(14, '0')
+					end
+
+					# Código do Convênio no Banco
+					# 20 posições
+					# 
+					def header_arquivo_posicao_033_a_052
+						codigo_convenio
+					end
+					
+					# Informações da conta bancária
+					# O padrão da FEBRABAN é: 
+					#      Posição de 53 até 57 com 05 posições = Agência Mantenedora da Conta
+					#      Posição de 58 até 58 com 01 posições = DV    -> Dígito Verificador da Agência
+					#      Posição de 59 até 70 com 12 posições = Conta -> Número Número da Conta Corrente
+					#      Posição de 71 até 71 com 01 posições = DV    -> Dígito Verificador da Conta
+					#      Posição de 72 até 72 com 01 posições = DV    -> Dígito Verificador da Ag/Conta
+					#
+					# Porém como no Brasil os bancos não conseguem seguir um padrão, cada banco faz da sua maneira
+					# 20 posições
+					#
+					def header_arquivo_posicao_053_a_072
+						informacoes_da_conta
+					end
+
+					# Nome da Empresa
+					# 30 posições
+					# 
+					def header_arquivo_posicao_073_a_102
+						nome_empresa_formatada
+					end
+
+					# Nome do Banco
+					# 30 posições
+					#
+					def header_arquivo_posicao_103_a_132
+						nome_banco
+					end
+
+					# Uso Exclusivo FEBRABAN / CNAB
+					# 10 posições
+					#
+					def header_arquivo_posicao_133_a_142 
+						''.rjust(10, ' ')
+					end
+
+					# Código Remessa / Retorno (1 para remessa)
+					# 1 posição
+					# 
+					def header_arquivo_posicao_143_a_143
+						'1'
+					end
+
+					# Data de Geração do Arquivo no formato (DDMMYYYY)
+					# 8 posições
+					# 
+					def header_arquivo_posicao_144_a_151
+						data_geracao
+					end
+
+					# Hora de Geração do Arquivo no formato (HHMMSS)
+					# 6 posições
+					# 
+					def header_arquivo_posicao_152_a_157
+						hora_geracao 
+					end
+
+					# Número Seqüencial do Arquivo
+					# 6 posições
+					#
+					def header_arquivo_posicao_158_a_163
+						"#{sequencial_remessa}".rjust(6, '0')
+					end
+
+					# Numero da Versão do Layout do Arquivo
+					# 3 posições
+					#
+					def header_arquivo_posicao_164_a_166
+						versao_layout_arquivo
+					end
+					
+					# Densidade de Gravação do Arquivo 
+					# 5 posições
+					#
+					def header_arquivo_posicao_167_a_171
+						''.rjust(5, '0')
+					end
+
+					# Espaço reservado para o Banco
+					# 20 posições
+					#
+					def header_arquivo_posicao_172_a_191
+						''.rjust(20, '0')
+					end
+
+					# Espaço reservado para a Empresa
+					# 20 posições
+					#
+					def header_arquivo_posicao_192_a_211
+						''.rjust(20, '0')
+					end
+
+					# Para Uso Exclusivo FEBRABAN / CNAB
+					# 29 posições
+					#
+					def header_arquivo_posicao_212_a_240 
+						complemento_header
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,180 @@
+module BrBoleto
+	module Remessa
+		module Cnab240
+			module Helper
+				module HeaderLote
+					# Monta o registro header do lote
+					#
+					# @param nro_lote [Integer]
+					#   numero do lote no arquivo (iterar a cada novo lote)
+					#
+					# @return [String]
+					#
+					def monta_header_lote(lote, nr_lote)
+						header_lote = ''                                        # CAMPO              TAMANHO
+						header_lote << header_lote_posicao_001_a_003         # codigo banco           3
+						header_lote << header_lote_posicao_004_a_007(nr_lote)# lote servico           4
+						header_lote << header_lote_posicao_008_a_008         # tipo de registro       1
+						header_lote << header_lote_posicao_009_a_009         # tipo de operacao       1
+						header_lote << header_lote_posicao_010_a_011         # tipo de servico        2
+						header_lote << header_lote_posicao_012_a_013         # uso exclusivo          2
+						header_lote << header_lote_posicao_014_a_016         # versao layout do lote  3
+						header_lote << header_lote_posicao_017_a_017         # uso exclusivo          1
+						header_lote << header_lote_posicao_018_a_018         # tipo de inscricao      1
+						header_lote << header_lote_posicao_019_a_033         # inscricao cedente      15
+						header_lote << header_lote_posicao_034_a_053(lote)   # codigo do convenio     20
+						header_lote << header_lote_posicao_054_a_073         # informacoes conta      20
+						header_lote << header_lote_posicao_074_a_103         # nome empresa           30
+						header_lote << header_lote_posicao_104_a_143         # 1a mensagem            40
+						header_lote << header_lote_posicao_144_a_183         # 2a mensagem            40
+						header_lote << header_lote_posicao_184_a_191         # numero remessa         8
+						header_lote << header_lote_posicao_192_a_199         # data gravacao          8
+						header_lote << header_lote_posicao_200_a_207         # data do credito        8
+						header_lote << header_lote_posicao_208_a_240         # complemento            33
+						header_lote.upcase
+					end
+					# Código do Banco na Compensação
+					# 3 posições
+					# 
+					def header_lote_posicao_001_a_003
+						codigo_banco
+					end
+
+					# Lote de Serviço 
+					# 4 posições
+					# 
+					def header_lote_posicao_004_a_007(numero_do_lote)
+						"#{numero_do_lote}".rjust(4, '0')
+					end
+
+					# Tipo de Registro 
+					# 1 posição
+					# 
+					def header_lote_posicao_008_a_008
+						'1'						
+					end
+
+					# Tipo da Operação
+					# 1 posição
+					#
+					def header_lote_posicao_009_a_009
+						'R'
+					end
+
+					# Tipo do Serviço
+					# 2 posições
+					#
+					def header_lote_posicao_010_a_011
+						'01'
+					end
+
+					# Forma de Lançamento
+					# 2 posições
+					#
+					def header_lote_posicao_012_a_013
+						'00'
+					end
+
+					# Nº da Versão do Layout do Lote
+					# 3 posições
+					#
+					def header_lote_posicao_014_a_016
+						versao_layout_lote
+					end
+
+					# Uso Exclusivo da FEBRABAN/CNAB
+					# 1 posição
+					#
+					def header_lote_posicao_017_a_017
+						' '
+					end
+					
+					# Tipo de Inscrição da Empresa 
+					# 1 posição
+					#
+					def header_lote_posicao_018_a_018
+						tipo_inscricao
+					end
+
+					# Número de Inscrição da Empresa 
+					# 15 posições
+					#
+					def header_lote_posicao_019_a_033
+						documento_cedente.to_s.rjust(15, '0')
+					end
+
+					# Convenio -> Código do Cedente no Banco
+					# 20 posições
+					#
+					def header_lote_posicao_034_a_053(lote)
+						convenio_lote(lote)
+					end
+
+					# Informações da conta bancária
+					# O padrão da FEBRABAN é: 
+					#      Posição de 54 até 58 com 05 posições = Agência Mantenedora da Conta
+					#      Posição de 59 até 59 com 01 posições = DV    -> Dígito Verificador da Agência
+					#      Posição de 60 até 71 com 12 posições = Conta -> Número Número da Conta Corrente
+					#      Posição de 72 até 72 com 01 posições = DV    -> Dígito Verificador da Conta
+					#      Posição de 73 até 73 com 01 posições = DV    -> Dígito Verificador da Ag/Conta
+					#
+					# Porém como no Brasil os bancos não conseguem seguir um padrão, cada banco faz da sua maneira
+					# 20 posições
+					#
+					def header_lote_posicao_054_a_073
+						informacoes_da_conta
+					end
+
+					# Nome da Empresa
+					# 30 posições
+					#
+					def header_lote_posicao_074_a_103
+						nome_empresa_formatada
+					end
+
+					# Mensagem 1 
+					# 40 posições
+					#
+					def header_lote_posicao_104_a_143
+						mensagem_1.to_s.adjust_size_to(40)
+					end
+
+					# Mensagem 2
+					# 40 posições
+					#
+					def header_lote_posicao_144_a_183
+						mensagem_2.to_s.adjust_size_to(40)
+					end
+
+					# Número Remessa/Retorno 
+					# 8 posições
+					#
+					def header_lote_posicao_184_a_191
+						sequencial_remessa.to_s.rjust(8, '0')
+					end
+
+					# Data de Gravação Remessa/Retorno 
+					# 8 posições
+					#
+					def header_lote_posicao_192_a_199
+						data_geracao
+					end
+
+					# Data do Crédito 
+					# 8 posições
+					#
+					def header_lote_posicao_200_a_207
+						''.rjust(8, '0')
+					end
+
+					# Uso Exclusivo FEBRABAN/CNAB
+					# 33 posições
+					# 
+					def header_lote_posicao_208_a_240
+						''.rjust(33, ' ')
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,349 @@
+module BrBoleto
+	module Remessa
+		module Cnab240
+			module Helper
+				module SegmentoP
+					# Monta o registro segmento P 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_p(pagamento, nr_lote, sequencial)
+						# campos com * na frente nao foram implementados
+						#                                                      # DESCRICAO                             TAMANHO
+						segmento_p =  ''
+						segmento_p <<  segmento_p_posicao_001_a_003             # codigo banco                          3
+						segmento_p << segmento_p_posicao_004_a_007(nr_lote)    # lote de servico                       4
+						segmento_p << segmento_p_posicao_008_a_008             # tipo de registro                      1
+						segmento_p << segmento_p_posicao_009_a_013(sequencial) # num. sequencial do registro no lote   5
+						segmento_p << segmento_p_posicao_014_a_014             # cod. segmento                         1
+						segmento_p << segmento_p_posicao_015_a_015             # uso exclusivo                         1
+						segmento_p << segmento_p_posicao_016_a_017             # cod. movimento remessa                2
+						segmento_p << segmento_p_posicao_018_a_022             # agencia                               5
+						segmento_p << segmento_p_posicao_023_a_023             # dv agencia                            1
+						segmento_p << segmento_p_posicao_024_a_057(pagamento)  # informacoes da conta                  34
+						segmento_p << segmento_p_posicao_058_a_058             # codigo da carteira                    1
+						segmento_p << segmento_p_posicao_059_a_059             # forma de cadastro do titulo           1
+						segmento_p << segmento_p_posicao_060_a_060             # tipo de documento                     1
+						segmento_p << segmento_p_posicao_061_a_061             # identificaco emissao                  1
+						segmento_p << segmento_p_posicao_062_a_062             # indentificacao entrega                1
+						segmento_p << segmento_p_posicao_063_a_077(pagamento)  # numro do documento                    15
+						segmento_p << segmento_p_posicao_078_a_085(pagamento)  # data de venc.                         8
+						segmento_p << segmento_p_posicao_086_a_100(pagamento)  # valor documento                       15
+						segmento_p << segmento_p_posicao_101_a_105             # agencia cobradora                     5
+						segmento_p << segmento_p_posicao_106_a_106             # dv agencia cobradora                  1
+						segmento_p << segmento_p_posicao_107_a_108             # especie do titulo                     2
+						segmento_p << segmento_p_posicao_109_a_109              # aceite                                1
+						segmento_p << segmento_p_posicao_110_a_117(pagamento)  # data de emissao titulo                8
+						segmento_p << segmento_p_posicao_118_a_118             # cod. do juros                         1   *
+						segmento_p << segmento_p_posicao_119_a_126             # data juros                            8   *
+						segmento_p << segmento_p_posicao_127_a_141             # valor juros                           15  *
+						segmento_p << segmento_p_posicao_142_a_142(pagamento)  # cod. do desconto                      1
+						segmento_p << segmento_p_posicao_143_a_150(pagamento)  # data desconto                         8
+						segmento_p << segmento_p_posicao_151_a_165(pagamento)  # valor desconto                        15
+						segmento_p << segmento_p_posicao_166_a_180(pagamento)  # valor IOF                             15
+						segmento_p << segmento_p_posicao_181_a_195(pagamento)  # valor abatimento                      15
+						segmento_p << segmento_p_posicao_196_a_220             # identificacao titulo empresa          25  *
+						segmento_p << segmento_p_posicao_221_a_221             # cod. para protesto                    1   *
+						segmento_p << segmento_p_posicao_222_a_223             # dias para protesto                    2   *
+						segmento_p << segmento_p_posicao_224_a_224             # cod. para baixa                       1   *
+						segmento_p << segmento_p_posicao_225_a_227             # dias para baixa                       2   *
+						segmento_p << segmento_p_posicao_228_a_229             # cod. da moeda                         2
+						segmento_p << segmento_p_posicao_230_a_239             # uso exclusivo                         10
+						segmento_p << segmento_p_posicao_240_a_240             # uso exclusivo                         1
+						segmento_p.upcase
+					end
+
+					def segmento_p_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_p_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_p_posicao_008_a_008
+						'3'
+					end
+
+					# Nº Sequencial do Registro no Lote: 
+					# Número adotado e controlado pelo responsável pela geração magnética dos dados contidos no arquivo, 
+					# para identificar a seqüência de registros encaminhados no lote. 
+					# Deve ser inicializado sempre em '1', em cada novo lote.
+					# 5 posições
+					#
+					def segmento_p_posicao_009_a_013(sequencial)
+						sequencial.to_s.rjust(5, '0')
+					end
+
+					# Cód. Segmento do Registro - Default: "P"
+					# 1 posição
+					#
+					def segmento_p_posicao_014_a_014
+						"P"
+					end
+
+					# Uso Exclusivo FEBRABAN/CNAB
+					# 1 posição
+					#
+					def segmento_p_posicao_015_a_015
+						' '
+					end
+
+					# cod. movimento remessa -> Padrão 01 = Entrada de Titulos
+					# 2 posições
+					#
+					def segmento_p_posicao_016_a_017
+						'01'
+					end
+
+					# Agência Mantenedora da Conta 
+					# 5 posições
+					#
+					def segmento_p_posicao_018_a_022
+						agencia.to_s.rjust(5, '0')
+					end
+
+					# Dígito Verificador da Agência 
+					# 1 posição
+					#
+					def segmento_p_posicao_023_a_023
+						digito_agencia.to_s
+					end
+
+					# O padrão da FEBRABAN é: 
+					#      Posição de 24 até 35 com 12 posições = Número da Conta Corrente
+					#      Posição de 36 até 36 com 01 posições = DV -> Dígito Verificador da Conta 
+					#      Posição de 37 até 37 com 01 posições = DV -> Dígito Verificador da Ag/Conta
+					#      Posição de 38 até 57 com 20 posições = Nosso Número -> Identificação do Título no Banco
+					# Mas cada banco tem seu padrão
+					# 34 posições
+					#
+					def segmento_p_posicao_024_a_057(pagamento)
+						complemento_p(pagamento)
+					end
+
+					# Código da carteira
+					# 1 posição
+					#
+					def segmento_p_posicao_058_a_058
+						codigo_carteira
+					end
+
+					# Forma de Cadastr. do Título no Banco
+					# 1 posição
+					#
+					def segmento_p_posicao_059_a_059
+						forma_cadastramento
+					end
+
+					# Tipo de Documento
+					# 1 posição
+					#
+					def segmento_p_posicao_060_a_060
+						'2'
+					end
+
+					# Identificação da Emissão do Bloqueto 
+					# 1 posição
+					#
+					def segmento_p_posicao_061_a_061
+						emissao_boleto
+					end
+
+					# Identificação da Distribuição
+					# 1 posição
+					#
+					def segmento_p_posicao_062_a_062
+						distribuicao_boleto
+					end
+
+					# Número do Documento de Cobrança 
+					# Cada banco tem seu padrão
+					# 15 Posições
+					#
+					def segmento_p_posicao_063_a_077(pagamento)
+						segmento_p_numero_do_documento(pagamento)
+					end
+
+					# Data de Vencimento do Título
+					# 8 posições
+					#
+					def segmento_p_posicao_078_a_085(pagamento)
+						pagamento.data_vencimento.strftime('%d%m%Y')
+					end
+
+					# Valor Nominal do Título 
+					# 15 posições (13 posições para valor inteiro e 2 posições para valor quebrado)
+					#
+					def segmento_p_posicao_086_a_100(pagamento)
+						pagamento.valor_documento_formatado(15)
+					end
+
+					# Agencia cobradora
+					# 5 posições
+					#
+					def segmento_p_posicao_101_a_105
+						''.rjust(5, '0')
+					end
+
+					# Dígito Verificador da Agência cobradora
+					# 1 posição
+					#
+					def segmento_p_posicao_106_a_106
+						' '
+					end
+
+					# Espécie do Título
+					# 2 posições
+					#
+					def segmento_p_posicao_107_a_108 
+						especie_titulo
+					end
+
+					# Identific. de Título Aceito/Não Aceito (A ou N)
+					# 1 posição
+					#
+					def segmento_p_posicao_109_a_109
+						aceite
+					end
+
+					# Data da Emissão do Título 
+					# 8 posições
+					#
+					def segmento_p_posicao_110_a_117(pagamento)
+						pagamento.data_emissao.strftime('%d%m%Y')
+					end
+
+					# Código do Juros de Mora 
+					# 1 posição
+					#
+					def segmento_p_posicao_118_a_118 
+						'0'
+					end
+
+					# Data do Juros de Mora 
+					# 8 posições
+					#
+					def segmento_p_posicao_119_a_126
+						''.rjust(8, '0')
+					end
+
+					# Juros de Mora por Dia/Taxa 
+					# 15 posições
+					#
+					def segmento_p_posicao_127_a_141
+						''.rjust(15, '0')
+					end
+
+					# Código do Desconto 1 
+					# 1 posição
+					#
+					def segmento_p_posicao_142_a_142(pagamento)
+						pagamento.cod_desconto
+					end
+
+					# Data do Desconto 1 
+					# 8 posições
+					#
+					def segmento_p_posicao_143_a_150(pagamento)
+						pagamento.data_desconto_formatado('%d%m%Y')
+					end
+
+					# Valor/Percentual a ser Concedido 
+					# 15 posições
+					#
+					def segmento_p_posicao_151_a_165(pagamento)
+						pagamento.valor_desconto_formatado(15)
+					end
+
+					# Valor do IOF a ser Recolhido
+					# 15 posições
+					#
+					def segmento_p_posicao_166_a_180(pagamento)
+						pagamento.valor_iof_formatado(15)
+					end
+
+					# Valor do Abatimento
+					# 15 posições
+					#
+					def segmento_p_posicao_181_a_195(pagamento)
+						pagamento.valor_abatimento_formatado(15)
+					end
+
+					# Identificação do Título na Empresa 
+					# 25 posições
+					#
+					def segmento_p_posicao_196_a_220
+						''.rjust(25, ' ') 
+					end
+
+					# Código para Protesto
+					# 1 posição
+					#
+					def segmento_p_posicao_221_a_221 
+						'1'
+					end
+
+					# Número de Dias para Protesto 
+					# 2 posições
+					#
+					def segmento_p_posicao_222_a_223
+						'00' 
+					end
+
+					# Código para Baixa/Devolução 
+					# 1 posição
+					#
+					def segmento_p_posicao_224_a_224
+						'0'  
+					end
+
+					# Número de Dias para Baixa/Devolução
+					# 3 posoções
+					#
+					def segmento_p_posicao_225_a_227
+						'000'
+					end
+
+					# Código da Moeda (09 para real)
+					# 2 posições
+					#
+					def segmento_p_posicao_228_a_229
+						'09'
+					end
+
+					# Nº do Contrato da Operação de Crédito (Uso do banco)
+					# 10 posições
+					#
+					def segmento_p_posicao_230_a_239
+						''.rjust(10, '0')
+					end
+
+					# Uso livre banco/empresa ou autorização de pagamento parcial 
+					# 1 posição
+					#
+					def segmento_p_posicao_240_a_240
+						' '
+					end
+
+				end
+			end
+		end
+	end
+end