brcobranca 2.0.6 → 3.0.0

data/lib/brcobranca/formatacao.rb

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+# @author Kivanio Barbosa
+module Brcobranca
+  # Métodos auxiliares de formatação
+  module Formatacao
+    # Formata como CPF
+    #
+    # @return [String]
+    # @example
+    #  "12345678901".to_br_cpf #=> 123.456.789-01
+    def to_br_cpf
+      self.to_s.gsub(/^(.{3})(.{3})(.{3})(.{2})$/,'\1.\2.\3-\4')
+    end
+
+    # Formata como CEP
+    #
+    # @return [String]
+    # @example
+    #   "85253100".to_br_cep #=> "85253-100"
+    #   85253100.to_br_cep #=> "85253-100"
+    def to_br_cep
+      self.to_s.gsub(/^(.{5})(.{3})$/,'\1-\2')
+    end
+
+    # Formata como CNPJ
+    #
+    # @return [String]
+    # @example
+    #  "12345678000901".to_br_cnpj #=> 12.345.678/0009-01
+    def to_br_cnpj
+      self.to_s.gsub(/^(.{2})(.{3})(.{3})(.{4})(.{2})$/,'\1.\2.\3/\4-\5')
+    end
+
+    # Gera formatação automática do documento baseado no tamanho do campo.
+    #
+    # @return [String] Retorna a mesma caso não encontre o formato adequado.
+    # @example
+    #  "12345678000901".formata_documento #=> 12.345.678/0009-01
+    #  "85253100".formata_documento #=> "85253-100"
+    #  "12345678901".formata_documento #=> 123.456.789-01
+    #  "12345".formata_documento #=> 12345
+    def formata_documento
+      case self.to_s.size
+      when 8 then self.to_br_cep
+      when 11 then self.to_br_cpf
+      when 14 then self.to_br_cnpj
+      else
+        self
+      end
+    end
+
+    # Remove caracteres que não sejam numéricos.
+    #
+    # @return [String]
+    # @example
+    #   1a23e45+".somente_numeros #=> 12345
+    def somente_numeros
+      self.to_s.gsub(/\D/,'')
+    end
+
+    # Monta a linha digitável padrão para todos os bancos segundo a BACEN.
+    #
+    # A linha digitável será composta por cinco campos:<br/>
+    # <b>1º campo</b>: <br/>
+    # Composto pelo código de Banco, código da moeda, as cinco primeiras posições do campo livre
+    # e o dígito verificador deste campo.<br/>
+    # <b>2º campo</b>: <br/>
+    # Composto pelas posições 6ª a 15ª do campo livre e o dígito verificador deste campo.<br/>
+    # <b>3º campo</b>: <br/>
+    # Composto pelas posições 16ª a 25ª do campo livre e o dígito verificador deste campo.<br/>
+    # <b>4º campo</b>: <br/>
+    # Composto pelo dígito verificador do código de barras, ou seja, a 5ª posição do código de barras.<br/>
+    # <b>5º campo</b>: <br/>
+    # Composto pelo fator de vencimento com 4(quatro) caracteres e o valor do documento com
+    # 10(dez) caracteres, sem separadores e sem edição.<br/>
+    #
+    # @return [String]
+    # @raise  [ArgumentError] Caso não seja um número de 44 dígitos.
+    # @example
+    #  "00192376900000135000000001238798777770016818".linha_digitavel #=> "00190.00009 01238.798779 77700.168188 2 37690000013500"
+    def linha_digitavel
+      if self =~ /^(\d{4})(\d{1})(\d{14})(\d{5})(\d{10})(\d{10})$/
+        linha = $1
+        linha << $4
+        linha << linha.modulo10.to_s
+        linha << $5
+        linha << $5.modulo10.to_s
+        linha << $6
+        linha << $6.modulo10.to_s
+        linha << $2
+        linha << $3
+        linha.gsub(/^(.{5})(.{5})(.{5})(.{6})(.{5})(.{6})(.{1})(.{14})$/,'\1.\2 \3.\4 \5.\6 \7 \8')
+      else
+        raise ArgumentError, "#{self} Precisa conter 44 caracteres numéricos."
+      end
+    end
+  end
+end
+
+[ String, Numeric ].each do |klass|
+  klass.class_eval { include Brcobranca::Formatacao }
+end

