ibge-ruby 1.0.2

data/lib/ibge/uf.rb

@@ -0,0 +1,73 @@
+module IBGE
+  class UF
+    attr_accessor :id, :nome, :sigla, :regiao
+
+    def initialize(options = {})
+      @id     = options['id']
+      @nome   = options['nome']
+      @sigla  = options['sigla']
+      @regiao = Regiao.new(options['regiao'])
+    end
+
+    # Obtém o conjunto de Unidades da Federação do Brasil.
+    #
+    # @example
+    #           ufs = IBGE::UF.obter_ufs
+    #           ufs.first.class #=> IBGE::UF
+    #           ufs.first.nome #=> "Acre"
+    #           ufs.map(&:sigla) #=> ['AC', 'AM', 'AP'...]
+    def self.obter_ufs
+      resposta = RestClient.get("#{BASE_URL}/estados")
+
+      tratar_retorno(resposta)
+    end
+
+    # Obtém o conjunto de Unidades da Federação do Brasil a partir dos respectivos identificadores.
+    # Pode ser informada a sigla, identificador (ID) ou um array de siglas/identificadores.
+    #
+    # @param ufs [String, Integer, Array]
+    # @return [UF, Array<UF>]
+    #
+    # @example
+    #           uf = IBGE::UF.uf_por_identificador('CE')
+    #
+    #           ufs = IBGE::UF.ufs_por_identificador(['BA', 'CE'])
+    def self.ufs_por_identificador(ufs)
+      ufs      = IBGE.formatar(ufs)
+      resposta = RestClient.get("#{BASE_URL}/estados/#{ufs}")
+
+      tratar_retorno(resposta)
+    end
+
+    # Obtém o conjunto de Unidades da Federação do Brasil a partir dos identificadores das regiões.
+    # Pode ser informada a sigla, o identificador (ID) ou um array de siglas/identificadores.
+    #
+    # @param regioes [String, Integer, Array]
+    # @return [Array<UF>]
+    #
+    # @example
+    #           ufs = IBGE::UF.ufs_por_regiao('NE')
+    #           ufs.first.nome #=> "Maranhão"
+    #
+    #           ufs = IBGE::UF.ufs_por_regiao(['NE', 'N'])
+    #           ufs.map(&:nome) #=> ['Ceará', 'Amazonas'...]
+    def self.ufs_por_regiao(regioes)
+      regioes  = IBGE.formatar(regioes)
+      resposta = RestClient.get("#{BASE_URL}/regioes/#{regioes}/estados")
+
+      tratar_retorno(resposta)
+    end
+
+    private
+
+    def self.tratar_retorno(resposta)
+      ufs = JSON.parse(resposta.body)
+
+      if ufs.is_a?(Array) 
+        ufs.map { |uf| UF.new(uf) }
+      else
+        UF.new(ufs)
+      end 
+    end
+  end
+end

data/lib/ibge/utils.rb

@@ -0,0 +1,7 @@
+module IBGE
+  class << self
+    def formatar(parametro)
+      parametro.is_a?(Array) ? parametro.join('%7C') : parametro
+    end
+  end
+end 

data/lib/ibge/version.rb

@@ -0,0 +1,3 @@
+module IBGE
+  VERSION = '1.0.2'.freeze
+end

data/lib/ibge.rb

@@ -0,0 +1,18 @@
+require 'rest-client'
+require 'json'
+require 'ibge/utils'
+
+module IBGE
+  BASE_URL = 'https://servicodados.ibge.gov.br/api/v1/localidades'
+
+  autoload :Distrito,            'ibge/distrito'
+  autoload :Mesorregiao,         'ibge/mesorregiao'
+  autoload :Microrregiao,        'ibge/microrregiao'
+  autoload :Municipio,           'ibge/municipio'
+  autoload :Subdistrito,         'ibge/subdistrito'
+  autoload :Regiao,              'ibge/regiao'
+  autoload :RegiaoImediata,      'ibge/regiao_imediata'
+  autoload :RegiaoIntermediaria, 'ibge/regiao_intermediaria'
+  autoload :Pais,                'ibge/pais'
+  autoload :UF,                  'ibge/uf'
+end

