boleto_bancario 0.0.1.beta → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd0a9ec52328f6ce59edd1d4105e868345dcb0fc
+  data.tar.gz: 7b290c3183af8c16461d56604152d4f3a7e1d1df
+SHA512:
+  metadata.gz: a9a9fd7deda2d72950c4339e600ec28d787efd4d94da0c1883162f78db6745cd456bd09ea21d3a558fc2896a5bdd925be70a18134374d41dee4b777d3a6e18ab
+  data.tar.gz: dd9f31fad47809390594a97dd34af31da5495b0623e083139bbbe05ad0a8c4808a220fa94d3a9abbae941f136fe813c08a8f79784c36a2b918f7b4444d2bfa7f

data/.gitignore

@@ -3,16 +3,17 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
 doc/
 lib/bundler/man
+vendor/
 pkg
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-.DS_Store
+.DS_Store
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby
+  - 2.0
+before_install:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+script:
+  - bundle exec rspec

data/Changelog.markdown

@@ -1,5 +1,9 @@
 # development
 
+* Implementado Banrisul.
+
+# 0.0.1.beta
+
 * Implementado Banco do Brasil.
 * Implementado Santander.
 * Implementado Bradesco.

data/Gemfile

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

data/Planning.markdown

@@ -2,104 +2,26 @@
 
 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.
 
-HTML 5 é o formato suportado por enquanto. Para usar em Html, você precisa usar a gem **[boleto_bancario_html](https://github.com/tomas-stefano/boleto_bancario_html)**:
-
-    gem install boleto_bancario_html
-
-E colocar na classe:
+Colocar na classe:
 
 ```ruby
-  class Itau < BoletoBancario::Itau
-    def format
-      BoletoBancario::HTML5
-    end
+  class BoletoItau < BoletoBancario::Itau
+    respond_to :html, :pdf, :png
   end
 ```
 
 Para renderizar o html:
 
 ```ruby
-   itau = Itau.new
+   itau = BoletoItau.new
+
+   itau.respond_with # Irá chamar o método render da instância do objeto passado no método format.
 
-   itau.render # Irá chamar o método render da instância do objeto passado no método format.
+   itau.respond_with(:pdf)
 ```
 
 ### Criando um novo Formato
@@ -108,12 +30,22 @@ Em relação a parte de formatos a gem de boleto bancário é extremamente flex
 
 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

data/README.markdown

@@ -1,4 +1,4 @@
-# BoletoBancario
+# Boleto Bancario
 
 Emissão de Boletos Bancários em Ruby.
 
@@ -25,14 +25,20 @@ Essa biblioteca é baseada em outras **ótimas** bibliotecas.
 
 ## Documentação
 
-Seguimos todas as documentações que estão dentro do repositório:
+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)
+* [Banco do Brasil](documentacoes_dos_boletos/banco_brasil)
+* [Banrisul](documentacoes_dos_boletos/banrisul)
+* [Bradesco](documentacoes_dos_boletos/Bradesco)
+* [Caixa](documentacoes_dos_boletos/Caixa)
+* [HSBC](documentacoes_dos_boletos/HASBC)
+* [Itaú](documentacoes_dos_boletos/Itau)
+* [Real](documentacoes_dos_boletos/Real)
+* [Santander](documentacoes_dos_boletos/santander)
+* [Sicoob](documentacoes_dos_boletos/Sicoob)
+* [Sicredi](documentacoes_dos_boletos/Sicredi)
 
-Se você tiver uma documentação do boleto, **mais atualizada**, venha contribuir para a gem. :)
+Se você tiver uma documentação do boleto, **mais atualizada**, gostaria de pedir que você me enviasse. :)
 
 ## Bancos Suportados
 
@@ -56,8 +62,8 @@ Para todos os bancos e carteiras implementadas, **seguimos as documentações**
     <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>Banrisul</td>
+    <td>00, 08.</td>
     <td>Esperando Contribuição</td>
   </tr>
   <tr>
