br_boleto 1.0.1 → 1.1.0

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

@@ -41,6 +41,13 @@ module BrBoleto
 					end
 
 					# Tipo do registro -> Padrão 9
+					# Código adotado pela FEBRABAN para identificar o tipo de registro:
+					#     0 = Header de Arquivo
+					#     1 = Header de Lote
+					#     3 = Detalhe
+					#     5 = Trailer de Lote
+					#     9 = Trailer de Arquivo
+					#
 					# 1 posição
 					#
 					def trailer_arquivo_posicao_008_a_008

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

@@ -99,7 +99,7 @@ module BrBoleto
 					"#{agencia.rjust(5, '0')}#{digito_agencia}#{conta_corrente.rjust(12, '0')}#{digito_conta}".adjust_size_to(20)
 				end
 
-				def complemento_header
+				def complemento_header_arquivo
 					''.rjust(29, ' ')
 				end
 
@@ -118,7 +118,7 @@ module BrBoleto
 				# 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
+				def tipo_cobranca_formatada
 					case "#{modalidade_carteira}".rjust(2, "0")
 					when '01', '02'
 						:simples
@@ -165,14 +165,14 @@ module BrBoleto
 				# 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')
+					tipo_cobranca_formatada == :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
+					if tipo_cobranca_formatada == :simples
 						BrBoleto::Helper::Number.new(lote.pagamentos.map(&:valor_documento).sum).formata_valor_monetario(17)
 					else
 						''.rjust(17, '0')
@@ -198,14 +198,14 @@ module BrBoleto
 				# 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')
+					tipo_cobranca_formatada == :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
+					if tipo_cobranca_formatada == :caucionada
 						BrBoleto::Helper::Number.new(lote.pagamentos.map(&:valor_documento).sum).formata_valor_monetario(17)
 					else
 						''.rjust(17, '0')

data/lib/br_boleto/remessa/lote.rb

@@ -1,14 +1,7 @@
 # -*- encoding: utf-8 -*-
 module BrBoleto
 	module Remessa
-		class Lote
-			# Seguindo a interface do Active Model para:
-			# * Validações;
-			# * Internacionalização;
-			# * Nomes das classes para serem manipuladas;
-			#
-			include ActiveModel::Model
-
+		class Lote < BrBoleto::ActiveModelBase
 			# variavel que terá os pagamentos no qual será gerado o lote do arquivo de remessa
 			# Pode haver 1 ou vários pagamentos para o mesmo arquivo
 			attr_accessor :pagamentos
@@ -17,19 +10,6 @@ module BrBoleto
 				BrBoleto::Remessa::Pagamento
 			end
 
-			def initialize(attributes = {})
-				self.pagamentos = [] # Para poder utilizar o << para incrementar o array
-				assign_attributes(attributes)
-				yield self if block_given?
-			end
-
-			def assign_attributes(attributes)
-				attributes ||= {}
-				attributes.each do |name, value|
-					send("#{name}=", value)
-				end
-			end
-
 			validates_each :pagamentos do |record, attr, value|
 				record.errors.add(attr, 'não pode estar vazio.') if value.empty?
 				value.each do |pagamento|

data/lib/br_boleto/remessa/pagamento.rb

@@ -1,17 +1,17 @@
 # -*- encoding: utf-8 -*-
 module BrBoleto
 	module Remessa
-		class Pagamento
-			# Seguindo a interface do Active Model para:
-			# * Validações;
-			# * Internacionalização;
-			# * Nomes das classes para serem manipuladas;
-			#
-			include ActiveModel::Model
-
+		class Pagamento < BrBoleto::ActiveModelBase
 			# <b>REQUERIDO</b>: nosso numero
 			attr_accessor :nosso_numero
 
+			# <b>OPCIONAL</b>: Número do Documento de Cobrança - Número adotado e controlado pelo Cliente,
+			# para identificar o título de cobrança.
+			# Informação utilizada para referenciar a identificação do documento objeto de cobrança.
+			# Poderá conter número de duplicata, no caso de cobrança de duplicatas; número da apólice,
+			# no caso de cobrança de seguros, etc
+			attr_accessor :numero_documento
+
 			# <b>REQUERIDO</b>: data do vencimento do boleto
 			attr_accessor :data_vencimento
 
@@ -88,6 +88,13 @@ module BrBoleto
 			# <b>OPCIONAL</b>: Informações para multa
 			attr_accessor :codigo_multa, :data_multa, :valor_multa
 