data/spec/lib/ibge/distrito_spec.rb

@@ -0,0 +1,250 @@
+describe IBGE::Distrito do
+  shared_examples_for 'objeto' do
+    it 'deve retornar o nome Fortaleza' do
+      expect(subject.first.nome).to eq('Fortaleza')
+    end
+
+    it 'deve retornar o ID 230440005' do
+      expect(subject.first.id).to eq("230440005")
+    end
+
+    it 'deve retornar o município, que é um objeto IBGE::Municipio' do
+      expect(subject.first.municipio).to be_an IBGE::Municipio
+    end
+  end
+
+  shared_examples_for 'array' do |tamanho|
+    it 'deve retornar um Array<IBGE::Distrito>' do
+      aggregate_failures do
+        is_expected.to be_an Array
+        expect(subject.first).to be_an IBGE::Distrito
+      end
+    end
+  end
+
+  describe '.obter_distritos' do
+    subject do
+      VCR.use_cassette('distrito/obter_distritos') do
+        IBGE::Distrito.obter_distritos
+      end
+    end
+
+    it_has_behavior 'array'
+  end
+
+  describe '.distritos_por_id' do
+    context 'recebendo um array de IDs (["230440005", "230370905"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_id:230440005|230370905', erb: { param: '230440005%7C230370905' }) do
+          IBGE::Distrito.distritos_por_id(%w(230440005 230370905))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID ("230440005") como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_id:230440005', erb: { param: '230440005' }) do
+          IBGE::Distrito.distritos_por_id('230440005')
+        end
+      end
+
+      it_has_behavior 'objeto'
+    end
+  end
+
+  describe '.distritos_por_uf' do
+    context 'recebendo um array de siglas (["BA", "CE"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_uf:BA|CE', erb: { param: 'BA%7CCE' }) do
+          IBGE::Distrito.distritos_por_uf(%w(BA CE))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um array de IDs ([29, 23]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_uf:BA|CE', erb: { param: '29%7C23' }) do
+          IBGE::Distrito.distritos_por_uf([29, 23])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo uma sigla (CE) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_uf:CE', erb: { param: 'CE' }) do
+          IBGE::Distrito.distritos_por_uf('CE')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (23) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_uf:CE', erb: { param: 23 }) do
+          IBGE::Distrito.distritos_por_uf(23)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.distritos_por_regiao' do
+    context 'recebendo um array de siglas (["N", "NE"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao:N|NE', erb: { param: 'N%7CNE' }) do
+          IBGE::Distrito.distritos_por_regiao(%w(N NE))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um array de IDs ([1, 2]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao:N|NE', erb: { param: '1%7C2' }) do
+          IBGE::Distrito.distritos_por_regiao([1, 2])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao:NE', erb: { param: 2 }) do
+          IBGE::Distrito.distritos_por_regiao(2)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo uma sigla (NE) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao:NE', erb: { param: 'NE' }) do
+          IBGE::Distrito.distritos_por_regiao('NE')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.distritos_por_municipio' do
+    context 'recebendo um array de IDs (["2307254", "2302206"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_municipio:2307254|2302206', erb: { param: '2307254%7C2302206' }) do
+          IBGE::Distrito.distritos_por_municipio(['2307254', '2302206'])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID ("2307254") como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_municipio:2307254', erb: { param: '2307254' }) do
+          IBGE::Distrito.distritos_por_municipio('2307254')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.distritos_por_regiao_imediata' do
+    context 'recebendo um array de IDs ([230001, 230002]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao_imediata:230001|230002', erb: { param: '230001%7C230002' }) do
+          IBGE::Distrito.distritos_por_regiao_imediata([230001, 230002])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (230001) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao_imediata:230001', erb: { param: '230001' }) do
+          IBGE::Distrito.distritos_por_regiao_imediata(230001)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.distritos_por_regiao_intermediaria' do
+    context 'recebendo um array de IDs ([2301, 2302]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao_intermediaria:2301|2302', erb: { param: '2301%7C23017' }) do
+          IBGE::Distrito.distritos_por_regiao_intermediaria([2301, 2302])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2301) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_regiao_intermediaria:2301', erb: { param: '2301' }) do
+          IBGE::Distrito.distritos_por_regiao_intermediaria(2301)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.distritos_por_mesorregiao' do
+    context 'recebendo um array de IDs ([2303, 2304]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_mesorregiao:2303|2304', erb: { param: '2303%7C2304' }) do
+          IBGE::Distrito.distritos_por_mesorregiao([2303, 2304])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2303) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_mesorregiao:2303', erb: { param: '2303' }) do
+          IBGE::Distrito.distritos_por_mesorregiao(2303)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.distritos_por_microrregiao' do
+    context 'recebendo um array de IDs ([23016, 23017]) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_microrregiao:23016|23017', erb: { param: '23016%7C23017' }) do
+          IBGE::Distrito.distritos_por_microrregiao([23016, 23017])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (23016) como parâmetro' do
+      subject do
+        VCR.use_cassette('distrito/distritos_por_microrregiao:23016', erb: { param: '23016' }) do
+          IBGE::Distrito.distritos_por_microrregiao(23016)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+end

