https://github.com/marcelobarreto/via_cep

Brazilian zipcode information
https://github.com/marcelobarreto/via_cep

brazil cep rubygems zipcode

Last synced: 10 months ago
JSON representation

Brazilian zipcode information

• Host: GitHub
• URL: https://github.com/marcelobarreto/via_cep
• Owner: marcelobarreto
• License: mit
• Created: 2016-03-04T21:51:11.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T18:52:53.000Z (over 1 year ago)
• Last Synced: 2025-04-12T16:52:40.630Z (11 months ago)
• Topics: brazil, cep, rubygems, zipcode
• Language: Ruby
• Homepage: https://rubygems.org/gems/via_cep
• Size: 94.7 KB
• Stars: 78
• Watchers: 5
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: FUNDING.yml
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# ViaCep

## Status

[![Build Status](https://api.travis-ci.org/marcelobarreto/via_cep.svg?branch=master)](https://travis-ci.org/marcelobarreto/via_cep)

[![Code Climate](https://codeclimate.com/github/marcelobarreto/via_cep.svg)](https://codeclimate.com/github/marcelobareto/via_cep)

[![Code Climate](https://codeclimate.com/github/marcelobarreto/via_cep/coverage.svg)](https://codeclimate.com/github/marcelobarreto/via_cep)

[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)

[![RubyGems](http://img.shields.io/gem/dt/via_cep.svg?style=flat)](http://rubygems.org/gems/via_cep)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'via_cep'

```

And then execute:

```$ bundle```

Or install it yourself as:

```$ gem install via_cep```

## Usage

On terminal you can use via_cep like this:

```ruby

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

```bash

$ zipcode 01001-000 01406000

```

It will return 2 address with its information

```bash

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

```ruby

search = ViaCep::SearchByAddress.new(state: 'SP', city: 'São Paulo', street: 'Praça da Sé')

search.zipcode # => "01001-000"

```

### Available methods

zipcode, street, complement, neighborhood, city, state, ibge, gia.

## Development

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](https://rubygems.org).

## Contributing

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.md) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).