bbrcobranca 0.0.1

data/lib/bbrcobranca/remessa/pagamento.rb

@@ -0,0 +1,288 @@
+# -*- encoding: utf-8 -*-
+module Bbrcobranca
+  module Remessa
+    class Pagamento
+
+      include Bbrcobranca::Validations
+
+      # <b>REQUERIDO</b>: nosso numero
+      attr_accessor :nosso_numero
+      # <b>REQUERIDO</b>: data do vencimento do boleto
+      attr_accessor :data_vencimento
+      # <b>REQUERIDO</b>: data de emissao do boleto
+      attr_accessor :data_emissao
+      # <b>REQUERIDO</b>: valor do boleto
+      attr_accessor :valor
+      # <b>REQUERIDO</b>: documento do sacado (cliente)
+      attr_accessor :documento_sacado
+      # <b>REQUERIDO</b>: nome do sacado (cliente)
+      attr_accessor :nome_sacado
+      # <b>REQUERIDO</b>: endereco do sacado (cliente)
+      attr_accessor :endereco_sacado
+      # <b>REQUERIDO</b>: bairro do sacado (cliente)
+      attr_accessor :bairro_sacado
+      # <b>REQUERIDO</b>: CEP do sacado (cliente)
+      attr_accessor :cep_sacado
+      # <b>REQUERIDO</b>: cidade do sacado (cliente)
+      attr_accessor :cidade_sacado
+      # <b>REQUERIDO</b>: UF do sacado (cliente)
+      attr_accessor :uf_sacado
+      # <b>REQUERIDO</b>: Código da ocorrência
+      attr_accessor :identificacao_ocorrencia
+      # <b>OPCIONAL</b>: nome do avalista
+      attr_accessor :nome_avalista
+      # <b>OPCIONAL</b>: documento do avalista
+      attr_accessor :documento_avalista
+      # <b>OPCIONAL</b>: codigo da 1a instrucao
+      attr_accessor :cod_primeira_instrucao
+      # <b>OPCIONAL</b>: codigo da 2a instrucao
+      attr_accessor :cod_segunda_instrucao
+      # <b>OPCIONAL</b>: valor da mora ao dia
+      attr_accessor :valor_mora
+      # <b>OPCIONAL</b>: data limite para o desconto
+      attr_accessor :data_desconto
+      # <b>OPCIONAL</b>: valor a ser concedido de desconto
+      attr_accessor :valor_desconto
+      # <b>OPCIONAL</b>: codigo do desconto (para CNAB240)
+      attr_accessor :cod_desconto
+      # <b>OPCIONAL</b>: valor do IOF
+      attr_accessor :valor_iof
+      # <b>OPCIONAL</b>: valor do abatimento
+      attr_accessor :valor_abatimento
+      # <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
+      # <b>OPCIONAL</b>: Número utilizado para controle do beneficiário/cedente
+      attr_accessor :documento
+      # <b>OPCIONAL</b>: data limite para o desconto
+      attr_accessor :data_segundo_desconto
+      # <b>OPCIONAL</b>: valor a ser concedido de desconto
+      attr_accessor :valor_segundo_desconto
+      # <b>OPCIONAL</b>: espécie do título
+      attr_accessor :especie_titulo
+      # <b>OPCIONAL</b>: código da multa
+      attr_accessor :codigo_multa
+      # <b>OPCIONAL</b>: Percentual multa por atraso %
+      attr_accessor :percentual_multa
+      # <b>OPCIONAL</b>: Data para cobrança de multa
+      attr_accessor :data_multa
+      # <b>OPCIONAL</b>: tipo de mora (diário, mensal)
+      attr_accessor :tipo_mora
+      # <b>OPCIONAL</b>: Data para cobrança de mora
+      attr_accessor :data_mora
+      # <b>OPCIONAL</b>: codigo dos juros
+      attr_accessor :codigo_juros
+      # <b>OPCIONAL</b>: codigo do protesto
+      attr_accessor :codigo_protesto
+      # <b>OPCIONAL</b>: dias para protesto
+      attr_accessor :dias_protesto
+      # <b>OPCIONAL</b>: codigo baixa
+      attr_accessor :codigo_baixa
+      # <b>OPCIONAL</b>: dias para baixa
+      attr_accessor :dias_baixa
+      # <b>OPCIONAL</b>: Número da Parcela
+      attr_accessor :parcela
+
+      validates_presence_of :nosso_numero, :data_vencimento, :valor,
+        :documento_sacado, :nome_sacado, :endereco_sacado,
+        :cep_sacado, :cidade_sacado, :uf_sacado, message: 'não pode estar em branco.'
+      validates_length_of :uf_sacado, is: 2, message: 'deve ter 2 dígitos.'
+      validates_length_of :cep_sacado, is: 8, message: 'deve ter 8 dígitos.'
+      validates_length_of :cod_desconto, is: 1, message: 'deve ter 1 dígito.'
+      validates_length_of :especie_titulo, is: 2, message: 'deve ter 2 dígitos.', allow_blank: true
+      validates_length_of :identificacao_ocorrencia, is: 2, message: 'deve ter 2 dígitos.'
+
+      # Nova instancia da classe Pagamento
+      #
+      # @param campos [Hash]
+      #
+      def initialize(campos = {})
+        padrao = {
+          data_emissao: Date.current,
+          data_segundo_desconto:'00-00-00',
+          tipo_mora: "3",
+          valor_mora: 0.0,
+          valor_desconto: 0.0,
+          valor_segundo_desconto: 0.0,
+          valor_iof: 0.0,
+          valor_abatimento: 0.0,
+          nome_avalista: '',
+          cod_desconto: '0',
+          especie_titulo: '01',
+          identificacao_ocorrencia: '01',
+          codigo_multa: '0',
+          percentual_multa: 0.0,
+          parcela: '01',
+          codigo_protesto: '3',
+          dias_protesto: '00',
+          codigo_baixa: '0',
+          dias_baixa: '000',
+          cod_primeira_instrucao: '00',
+          cod_segunda_instrucao: '00'
+        }
+
+        campos = padrao.merge!(campos)
+        campos.each do |campo, valor|
+          send "#{campo}=", valor
+        end
+
+        yield self if block_given?
+      end
+
+      # Formata a data de desconto de acordo com o formato passado
+      #
+      # @return [String]
+      #
+      def formata_data_desconto(formato = '%d%m%y')
+        data_desconto.strftime(formato)
+      rescue
+        if formato == '%d%m%y'
+          '000000'
+        else
+          '00000000'
+        end
+      end
+
+      # Formata a data de segundo desconto de acordo com o formato passado
+      #
+      # @return [String]
+      #
+      def formata_data_segundo_desconto(formato = '%d%m%y')
+        data_segundo_desconto.strftime(formato)
+      rescue
+        if formato == '%d%m%y'
+          '000000'
+        else
+          '00000000'
+        end
+      end
+
+      # Formata a valor do percentual da multa
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      # @return [String]
+      #
+      def formata_percentual_multa(tamanho = 4)
+        format_value(percentual_multa, tamanho)
+      end
+
+      # Formata a data de cobrança da multa
+      #
+      # @return [String]
+      #
+      def formata_data_multa(formato = '%d%m%y')
+        data_multa.strftime(formato)
+      rescue
+        if formato == '%d%m%y'
+          '000000'
+        else
+          '00000000'
+        end
+      end
+
+      # Formata o campo valor
+      # referentes as casas decimais
+      # exe. R$199,90 => 0000000019990
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor(tamanho = 13)
+        format_value(valor, tamanho)
+      end
+
+      def documento_ou_numero
+        documento.present? ? documento : numero
+      end
+
+      def formata_documento_ou_numero(tamanho = 25, caracter = ' ')
+        doc = documento_ou_numero.to_s.gsub(/[^0-9A-Za-z ]/, '')
+        doc.rjust(tamanho, caracter)[0...tamanho]
+      end
+
+      # Formata o campo valor da mora
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor_mora(tamanho = 13)
+        format_value(valor_mora, tamanho)
+      end
+
+      # Formata o campo valor da multa
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor_multa(tamanho = 6)
+        format_value(percentual_multa, tamanho)
+      end
+
+      # Formata o campo valor do desconto
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor_desconto(tamanho = 13)
+        format_value(valor_desconto, tamanho)
+      end
+
+      # Formata o campo valor do segundo desconto
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor_segundo_desconto(tamanho = 13)
+        format_value(valor_segundo_desconto, tamanho)
+      end
+
+      # Formata o campo valor do IOF
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor_iof(tamanho = 13)
+        format_value(valor_iof, tamanho)
+      end
+
+      # Formata o campo valor do IOF
+      #
+      # @param tamanho [Integer]
+      #   quantidade de caracteres a ser retornado
+      #
+      def formata_valor_abatimento(tamanho = 13)
+        format_value(valor_abatimento, tamanho)
+      end
+
+      # Retorna a identificacao do pagador
+      # Se for pessoa fisica (CPF com 11 digitos) é 1
+      # Se for juridica (CNPJ com 14 digitos) é 2
+      #
+      def identificacao_sacado(zero = true)
+        Bbrcobranca::Util::Empresa.new(documento_sacado, zero).tipo
+      end
+
+      # Retorna a identificacao do avalista
+      # Se for pessoa fisica (CPF com 11 digitos) é 1
+      # Se for juridica (CNPJ com 14 digitos) é 2
+      #
+      def identificacao_avalista(zero = true)
+        return '0' if documento_avalista.nil?
+        Bbrcobranca::Util::Empresa.new(documento_avalista, zero).tipo
+      end
+
+      private
+
+      def format_value(value, tamanho)
+        raise ValorInvalido, 'Deve ser um Float' unless value.to_s =~ /\./
+
+        sprintf('%.2f', value).delete('.').rjust(tamanho, '0')
+      end
+    end
+  end
+end