data/lib/brcobranca/limpeza.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+module Brcobranca
+  module Limpeza
+    # Transforma Float em String preservando o zero a direita.
+    #
+    # @return [String]
+    # @example
+    #  1.9  #=> 190
+    #  1.93 #=> 193
+    def limpa_valor_moeda
+      inicio, fim = self.to_s.split(/\./)
+      (inicio + fim.ljust(2,'0'))
+    end
+  end
+end
+
+[ Float ].each do |klass|
+  klass.class_eval { include Brcobranca::Limpeza }
+end

data/lib/brcobranca/retorno/base.rb

@@ -1,7 +1,6 @@
 module Brcobranca
   module Retorno
-    class Base
-      # Agência com DV, posições 17 à 21
+    class Base # Classe base para retornos bancários
       attr_accessor :agencia_com_dv
       attr_accessor :cedente_com_dv
       attr_accessor :convenio

data/lib/brcobranca/retorno/retorno_cbr643.rb

@@ -1,44 +1,46 @@
 require 'parseline'
+module Brcobranca
+  module Retorno
+    # Formato de Retorno CNAB 643
+    class RetornoCbr643 < Base
+      extend ParseLine::FixedWidth # Extendendo parseline
 
-# Formato de Retorno CNAB 643
-class RetornoCbr643 < Brcobranca::Retorno::Base
-  # Extendendo parseline
-  extend ParseLine::FixedWidth
-  
-  fixed_width_layout do |parse|
-    parse.field :agencia_com_dv,17..21
-    parse.field :cedente_com_dv,22..30
-    parse.field :convenio,31..37
-    parse.field :nosso_numero,63..79
-    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 :carteira,106..107
-    parse.field :comando,108..109
-    parse.field :data_liquidacao,110..115
-    parse.field :data_vencimento,146..151
-    parse.field :valor_titulo,152..164
-    parse.field :banco_recebedor,165..167
-    parse.field :agencia_recebedora_com_dv,168..172
-    parse.field :especie_documento,173..174
-    parse.field :data_credito,175..180
-    parse.field :valor_tarifa,181..187
-    parse.field :outras_despesas,188..200
-    parse.field :juros_desconto,201..213
-    parse.field :iof_desconto,214..226
-    parse.field :valor_abatimento,227..239
-    parse.field :desconto_concedito,240..252
-    parse.field :valor_recebido,253..265
-    parse.field :juros_mora,266..278
-    parse.field :outros_recebimento,279..291
-    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
-    parse.field :sequencial,394..399
+      fixed_width_layout do |parse|
+        parse.field :agencia_com_dv,17..21
+        parse.field :cedente_com_dv,22..30
+        parse.field :convenio,31..37
+        parse.field :nosso_numero,63..79
+        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 :carteira,106..107
+        parse.field :comando,108..109
+        parse.field :data_liquidacao,110..115
+        parse.field :data_vencimento,146..151
+        parse.field :valor_titulo,152..164
+        parse.field :banco_recebedor,165..167
+        parse.field :agencia_recebedora_com_dv,168..172
+        parse.field :especie_documento,173..174
+        parse.field :data_credito,175..180
+        parse.field :valor_tarifa,181..187
+        parse.field :outras_despesas,188..200
+        parse.field :juros_desconto,201..213
+        parse.field :iof_desconto,214..226
+        parse.field :valor_abatimento,227..239
+        parse.field :desconto_concedito,240..252
+        parse.field :valor_recebido,253..265
+        parse.field :juros_mora,266..278
+        parse.field :outros_recebimento,279..291
+        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
+        parse.field :sequencial,394..399
+      end
+    end
   end
 end

data/lib/brcobranca/version.rb

@@ -0,0 +1,3 @@
+module Brcobranca
+  VERSION = "3.0.0"
+end

data/lib/brcobranca.rb

@@ -1,4 +1,10 @@
-$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# -*- encoding: utf-8 -*-
+$:.push File.join(File.dirname(__FILE__))
+require 'brcobranca/calculo'
+require 'brcobranca/limpeza'
+require 'brcobranca/formatacao'
+require 'brcobranca/calculo_data'
+require 'brcobranca/currency'
 
 begin
   require 'date'
@@ -8,28 +14,99 @@ rescue LoadError
   require 'date'
 end
 
-%w(core_ext currency config).each {|req| require File.join(File.dirname(__FILE__),"brcobranca",req) }
+begin
+  require 'active_model'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'active_model', ">= 3.0.0"
+  require 'active_model'
+end
+
 
