boleto_bancario 0.0.2 → 1.0.0

data/Planning.markdown

@@ -1,63 +0,0 @@
-# BoletoBancario
-
-Emissão de Boletos Bancários em Ruby. Simples, fácil e principalmente, flexível.
-
-## Formatos
-
-* TODO: Essa parte ainda pode mudar até a versão 0.0.1.
-
-Colocar na classe:
-
-```ruby
-  class BoletoItau < BoletoBancario::Itau
-    respond_to :html, :pdf, :png
-  end
-```
-
-Para renderizar o html:
-
-```ruby
-   itau = BoletoItau.new
-
-   itau.respond_with # Irá chamar o método render da instância do objeto passado no método format.
-
-   itau.respond_with(:pdf)
-```
-
-### Criando um novo Formato
-
-Em relação a parte de formatos a gem de boleto bancário é extremamente flexível.
-
-Basta criar um objeto que responda ao método **render**:
-
-```ruby
-   module BoletoBancario
-     module Formato
-       class Html < Boleto
-         def render(*args)
-         end
-       end
-     end
-   end
-```
-
-```ruby
-   module BoletoBancario
-     module Formato
-       class Pdf < Boleto
-         def render(*args)
-         end
-       end
-     end
-   end
-```
-
-## Contribuições
-
-Seja um contribuidor. Você pode contribuir de N formas. Seguem elas:
-
-* Homologando boletos junto ao banco.
-* Fornecendo documentações mais atualizadas dos Bancos.
-* Escrevendo novos formatos (PDF, PNG), e me avisando para divulgar no Readme.
-* Refatorando código!!
-* Fornecendo Feedback construtivo! (Sempre bem vindo!)

data/Rakefile

@@ -1,15 +0,0 @@
-# encoding: utf-8
-require 'bundler/gem_tasks'
-require 'yard'
-require 'rspec/core/rake_task'
-
-task :default => :spec
-
-desc 'Running Tests'
-RSpec::Core::RakeTask.new(:spec)
-
-desc 'Generate documentation'
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', '-', 'LICENSE']
-  t.options = ['--main', 'README.markdown', '--no-private', '--title', "Boleto Bancário #{BoletoBancario::VERSION}"]
-end

data/TODO.markdown

@@ -1,19 +0,0 @@
-# Road to 1.0.0
-
-## Código de barras
-
-* Colocar a gem barby para gerar a imagem do código de barras.
-
-## Layout
-
-* Verificar a questão dos formatos (html, pdf, png).
-
-# Outros
-
-* Logo dos bancos.
-* Formatacao documento (CPF/CNPJ).
-* Colocar exemplos melhores na documentação de cada banco.
-* Nos exemplos de cada banco colocar os métodos que são chamados pelo objeto.
-* Verificar as validações e suas mensagens de erro.
-* Internacionalização / Locales.
-* Criar páginas explicando cada banco.

data/boleto_bancario.gemspec

@@ -1,29 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/boleto_bancario/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Tomas D'Stefano"]
-  gem.email         = ["tomas_stefano@successoft.com"]
-  gem.description   = %q{Emissão de Boletos Bancários em Ruby}
-  gem.summary       = %q{Emissão de Boletos Bancários em Ruby}
-  gem.homepage      = "https://github.com/tomas-stefano/boleto_bancario"
-
-  gem.files         = `git ls-files`.split($\).reject { |f| File.extname(f) == '.pdf' }
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "boleto_bancario"
-  gem.require_paths = ["lib"]
-  gem.version       = BoletoBancario::VERSION
-
-  gem.add_dependency "rake"
-  gem.add_dependency "activesupport", "~> 4.1"
-  gem.add_dependency "activemodel", "~> 4.1"
-  gem.add_dependency "barby"
-
-  gem.add_development_dependency "rspec", "~> 2.13"
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "valid_attribute", "~> 1.3"
-  gem.add_development_dependency "pry", "~> 0.9"
-  gem.add_development_dependency "simplecov", "~> 0.2"
-  gem.add_development_dependency "simplecov-html", "~> 0.7"
-end

data/lib/boleto_bancario/core/hsbc.rb

