br_boleto 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7779abe6dc0c653dd1e82299a4e9c89d2007e7c8
-  data.tar.gz: 95d6fe53fe8ffa6c007e682130176450df534c9b
+  metadata.gz: d16dbfe9183a80cf5104917582d4af59fe5aaf9e
+  data.tar.gz: 85abfe56bca98763364c99ba3e0e2eefc0c86f05
 SHA512:
-  metadata.gz: 035233e8e9c63da0579d77974df98b43cf9535bea8b184ff9ec94bcdfa865093bdffb3cbb766dd9b93a984fad0997e6c8da7fec02c3fb0afaf89eec915503bff
-  data.tar.gz: b38d7006eb7451b0a765e5d64d03466d33b4d484e12937aab3809a8a683531a0c3112c89bc5f69b9e2968430470885f48a62c0a75211239c0a4b041d16330004
+  metadata.gz: c6e8f71c47f86caf28d2e6ea49794a748995603985714d15ccfebaa8e9986a39a16f83d4cd6bb750f62321fc93fd69cd4db4b74ac2408161c229f09bc5cf9163
+  data.tar.gz: 359f97d528bbb8b6689c78acfbc033d043aa18328d85dd2e05794a320be1c790e7246a1cb307614fad3958f88701e13ddb6ecefc305af34bbb16503161ef35fc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile.lock

@@ -2,9 +2,9 @@ PATH
   remote: .
   specs:
     br_boleto (0.1.0)
-      activemodel (>= 4.1)
-      activesupport (>= 4.1)
-      rake
+      activemodel (~> 4.2)
+      activesupport (~> 4.2)
+      rake (>= 0.8.7)
 
 GEM
   remote: http://rubygems.org/

data/README.markdown

@@ -1,28 +1,33 @@
-# BrBoleto
+# **BrBoleto**
 
 Emissão de Boletos Bancários em Ruby.
 