-%w(base banco_brasil banco_itau banco_hsbc banco_real banco_bradesco banco_unibanco banco_banespa).each {|req| require File.join(File.dirname(__FILE__),"brcobranca","boleto",req) }
+module Brcobranca
+  # Exception lançada quando algum tipo de boleto soicitado ainda não tiver sido implementado.
+  class NaoImplementado < NotImplementedError
+  end
+
+  # Exception lançada quando os dados informados para o boleto estão inválidos.
+  #
+  # Você pode usar assim na sua aplicação:
+  #   rescue Brcobranca::BoletoInvalido => invalido
+  #   puts invalido.errors
+  class BoletoInvalido < StandardError
 
-%w(util rghost).each {|req| require File.join(File.dirname(__FILE__),"brcobranca","boleto","template",req) }
+    # Atribui o objeto boleto e pega seus erros de validação
+    def initialize(boleto)
+      errors = boleto.errors.full_messages.join(', ')
+      super(errors)
+    end
+  end
 
-%w(base retorno_cbr643).each {|req| require File.join(File.dirname(__FILE__),"brcobranca","retorno",req) }
+  # Configurações do Brcobranca.
+  #
+  # Para mudar as configurações padrão, você pode fazer assim:
+  # config/environments/test.rb:
+  #
+  #     Brcobranca.configure do |config|
+  #       config.formato = :gif
+  #     end
+  #
+  # Ou colocar em um arquivo na pasta initializer do rails.
+  class Configuration
+    # Gerador de arquivo de boleto.
+    # @return [Symbol]
+    # @param  [Symbol] (Padrão: :rghost)
+    attr_accessor :gerador
+    # Formato do arquivo de boleto a ser gerado.
+    # @return [Symbol]
+    # @param  [Symbol] (Padrão: :pdf)
+    # @see http://wiki.github.com/shairontoledo/rghost/supported-devices-drivers-and-formats Veja mais formatos na documentação do rghost.
+    attr_accessor :formato
 
-case Brcobranca::Config::OPCOES[:gerador]
-when 'rghost'
+    # Resolução em pixels do arquivo gerado.
+    # @return [Integer]
+    # @param  [Integer] (Padrão: 150)
+    attr_accessor :resolucao
 
-  module Brcobranca::Boleto
-    Base.class_eval do
-      include Brcobranca::Boleto::Template::Rghost
-      include Brcobranca::Boleto::Template::Util
+    # Atribui valores padrões de configuração
+    def initialize
+      self.gerador = :rghost
+      self.formato = :pdf
+      self.resolucao = 150
     end
   end
 
-else
-  "Configure o gerador na opção 'Brcobranca::Config::OPCOES[:gerador]' corretamente!!!"
-end
+  # Atribui os valores customizados para as configurações.
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
-module Brcobranca
-  VERSION = '2.0.6'
+  # Bloco para realizar configurações customizadas.
+  def self.setup
+    yield(configuration)
+  end
+
+  # Módulo para classes de boletos
+  module Boleto
+    autoload :Base,          'brcobranca/boleto/base'
+    autoload :BancoBrasil,   'brcobranca/boleto/banco_brasil'
+    autoload :Itau,          'brcobranca/boleto/itau'
+    autoload :Hsbc,          'brcobranca/boleto/hsbc'
+    autoload :Real,          'brcobranca/boleto/real'
+    autoload :Bradesco,      'brcobranca/boleto/bradesco'
+    autoload :Unibanco,      'brcobranca/boleto/unibanco'
+    autoload :Caixa,         'brcobranca/boleto/caixa'
+
+    # Módulos para classes de template
+    module Template
+      autoload :Base,   'brcobranca/boleto/template/base'
+      autoload :Rghost, 'brcobranca/boleto/template/rghost'
+    end
+  end
+
+  # Módulos para classes de retorno bancário
+  module Retorno
+    autoload :Base,           'brcobranca/retorno/base'
+    autoload :RetornoCbr643,  'brcobranca/retorno/retorno_cbr643'
+  end
 end

data/spec/brcobranca/banco_bradesco_spec.rb

@@ -1,6 +1,7 @@
+# -*- encoding: utf-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe BancoBradesco do  
+describe Brcobranca::Boleto::Bradesco do
   before(:each) do
     @valid_attributes = {
       :especie_documento => "DM",
@@ -22,8 +23,8 @@ describe BancoBradesco do
     }
   end
 
