CodigoPostal

Validate, format and get the corresponding Brazilian state for a CEP without making HTTP requests.

Installation

Add this line to your application's Gemfile:

gem 'codigo_postal'

And then execute:

$ bundle install

Usage

To use CodigoPostal, create a new instance of the CodigoPostal class with a valid Brazilian postal code:

cep = CodigoPostal.new(1001000)
puts cep.state_code # => 'SP'
puts cep.state_name # => 'São Paulo'
puts cep.to_s # => '01001-000'

You can also compare two CodigoPostal instances using the == operator:

cep1 = CodigoPostal.new(4094050)
cep2 = CodigoPostal.new("04.094-050")
puts cep1 == cep2 # => true

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/felipedmesquita/codigo-postal.

License

The gem is available as open source under the terms of the MIT License.