data/spec/lib/ibge/mesorregiao_spec.rb

@@ -0,0 +1,144 @@
+describe IBGE::Mesorregiao do
+  shared_examples_for 'objeto' do
+    it 'deve retornar um objeto IBGE::Mesorregiao' do
+      is_expected.to be_an IBGE::Mesorregiao
+    end
+
+    it 'deve retornar o nome Metropolitana de Fortaleza' do
+      expect(subject.nome).to eq('Metropolitana de Fortaleza')
+    end
+
+    it 'deve retornar o ID 2303' do
+      expect(subject.id).to eq(2303)
+    end
+
+    it 'deve retornar a UF, que é um objeto IBGE::UF' do
+      expect(subject.uf).to be_an IBGE::UF
+    end
+  end
+
+  shared_examples_for 'array' do
+    it 'deve retornar um Array<IBGE::Mesorregiao>' do
+      aggregate_failures do
+        is_expected.to be_an Array
+        expect(subject.first).to be_an IBGE::Mesorregiao
+      end
+    end
+  end
+
+  describe '.obter_mesorregioes' do
+    subject do
+      VCR.use_cassette('mesorregiao/obter_mesorregioes') do
+        IBGE::Mesorregiao.obter_mesorregioes
+      end
+    end
+
+    it_has_behavior 'array'
+  end
+
+  describe '.mesorregioes_por_uf' do
+    context 'recebendo um array de siglas (["BA", "CE"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_uf:BA|CE', erb: { param: 'BA%7CCE' }) do
+          IBGE::Mesorregiao.mesorregioes_por_uf(%w(BA CE))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um array de IDs ([29, 23]) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_uf:BA|CE', erb: { param: '29%7C23' }) do
+          IBGE::Mesorregiao.mesorregioes_por_uf([29, 23])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo uma sigla (CE) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_uf:CE', erb: { param: 'CE' }) do
+          IBGE::Mesorregiao.mesorregioes_por_uf('CE')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (23) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_uf:CE', erb: { param: 23 }) do
+          IBGE::Mesorregiao.mesorregioes_por_uf(23)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.mesorregioes_por_regiao' do
+    context 'recebendo um array de siglas (["N", "NE"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_regiao:N|NE', erb: { param: 'N%7CNE' }) do
+          IBGE::Mesorregiao.mesorregioes_por_regiao(%w(N NE))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um array de IDs ([1, 2]) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_regiao:N|NE', erb: { param: '1%7C2' }) do
+          IBGE::Mesorregiao.mesorregioes_por_regiao([1, 2])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_regiao:NE', erb: { param: 2 }) do
+          IBGE::Mesorregiao.mesorregioes_por_regiao(2)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo uma sigla (NE) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_regiao:NE', erb: { param: 'NE' }) do
+          IBGE::Mesorregiao.mesorregioes_por_regiao('NE')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.mesorregioes_por_id' do
+    context 'recebendo um array de IDs ([2303, 2304]) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_id:2303|2304', erb: { param: '2303|2304' }) do
+          IBGE::Mesorregiao.mesorregioes_por_id([2303, 2304])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2303) como parâmetro' do
+      subject do
+        VCR.use_cassette('mesorregiao/mesorregioes_por_id:2303', erb: { param: '2303' }) do
+          IBGE::Mesorregiao.mesorregioes_por_id(2303)
+        end
+      end
+
+      it_has_behavior 'objeto'
+    end
+  end
+end

