Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

viacep Tests GitHub 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:

gem install viacep
=> Rock on! 🚀

or add the following to your Gemfile:

gem "viacep"

Usage

require 'viacep'

# with unformatted zipcodes... =)
ViaCep::Address.new('80210130')
=> #<ViaCep::Address:0x00007fe52a8a0568 @cep="80210-130", @address="Rua José Ananias Mauad", @neighborhood="Jardim Botânico", @city="Curitiba", @state="PR", @ibge="4106902", @gia="">

# with formatted zipcodes... =)
ViaCep::Address.new('13035-680')
=> #<ViaCep::Address:0x00007fe52a99e730 @cep="13035-680", @address="Avenida João Jorge", @neighborhood="Vila Industrial", @city="Campinas", @state="SP", @ibge="3509502", @gia="2446">

# 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. Starting on 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! 🤙🏼
You can’t perform that action at this time.