https://github.com/vinibrsl/viacep
🇧🇷 Dependency-less zipcode/CEP lookup gem for Brazilian addresses
https://github.com/vinibrsl/viacep
brasil cep gem ruby viacep zipcode-lookup-gem
Last synced: about 2 months ago
JSON representation
🇧🇷 Dependency-less zipcode/CEP lookup gem for Brazilian addresses
- Host: GitHub
- URL: https://github.com/vinibrsl/viacep
- Owner: vinibrsl
- License: mit
- Created: 2018-04-21T13:23:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-30T08:58:11.000Z (almost 2 years ago)
- Last Synced: 2025-05-12T05:08:50.146Z (about 2 months ago)
- Topics: brasil, cep, gem, ruby, viacep, zipcode-lookup-gem
- Language: Ruby
- Homepage:
- Size: 45.9 KB
- Stars: 18
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# viacep  [](https://github.com/vnbrs/burocracia.cr/blob/master/LICENSE)
> Dependency-less zipcode lookup gem for Brazilian addresses with an easy-to-use API and useful features such as timeout.
## Installing
You can easily install viacep through [RubyGems](https://rubygems.org/gems/viacep/):
```shell
gem install viacep
=> Rock on! 🚀
```
or add the following to your Gemfile:
```shell
gem "viacep"
```
## Usage
```ruby
require 'viacep'
# with unformatted zipcodes... =)
ViaCep::Address.new('80210130')
=> #
# with formatted zipcodes... =)
ViaCep::Address.new('13035-680')
=> #
# or even an nonexistent zipcode... =(
ViaCep::Address.new('12345678')
=> exception thrown: ViaCep::ApiRequestError
# and specifying a timeout in seconds... =)
ViaCep::Address.new('80210130', timeout: 0.2)
=> exception thrown: Timeout::Error (execution expired)
```
## Docs
The documentation is available on [RubyDoc](https://www.rubydoc.info/gems/viacep). Starting on [`ViaCep::Address`](https://www.rubydoc.info/gems/viacep/ViaCep/Address) might be a good start.
## Contributing
1. Create a fork (https://github.com/vnbrs/viacep/fork)
2. Create a branch (git checkout -b my-new-feature)
3. Make a commit (git commit -am 'Add some feature')
4. Push your code (git push origin my-new-feature)
5. Create a Pull Request
6. Thanks! 🤙🏼