bancos_brasileiros 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 753d883296d6bc4b12ef397219f4349b43376cfdb80dd121a7cb639a0880c2c1
-  data.tar.gz: df8b4170b7359151a318574507a6d03ba8be3204316665a7a50f9d3810d3fea9
+  metadata.gz: 96be3635b8df0b4c066e06deee0364c36d6fb61580e3fd0c76a3ecd256a76efe
+  data.tar.gz: bb26b0c533c5e983ad3885c8da9764ce2be0892c5fe1c7b4b8b6c2dca87a2f26
 SHA512:
-  metadata.gz: 58719dd199e01bc14e85756f2891921ad64da8beb84be7b2f6d4311b9e03c9e0fc6389ebcd57f0a89cb2ada606959f615aeb08f823075a6b0055d4dd74a874f0
-  data.tar.gz: 7bf37187aab4faac20f8712204b73d3906ab81ab96092b133e0ef542e910751f84de694dc2ab1e8a60804c67a008aac2da91e4cfdc5e15a2ff38a6ef87551bc3
+  metadata.gz: f00d5d58211f72a7c39214ee712e190a1ae952f4f24ae414dc8547ae3c7700bfcafaacade678918de3597533a1ff0fb59e78d41d032178d53b64042a11e17e5d
+  data.tar.gz: 61c64b8a61db2714e0692b8c89c7f7b82438b556b4b3110a77d115bc08fbcf6197d410202e8e7bc80232f9f9992e896b4683ec0d63588500dd57a344404729fd

data/CHANGELOG.md

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

data/README.md

@@ -1,30 +1,83 @@
-# BancosBrasileiros
+# Bancos Brasileiros
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bancos_brasileiros`. To experiment with that code, run `bin/console` for an interactive prompt.
+🇧🇷 🏦 📋 Brazilian commercial banks list
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
+Add gem in your Gemfile:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem 'bancos_brasileiros'
+```
+and run **bundle install**
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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+)  
+- Rails >= 6.0 (compatible up to Rails 7)
 
 ## Contributing to Bancos Brasileiros