-  it "should create a new default instance" do
-    boleto_novo = BancoBradesco.new
+  it "Criar nova instancia com atributos padrões" do
+    boleto_novo = Brcobranca::Boleto::Bradesco.new
     boleto_novo.banco.should eql("237")
     boleto_novo.especie_documento.should eql("DM")
     boleto_novo.especie.should eql("R$")
@@ -37,11 +38,11 @@ describe BancoBradesco do
     boleto_novo.valor_documento.should eql(0.0)
     boleto_novo.local_pagamento.should eql("QUALQUER BANCO ATÉ O VENCIMENTO")
     boleto_novo.carteira.should eql("06")
-    boleto_novo.should be_instance_of(BancoBradesco)
+
   end
 
-  it "should create a new instance given valid attributes" do
-    boleto_novo = BancoBradesco.new(@valid_attributes)
+  it "Criar nova instancia com atributos válidos" do
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
     boleto_novo.banco.should eql("237")
     boleto_novo.especie_documento.should eql("DM")
     boleto_novo.especie.should eql("R$")
@@ -58,29 +59,28 @@ describe BancoBradesco do
     boleto_novo.documento_cedente.should eql("12345678912")
     boleto_novo.sacado.should eql("Claudio Pozzebom")
     boleto_novo.sacado_documento.should eql("12345678900")
-    boleto_novo.conta_corrente.should eql("61900")
+    boleto_novo.conta_corrente.should eql("0061900")
     boleto_novo.agencia.should eql("4042")
     boleto_novo.convenio.should eql(12387989)
-    boleto_novo.numero_documento.should eql("777700168")
+    boleto_novo.numero_documento.should eql("00777700168")
     boleto_novo.carteira.should eql("06")
-    boleto_novo.should be_instance_of(BancoBradesco)
   end
 
-  it "should mount codigo de barras para carteira numero 06" do
+  it "Montar código de barras para carteira número 06" do
     @valid_attributes[:valor] = 2952.95
     @valid_attributes[:data_documento] = Date.parse("2009-04-30")
     @valid_attributes[:dias_vencimento] = 0
     @valid_attributes[:numero_documento] = "75896452"
     @valid_attributes[:conta_corrente] = "0403005"
     @valid_attributes[:agencia] = "1172"
-    boleto_novo = BancoBradesco.new(@valid_attributes)
-    boleto_novo.should be_instance_of(BancoBradesco)
-    boleto_novo.monta_codigo_43_digitos.should eql("2379422300002952951172060007589645204030050")
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
+
+    boleto_novo.codigo_barras_segunda_parte.should eql("1172060007589645204030050")
     boleto_novo.codigo_barras.should eql("23795422300002952951172060007589645204030050")
-    boleto_novo.codigo_barras.linha_digitavel.should eql("23791.17209 60007.589645 52040.300502 5 42230000295295")    
+    boleto_novo.codigo_barras.linha_digitavel.should eql("23791.17209 60007.589645 52040.300502 5 42230000295295")
   end
 
-  it "should mount codigo de barras para carteira numero 03" do
+  it "Montar código de barras para carteira número 03" do
     @valid_attributes[:valor] = 135.00
     @valid_attributes[:dias_vencimento] = 1
     @valid_attributes[:data_documento] = Date.parse("2008-02-01")
@@ -88,36 +88,22 @@ describe BancoBradesco do
     @valid_attributes[:conta_corrente] = "61900"
     @valid_attributes[:agencia] = "4042"
     @valid_attributes[:carteira] = "03"
-    boleto_novo = BancoBradesco.new(@valid_attributes)
-    boleto_novo.should be_instance_of(BancoBradesco)
-    boleto_novo.monta_codigo_43_digitos.should eql("2379377000000135004042030077770016800619000")
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
+
+    boleto_novo.codigo_barras_segunda_parte.should eql("4042030077770016800619000")
     boleto_novo.codigo_barras.should eql("23791377000000135004042030077770016800619000")
     boleto_novo.codigo_barras.linha_digitavel.should eql("23794.04201 30077.770011 68006.190000 1 37700000013500")
   end
 