@@ -1,170 +0,0 @@
-# encoding: utf-8
-module BoletoBancario
-  module Core
-    # Implementação de emissão de boleto bancário pelo Banco HSBC.
-    #
-    # === Documentação Implementada
-    #
-    # A documentação na qual essa implementação foi baseada está localizada na pasta
-    # 'documentacoes_dos_boletos/hsbc' dentro dessa biblioteca.
-    #
-    # === Carteiras
-    #      ______________________________________________
-    #     | Carteira | Descrição               | Produto |
-    #     |    CNR   | Cobrança não Registrada |    2    |
-    #     |______________________________________________|
-    #
-    class Hsbc < Boleto
-      # Tamanho máximo do código do cedente emitido no Boleto.
-      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
-      #
-      # @return [Fixnum] 7
-      #
-      def self.tamanho_maximo_codigo_cedente
-        7
-      end
-
-      # Tamanho máximo do número do documento emitido no Boleto.
-      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
-      #
-      # @return [Fixnum] 13
-      #
-      def self.tamanho_maximo_numero_documento
-        13
-      end
-
-      # <b>Carteiras suportadas.</b>
-      # <b>Método criado para validar se a carteira informada é suportada.</b>
-      #
-      # @return [Array]
-      #
-      def self.carteiras_suportadas
-        %w[CNR]
-      end
-
-      # Validações para os campos abaixo:
-      #
-      # * Conta Corrente
-      # * Número do documento
-      #
-      # Se você quiser sobrescrever os metodos, <b>ficará a sua responsabilidade.</b>
-      # Basta você sobrescrever os métodos de validação:
-      #
-      #    class Hsbc < BoletoBancario::Core::Hsbc
-      #       def self.tamanho_maximo_codigo_cedente
-      #         5
-      #       end
-      #
-      #       def self.tamanho_maximo_numero_documento
-      #         10
-      #       end
-      #    end
-      #
-      # Obs.: Mudar as regras de validação podem influenciar na emissão do boleto em si.
-      # Talvez você precise analisar o efeito no #codigo_de_barras e na #linha_digitável (ambos podem ser
-      # sobreescritos também).
-      #
-      validates :codigo_cedente, presence: true
-
-      validates :codigo_cedente,   length: { maximum: tamanho_maximo_codigo_cedente   }, if: :deve_validar_codigo_cedente?
-      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
-
-      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
-
-      # @return [String] 7 caracteres
-      #
-      def codigo_cedente
-        @codigo_cedente.to_s.rjust(7, '0') if @codigo_cedente.present?
-      end
-
-      # @return [String] 13 caracteres
-      #
-      def numero_documento
-        @numero_documento.to_s.rjust(13, '0') if @numero_documento.present?
-      end
-
-      def produto
-        '2'
-      end
-
-      # @return [String] Código do Banco descrito na documentação.
-      #
-      def codigo_banco
-        '399'
-      end
-
-      # @return [String] Não possui dígito do código do banco.
-      #
-      def digito_codigo_banco
-        '9'
-      end
-
-      # Campo Agência / Código do Cedente
-      #
-      # @return [String]
-      #
-      def agencia_codigo_cedente
-        "#{codigo_cedente}"
-      end
-
-      # Nosso numero calculado pelo Tipo Identificador 4 descrito na documentação
-      #
-      # @return [String]
-      #
-      def nosso_numero
-        "#{numero_documento}#{nosso_numero_dv_1}#{tipo_identificador}#{nosso_numero_dv_2}"
-      end
-
-      def nosso_numero_dv_1
-        Modulo11FatorDe9a2.new(numero_documento)
-      end
-
-      def tipo_identificador
-        4
-      end
-
-      def nosso_numero_dv_2
-        soma = "#{numero_documento}#{nosso_numero_dv_1}#{tipo_identificador}".to_i
-        soma += codigo_cedente.to_i
-        soma += data_vencimento_para_calculo.to_i
-
-        Modulo11FatorDe9a2.new(soma)
-      end
-
-      # Data do vencimento para ser usada no calculo do segundto dígito identificador do nosso numero
-      #
-      # Exemplo: 18/03/2015 => 180315
-      #
-      # @return [String]
-      #
-      def data_vencimento_para_calculo
-        @data_vencimento.strftime('%d%m%y') if @data_vencimento.present?
-      end
-
-      #  === Código de barras do banco
-      #
-      #     _______________________________________________________________________________________
-      #    | Posição  | Tamanho | Descrição                                                        |
-      #    |----------|---------|------------------------------------------------------------------|
-      #    | 20 - 26  |   07    | Código do Cedente                                                |
-      #    | 27 - 39  |   13    | Código do Documento                                              |
-      #    | 40 - 43  |   04    | Data de Vencimento no Formato Juliano.                           |
-      #    | 44 – 44  |   01    | Código do Produto CNR, número 2.                                 |
-      #    |_______________________________________________________________________________________|
-      #
-      # @return [String]
-      #
-      def codigo_de_barras_do_banco
-        "#{codigo_cedente}#{numero_documento}#{data_vencimento_formato_juliano}#{produto}"
-      end
-
-      # Data do vencimento no formato Juliano composta por 4 dígitos
-      #
-      # @return [String]
-      #
-      def data_vencimento_formato_juliano
-        "#{@data_vencimento.yday.to_s.rjust(3, '0')}#{@data_vencimento.year.to_s.last}" if @data_vencimento.present?
-      end
-    end
-  end
-end