+			def cep_sacado
+				"#{@cep_sacado}".gsub(/[^0-9]/, "")
+			end
+
+			def nosso_numero
+				"#{@nosso_numero}".gsub(/[^0-9]/, "")
+			end
 
 			validates :nosso_numero, :data_vencimento, :valor_documento, :documento_sacado, :nome_sacado, 
 			          :endereco_sacado, :cep_sacado, :cidade_sacado, :uf_sacado, :bairro_sacado, :tipo_impressao,
@@ -96,36 +103,15 @@ module BrBoleto
 			validates :cep_sacado,   length: {is: 8, message: 'deve ter 8 dígitos.'}
 			validates :cod_desconto, length: {is: 1, message: 'deve ter 1 dígito.'}
 
-			# Nova instancia da classe Pagamento
-			#
-			# @param campos [Hash]
-			#
-			def initialize(attributes = {})
-				attributes = default_values.merge!(attributes)
-				assign_attributes(attributes)
-				yield self if block_given?
-			end
-
-			def assign_attributes(attributes={})
-				attributes ||= {}
-				attributes.each do |name, value|
-					send("#{name}=", value)
-				end
-			end
-
-			def nosso_numero
-				"#{@nosso_numero}".gsub(/[^0-9]/, "")
-			end
-
 			def default_values
 				{
-					data_emissao:     Date.today,
-					valor_mora:       0.0,
-					valor_desconto:   0.0,
-					valor_iof:        0.0,
-					valor_abatimento: 0.0,
-					nome_avalista:    '',
-					cod_desconto:     '0',
+					data_emissao:      Date.today,
+					valor_mora:        0.0,
+					valor_desconto:    0.0,
+					valor_iof:         0.0,
+					valor_abatimento:  0.0,
+					nome_avalista:     '',
+					cod_desconto:      '0',
 					desconto_2_codigo: '0',
 					desconto_2_valor:  0.0,
 					desconto_3_codigo: '0',

data/lib/br_boleto/retorno/base.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+module BrBoleto
+	module Retorno
+		class Base < BrBoleto::ActiveModelBase
+			
+			attr_accessor :pagamentos			
+			attr_accessor :codigo_banco
+
+			def initialize(file)
+				self.pagamentos = []
+				@file = file
+				read_file!
+			end
+
+			# O atributo pagamentos sempre irá retornar um Array 
+			def pagamentos
+				@pagamentos = [@pagamentos].flatten
+			end
+
+			def file
+				@file
+			end
+		
+		private
+
+			def read_file!
+				raise NotImplementedError.new('Sobreescreva este método na classe referente ao CNAB 240 ou 400')
+			end
+		end
+	end
+end

data/lib/br_boleto/retorno/cnab240/base.rb

@@ -0,0 +1,101 @@
+# -*- encoding: utf-8 -*-
+module BrBoleto
+	module Retorno
+		module Cnab240
+			class Base < BrBoleto::Retorno::Base
+
+			# Esta classe foi desenvolvida baseando-se no manual disponibilizado pela FEBRABAN
+			# Manual: Layout Padrão Febraban 240 posições v09.0
+				
+			private
+
+				# É feito um loop em todas as linhas do arquivo onde ignora se a linha não
+				# for do segmento T ou do segmento U.
+				# A cada loop é lido 2 linhas por vez, onde sempre terá o segmento T e U juntos.
+				# Cada loop representa um pagamento.
+				#
+				def read_file! #:doc:
+					File.readlines(file).reject{|l| l =~ /^((?!^.{7}3.{5}[T|U].*$).)*$/}.each_slice(2) do |line|
+						instnce_payment(line)
+					end
+					pagamentos
+				end
+
+				# Método utilizado para instanciar um novo Pagamento a partir das linhas dos
+				# Segmentos T e U do arquivo de retorno
+				#
+				def instnce_payment(lines) #:doc:
+					payment = BrBoleto::Retorno::Pagamento.new
+					lines.each do |line|
+						self.codigo_banco ||= line[0..2]
+						if line[13] == 'T'
+							set_values_for_segment_t(payment, line)
+						else # U
+							set_values_for_segment_u(payment, line)
+						end
+					end
+					self.pagamentos << payment
+				end
+
+				def set_values_for_segment_u(payment, line) #:doc: 
+					segmento_u_fields.each do |column, position |
+						payment.send("#{column}=", "_#{line}"[position].try(:strip))
+					end
+				end
+
+				def set_values_for_segment_t(payment, line) #:doc:
+					segmento_t_fields.each do |column, position |
+						payment.send("#{column}=", "_#{line}"[position].try(:strip))
+					end
+				end
+				
+				def segmento_t_fields #:doc:
+					{ #    ATRIBUTO               POSIÇÃO DA LINHA
+						agencia_com_dv:                18..23,
+						agencia_sem_dv:                18..22,
+						numero_conta_com_dv:           24..36,
+						numero_conta_sem_dv:           24..35,
+						dv_conta_e_agencia:            37..37,
+						nosso_numero:                  38..57,
+						carteira:                      58..58,
+						numero_codumento:              59..73,
+						data_vencimento:               74..81,
+						valor_titulo:                  82..96,
+						banco_recebedor:               97..99,
+						agencia_recebedora_com_dv:    100..105,
+						identificacao_titulo_empresa: 106..130,
+						codigo_moeda:                 131..132,
+						sacado_tipo_documento:        133..133,
+						sacado_documento:             134..148,
+						sacado_nome:                  149..188,
+						numero_contrato:              189..198,
+						valor_tarifa:                 199..213,
+						motivo_ocorrencia:            214..223
+					}
+				end
+
+				def segmento_u_fields #:doc:
+					{ #    ATRIBUTO                        POSIÇÃO DA LINHA     
+						valor_juros_multa:                       18..32,
+						valor_desconto:                          33..47,
+						valor_abatimento:                        48..62,
+						valor_iof:                               63..77,
+						valor_pago:                              78..92,
+						valor_liquido:                           93..107,
+						valor_coutras_despesas:                 108..122,
+						valor_coutros_creditos:                 123..137,
+						data_ocorrencia:                        138..145,
+						data_credito:                           146..153,
+						codigo_ocorrencia_sacado:               154..157,
+						data_ocorrencia_sacado:                 158..165,
+						valor_ocorrencia_sacado:                166..180,
+						complemento_ocorrencia_sacado:          181..210,
+						codigo_ocorrencia_banco_correspondente: 211..213,
+						nosso_numero_banco_correspondente:      214..133,
+					}				
+				end
+
+			end
+		end
+	end
+end

data/lib/br_boleto/retorno/cnab240/caixa.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+module BrBoleto
+	module Retorno
+		module Cnab240
+			class Caixa < BrBoleto::Retorno::Cnab240::Base
+
+			private
+				# O Banco da Caixa não tem a capacidade de seguir o padrão da FEBRABAN
+				# então tem algumas particularidades nas posições dos valores:
+				#  - numero_conta (codigo cedente)
+				#  - Modalidade
+				#  - Nosso número
+				#  - Número documento
+				#
+				def segmento_t_fields #:doc:
+					super.merge({ 
+					#    ATRIBUTO               POSIÇÃO DA LINHA
+						numero_conta_com_dv:         24..29, # Código do cedente
+						numero_conta_sem_dv:         24..29, # Código do cedente
+						dv_conta_e_agencia:          250, # Defino como 250 para setar nil ao atributo
+						modalidade:                  40..41,
+						nosso_numero:                42..56,
+						# carteira:                  58..58, # Cartéira segue o padrão da FEBRABAN
+						numero_codumento:            59..69,
+					})
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+module BrBoleto
+	module Retorno
+		module Cnab240
+			class Sicoob < BrBoleto::Retorno::Cnab240::Base
+
+			private
+				# O valor da posição que representa o nosso_numero está 
+				# subdividido e várias partes para o sicoob.
+				#
+				# Pelo Layout da FEBRABAN o valor para a informação do nosso_numero
+				# Está localizado entre as posições 38 a 57 contendo 20 caracteres.
+				#
+				# Nosso Número:
+				# - NumTitulo       - 10 posições (01 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 segmento_t_fields #:doc:
+					super.merge({ 
+					#    ATRIBUTO               POSIÇÃO DA LINHA
+						nosso_numero:                 38..47,
+						modalidade:                   50..51
+					})
+				end
+			end
+		end
+	end
+end

data/lib/br_boleto/retorno/pagamento.rb

@@ -0,0 +1,242 @@
+# -*- encoding: utf-8 -*-
+module BrBoleto
+	module Retorno
+		class Pagamento < BrBoleto::ActiveModelBase
+			
+			#############################################################################################
+			############################# VALORES ENCONTRADOS NO SEGMENTO T #############################
+			#############################################################################################
+			# AGÊNCIA
+			attr_accessor :agencia_com_dv # tamanho = 6
+			attr_accessor :agencia_sem_dv # tamanho = 5
+			
+			# NÚMERO DA CONTA CORRENTE/CEDENTE
+			attr_accessor :numero_conta_com_dv # tamanho = 13
+			attr_accessor :numero_conta_sem_dv # tamanho = 12
+			alias_attribute :codigo_cedente, :numero_conta_sem_dv
+			alias_attribute :numero_conta,   :numero_conta_sem_dv
+			
+			# IDENTIFICAÇÃO DO TÍTULO
+			# Tamanho    Posição
+			#   1         37-37
+			attr_accessor :dv_conta_e_agencia
+
+			# IDENTIFICAÇÃO DO TÍTULO
+			# Tamanho    Posição
+			#   20        38-57
+			attr_accessor :nosso_numero
+			
+			# CÓDIGO DA CARTEIRA
+			# Tamanho    Posição
+			#   1         58-58
+			attr_accessor :carteira
+
+			# NÚMERO DO DOCUMENTO
+			# Tamanho    Posição
+			#   15        59-73
+			attr_accessor :numero_codumento
+
+			# DATA DE VENCIMENTO
+			# Tamanho    Posição
+			#   8        74-81
+			attr_accessor :data_vencimento
+			
+			# VALRO DO TÍTULO
+			# Tamanho    Posição
+			#   15        82-96
+			attr_accessor :valor_titulo
+			
+			# CÓDIGO DO BANCO RECEBEDOR DO TÚTULO
+			# Tamanho    Posição
+			#   3        97-99
+			attr_accessor :banco_recebedor
+
+			# AGÊNCIA(com dv) DO BANCO RECEBEDOR DO TÚTULO
+			# Tamanho    Posição
+			#   6        100-105
+			attr_accessor :agencia_recebedora_com_dv
+
+			# IDENTIFICAÇÃO/DESCRIÇÃO DO TÍTULO DA EMPRESA
+			# Tamanho    Posição
+			#   25        106-130
+			attr_accessor :identificacao_titulo_empresa
+
+			# CÓDIGO DA MOEDA
+			# Tamanho    Posição
+			#   2        131-132
+			attr_accessor :codigo_moeda
+
+			# SACADO TIPO DE INSCRIÇÃO
+			# '0' = Isento / Não Informado
+			# '1' = CPF
+			# '2' = CGC / CNPJ
+			# '3' = PIS / PASEP
+			# '9' = Outros 
+			# Tamanho    Posição
+			#   1        133-133
+			attr_accessor :sacado_tipo_documento
+
+			# NÚMEDO DO DOCUMENTO DO SACADO (CPF/CNPJ)
+			# Tamanho    Posição
+			#   15       134-148
+			attr_accessor :sacado_documento
+
+			# NOME DO SACADO
+			# Tamanho    Posição
+			#   40       149-188
+			attr_accessor :sacado_nome
+
+			# NÚMERO DO CONTRATO DA OPERAÇÃO DE CRÉDITO
+			# Tamanho    Posição
+			#   10       189-198
+			attr_accessor :numero_contrato
+
+			# VALOR DA TARIFA
+			# Tamanho    Posição
+			#   15       199-213
+			attr_accessor :valor_tarifa
+
+			# IDENTIFICAÇÃO PARA REJEIÇÕES, TARIFAS, CUSTOS, LIQUIDAÇÃO E BAIXAS
+			# Tamanho    Posição
+			#   10       214-223
+			attr_accessor :motivo_ocorrencia
+
+			#############################################################################################
+			############################# VALORES ENCONTRADOS NO SEGMENTO U #############################
+			#############################################################################################
+			# ACRÉSCIMOS COM JUROS E MULTAS
+			# Tamanho    Posição
+			#   15        18-32
+			attr_accessor :valor_juros_multa
+
+			# VALOR DO DESCONTO
+			# Tamanho    Posição
+			#   15        33-47
+			attr_accessor :valor_desconto
+
+			# VALOR DO ABATIMENTO CONCEDIDO/CENCELADO
+			# Tamanho    Posição
+			#   15        48-62
+			attr_accessor :valor_abatimento
+
+			# VALOR DO IOF
+			# Tamanho    Posição
+			#   15        63-77
+			attr_accessor :valor_iof
+
+			# VALOR PAGO PELO SACADO
+			# Tamanho    Posição
+			#   15        78-92
+			attr_accessor :valor_pago
+
+			# VALOR LIQUIDO
+			# Tamanho    Posição
+			#   15        93-107
+			attr_accessor :valor_liquido
+
+			# VALRO COM COUTRAS DESPESAS
+			# Tamanho    Posição
+			#   15        108-122
+			attr_accessor :valor_coutras_despesas
+
+			# VALRO COM COUTROS CRÉDITOS
+			# Tamanho    Posição
+			#   15        123-137
+			attr_accessor :valor_coutros_creditos
+
+			# DATA OCORRÊNCIA
+			# Tamanho    Posição
+			#   8        138-145
+			attr_accessor :data_ocorrencia
+
+			# DATA DA EFETIVAÇÃO DO CRÉDITO
+			# Tamanho    Posição
+			#   8        146-153
+			attr_accessor :data_credito
+
+			# CÓDIGO DA OCORRÊNCIA DO SACADO
+			# Tamanho    Posição
+			#   4        154-157
+			attr_accessor :codigo_ocorrencia_sacado
+
+			# DATA DA OCORRÊNCIA DO SACADO
+			# Tamanho    Posição
+			#   8        158-165
+			attr_accessor :data_ocorrencia_sacado
+
+			# VALOR DA OCORRÊNCIA DO SACADO
+			# Tamanho    Posição
+			#   15        166-180
+			attr_accessor :valor_ocorrencia_sacado
+
+			# COMPLEMENTO DA OCORRÊNCIA DO SACADO
+			# Tamanho    Posição
+			#   30        181-210
+			attr_accessor :complemento_ocorrencia_sacado
+
+			# CÓDIGO DA OCORRÊNCIA DO BANCO CORRESPONDETNTE
+			# Tamanho    Posição
+			#   3        211-213
+			attr_accessor :codigo_ocorrencia_banco_correspondente
+
+			# CÓDIGO DA OCORRÊNCIA DO BANCO CORRESPONDETNTE
+			# Tamanho    Posição
+			#   3        211-213
+			attr_accessor :nosso_numero_banco_correspondente
+
+			# MODALIDADE 
+			# O Padrão da FEBRABAN não prevê este valor, porém na maioria dos bancos
+			# este valor está incluso junto com a posição do nosso_numero
+			# É implementado apenas para os bancos que não conseguem seguir um padrão estabelecido
+			attr_accessor :modalidade
+
+			def initialize(attributes = {})
+				define_formatted_methods!
+				super
+			end
+
+			def self.formatted_values
+				{
+					data_vencimento:         {type: :date},
+					data_ocorrencia:         {type: :date},
+					data_credito:            {type: :date},
+					data_ocorrencia_sacado:  {type: :date},
+					valor_titulo:            {type: :float},
+					valor_tarifa:            {type: :float},
+					valor_juros_multa:       {type: :float},
+					valor_desconto:          {type: :float},
+					valor_abatimento:        {type: :float},
+					valor_iof:               {type: :float},
+					valor_pago:              {type: :float},
+					valor_liquido:           {type: :float},
+					valor_coutras_despesas:  {type: :float},
+					valor_coutros_creditos:  {type: :float},
+					valor_ocorrencia_sacado: {type: :float},
+				}
+			end
+
+			def define_formatted_methods!
+				self.class.formatted_values.each do |attr_name, options|
+					case options[:type]
+					when :date
+						define_date_attribute(attr_name)
+					when :float
+						define_float_attribute(attr_name)
+					end						
+				end
+			end
+
+			def define_float_attribute(attr_name)
+				define_singleton_method "#{attr_name}=" do |value|
+					self.instance_variable_set("@#{attr_name}", BrBoleto::Helper::FormatValue.string_to_float(value) )
+				end
+			end
+
+			def define_date_attribute(attr_name)
+				define_singleton_method "#{attr_name}=" do |value|
+					self.instance_variable_set("@#{attr_name}", BrBoleto::Helper::FormatValue.string_to_date(value) )
+				end
+			end
+		end	
+	end
+end

data/lib/br_boleto/version.rb

@@ -1,8 +1,8 @@
 module BrBoleto
 	module Version
 		MAJOR = 1 #inclui alterações de API e pode quebrar compatibilidade com versões anteriores
-		MINOR = 0 #inclui novas funcionalidades, sem quebrar APIs existentes
-		PATCH = 1 #corrige bugs ou traz melhorias em implementações já existentes
+		MINOR = 1 #inclui novas funcionalidades, sem quebrar APIs existentes
+		PATCH = 0 #corrige bugs ou traz melhorias em implementações já existentes
 		CURRENT = "#{MAJOR}.#{MINOR}.#{PATCH}"
 	end
 end