-  # TODO -  should give exception
-  it "should return nil when attributes are nil" do
-    @valid_attributes[:valor] = 0
-    @valid_attributes[:data_documento] = Date.parse("2008-02-01")
-    @valid_attributes[:dias_vencimento] = 0
-    @valid_attributes[:numero_documento] = ""
-    @valid_attributes[:banco] = ""
-    @valid_attributes[:carteira] = ""
-    @valid_attributes[:moeda] = ""
-    @valid_attributes[:convenio] = ""
-    @valid_attributes[:conta_corrente] = ""
-    @valid_attributes[:agencia] = ""
-    @valid_attributes[:carteira] = ""
-
-    boleto_novo = BancoBradesco.new(@valid_attributes)
-    boleto_novo.should be_instance_of(BancoBradesco)
-    boleto_novo.monta_codigo_43_digitos.should be_nil
-    boleto_novo.codigo_barras.should be_nil
+  it "Não permitir gerar boleto com atributos inválido" do
+    boleto_novo = Brcobranca::Boleto::Bradesco.new
+    lambda { boleto_novo.codigo_barras }.should raise_error(Brcobranca::BoletoInvalido)
+    boleto_novo.errors.count.should eql(3)
   end
 
-  it "should mount nosso_numero_boleto" do
-    boleto_novo = BancoBradesco.new(@valid_attributes)
-    boleto_novo.should be_instance_of(BancoBradesco)
+  it "Montar nosso_numero_boleto" do
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
+
     boleto_novo.numero_documento = "4042"
     boleto_novo.carteira = "06"
     boleto_novo.nosso_numero_boleto.should eql("06/00000004042-8")
@@ -144,28 +130,55 @@ describe BancoBradesco do
     boleto_novo.nosso_numero_dv.should eql(6)
   end
 
-  it "should mount agencia_conta_boleto" do
-    boleto_novo = BancoBradesco.new(@valid_attributes)
-    boleto_novo.should be_instance_of(BancoBradesco)
-    boleto_novo.agencia_conta_boleto.should eql("4042-8 / 61900-0")
+  it "Montar agencia_conta_boleto" do
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
+
+    boleto_novo.agencia_conta_boleto.should eql("4042-8 / 0061900-0")
     boleto_novo.agencia = "0719"
-    boleto_novo.agencia_conta_boleto.should eql("0719-6 / 61900-0")
+    boleto_novo.agencia_conta_boleto.should eql("0719-6 / 0061900-0")
     boleto_novo.agencia = "0548"
     boleto_novo.conta_corrente = "1448"
-    boleto_novo.agencia_conta_boleto.should eql("0548-7 / 1448-6")
+    boleto_novo.agencia_conta_boleto.should eql("0548-7 / 0001448-6")
   end
-  
-  it "should test outputs" do
+
+  it "Busca logotipo do banco" do
+    boleto_novo = Brcobranca::Boleto::Bradesco.new
+    File.exist?(boleto_novo.logotipo).should be_true
+    File.stat(boleto_novo.logotipo).zero?.should be_false
+  end
+
+  it "Gerar boleto nos formatos válidos com método to_" do
     @valid_attributes[:valor] = 2952.95
     @valid_attributes[:data_documento] = Date.parse("2009-04-30")
     @valid_attributes[:dias_vencimento] = 0
     @valid_attributes[:numero_documento] = "75896452"
     @valid_attributes[:conta_corrente] = "0403005"
     @valid_attributes[:agencia] = "1172"
-    boleto_novo = BancoBradesco.new(@valid_attributes)
-    boleto_novo.should be_instance_of(BancoBradesco)
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
+
+    %w| pdf jpg tif png ps |.each do |format|
+      file_body=boleto_novo.send("to_#{format}".to_sym)
+      tmp_file=Tempfile.new("foobar." << format)
+      tmp_file.puts file_body
+      tmp_file.close
+      File.exist?(tmp_file.path).should be_true
+      File.stat(tmp_file.path).zero?.should be_false
+      File.delete(tmp_file.path).should eql(1)
+      File.exist?(tmp_file.path).should be_false
+    end
+  end
+
+  it "Gerar boleto nos formatos válidos" do
+    @valid_attributes[:valor] = 2952.95
+    @valid_attributes[:data_documento] = Date.parse("2009-04-30")
+    @valid_attributes[:dias_vencimento] = 0
+    @valid_attributes[:numero_documento] = "75896452"
+    @valid_attributes[:conta_corrente] = "0403005"
+    @valid_attributes[:agencia] = "1172"
+    boleto_novo = Brcobranca::Boleto::Bradesco.new(@valid_attributes)
+
     %w| pdf jpg tif png ps |.each do |format|
-      file_body=boleto_novo.to(format.to_sym)
+      file_body=boleto_novo.to(format)
       tmp_file=Tempfile.new("foobar." << format)
       tmp_file.puts file_body
       tmp_file.close