Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install via_cep
On terminal you can use via_cep like this:
require 'via_cep' address = ViaCep::Address.new('01001-000') address = ViaCep::Address.new(01001000) address.street # Returns "Praça da Sé"
You can use from terminal either
$ zipcode 01001-000 01406000
It will return 2 address with its information
01001-000: Praça da Sé Sé São Paulo SP 01406000: Avenida Nove de Julho Jardim Paulista São Paulo SP
And also search for a zipcode by an address
search = ViaCep::SearchByAddress.new(state: 'SP', city: 'São Paulo', street: 'Praça da Sé') search.zipcode # => "01001-000"
zipcode, street, complement, neighborhood, city, state, ibge, gia.
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/marcelobarreto/via_cep. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.