data/lib/boleto_bancario/core/real.rb

@@ -1,177 +0,0 @@
-# encoding: utf-8
-module BoletoBancario
-  module Core
-    # Implementação de emissão de boleto bancário pelo Banco Real.
-    #
-    # === Documentação Implementada
-    #
-    # A documentação na qual essa implementação foi baseada está localizada na pasta
-    # 'documentacoes_dos_boletos/real' dentro dessa biblioteca.
-    #
-    # Cobrança sem registro:
-    #   Nosso número: 13 dígitos
-    #   Código da Agência: 4 dígitos
-    #   Número da Conta: 7 dígitos
-    #
-    # === Código da Carteira
-    #
-    #   '00' - Carteira do convênio
-    #   '20' - Cobrança Simples
-    #   '31' - Cobrança Câmbio
-    #   '42' - Cobrança Caucionada
-    #   '47' - Cobr. Caucionada Crédito Imobiliário
-    #   '85' - Cobrança Partilhada
-    #
-    class Real < Boleto
-      # Tamanho máximo de uma agência no Banco Real.
-      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
-      #
-      # @return [Fixnum] 4
-      #
-      def self.tamanho_maximo_agencia
-        4
-      end
-
-      # Tamanho máximo da conta corrente no Boleto.
-      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
-      #
-      # @return [Fixnum] 7
-      #
-      def self.tamanho_maximo_conta_corrente
-        7
-      end
-
-      # Tamanho máximo do numero do documento no Boleto.
-      # <b>Método criado justamente para ficar documentado o tamanho máximo aceito até a data corrente.</b>
-      #
-      # @return [Fixnum] 13
-      #
-      def self.tamanho_maximo_numero_documento
-        13
-      end
-
-      # <b>Carteiras suportadas.</b>
-      #
-      # <b>Método criado para validar se a carteira informada é suportada.</b>
-      #
-      # @return [Array]
-      #
-      def self.carteiras_suportadas
-        %w[00 20 31 42 47 85]
-      end
-
-      # Validações para os campos abaixo:
-      #
-      # * Agencia
-      # * Conta Corrente
-      # * Número do documento
-      #
-      # Se você quiser sobrescrever os metodos, <b>ficará a sua responsabilidade.</b>
-      # Basta você sobrescrever os métodos de validação:
-      #
-      #    class Real < BoletoBancario::Core::Real
-      #       def self.tamanho_maximo_agencia
-      #         6
-      #       end
-      #
-      #       def self.tamanho_maximo_conta_corrente
-      #         9
-      #       end
-      #
-      #       def self.tamanho_maximo_numero_documento
-      #         10
-      #       end
-      #    end
-      #
-      # Obs.: Mudar as regras de validação podem influenciar na emissão do boleto em si.
-      # Talvez você precise analisar o efeito no #codigo_de_barras e na #linha_digitável (ambos podem ser
-      # sobreescritos também).
-      #
-      validates :agencia, :conta_corrente, presence: true
-
-      validates :agencia,          length: { maximum: tamanho_maximo_agencia          }, if: :deve_validar_agencia?
-      validates :conta_corrente,   length: { maximum: tamanho_maximo_conta_corrente   }, if: :deve_validar_conta_corrente?
-      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
-
-      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
-
-      # @return [String] 4 caracteres
-      #
-      def agencia
-        @agencia.to_s.rjust(4, '0') if @agencia.present?
-      end
-
-      # @return [String] 7 caracteres
-      #
-      def conta_corrente
-        @conta_corrente.to_s.rjust(7, '0') if @conta_corrente.present?
-      end
-
-      # @return [String] 13 caracteres
-      #
-      def numero_documento
-        @numero_documento.to_s.rjust(13, '0') if @numero_documento.present?
-      end
-
-      # @return [String] 2 caracteres
-      #
-      def carteira
-        @carteira.to_s.rjust(2, '0') if @carteira.present?
-      end
-
-      # @return [String] Código do Banco descrito na documentação.
-      #
-      def codigo_banco
-        '356'
-      end
-
-      # @return [String] Dígito do código do banco descrito na documentação.
-      #
-      def digito_codigo_banco
-        '5'
-      end
-
-      # Campo Agência/Código Cedente
-      #
-      # @return [String] Campo descrito na documentação.
-      #
-      def agencia_codigo_cedente
-        "#{agencia}/#{conta_corrente}/#{cobranca_dv}"
-      end
-
-      # Cálculo do Digito verificador da Cobrança
-      #   Nosso Número + Agência + Conta Corrente
-      #   Calculado atravez do modulo 10
-      #
-      # @return [String]
-      #
-      def cobranca_dv
-        Modulo10.new("#{nosso_numero}#{agencia}#{conta_corrente}")
-      end
-
-      # O nosso numero é o mesmo numero que o cliente informa para o numero do documento
-      #
-      # @return [String]
-      #
-      def nosso_numero
-        "#{numero_documento}"
-      end
-
-      #  === Código de barras do banco
-      #     ____________________________________________________
-      #    | Posição | Tamanho | Descrição                      |
-      #    |---------|---------|--------------------------------|
-      #    | 20 – 23 |   04    | Agencia                        |
-      #    | 24 – 30 |   07    | Conta corrente                 |
-      #    | 31 – 31 |   01    | Digito verificador da cobrança |
-      #    | 32 – 44 |   13    | Nosso numero                   |
-      #    |____________________________________________________|
-      #
-      # @return [String]
-      #
-      def codigo_de_barras_do_banco
-        "#{agencia}#{conta_corrente}#{cobranca_dv}#{nosso_numero}"
-      end
-    end
-  end
-end

