brasilapi 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40af8e101ebaefb3a05d6e4eb5bf756b6e0fb5feac9bd1b7df9d6aeeb920ee7e
-  data.tar.gz: dd7b7cb583665180ef77b39e040a585b8746fc53a4ecfc1ec7821d19f01e26d3
+  metadata.gz: 90984c3c65874f8182c32cf0117ecbec0b6c93595885323a7d8d23597788941f
+  data.tar.gz: f708ddf656929596da3ff1c8c44a30abedd6cdff120222edd6b007b0b878ca40
 SHA512:
-  metadata.gz: 0a2b7630a8d5eef7358231019feaeed5610969b09357e439128f138e1456d89fc0cdddc211fa4c1cd3bec363913b192bcab0639e9f034ff4121710a15c6e4f87
-  data.tar.gz: 9841a7a7fc7df413fee19810872969b9290ec2dbb93a7519acea864a2953327dc80d0ce0bca028a8c6d042f368cdafad1774ac56b489d5cd7d1d1228127884c2
+  metadata.gz: cb1831e4435f2a28c0b6e5df7b822c5c65a84f65866096231742a98c87696c31c0058f06837a7b6b7860eb50874f4cdfb8a0f900727d7f32844990c5b9e966cd
+  data.tar.gz: 20193f1e912ca81e215760aa9bc7daaf5fefc9adbf82101da8889c21e6bca7365d79bd95f94d1b4aed8074902fa1b76363bb1a086935e1fd91eb26cd5991af5a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [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

data/Gemfile.lock

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

data/README.md

@@ -14,7 +14,7 @@ Dependency-less Brasil API lookup gem for brazilian data with an easy-to-use API
  - [x] **DDD**
  - [x] **Feriados Nacionais**
  - [ ] **FIPE**
- - [ ] **IBGE**
+ - [x] **IBGE**
  - [ ] **ISBN**
  - [ ] **NCM**
  - [ ] **PIX**
@@ -98,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/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.5.1"
+  VERSION = "0.6.0"
 end

data/lib/brasil_api.rb

@@ -7,6 +7,7 @@ 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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Dayvid Emerson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 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
@@ -42,6 +42,7 @@ files:
 - 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