data/spec/lib/ibge/microrregiao_spec.rb

@@ -0,0 +1,166 @@
+describe IBGE::Microrregiao do
+  shared_examples_for 'objeto' do
+    it 'deve retornar um objeto IBGE::Microrregiao' do
+      is_expected.to be_an IBGE::Microrregiao
+    end
+
+    it 'deve retornar o ID 23016' do
+      expect(subject.id).to eq(23016)
+    end
+
+    it 'deve retornar o nome Fortaleza' do
+      expect(subject.nome).to eq('Fortaleza')
+    end
+
+    it 'deve retornar a mesorregião, que é um objeto IBGE::Mesorregiao' do
+      expect(subject.mesorregiao).to be_an IBGE::Mesorregiao
+    end
+  end
+
+  shared_examples_for 'array' do
+    it 'deve retornar um Array<IBGE::Microrregiao>' do
+      aggregate_failures do
+        is_expected.to be_an Array
+        expect(subject.first).to be_an IBGE::Microrregiao
+      end
+    end
+  end
+
+  describe '.obter_microrregioes' do
+    subject do
+      VCR.use_cassette('microrregiao/obter_microrregioes') do
+        IBGE::Microrregiao.obter_microrregioes
+      end
+    end
+
+    it_has_behavior 'array'
+  end
+
+  describe '.microrregioes_por_id' do
+    context 'recebendo um array de IDs ([23016, 23017]) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_id:23016|23017', erb: { param: '23016%7C23017' }) do
+          IBGE::Microrregiao.microrregioes_por_id([23016, 23017])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (23016) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_id:23016', erb: { param: '23016' }) do
+          IBGE::Microrregiao.microrregioes_por_id(23016)
+        end
+      end
+
+      it_has_behavior 'objeto'
+    end
+  end
+
+  describe '.microrregioes_por_uf' do
+    context 'recebendo um array de siglas (["BA", "CE"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_uf:BA|CE', erb: { param: 'BA%7CCE' }) do
+          IBGE::Microrregiao.microrregioes_por_uf(%w(BA CE))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um array de IDs ([29, 23]) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_uf:BA|CE', erb: { param: '29%7C23' }) do
+          IBGE::Microrregiao.microrregioes_por_uf([29, 23])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo uma sigla (CE) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_uf:CE', erb: { param: 'CE' }) do
+          IBGE::Microrregiao.microrregioes_por_uf('CE')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (23) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_uf:CE', erb: { param: 23 }) do
+          IBGE::Microrregiao.microrregioes_por_uf(23)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.microrregioes_por_regiao' do
+    context 'recebendo um array de siglas (["N", "NE"]) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_regiao:N|NE', erb: { param: 'N%7CNE' }) do
+          IBGE::Microrregiao.microrregioes_por_regiao(%w(N NE))
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um array de IDs ([1, 2]) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_regiao:N|NE', erb: { param: '1%7C2' }) do
+          IBGE::Microrregiao.microrregioes_por_regiao([1, 2])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_regiao:NE', erb: { param: 2 }) do
+          IBGE::Microrregiao.microrregioes_por_regiao(2)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo uma sigla (NE) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_regiao:NE', erb: { param: 'NE' }) do
+          IBGE::Microrregiao.microrregioes_por_regiao('NE')
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+
+  describe '.microrregioes_por_mesorregiao' do
+    context 'recebendo um array de IDs ([2303, 2304]) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_mesorregiao:2303|2304', erb: { param: '2303%7C2304' }) do
+          IBGE::Microrregiao.microrregioes_por_mesorregiao([2303, 2304])
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+
+    context 'recebendo um ID (2303) como parâmetro' do
+      subject do
+        VCR.use_cassette('microrregiao/microrregioes_por_mesorregiao:2303', erb: { param: '2303' }) do
+          IBGE::Microrregiao.microrregioes_por_mesorregiao(2303)
+        end
+      end
+
+      it_has_behavior 'array'
+    end
+  end
+end