data/spec/boleto_bancario/calculos/digitos_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-module BoletoBancario
-  module Calculos
-    describe Digitos do
-      (0..9).each do |number|
-        it "should return self when is #{number}" do
-          Digitos.new(number).sum.should eq number
-        end
-      end
-
-      { 11 => 2, '18' => 9, 99 => 18, '58' => 13, 112 => 4, '235' => 10 }.each do |number, expecting|
-        it "should sum the sum of the digits when is '#{number}', expecting to be '#{expecting}'" do
-          Digitos.new(number).sum.should eq expecting
-        end
-      end
-    end
-  end
-end

data/spec/boleto_bancario/calculos/fator_vencimento_spec.rb

@@ -1,59 +0,0 @@
-require 'spec_helper'
-
-module BoletoBancario
-  module Calculos
-    describe FatorVencimento do
-      describe "#base_date" do
-        it "should be 1997-10-07" do
-          FatorVencimento.new(Date.parse("2012-02-01")).base_date.should eq Date.new(1997, 10, 7)
-        end
-      end
-
-      describe "#calculate" do
-        it 'should return an empty string when passing nil value' do
-          FatorVencimento.new(nil).should eq ''
-        end
-
-        it 'should return an empty string when passing empty value' do
-          FatorVencimento.new('').should eq ''
-        end
-
-        it "should calculate the days between expiration date and base date" do
-          FatorVencimento.new(Date.parse("2012-12-2")).should eq "5535"
-        end
-
-        it "should calculate equal to itau documentation example" do
-          FatorVencimento.new(Date.parse("2000-07-04")).should eq "1001"
-        end
-
-        it "should calculate equal to itau documentation last section of the docs" do
-          FatorVencimento.new(Date.parse("2002-05-01")).should eq "1667"
-        end
-
-        it "should calculate to the maximum date equal to itau documentation example" do
-          FatorVencimento.new(Date.parse("2025-02-21")).should eq "9999"
-        end
-
-        it "should calculate the days between expiration date one year ago" do
-          FatorVencimento.new(Date.parse("2011-05-25")).should eq "4978"
-        end
-
-        it "should calculate the days between expiration date two years ago" do
-          FatorVencimento.new(Date.parse("2010-10-02")).should eq "4743"
-        end
-
-        it "should calculate the days between expiration date one year from now" do
-          FatorVencimento.new(Date.parse("2013-02-01")).should eq "5596"
-        end
-
-        it "should calculate the days between expiration date eigth years from now" do
-          FatorVencimento.new(Date.parse("2020-02-01")).should eq "8152"
-        end
-
-        it "should calculate the days between expiration date formating with 4 digits" do
-          FatorVencimento.new(Date.parse("1997-10-08")).should eq "0001"
-        end
-      end
-    end
-  end
-end

data/spec/boleto_bancario/calculos/fatores_de_multiplicacao_spec.rb