data/lib/bbrcobranca/retorno/base.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Bbrcobranca
+  module Retorno
+    class Base # Classe base para retornos bancários
+      attr_accessor :codigo_registro
+      attr_accessor :agencia_com_dv
+      attr_accessor :agencia_sem_dv
+      attr_accessor :cedente_com_dv
+      attr_accessor :convenio
+      attr_accessor :nosso_numero
+      attr_accessor :documento_numero
+      attr_accessor :tipo_cobranca
+      attr_accessor :tipo_cobranca_anterior
+      attr_accessor :natureza_recebimento
+      attr_accessor :carteira_variacao
+      attr_accessor :desconto
+      attr_accessor :iof
+      attr_accessor :carteira
+      attr_accessor :comando
+      attr_accessor :data_liquidacao
+      attr_accessor :data_vencimento
+      attr_accessor :valor_titulo
+      attr_accessor :banco_recebedor
+      attr_accessor :agencia_recebedora_com_dv
+      attr_accessor :especie_documento
+      attr_accessor :codigo_ocorrencia
+      attr_accessor :motivo_ocorrencia
+      attr_accessor :data_ocorrencia
+      attr_accessor :data_credito
+      attr_accessor :valor_tarifa
+      attr_accessor :outras_despesas
+      attr_accessor :juros_desconto
+      attr_accessor :iof_desconto
+      attr_accessor :valor_abatimento
+      attr_accessor :desconto_concedito
+      attr_accessor :valor_recebido
+      attr_accessor :juros_mora
+      attr_accessor :outros_recebimento
+      attr_accessor :abatimento_nao_aproveitado
+      attr_accessor :valor_lancamento
+      attr_accessor :indicativo_lancamento
+      attr_accessor :indicador_valor
+      attr_accessor :valor_ajuste
+      attr_accessor :sequencial
+      attr_accessor :arquivo
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+require 'parseline'
+
+module Bbrcobranca
+  module Retorno
+    module Cnab240
+      class Base < Bbrcobranca::Retorno::Base
+
+        # Load lines
+        def self.load_lines(file, options={})
+          return nil if file.blank?
+
+          codigo_banco = codigo_banco_do_arquivo(file)
+
+          case codigo_banco
+          when "033"
+            Bbrcobranca::Retorno::Cnab240::Santander.load_lines(file, options)
+          when "085"
+            Bbrcobranca::Retorno::Cnab240::Cecred.load_lines(file, options)
+          when "748"
+            Bbrcobranca::Retorno::Cnab240::Sicredi.load_lines(file, options)
+          when "756"
+            Bbrcobranca::Retorno::Cnab240::Sicoob.load_lines(file, options)
+          else
+            Bbrcobranca::Retorno::RetornoCnab240.load_lines(file, options)
+          end
+        end
+
+        # Codigo do banco lido do arquivo.
+        # Registro Header [0..2]
+        def self.codigo_banco_do_arquivo(file)
+          arquivo = File.open(file)
+          header = arquivo.gets
+          codigo_banco = header.blank? ? nil : header[0..2]
+          arquivo.close
+          codigo_banco
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+#
+
+module Bbrcobranca
+  module Retorno
+    module Cnab240
+      # Formato de Retorno CNAB 240
+      # Baseado em: http://www.caixa.gov.br/downloads/cobranca-caixa-manuais/LEIAUTE_CNAB_240_SIGCB_COBRANCA_CAIXA.pdf
+      class Caixa < Bbrcobranca::Retorno::RetornoCnab240
+        class Line < Bbrcobranca::Retorno::RetornoCnab240::Line
+          # Fixed width layout for Caixa
+          fixed_width_layout do |parse|
+            # REGISTRO_T_FIELDS
+            # Not applicable
+            # :cedente_com_dv
+
+            # Same inherited from parent
+            # parse.field :data_vencimento, 73..80
+            # parse.field :valor_titulo, 81..95
+            # parse.field :banco_recebedor, 96..98
+            # parse.field :sequencial, 8..12
+            # parse.field :valor_tarifa, 198..212
+            # parse.field :agencia_com_dv, 17..22
+
+            parse.field :codigo_ocorrencia, 15..16
+            parse.field :nosso_numero, 39..55
+            parse.field :agencia_recebedora_com_dv, 99..103
+            parse.field :motivo_ocorrencia, 213..222, ->(motivos) do
+              motivos.scan(/.{2}/).reject(&:blank?).reject{|motivo| motivo == '00'}
+            end
+
+            # REGISTRO_U_FIELDS
+
+            # Same inherited from parent
+            # parse.field :desconto_concedito, 32..46
+            # parse.field :valor_abatimento, 47..61
+            # parse.field :iof_desconto, 62..76
+            # parse.field :juros_mora, 17..31
+            # parse.field :valor_recebido, 77..91
+            # parse.field :outras_despesas, 107..121
+            # parse.field :outros_recebimento, 122..136
+            # parse.field :data_credito, 145..152
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bbrcobranca/retorno/cnab240/cecred.rb

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+
+require 'parseline'
+
+module Bbrcobranca
+  module Retorno
+    module Cnab240
+      class Cecred < Bbrcobranca::Retorno::Cnab240::Base
+        # Regex para remoção de headers e trailers além de registros diferentes de T ou U
+        REGEX_DE_EXCLUSAO_DE_REGISTROS_NAO_T_OU_U = /^((?!^.{7}3.{5}[T|U].*$).)*$/
+
+        def self.load_lines(file, options = {})
+          default_options = { except: REGEX_DE_EXCLUSAO_DE_REGISTROS_NAO_T_OU_U }
+          options = default_options.merge!(options)
+
+          Line.load_lines(file, options).each_slice(2).reduce([]) do |retornos, cnab_lines|
+            retornos << generate_retorno_based_on_cnab_lines(cnab_lines)
+          end
+        end
+
+        def self.generate_retorno_based_on_cnab_lines(cnab_lines)
+          retorno = new
+          cnab_lines.each do |line|
+            if line.tipo_registro == 'T'
+              Line::REGISTRO_T_FIELDS.each do |attr|
+                retorno.send(attr + '=', line.send(attr))
+              end
+            else
+              Line::REGISTRO_U_FIELDS.each do |attr|
+                retorno.send(attr + '=', line.send(attr))
+              end
+            end
+          end
+          retorno
+        end
+
+        # Linha de mapeamento do retorno do arquivo CNAB 240
+        # O registro CNAB 240 possui 2 tipos de registros que juntos geram um registro de retorno bancário
+        # O primeiro é do tipo T que retorna dados gerais sobre a transação
+        # O segundo é do tipo U que retorna os valores da transação
+        class Line < Base
+          extend ParseLine::FixedWidth # Extendendo parseline
+
+          REGISTRO_T_FIELDS = %w(codigo_registro codigo_ocorrencia agencia_com_dv cedente_com_dv nosso_numero carteira data_vencimento valor_titulo banco_recebedor agencia_recebedora_com_dv sequencial valor_tarifa motivo_ocorrencia)
+          REGISTRO_U_FIELDS = %w(desconto_concedito valor_abatimento iof_desconto juros_mora valor_recebido outras_despesas outros_recebimento data_credito data_ocorrencia)
+
+          attr_accessor :tipo_registro
+
+          fixed_width_layout do |parse|
+            # Segmento T
+            parse.field :codigo_registro, 7..7
+            parse.field :sequencial, 8..12
+            parse.field :tipo_registro, 13..13
+            parse.field :codigo_ocorrencia, 15..16
+            parse.field :agencia_com_dv, 17..22
+            parse.field :cedente_com_dv, 23..35
+            parse.field :nosso_numero, 37..56
+            parse.field :carteira, 57..57
+            parse.field :data_vencimento, 73..80
+            parse.field :valor_titulo, 81..95
+            parse.field :banco_recebedor, 96..98
+            parse.field :agencia_recebedora_com_dv, 99..104
+            parse.field :valor_tarifa, 198..212
+            parse.field :motivo_ocorrencia, 213..222, ->(motivos) do
+              motivos.scan(/.{2}/).reject(&:blank?).reject{|motivo| motivo == '00'}
+            end
+
+            # Segmento U
+            parse.field :data_ocorrencia, 137..144
+            parse.field :data_credito, 145..152
+            parse.field :outras_despesas, 107..121
+            parse.field :iof_desconto, 62..76
+            parse.field :valor_abatimento, 47..61
+            parse.field :desconto_concedito, 32..46
+            parse.field :valor_recebido, 77..91
+            parse.field :juros_mora, 17..31
+            parse.field :outros_recebimento, 122..136
+
+            # Dados que não consegui extrair dos registros T e U
+            # parse.field :convenio,31..37
+            # parse.field :tipo_cobranca,80..80
+            # parse.field :tipo_cobranca_anterior,81..81
+            # parse.field :natureza_recebimento,86..87
+            # parse.field :carteira_variacao,91..93
+            # parse.field :desconto,95..99
+            # parse.field :iof,100..104
+            # parse.field :comando,108..109
+            # parse.field :data_liquidacao,110..115
+            # parse.field :especie_documento,173..174
+            # parse.field :valor_tarifa,181..187
+            # parse.field :juros_desconto,201..213
+            # parse.field :abatimento_nao_aproveitado,292..304
+            # parse.field :valor_lancamento,305..317
+            # parse.field :indicativo_lancamento,318..318
+            # parse.field :indicador_valor,319..319
+            # parse.field :valor_ajuste,320..331
+          end
+        end
+      end
+    end
+  end
+end