# viacep [](https://github.com/vnbrs/burocracia.cr/blob/master/LICENSE)
> Gem responsável por buscar endereços a partir do CEP utilizando a API do ViaCEP com features úteis como timeout.
## Instalação
Instale o viacep pelo [RubyGems](https://rubygems.org/gems/viacep/) facilmente via terminal:
```shell
gem install viacep
=> Vai que é tua! 🚀
```
## Como usar?
```ruby
require 'viacep'
# com CEPs sem formatação...
ViaCep::Address.new('80210130')
=> #
# com CEPs formatados...
ViaCep::Address.new('13035-680')
=> #
# um CEP não existente...
ViaCep::Address.new('123')
=> exception thrown: ViaCep::ApiRequestError
# especificando um timeout em segundos...
ViaCep::Address.new('80210130', timeout: 0.2)
=> exception thrown: Timeout::Error (execution expired)
```
## Contribuindo
1. Faça um fork (https://github.com/vnbrs/viacep/fork)
2. Crie uma branch (git checkout -b my-new-feature)
3. Faça um commit (git commit -am 'Add some feature')
4. Faça o push (git push origin my-new-feature)
5. Crie um Pull Request
6. Valeu! 🤙🏼
## Contribuidores
- [vnbrs](https://github.com/vnbrs) Vinicius Brasil - creator, maintainer