@@ -1,69 +0,0 @@
-require 'spec_helper'
-
-module BoletoBancario
-  module Calculos
-    describe FatoresDeMultiplicacao do
-      context 'with factors of 2 and 1' do
-        let(:factors) { [2, 1] }
-
-        context 'with one digit' do
-          subject { FatoresDeMultiplicacao.new(1, fatores: factors) }
-
-          it { should eq [2] }
-        end
-
-        context 'with four digits' do
-          subject { FatoresDeMultiplicacao.new(1234, fatores: factors) }
-
-          it { should eq [1, 4, 3, 8] }
-        end
-
-        context 'with five digits' do
-          subject { FatoresDeMultiplicacao.new(11385, fatores: factors) }
-
-          it { should eq [2, 1, 6, 8, 10] }
-        end
-
-        context 'with ten digits' do
-          subject { FatoresDeMultiplicacao.new(1234567890, fatores: factors) }
-
-          it { should eq [1, 4, 3, 8, 5, 12, 7, 16, 9, 0] }
-        end
-      end
-
-      context 'with factors of 2..9' do
-        let(:factors) { (2..9).to_a }
-
-        context 'with one digit' do
-          subject { FatoresDeMultiplicacao.new(4, fatores: factors) }
-
-          it { should eq [8] }
-        end
-
-        context 'with four digits' do
-          subject { FatoresDeMultiplicacao.new(1864, fatores: factors) }
-
-          it { should eq [ 5, 32, 18, 8] }
-        end
-
-        context 'with ten digits' do
-          subject { FatoresDeMultiplicacao.new(1234567890, fatores: factors) }
-        end
-
-        context 'with bradesco documentation example' do
-          let(:bradesco_example) { '9999101200000350007772130530150081897500000' }
-          subject { FatoresDeMultiplicacao.new(bradesco_example, fatores: factors) }
-
-          it { should eq [36, 27, 18, 81, 8, 0, 6, 10, 0, 0, 0, 0, 0, 21, 30, 0, 0, 0, 14, 63, 56, 14, 6, 15, 0, 15, 6, 0, 8, 35, 0, 0, 32, 3, 16, 81, 56, 35, 0, 0, 0, 0, 0] }
-        end
-
-        context 'with itau documentation example' do
-          let(:itau_example) { '3419166700000123451101234567880057123457000' }
-          subject { FatoresDeMultiplicacao.new(itau_example, fatores: factors) }
-
-          it { should eq [12, 12, 2, 81, 8, 42, 36, 35, 0, 0, 0, 0, 0, 7, 12, 15, 16, 15, 2, 9, 0, 7, 12, 15, 16, 15, 12, 63, 64, 56, 0, 0, 20, 21, 2, 18, 24, 28, 30, 35, 0, 0, 0] }
-        end
-      end
-    end
-  end
-end

data/spec/boleto_bancario/calculos/linha_digitavel_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-module BoletoBancario
-  module Calculos
-    describe LinhaDigitavel do
-      context "using the Itau documentation example" do
-        subject { LinhaDigitavel.new('34196166700000123451091234567880057123457000') }
-
-        it { should eq '34191.09123 34567.880058 71234.570001 6 16670000012345' }
-      end
-
-      context "using the Bradesco documentation example" do
-        subject { LinhaDigitavel.new('99991101200000350007772130530150081897500000') }
-
-        it { should eq '99997.77213 30530.150082 18975.000003 1 10120000035000' }
-      end
-
-      context "using the HSBC documentation example" do
-        subject { LinhaDigitavel.new('39998100100000311551111122222500546666666001') }
-
-        it { should eq '39991.11119 22222.500542 66666.660015 8 10010000031155' }
-      end
-
-      context "using the Caixa documentation example" do
-        subject { LinhaDigitavel.new('10491107400000160000001100128701000901200200') }
-
-        it { should eq '10490.00118 00128.701000 09012.002003 1 10740000016000' }
-      end
-
-      describe "when 'codigo_de_barras' invalid" do
-        context "when is empty" do
-          subject { LinhaDigitavel.new('') }
-
-          it { should eq '' }
-        end
-
-        context "when nil" do
-          subject { LinhaDigitavel.new(nil) }
-
-          it { should eq '' }
-        end
-
-        context "when have less than 44 positions" do
-          subject { LinhaDigitavel.new('121212121') }
-
-          it { should eq '' }
-        end
-
-        context "when have more than 44 positions" do
-          subject { LinhaDigitavel.new('12345678901234567890123456789012345678901234567890') }
-
-          it { should eq '' }
-        end
-      end
-    end
-  end
-end