conectiva-boleto_bancario 0.0.2.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 298fc3490e425163cd1e07ec2048f99588e45ab0
+  data.tar.gz: d1b03969c89da2e59f1add6971f1a60e2da32fad
+SHA512:
+  metadata.gz: e0ad2738b0e28ababe687be5ef35630ce0c57ff0bd625003512e04310a189a78a65cd49f6b65029296d1498eae410e899734ac1232427b1855da3eaac8cbd0cc
+  data.tar.gz: 24d3efc46215911a1db98e56b003de385905dc4a43c6980c6753daf0d797b4d069382cfa5084344d8726cd68d08495c75914ba3be932ab5164b35abc950c8988

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color -f d

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@boleto_bancario --create

data/Changelog.markdown

@@ -0,0 +1,10 @@
+# development
+
+* Implementado Banrisul.
+
+# 0.0.1.beta
+
+* Implementado Banco do Brasil.
+* Implementado Santander.
+* Implementado Bradesco.
+* Implementado Itaú.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tomas D'Stefano http://successoft.com
+
+MIT License
+
+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/Planning.markdown

@@ -0,0 +1,137 @@
+# BoletoBancario
+
+Emissão de Boletos Bancários em Ruby. Simples, fácil e principalmente, flexível.
+
+## Alternativas
+
+Essa biblioteca é baseada em outras **ótimas** bibliotecas (**Recomendo analisar muito bem cada solução e usar a que resolver o seu problema!**):
+
+* 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 (essa gem) [https://github.com/tomas-stefano/boleto_bancario](https://github.com/tomas-stefano/boleto_bancario)
+
+## Instalação
+
+    gem install boleto_bancario
+
+## Bancos Suportados
+
+* TODO: Precisa escrever essa parte
+
+## 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 Itau < BoletoBancario::Itau
+  end
+
+  class Santander < BoletoBancario::Santander
+  end
+
+  class Bradesco < BoletoBancario::Bradesco
+  end
+
+  class BancoBrasil < BoletoBancario::BancoBrasil
+  end
+```
+
+## Attributos
+
+* TODO: Precisa escrever essa parte
+
+## Internacionalização (i18n)
+
+* TODO: Precisa escrever essa parte
+
+## Validações
+
+* TODO: Precisa escrever essa parte
+
+## Código do Banco
+
+* TODO: Precisa escrever essa parte
+
+## Agência / Código do Cedente
+
+* TODO: Precisa escrever essa parte
+
+## Nosso Número
+
+* TODO: Precisa escrever essa parte
+
+## Código de Barras
+
+* TODO: Precisa escrever essa parte
+
+## Linha digitável
+
+* TODO: Precisa escrever essa parte
+
+## Documentação
+
+* TODO: Precisa escrever essa parte
+
+## 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/README.markdown

@@ -0,0 +1,215 @@
+# BoletoBancario
+
+Emissão de Boletos Bancários em Ruby.
+
+Foi colocado um esforço enorme para tornar a gem **simples e principalmente, flexível**.
+
+## Versão Beta
+
+Essa gem ainda está em versão beta. Algumas coisas podem mudar até que a versão oficial seja lançada.
+
+## 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 (essa gem) [https://github.com/tomas-stefano/boleto_bancario](https://github.com/tomas-stefano/boleto_bancario)
+
+## Instalação
+
+    gem install boleto_bancario
+
+## Documentação
+
+Seguimos todas as documentações descritas abaixo:
+
+* [Bradesco](https://github.com/tomas-stefano/boleto_bancario/tree/master/documentacoes_dos_boletos/bradesco)
+* [Banco do Brasil](https://github.com/tomas-stefano/boleto_bancario/tree/master/documentacoes_dos_boletos/banco_brasil)
+* [Itaú](https://github.com/tomas-stefano/boleto_bancario/tree/master/documentacoes_dos_boletos/itau)
+* [Santander](https://github.com/tomas-stefano/boleto_bancario/tree/master/documentacoes_dos_boletos/santander)
+
+Se você tiver uma documentação do boleto, **mais atualizada**, gostaria de pedir que você me enviasse. :)
+
+## 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>Banco do Brasil</td>
+    <td>
+      12 com código do cedente de 6 dígitos,
+      16 e 18 com código do cedente de 4 dígitos,
+      16 e 18 com código do cedente e nosso número de 17 dígitos,
+      16 e 18 com código do cedente de 6 dígitos,
+      16, 17 e 18 código do cedente de 7 e 8 dígitos.
+    </td>
+    <td>Esperando Contribuição</td>
+  </tr>
+  <tr>
+    <td>Itaú</td>
+    <td>107, 109, 122, 142, 143, 126, 174, 175, 196, 198, 131, 146, 150, 168.</td>
+    <td>Esperando Contribuição</td>
+  </tr>
+  <tr>
+    <td>Bradesco</td>
+    <td>03, 06, 09, 19, 21, 22.</td>
+    <td>Esperando Contribuição</td>
+  </tr>
+  <tr>
+    <td>Santander</td>
+    <td>101, 102, 121.</td>
+    <td>Esperando Contribuição</td>
+  </tr>
+</table>
+
+**OBS.: Caso a homologação seja aceita junto ao banco, contribua e mude a seção acima. Caso recuse alguma carteira acima, por favor me avise, para tirar dessa lista.**
+
+## Homologação no Banco
+
+Uma ótima forma de contribuir para a gem, é validar junto ao banco os boletos implementados acima.
+
+## 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 BoletoItau < BoletoBancario::Itau
+  end
+
+  class BoletoSantander < BoletoBancario::Santander
+  end
+
+  class BoletoBradesco < BoletoBancario::Bradesco
+  end
+
+  class BoletoBancoBrasil < BoletoBancario::BancoBrasil
+  end
+```
+
+Segue os attributos dos boletos:
+
+* Agência
+* Dígito da agência
+* Conta Corrente
+* Dígito da Conta Corrente
+* Carteira
+* Cedente
+* Código do Cedente
+* Documento do Cedente
+* Endereço do Cedente
+* Sacado
+* Documento do Sacado
+* Código da Moeda
+* Data do documento
+* Data do vencimento
+* Número do documento
+* Valor do documento (valor do boleto)
+* Espécie
+* Espécie do documento
+
+### Criando os boletos / Validações
+
+Agora você pode emitir um boleto, **usando a classe criada no exemplo acima**:
+
+    BoletoItau.new(conta_corrente: '89755', agencia: '0097', :carteira => '195')
+
+Você pode usar blocos se quiser:
+
+    BoletoItau.new do |boleto|
+      boleto_itau.conta_corrente        = '89755'
+      boleto_itau.digito_conta_corrente = '1'
+      boleto_itau.agencia               = '0097'
+      boleto_itau.carteira              = '198'
+      boleto_itau.cedente               = 'Razao Social da Empresa'
+      boleto_itau.codigo_cedente        = '90901'
+      boleto_itau.endereco_cedente      = 'Rua nome da rua, 9999'
+      boleto_itau.numero_documento      = '12345678'
+      boleto_itau.sacado                = 'Nome do Sacado'
+      boleto_itau.documento_sacado      = '35433793990'
+      boleto_itau.data_vencimento       = Date.tomorrow
+      boleto_itau.valor_documento       = 31678.99
+      boleto_itau.seu_numero            = 1234
+    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**.
+
+    if boleto_itau.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:
+
+    boleto_itau.codigo_banco_formatado # Retorna o código do banco, junto com seu dígito
+
+    boleto_itau.codigo_de_barras
+
+    boleto_itau.linha_digitavel
+
+    boleto_itau.nosso_numero
+
+    boleto_itau.agencia_codigo_cedente
+
+    boleto_itau.carteira_formatada # Formata a carteira, para mostrar no boleto.
+
+    boleto_itau.numero_documento
+
+    boleto_itau.valor_documento
+
+    boleto_itau.especie
+
+    boleto_itau.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 BoletoBancario::Boleto** fica bem simples:
+
+    class BoletoItau < BoletoBancario::Itau
+       def codigo_de_barras_do_banco
+         # Sua implementação ...
+       end
+    end
+
+## Formatos (HTML, PDF e PNG)
+
+**Objetivos para as próximas versões: criar os formatos dos boletos de:**
+
+* HTML
+* PDF
+* PNG
+
+## O que a gem não faz
+
+A gem não trata os arquivos de remessa e os arquivos de retorno do banco.
+
+Na minha opinião não deveria ser responsabilidade dessa gem.
+Essa gem **apenas emite o boleto**, com todas as informações necessárias do boleto.
+
+## 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

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+require 'yard'
+
+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

@@ -0,0 +1,11 @@
+* Logo.
+* Formatacao documento (CPF/CNPJ).
+* Aceite.
+* Instruções.
+* 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.
+* Código de barras como imagem (usar a gem Barby).
+* Internacionalização / Locales.
+* Verificar a questão dos formatos (html, pdf, png).
+* Criar páginas explicando cada banco.