brasilapi 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea46d9028ee79406566abf23b22f13aa2bbdc39627514285d8b37aaefb800155
-  data.tar.gz: bf450026f52e66133949d096bab1c0f928d99ba8470113b605b35a224f5ad024
+  metadata.gz: 90984c3c65874f8182c32cf0117ecbec0b6c93595885323a7d8d23597788941f
+  data.tar.gz: f708ddf656929596da3ff1c8c44a30abedd6cdff120222edd6b007b0b878ca40
 SHA512:
-  metadata.gz: 270117e9836151ac6c82a96846c79d50e2aa6934e65262a0dd1114695d38a1cc79a4c84fa06c268919855716d174d02c970a0b565a711ee411b9f141ce0f38a4
-  data.tar.gz: 210966b126a31f9761ffed838e89b3e612e43d2706fa5bf547de48fb3b197d6fb12297ad7ff3b8f730865cec7eb20fe659397e2453a679eaff93ab323a080dc0
+  metadata.gz: cb1831e4435f2a28c0b6e5df7b822c5c65a84f65866096231742a98c87696c31c0058f06837a7b6b7860eb50874f4cdfb8a0f900727d7f32844990c5b9e966cd
+  data.tar.gz: 20193f1e912ca81e215760aa9bc7daaf5fefc9adbf82101da8889c21e6bca7365d79bd95f94d1b4aed8074902fa1b76363bb1a086935e1fd91eb26cd5991af5a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.6.0] - 2024-02-25
+
+- Integração da API do IBGE
+
+## [0.5.1] - 2023-12-01
+
+- Corrigindo versão publicada no RubyGems
+
+## [0.5.0] - 2023-12-01
+
+- Integração da API de Corretoras ativas listadas na CVM
+
 ## [0.4.0] - 2023-10-30
 
 - Integração da API de Feriados Nacionais

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brasilapi (0.4.0)
+    brasilapi (0.6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -9,12 +9,12 @@ Dependency-less Brasil API lookup gem for brazilian data with an easy-to-use API
  - [x] **Bank**
  - [x] **CEP (Zip code)**
  - [x] **CNPJ**
- - [ ] **Corretoras**
+ - [x] **Corretoras**
  - [ ] **CPTEC**
  - [x] **DDD**
  - [x] **Feriados Nacionais**
  - [ ] **FIPE**
- - [ ] **IBGE**
+ - [x] **IBGE**
  - [ ] **ISBN**
  - [ ] **NCM**
  - [ ] **PIX**
@@ -50,9 +50,9 @@ BrasilAPI::Bank.find_by_code(77)
 # find company by cnpj
 BrasilAPI::Company.find_by_cnpj("60316817000103")
 => 
-{"uf"=>"SP",                                                        
- "cep"=>"04543907",                                                 
- "qsa"=>                                                            
+{"uf"=>"SP",
+ "cep"=>"04543907",
+ "qsa"=>
   [{"pais"=>"ESTADOS UNIDOS",
   ...}
 
@@ -71,12 +71,26 @@ BrasilAPI::Address.find_by_zip_code('80060000', location: true)
 # get state and cities by area code
 BrasilAPI::Address.state_and_cities_by_area_code('89')
 => 
-{"state"=>"PI",                                                     
- "cities"=>                                                         
-  ["MASSÂPE DO PIAUÍ",                                              
-   ...,
-   "ACAUÃ"
-  ]}
+{"state"=>"PI",
+ "cities"=>
+ ["MASSÂPE DO PIAUÍ",
+  ...,
+  "ACAUÃ"
+ ]}
+
+# get all CVM brokers
+BrasilAPI::CVM.all
+=> 
+[{"cnpj"=>"76621457000185",
+  "type"=>"CORRETORAS",
+  ...]
+
+# find bank by code
+BrasilAPI::CVM.find_by_cnpj('74014747000135')
+=> 
+{"cnpj"=>"74014747000135",
+ "type"=>"CORRETORAS",
+ ...}
 
 # get brazilian national holidays by year
 BrasilAPI::Holiday.by_year(2024)
@@ -84,8 +98,46 @@ BrasilAPI::Holiday.by_year(2024)
 [{"date"=>"2024-01-01", "name"=>"Confraternização mundial", "type"=>"national"},
  ...
  {"date"=>"2024-12-25", "name"=>"Natal", "type"=>"national"}]
+
+# get states from ibge
+BrasilAPI::IBGE.states
+=> 
+[{"id"=>11,
+  "sigla"=>"RO"
+  "nome"=>"Rondônia",
+  "regiao"=>{"id"=>1, "sigla"=>"N", "nome"=>"Norte"}},
+  ...
+   {"id"=>53,
+  "sigla"=>"DF",
+  "nome"=>"Distrito Federal",
+  "regiao"=>{"id"=>5, "sigla"=>"CO", "nome"=>"Centro-Oeste"}}]
+
+# find state by abbreviation from ibge
+BrasilAPI::IBGE.find_state_by_code('PI')
+=> 
+{"id"=>22,
+ "sigla"=>"PI",
+ "nome"=>"Piauí",
+ "regiao"=>{"id"=>2, "sigla"=>"NE", "nome"=>"Nordeste"}}
+
+# find state by code from ibge
+BrasilAPI::IBGE.find_state_by_code(53)
+=> 
+{"id"=>53,
+ "sigla"=>"DF",
+ "nome"=>"Distrito Federal",
+ "regiao"=>{"id"=>5, "sigla"=>"CO", "nome"=>"Centro-Oeste"}}
+
+# get cities by state abbreviation from ibge
+BrasilAPI::IBGE.cities_by_state('CE')
+=> 
+[{"nome"=>"ABAIARA", "codigo_ibge"=>"2300101"},
+ ...
+ {"nome"=>"VÁRZEA ALEGRE", "codigo_ibge"=>"2314003"},
+ {"nome"=>"VIÇOSA DO CEARÁ", "codigo_ibge"=>"2314102"}]
 ```
 
+
 # License
 [MIT](./LICENSE)
 

data/lib/brasil_api/cvm.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BrasilAPI
+  class CVM < Base
+    class << self
+      def all
+        get("/cvm/corretoras/v1")
+      end
+
+      def find_by_cnpj(cnpj)
+        get("/cvm/corretoras/v1/#{cnpj}")
+      end
+    end
+  end
+end

data/lib/brasil_api/ibge.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrasilAPI
+  class IBGE < Base
+    class << self
+      def states
+        get("/ibge/uf/v1")
+      end
+
+      def find_state_by_code(code)
+        get("/ibge/uf/v1/#{code}")
+      end
+
+      def cities_by_state(state_abbr, providers: [])
+        return get("/ibge/municipios/v1/#{state_abbr}") if providers.empty?
+
+        providers_query = providers.join(",")
+        get("/ibge/municipios/v1/#{state_abbr}?providers=#{providers_query}")
+      end
+    end
+  end
+end

data/lib/brasil_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrasilAPI
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/brasil_api.rb

@@ -5,7 +5,9 @@ require_relative "brasil_api/base"
 require_relative "brasil_api/address"
 require_relative "brasil_api/bank"
 require_relative "brasil_api/company"
+require_relative "brasil_api/cvm"
 require_relative "brasil_api/holiday"
+require_relative "brasil_api/ibge"
 
 module BrasilAPI
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brasilapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Dayvid Emerson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies: []
 description: Acesso programático de informações é algo fundamental na comunicação
   entre sistemas, mas, para nossa surpresa, uma informação tão útil e pública quanto
@@ -40,7 +40,9 @@ files:
 - lib/brasil_api/bank.rb
 - lib/brasil_api/base.rb
 - lib/brasil_api/company.rb
+- lib/brasil_api/cvm.rb
 - lib/brasil_api/holiday.rb
+- lib/brasil_api/ibge.rb
 - lib/brasil_api/version.rb
 - lib/brasilapi.rb
 homepage: https://brasilapi.com.br