@@ -65,11 +71,41 @@ Para todos os bancos e carteiras implementadas, **seguimos as documentações**
     <td>03, 06, 09, 19, 21, 22.</td>
     <td>Esperando Contribuição</td>
   </tr>
+  <tr>
+    <td>Caixa</td>
+    <td>14, 24.</td>
+    <td>Esperando Contribuição</td>
+  </tr>
+  <tr>
+    <td>HSBC</td>
+    <td>CNR.</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>Real</td>
+    <td>00, 20, 31, 42, 47, 85.</td>
+    <td>Esperando Contribuição</td>
+  </tr>
   <tr>
     <td>Santander</td>
     <td>101, 102, 121.</td>
     <td>Esperando Contribuição</td>
   </tr>
+  <tr>
+    <td>Sicoob</td>
+    <td>1, 9.</td>
+    <td>Esperando Contribuição</td>
+  </tr>
+  <tr>
+    <td>Sicredi</td>
+    <td>03, C.</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.**
@@ -85,17 +121,17 @@ Você pode usar as próprias classes da gem, porém, **recomendo criar uma subcl
 ### Exemplo
 
 ```ruby
-  class BoletoItau < BoletoBancario::Itau
-  end
+class BoletoItau < BoletoBancario::Itau
+end
 
-  class BoletoSantander < BoletoBancario::Santander
-  end
+class BoletoSantander < BoletoBancario::Santander
+end
 
-  class BoletoBradesco < BoletoBancario::Bradesco
-  end
+class BoletoBradesco < BoletoBancario::Bradesco
+end
 
-  class BoletoBancoBrasil < BoletoBancario::BancoBrasil
-  end
+class BoletoBancoBrasil < BoletoBancario::BancoBrasil
+end
 ```
 
 Segue os attributos dos boletos:
@@ -123,58 +159,65 @@ Segue os attributos dos boletos:
 
 Agora você pode emitir um boleto, **usando a classe criada no exemplo acima**:
 
-    BoletoItau.new(conta_corrente: '89755', agencia: '0097', :carteira => '195')
+```ruby
+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
+```ruby
+boleto_itau = BoletoItau.new do |boleto|
+  boleto.conta_corrente        = '89755'
+  boleto.agencia               = '0097'
+  boleto.carteira              = '198'
+  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
+  boleto.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
+```ruby
+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
+```ruby
+boleto_itau.codigo_banco_formatado # Retorna o código do banco, junto com seu dígito
 
-    boleto_itau.codigo_de_barras
+boleto_itau.codigo_de_barras
 
-    boleto_itau.linha_digitavel
+boleto_itau.linha_digitavel
 
-    boleto_itau.nosso_numero
+boleto_itau.nosso_numero
 
-    boleto_itau.agencia_codigo_cedente
+boleto_itau.agencia_codigo_cedente
 
-    boleto_itau.carteira_formatada # Formata a carteira, para mostrar no boleto.
+boleto_itau.carteira_formatada # Formata a carteira, para mostrar no boleto.
 
-    boleto_itau.numero_documento
+boleto_itau.numero_documento
 
-    boleto_itau.valor_documento
+boleto_itau.valor_documento
 
-    boleto_itau.especie
+boleto_itau.especie
 
-    boleto_itau.especie_documento
+boleto_itau.especie_documento
+```
 
 ## Sobrescrevendo comportamentos
 
@@ -183,18 +226,28 @@ 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
+```ruby
+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 para o pagamento.
+Essa gem **apenas emite o boleto**, com todas as informações necessárias do boleto.
 
 ## Contribuições
 
@@ -205,4 +258,3 @@ Seja um contribuidor. Você pode contribuir de N formas. Seguem elas:
 * Escrevendo novos formatos (PDF, PNG), e me avisando para divulgar no Readme.
 * Refatorando código!!
 * Fornecendo Feedback construtivo! (Sempre bem vindo!)
-

data/Rakefile

@@ -1,9 +1,15 @@
 # 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
+end