br_boleto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7779abe6dc0c653dd1e82299a4e9c89d2007e7c8
+  data.tar.gz: 95d6fe53fe8ffa6c007e682130176450df534c9b
+SHA512:
+  metadata.gz: 035233e8e9c63da0579d77974df98b43cf9535bea8b184ff9ec94bcdfa865093bdffb3cbb766dd9b93a984fad0997e6c8da7fec02c3fb0afaf89eec915503bff
+  data.tar.gz: b38d7006eb7451b0a765e5d64d03466d33b4d484e12937aab3809a8a683531a0c3112c89bc5f69b9e2968430470885f48a62c0a75211239c0a4b041d16330004

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+	# gem "mocha", :require => false
+	gem "mocha", :require => false
+	gem "factory_girl_rails"
+	gem 'minitest-reporters'
+	gem 'minitest-rails'
+	gem 'minitest-spec-rails'
+	gem 'shoulda-matchers', require: false
+	gem "minitest-matchers_vaccine"
+	gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,145 @@
+PATH
+  remote: .
+  specs:
+    br_boleto (0.1.0)
+      activemodel (>= 4.1)
+      activesupport (>= 4.1)
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.3)
+      activesupport (= 4.2.3)
+      globalid (>= 0.3.0)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    arel (6.0.2)
+    builder (3.2.2)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    metaclass (0.0.4)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    minitest-matchers_vaccine (1.0.3)
+      minitest (~> 5.0)
+    minitest-rails (2.2.0)
+      minitest (~> 5.7)
+      railties (~> 4.1)
+    minitest-reporters (1.0.19)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    minitest-spec-rails (5.2.2)
+      minitest (~> 5.0)
+      rails (~> 4.1)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.3)
+      actionmailer (= 4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      activemodel (= 4.2.3)
+      activerecord (= 4.2.3)
+      activesupport (= 4.2.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.3)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    ruby-progressbar (1.7.5)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  br_boleto!
+  factory_girl_rails
+  minitest-matchers_vaccine
+  minitest-rails
+  minitest-reporters
+  minitest-spec-rails
+  mocha
+  shoulda-matchers
+  simplecov

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 27-07-2015
+
+	* Criação da Gem
+	* Boleto para o Banco Sicoob

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Bruno M. Mergen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,156 @@
+# BrBoleto
+
+Emissão de Boletos Bancários em Ruby.
+
+## Versão 1.0.0
+
+Por enquanto esta gem apenas faz os cálculos para o banco 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**
+
+    gem install br_boleto
+
+**Instalação via Gemfile**
+    
+     gem 'br_boleto'
+
+## Documentação
+
+Seguimos as documentações descritas abaixo:
+
+* [Sicoob](documentacoes_boletos/Sicoob)
+
+
+## Bancos Suportados
+
+Para todos os bancos e carteiras implementadas, **seguimos as documentações** que estão dentro do repositório:
+
+<table>
+  <tr>
+    <th>Nome do Banco</th>
+    <th>Carteiras Suportadas</th>
+    <th>Testada/Homologada no banco</th>
+  </tr>
+  <tr>
+    <td>Sicoob</td>
+    <td>1, 3.</td>
+    <td>Emm andamento...</td>
+  </tr>
+</table>
+
+## Usage
+
+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
+end
+
+```
+
+### Criando os boletos / Validações
+
+Agora você pode emitir um boleto, **usando a classe criada no exemplo acima**:
+
+```ruby
+BoletoSicoob.new(agencia: '3195', codigo_cedente: '6532', numero_documento: '1101', carteira: '1', valor_documento: 105.78) 
+```
+
+Você pode usar blocos se quiser:
+
+```ruby
+boleto_sicoob = BoletoSicoob.new do |boleto|
+  boleto.agencia               = '0097'
+  boleto.carteira              = '1'
+  boleto.cedente               = 'Razao Social da Empresa'
+  boleto.codigo_cedente        = '90901'
+  boleto.endereco_cedente      = 'Rua nome da rua, 9999'
+  boleto.numero_documento      = '12345678'
+  boleto.sacado                = 'Nome do Sacado'
+  boleto.documento_sacado      = '35433793990'
+  boleto.data_vencimento       = Date.tomorrow
+  boleto.valor_documento       = 31678.99
+end
+```
+
+**Cada banco possui suas próprias validações de campo e de tamanho**.
+Primeiramente, **antes de renderizar qualquer boleto você precisar verificar se esse o boleto é válido**.
+
+```ruby
+if boleto_sicoob.valid?
+   # Renderiza o boleto itau
+else
+   # Trata os erros
+end
+```
+
+### Campos do Boleto
+
+Segue abaixo os métodos para serem chamados, no momento de renderizar os boletos. Os campos são de mesmo nome:
+
+```ruby
+boleto_sicoob.codigo_banco_formatado # Retorna o código do banco, junto com seu dígito
+
+boleto_sicoob.codigo_de_barras
+
+boleto_sicoob.linha_digitavel
+
+boleto_sicoob.nosso_numero
+
+boleto_sicoob.agencia_codigo_cedente
+
+boleto_sicoob.carteira_formatada # Formata a carteira, para mostrar no boleto.
+
+boleto_sicoob.numero_documento
+
+boleto_sicoob.valor_documento
+
+boleto_sicoob.especie
+
+boleto_sicoob.especie_documento
+```
+
+## Sobrescrevendo comportamentos
+
+Você pode sobrescrever os comportamentos na subclasse.
+
+Por exemplo, imagine que você quer sobrescrever a forma como é tratada a segunda parte do código de barras.
+**Seguindo a interface da classe BrBoleto::Boleto** fica bem simples:
+
+```ruby
+class BoletoSicoob < BrBoleto::Sicoob
+  def codigo_de_barras_do_banco
+   # Sua implementação ...
+  end
+end
+```
+
+## Contribuições
+
+Seja um contribuidor. Você pode contribuir de N formas. Seguem elas:
+
+* Criar boletos para outros bancos.
+* 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!)
+
+## Licença
+
+- BSD
+- Copyleft 2015 Bruno M. Mergen

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |task|
+  task.libs << %w(test lib)
+  task.pattern = 'test/**/*_test.rb'
+end
+ 
+task :default => :test

data/br_boleto.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/br_boleto/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bruno M. Mergen"]
+  gem.email         = ["brunomergen@gmail.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/Brunomm/br_boleto"
+  gem.license       = "BSD"
+
+  gem.files         = `git ls-files`.split($\).reject { |f| ['.pdf','.xls'].include?(File.extname(f)) }
+  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
+
+  gem.required_ruby_version = '>= 2.1'
+
+
+  gem.add_dependency "rake", '>= 0.8.7'
+  gem.add_dependency "activesupport", '~> 4.2'
+  gem.add_dependency "activemodel",   '~> 4.2'
+
+end

data/lib/br_boleto.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+require 'br_boleto/version'
+require 'active_model'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/string'
+
+# Copyright (C) 2015 Bruno M. Mergen <http://duobr.com.br>
+#
+# @author Bruno Mucelini Mergen <brunomergen@gmail.com>
+#
+# == Boleto Bancário
+#
+# Emissão de Boletos Bancários em Ruby. Simples e principalmente, flexível.
+#
+# Essa biblioteca é baseada em outras <b>ótimas</b> bibliotecas.
+# Recomendo analisar muito bem cada solução!
+#
+# * Novo Gateway de Pagamentos da Locaweb: http://www.locaweb.com.br/produtos/gateway-pagamento.html
+# * Brcobranca: https://github.com/kivanio/brcobranca
+# * Boleto Php: http://boletophp.com.br
+# * Stella Caelum: http://stella.caelum.com.br
+# * BoletoBancario: https://github.com/tomas-stefano/boleto_bancario
+#
+# === Instalação via Rubygems
+#
+#	gem install br_boleto
+#
+# === Instalar via Bundler
+#
+# Coloque no Gemfile:
+#
+#	gem 'br_boleto'
+#
+# Depois de colocar no Gemfile:
+#
+#   bundle install
+#
+module BrBoleto
+	# Modulo responsável por guardar todas as regras dos campos de
+	# todos os Boletos Bancários. <b>Contribuicões com novas documentações dos
+	# bancos e homologação dos boletos são extremamente bem vindas!</b>
+	#
+	# Esse módulo também é responsável por guardar todas as regras de validação dos boletos e
+	# contém a forma de chamar os objetos necessários para renderização
+	# dos formatos (pdf, html, etc) e internacionalização dos boletos (caso
+	# você precise mudar os nomes dos campos nos boletos)
+	#
+	module Core
+		extend ActiveSupport::Autoload
+
+		autoload :Boleto
+		autoload :BancoBrasil
+		autoload :Banrisul
+		autoload :Bradesco
+		autoload :Caixa
+		autoload :Hsbc
+		autoload :Itau
+		autoload :Real
+		autoload :Santander
+		autoload :Sicredi
+		autoload :Sicoob
+	end
+
+	# Módulo que possui classes que realizam os cálculos dos campos que serão mostrados nos boletos.
+	#
+	module Calculos
+		extend ActiveSupport::Autoload
+
+		autoload :FatorVencimento
+		autoload :FatoresDeMultiplicacao
+		autoload :LinhaDigitavel
+		autoload :Modulo10
+		autoload :Modulo11
+		autoload :Modulo11FatorDe2a9
+		autoload :Modulo11Fator3197
+		autoload :Modulo11FatorDe2a9RestoZero
+		autoload :Modulo11FatorDe2a7
+		autoload :Modulo11FatorDe9a2
+		autoload :Modulo11FatorDe9a2RestoX
+		autoload :ModuloNumeroDeControle
+		autoload :Digitos
+	end
+
+	include Core
+end