bancos_brasileiros 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94008e2224172585906defd9ea32701115421c4ed642c2f83544c9fa45400c0
-  data.tar.gz: 361a1b62a8226f51bbcb4856a83bcec30d9e3f9856c2ca60f190ad91751a33b8
+  metadata.gz: 30339bda5226f9da5f97b9cd634a9ed180b48d71db984bdd6bd46ec0c622de94
+  data.tar.gz: 2a3b8d73de7b39b5b659df47ec2f233fe548943e074ef6e2759c27aca8d555e2
 SHA512:
-  metadata.gz: 8adec4a93cce14226e8c0b7520ec6ac106bdb9ffa8cfd2b3af729527924371db1fa2940de1c1dcba0b15f1e9dd7537ae6dc1194f68e29e88b149ac7a39282cdb
-  data.tar.gz: 91e18688b8e73762fb3fc07489da7a57ce0d21981f8aea5e995b335ff7ba704dd2712bf506396a19ae0784793c100ddea70aa865bb8a9eb0d9fb4ddcc77174f6
+  metadata.gz: a67bdd5d7beb2442e97f674ac4dd80cf385dfd6d12d147dafdc4ced7b34dafe36ec97b5148ef80a79474dc36556b389d28bafc1ef34095e80266658d861ae863
+  data.tar.gz: 31123aa9e416a513544f672d2e65fa3ef7b3eacb4065cd5896fe74745c3544605082585d7577d7e50c23897ee582caa666325a811b73d43282b9c41b588cc3ea

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.1.3
+
+- Change README
+- Add view example
+
+## 0.1.2
+
+- Change README
+
 ## 0.1.1
 
 - Add json with all banks (updated until Jul 13, 2024)

data/README.md

@@ -1,6 +1,8 @@
 # Bancos Brasileiros
 
-🇧🇷 🏦 📋 Brazilian commercial banks list
+🇧🇷 🏦 📋 Brazilian commercial banks list.
+
+This gem was created to meet a need in the [Brazilian Banks Project](https://guibranco.github.io/BancosBrasileiros/), developed by [Guilherme Branco](https://github.com/guibranco). The project keeps an up-to-date list of banks in various programming languages, and I realized the need to provide support for Rails as well.
 
 ## Installation
 
@@ -11,6 +13,137 @@ gem 'bancos_brasileiros'
 ```
 and run **bundle install**
 
+## Usage
+
+Example of how to use the `bancos_brasileiros` in a rails project:
+
+Create a controller:
+
+```ruby
+  # app/controllers/banks_controller.rb
+  class BanksController < ApplicationController
+
+    def index
+      @banks = BancosBrasileiros.all_banks
+      respond_to do |format|
+        format.html
+        format.json { render json: @banks }
+      end
+    end
+
+    def show
+      @bank = BancosBrasileiros.find_bank_by_compe(params[:id])
+      respond_to do |format|
+        if @bank
+          format.html
+          format.json { render json: @bank }
+        else
+          format.html { render plain: 'Bank not found.', status: :not_found }
+          format.json { render json: { error: 'Bank not found.' }, status: :not_found }
+        end
+      end
+    end
+
+    def by_ispb
+      @bank = BancosBrasileiros.find_bank_by_ispb(params[:ispb])
+      respond_to do |format|
+        if @bank
+          format.html { render :show }
+          format.json { render json: @bank }
+        else
+          format.html { render plain: 'Bank not found.', status: :not_found }
+          format.json { render json: { error: 'Bank not found.' }, status: :not_found }
+        end
+      end
+    end
+
+    def by_network
+      @banks = BancosBrasileiros.find_banks_by_network(params[:network])
+      respond_to do |format|
+        format.html { render :index }
+        format.json { render json: @banks }
+      end
+    end
+
+    def by_type
+      @banks = BancosBrasileiros.find_banks_by_type(params[:type])
+      respond_to do |format|
+        format.html { render :index }
+        format.json { render json: @banks }
+      end
+    end
+
+    def by_pix_type
+      @banks = BancosBrasileiros.find_banks_by_pix_type(params[:pix_type])
+      respond_to do |format|
+        format.html { render :index }
+        format.json { render json: @banks }
+      end
+    end
+  end
+```
+Create routes:
+
+```ruby
+  # config/routes.rb
+  Rails.application.routes.draw do
+    resources :banks, only: [:index, :show] do
+      collection do
+        get 'by_ispb/:ispb', to: 'banks#by_ispb'
+        get 'by_network/:network', to: 'banks#by_network'
+        get 'by_type/:type', to: 'banks#by_type'
+        get 'by_pix_type/:pix_type', to: 'banks#by_pix_type'
+      end
+    end
+  end
+```
+Create a example of view:
+
+```html
+<!-- app/views/banks/index.html.erb -->
+<h1>Lista de Bancos Brasileiros</h1>
+<table>
+  <thead>
+    <tr>
+      <th>COMPE</th>
+      <th>Nome</th>
+      <th>Tipo</th>
+      <th>Network</th>
+      <th>Ações</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @banks.each do |bank| %>
+      <tr>
+        <td><%= bank['COMPE'] %></td>
+        <td><%= bank['LongName'] %></td>
+        <td><%= bank['Type'] %></td>
+        <td><%= bank['Network'] %></td>
+        <td><%= link_to 'Ver detalhes', bank_path(bank['COMPE']) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<!-- app/views/banks/show.html.erb -->
+<h1>Detalhes do Banco</h1>
+<p><strong>COMPE:</strong> <%= @bank['COMPE'] %></p>
+<p><strong>ISPB:</strong> <%= @bank['ISPB'] %></p>
+<p><strong>Nome:</strong> <%= @bank['LongName'] %></p>
+<p><strong>Nome Curto:</strong> <%= @bank['ShortName'] %></p>
+<p><strong>Tipo:</strong> <%= @bank['Type'] %></p>
+<p><strong>Network:</strong> <%= @bank['Network'] %></p>
+<p><strong>Pix Type:</strong> <%= @bank['PixType'] %></p>
+<p><strong>Produtos:</strong> <%= @bank['Products'].join(', ') %></p>
+<p><strong>URL:</strong> <%= link_to @bank['Url'], @bank['Url'] %></p>
+<p><strong>Data de Início de Operação:</strong> <%= @bank['DateOperationStarted'] %></p>
+<p><strong>Data de Início do Pix:</strong> <%= @bank['DatePixStarted'] %></p>
+<p><strong>Data de Registro:</strong> <%= @bank['DateRegistered'] %></p>
+<p><strong>Data de Atualização:</strong> <%= @bank['DateUpdated'] %></p>
+
+<%= link_to 'Voltar', banks_path %>
+```
+
 ## Requirements
 
 - Ruby >= 2.6.0 (recommended 2.7+)  

data/bancos_brasileiros.gemspec

@@ -19,8 +19,6 @@ Gem::Specification.new do |spec|
     "changelog_uri" => "https://github.com/eltonsantos/bancos_brasileiros/blob/master/CHANGELOG.md",
   }
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||
@@ -30,10 +28,4 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/bancos_brasileiros/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BancosBrasileiros
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bancos_brasileiros
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Elton Santos
@@ -23,6 +23,8 @@ files:
 - README.md
 - Rakefile
 - bancos_brasileiros-0.1.0.gem
+- bancos_brasileiros-0.1.1.gem
+- bancos_brasileiros-0.1.2.gem
 - bancos_brasileiros.gemspec
 - data/bancos.json
 - lib/bancos_brasileiros.rb