+[![Code Climate](https://codeclimate.com/github/Brunomm/br_boleto/badges/gpa.svg)](https://codeclimate.com/github/Brunomm/br_boleto)
+[![Build Status](https://travis-ci.org/Brunomm/br_boleto.svg?branch=master)](https://travis-ci.org/Brunomm/br_boleto)
+[![security](https://hakiri.io/github/Brunomm/br_boleto/master.svg)](https://hakiri.io/github/Brunomm/br_boleto/master)
+
 ## Versão 1.0.0
+**O que essa gem faz?**
 
-Por enquanto esta gem apenas faz os cálculos para o banco sicoob.
+ 1. Boleto bancário para os bancos:
+- Sicoob (apenas os cálculos para o boleto, sem a interface)
+ 2. Arquivo de remessa para os Bancos:
+- Sicoob
 
 ## Alternativas
 
 Essa biblioteca é baseada em outras **ótimas** bibliotecas.
 **Recomendo analisar muito bem cada solução**:
 
-* Stella Caelum [http://stella.caelum.com.br/](http://stella.caelum.com.br/)
-* Novo Gateway de Pagamentos da Locaweb [http://www.locaweb.com.br/produtos/gateway-pagamento.html](http://www.locaweb.com.br/produtos/gateway-pagamento.html)
 * Brcobranca [https://github.com/kivanio/brcobranca](https://github.com/kivanio/brcobranca)
-* Boleto Php [http://boletophp.com.br/](http://boletophp.com.br/)
 * Gem de Boleto Bancário [https://github.com/tomas-stefano/boleto_bancario](https://github.com/tomas-stefano/boleto_bancario)
 
 ## Instalação
-**Manual**
+**Manualmente**
 
     gem install br_boleto
 
-**Instalação via Gemfile**
+**Gemfile**
     
      gem 'br_boleto'
 
@@ -37,27 +42,48 @@ Seguimos as documentações descritas abaixo:
 
 Para todos os bancos e carteiras implementadas, **seguimos as documentações** que estão dentro do repositório:
 
+**Boletos**
 <table>
   <tr>
     <th>Nome do Banco</th>
     <th>Carteiras Suportadas</th>
     <th>Testada/Homologada no banco</th>
+    <th>Autor </th>
   </tr>
   <tr>
     <td>Sicoob</td>
     <td>1, 3.</td>
-    <td>Emm andamento...</td>
+    <td>Homologado dia 03/08/2015</td>
+   <td>Bruno M. Mergen</td>
+  </tr>
+</table>
+
+
+----------
+
+
+**Arquivos de remessa**
+<table>
+  <tr>
+    <th>Nome do Banco</th>
+    <th>Testada/Homologada no banco</th>
+    <th>Autor </th>
+  </tr>
+  <tr>
+    <td>Sicoob</td>
+    <td>Homologado dia 07/08/2015</td>
+    <td>Bruno M. Mergen</td>
   </tr>
 </table>
 
-## Usage
+## Como usar
 
 Você pode usar as próprias classes da gem, porém, **recomendo criar uma subclasse** para os bancos que você gostaria de desenvolver.
 
 ### Exemplo
 
 ```ruby
-class BoletoSicoob < BrBoleto::Sicoob
+class BoletoSicoob < BrBoleto::Boleto::Sicoob
 end
 
 ```
@@ -132,12 +158,171 @@ Por exemplo, imagine que você quer sobrescrever a forma como é tratada a segun
 **Seguindo a interface da classe BrBoleto::Boleto** fica bem simples:
 
 ```ruby
-class BoletoSicoob < BrBoleto::Sicoob
+class BoletoSicoob < BrBoleto::Boleto::Sicoob
   def codigo_de_barras_do_banco
    # Sua implementação ...
   end
 end
 ```
+#**Arquivo de remessa**
+
+##**CNAB 240**
+Um arquivo de remessa é composto de UM ou VÁRIOS lotes (class BrBoleto::Remessa::Lote).
+Estes lotes são compostos de UM ou VÁRIOS pagamentos (class BrBoleto::Remessa::Pagamento).
+
+Por exemplo, você gerou 2 boletos, e precisa criar um arquivo de remessa para os mesmos. Deve ser criado(instanciado) 2 pagamentos(BrBoleto::Remessa::Pagamento) onde deverão ter os dados requeridos do pagamento de cada boleto. (pagamento 1 com dados do boleto 1 e pagamento 2  com os dados do boleto 2).
+Com isso, deve-se instanciar um lote passando os dois pagamentos instanciados. Esse lote você adiciona aos lotes da remessa e chama o método `dados_do_arquivo` do objeto de Remessa do banco referente.
+
+Exemplo:
+```ruby
+boleto_1 = BrBoleto::Boleto::Sicoob.new({
+  agencia:          3069,
+  codigo_cedente:   6532,
+  numero_documento: 10001,
+  carteira:         1,
+  valor_documento:  100.78,
+  data_vencimento:  Date.tomorrow,
+  conta_corrente:   '5679',
+  cedente:          'Cedente 1',
+  documento_cedente:'12345678901',
+  sacado:           'Sacado',
+  documento_sacado: '725.275.005-10',
+  endereco_sacado:  'Rua teste, 23045',
+  instrucoes1:      'Lembrar de algo 1',
+  instrucoes2:      'Lembrar de algo 2',
+  instrucoes3:      'Lembrar de algo 3',
+  instrucoes4:      'Lembrar de algo 4',
+  instrucoes5:      'Lembrar de algo 5',
+  instrucoes6:      'Lembrar de algo 6'
+})
+
+boleto_2 = BrBoleto::Boleto::Sicoob.new({
+  agencia:          3069,
+  codigo_cedente:   6532,
+  numero_documento: 10002,
+  carteira:         1,
+  valor_documento:  200.78,
+  data_vencimento:  Date.tomorrow,
+  conta_corrente:   '5679',
+  cedente:          'Cedente 2',
+  documento_cedente:'12345678901',
+  sacado:           'Sacado',
+  documento_sacado: '725.275.005-10',
+  endereco_sacado:  'Rua teste, 23045',
+  instrucoes1:      'Lembrar de algo 1',
+  instrucoes2:      'Lembrar de algo 2',
+  instrucoes3:      'Lembrar de algo 3',
+  instrucoes4:      'Lembrar de algo 4',
+  instrucoes5:      'Lembrar de algo 5',
+  instrucoes6:      'Lembrar de algo 6'
+})
+
+
+pagamento_1 = BrBoleto::Remessa::Pagamento.new({
+  nosso_numero:     boleto_1.nosso_numero,
+  data_vencimento:  boleto_1.data_vencimento,
+  valor_documento:  boleto_1.valor_documento,
+  documento_sacado: boleto_1.documento_sacado,
+  nome_sacado:      boleto_1.sacado,
+  endereco_sacado:  "R. TESTE DO SACADO",
+  cep_sacado:       "89888000",
+  cidade_sacado:    "PIRÁPORA",
+  uf_sacado:        "SC",
+  bairro_sacado:    "Bairro"
+})
+
+pagamento_2 = BrBoleto::Remessa::Pagamento.new({
+  nosso_numero:     boleto_2.nosso_numero,
+  data_vencimento:  boleto_2.data_vencimento,
+  valor_documento:  boleto_2.valor_documento,
+  documento_sacado: boleto_2.documento_sacado,
+  nome_sacado:      boleto_2.sacado,
+  endereco_sacado:  "R. TESTE DO SACADO",
+  cep_sacado:       "89888000",
+  cidade_sacado:    "PIRÁPORA",
+  uf_sacado:        "SC",
+  bairro_sacado:    "Bairro"
+})
+
+
+lote = BrBoleto::Remessa::Lote.new(pagamentos: [pagamento_1, pagamento_2])
+
+remessa = BrBoleto::Remessa::Cnab240::Sicoob.new({
+  lotes:               lote,
+  nome_empresa:        "Sacado",
+  agencia:             "3069",
+  conta_corrente:      "5679", # Sem DV
+  digito_conta:        "5",
+  carteira:            "1",
+  sequencial_remessa:  1,
+  documento_cedente:   '12345678901',
+  convenio:            '1',
+  emissao_boleto:      '2',
+  distribuicao_boleto: '2',
+  especie_titulo:      '02'
+})
+
+
+remessa.dados_do_arquivo
+```
+Com isso irá gerar uma string com os dados para o arquivo de remessa.
+Ele irá ficar no seguinte formato
+```
+HEADER_ARQUIVO
+  HEADER_LOTE
+    SEGMENTO_P # Do pagamento 1
+    SEGMENTO_Q # Do pagamento 1
+    SEGMENTO_R # Do pagamento 1
+    SEGMENTO_S # Do pagamento 1
+    SEGMENTO_P # Do pagamento 2
+    SEGMENTO_Q # Do pagamento 2
+    SEGMENTO_R # Do pagamento 2
+    SEGMENTO_S # Do pagamento 2
+  TRAILER_LOTE
+TRAILER_ARQUIVO
+```
+
+Está nesse formato pois somente assim consegui homologar junto ao banco.
+
+Mas se você deseja colocar o arquivo no formato:
+```
+HEADER_ARQUIVO
+  HEADER_LOTE # Do pagamento 1
+    SEGMENTO_P
+    SEGMENTO_Q
+    SEGMENTO_R
+    SEGMENTO_S
+  TRAILER_LOTE
+  HEADER_LOTE # Do pagamento 2
+    SEGMENTO_P 
+    SEGMENTO_Q 
+    SEGMENTO_R 
+    SEGMENTO_S 
+  TRAILER_LOTE
+TRAILER_ARQUIVO
+```
+basta criar um lote para cada pagamento. Exemplo:
+
+```ruby
+lotes = []
+lotes << BrBoleto::Remessa::Lote.new(pagamentos: pagamento_1)
+lotes << BrBoleto::Remessa::Lote.new(pagamentos: pagamento_2)
+
+remessa = BrBoleto::Remessa::Cnab240::Sicoob.new({
+  lotes:               lotes,
+  nome_empresa:        "Sacado",
+  agencia:             "3069",
+  conta_corrente:      "5679", # Sem DV
+  digito_conta:        "5",
+  carteira:            "1",
+  sequencial_remessa:  1,
+  documento_cedente:   '12345678901',
+  convenio:            '1',
+  emissao_boleto:      '2',
+  distribuicao_boleto: '2',
+  especie_titulo:      '02'
+})
+```
 
 ## Contribuições
 

data/Rakefile

@@ -4,5 +4,10 @@ Rake::TestTask.new do |task|
   task.libs << %w(test lib)
   task.pattern = 'test/**/*_test.rb'
 end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r br_boleto.rb"
+end
  
 task :default => :test

data/br_boleto.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |gem|
   gem.license       = "BSD"
 
   gem.files         = `git ls-files`.split($\).reject { |f| ['.pdf','.xls'].include?(File.extname(f)) }
+  gem.test_files    = `git ls-files -- test/**/*`.split("\n")
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "br_boleto"
   gem.require_paths = ["lib"]
   gem.version       = BrBoleto::Version::CURRENT

data/lib/br_boleto.rb

@@ -6,6 +6,10 @@ require 'active_support/core_ext/enumerable'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/string'
 
+require 'br_boleto/string_methods'
+
+
+
 # Copyright (C) 2015 Bruno M. Mergen <http://duobr.com.br>
 #
 # @author Bruno Mucelini Mergen <brunomergen@gmail.com>
@@ -47,22 +51,34 @@ module BrBoleto
 	# dos formatos (pdf, html, etc) e internacionalização dos boletos (caso
 	# você precise mudar os nomes dos campos nos boletos)
 	#
-	module Core
+	module Boleto
 		extend ActiveSupport::Autoload
 
-		autoload :Boleto
-		autoload :BancoBrasil
-		autoload :Banrisul
-		autoload :Bradesco
-		autoload :Caixa
-		autoload :Hsbc
-		autoload :Itau
-		autoload :Real
-		autoload :Santander
-		autoload :Sicredi
+		autoload :Base
 		autoload :Sicoob
 	end
 
+
+	module Remessa
+		extend ActiveSupport::Autoload
+		autoload :Base
+		autoload :Lote
+		autoload :Pagamento
+
+		module Cnab240
+			extend ActiveSupport::Autoload
+			autoload :Base
+			autoload :Sicoob
+		end
+	end
+
+	module Helper
+		extend ActiveSupport::Autoload
+
+		autoload :CpfCnpj
+		autoload :Number
+	end
+
 	# Módulo que possui classes que realizam os cálculos dos campos que serão mostrados nos boletos.
 	#
 	module Calculos
@@ -83,5 +99,7 @@ module BrBoleto
 		autoload :Digitos
 	end
 
-	include Core
+	include Helper
+	include Boleto
+	include Remessa
 end

data/lib/br_boleto/{core/boleto.rb → boleto/base.rb}

@@ -1,10 +1,10 @@
 # encoding: utf-8
 module BrBoleto
-  module Core
+  module Boleto
     # @abstract Métodos { #codigo_banco, #digito_codigo_banco, #agencia_codigo_cedente, #nosso_numero, #codigo_de_barras_do_banco}
     # Métodos para serem escritos nas subclasses (exitem outros opcionais, conforme visto nessa documentação).
     #
-    class Boleto
+    class Base
       include BrBoleto::Calculos
 
       # Seguindo a interface do Active Model para:
@@ -224,16 +224,16 @@ module BrBoleto
       #
       # O recomendado é usar os boletos herdando de seu respectivo banco. Por exemplo:
       #
-      #     class Itau < BrBoleto::Itau
+      #     class Sicoob < BrBoleto::Sicoob
       #     end
       #
       # Agora você pode emitir um boleto usando a classe criada acima:
       #
-      #     Itau.new(conta_corrente: '89755', agencia: '0097', :carteira => '195')
+      #     Sicoob.new(conta_corrente: '89755', agencia: '0097', :carteira => '195')
       #
       # Você pode usar blocos se quiser:
       #
-      #     Itau.new do |boleto|
+      #     Sicoob.new do |boleto|
       #       boleto.conta_corrente   = '89755'
       #       boleto.agencia          = '0097'
       #       boleto.carteira         = '198'
@@ -277,6 +277,18 @@ module BrBoleto
         }
       end
 
+      # Tipo de cobrança
+      # Ex: :com_registro, :sem_registro, :garantia_caucionada
+      # A implementação para esse valor deve ser implementada para cada banco, 
+      # pois cada banco tem uma maneira diferente para saber o tipo de cobrança.
+      #
+      # 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, POR EXEMPLO:
+      # É UTILIZADO NOS PAGAMENTOS DAS REMESSAS, MAIS ESPECIFICAMENTE NO COMPLEMENTO TRAILER
+      # DO LOTE PARA O BANCO SICOOB NO CNAB 240.
+      def tipo_cobranca        
+      end
+
       # Código do Banco.
       # <b>Esse campo é específico para cada banco</b>.
       #
@@ -553,6 +565,72 @@ module BrBoleto
       def data_vencimento_deve_ser_uma_data
         errors.add(:data_vencimento, :invalid) unless data_vencimento.kind_of?(Date)
       end
+
+
+      ################ FORMATAÇÃO PARA CPF OU CNPJ ################
+      # tanto o documento do sacado quandto do cedente possui 3 tipos de formatação
+      # EX: 
+      #   documento_sacado = '12345678901'
+      #   atributo + '_formatado':
+      #       documento_sacado_formatado = '123.456.789-01'
+      #   atributo + '_formatado_com_label':
+      #       documento_sacado_formatado_com_label = 'CPF 123.456.789-01'
+      #
+      # OBS: O documento_cedente e documento_sacado SEMPRE irão retornar o valor sem a formatação
+      #      mesmo que seja setado
+      ##############################################################
+
+      # Retorna o documento do sacado com tamanho 0, 11 ou 14 caracteres
+      # Sempre retorna o valor sem a formatação
+      #
+      # @return String
+      #
+      def documento_sacado
+        return "" unless @documento_sacado.present?
+        BrBoleto::Helper::CpfCnpj.new(@documento_sacado).sem_formatacao
+      end
+
+      # Retorna o documento do sacado formatado
+      #
+      # @return String
+      #
+      def documento_sacado_formatado
+        BrBoleto::Helper::CpfCnpj.new(documento_sacado).com_formatacao
+      end
+
+      # Retorna o documento do sacado formatado com label de CNPJ ou CPF
+      #
+      # @return String
+      #
+      def documento_sacado_formatado_com_label
+        BrBoleto::Helper::CpfCnpj.new(documento_sacado).formatado_com_label
+      end
+
+      # Retorna o documento do cedente com tamanho 0, 11 ou 14 caracteres
+      # Sempre retorna o valor sem a formatação
+      #
+      # @return String
+      #
+      def documento_cedente
+        return "" unless @documento_cedente.present?
+        BrBoleto::Helper::CpfCnpj.new(@documento_cedente).sem_formatacao
+      end
+
+      # Retorna o documento do cedente formatado
+      #
+      # @return String
+      #
+      def documento_cedente_formatado
+        BrBoleto::Helper::CpfCnpj.new(documento_cedente).com_formatacao
+      end
+
+      # Retorna o documento do cedente formatado com label de CNPJ ou CPF
+      #
+      # @return String
+      #
+      def documento_cedente_formatado_com_label
+        BrBoleto::Helper::CpfCnpj.new(documento_cedente).formatado_com_label
+      end
     end
   end
 end