bancos_brasileiros 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94008e2224172585906defd9ea32701115421c4ed642c2f83544c9fa45400c0
-  data.tar.gz: 361a1b62a8226f51bbcb4856a83bcec30d9e3f9856c2ca60f190ad91751a33b8
+  metadata.gz: 96be3635b8df0b4c066e06deee0364c36d6fb61580e3fd0c76a3ecd256a76efe
+  data.tar.gz: bb26b0c533c5e983ad3885c8da9764ce2be0892c5fe1c7b4b8b6c2dca87a2f26
 SHA512:
-  metadata.gz: 8adec4a93cce14226e8c0b7520ec6ac106bdb9ffa8cfd2b3af729527924371db1fa2940de1c1dcba0b15f1e9dd7537ae6dc1194f68e29e88b149ac7a39282cdb
-  data.tar.gz: 91e18688b8e73762fb3fc07489da7a57ce0d21981f8aea5e995b335ff7ba704dd2712bf506396a19ae0784793c100ddea70aa865bb8a9eb0d9fb4ddcc77174f6
+  metadata.gz: f00d5d58211f72a7c39214ee712e190a1ae952f4f24ae414dc8547ae3c7700bfcafaacade678918de3597533a1ff0fb59e78d41d032178d53b64042a11e17e5d
+  data.tar.gz: 61c64b8a61db2714e0692b8c89c7f7b82438b556b4b3110a77d115bc08fbcf6197d410202e8e7bc80232f9f9992e896b4683ec0d63588500dd57a344404729fd

data/CHANGELOG.md

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

data/README.md

@@ -11,6 +11,69 @@ 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
+      render json: BancosBrasileiros.all_banks
+    end
+
+    def show
+      bank = BancosBrasileiros.find_bank_by_compe(params[:id])
+      if bank
+        render json: bank
+      else
+        render json: { error: 'Bank not found.' }, status: :not_found
+      end
+    end
+
+    def by_ispb
+      bank = BancosBrasileiros.find_bank_by_ispb(params[:ispb])
+      if bank
+        render json: bank
+      else
+        render json: { error: 'Bank not found.' }, status: :not_found
+      end
+    end
+
+    def by_network
+      banks = BancosBrasileiros.find_banks_by_network(params[:network])
+      render json: bancos
+    end
+
+    def by_type
+      banks = BancosBrasileiros.find_banks_by_type(params[:type])
+      render json: banks
+    end
+
+    def by_pix_type
+      banks = BancosBrasileiros.find_banks_by_pix_type(params[:pix_type])
+      render json: banks
+    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
+```
+
 ## Requirements
 
 - Ruby >= 2.6.0 (recommended 2.7+)  

data/lib/bancos_brasileiros/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BancosBrasileiros
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 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.2
 platform: ruby
 authors:
 - Elton Santos
@@ -23,6 +23,7 @@ files:
 - README.md
 - Rakefile
 - bancos_brasileiros-0.1.0.gem
+- bancos_brasileiros-0.1.1.gem
 - bancos_brasileiros.gemspec
 - data/bancos.json
 - lib/bancos_brasileiros.rb