vinibrsl / burocracia.cr

👔 Zero-dependency Crystal shard to validate, generate and format Brazilian burocracias (CPF, CNPJ, CEP)

burocracia.cr

All Brazilian boring burocracias solved

burocracia.cr is the dependecyless Crystal shard to validate, generate and format Brazilian burocracias such as CPF, CNPJ and CEP.

Installation

Add this to your application's shard.yml:

dependencies:
  burocracia:
    github: vinibrsl/burocracia.cr

Usage

require "burocracia"

Burocracia::CEP.generate
=> "23230133"

Burocracia::CEP.generate(format: true)
=> "71946-192"

Burocracia::CEP::Address.find "80210-130"
=> #<CEP::Address:0x10e1b83c0 @cep="80210130", @neighborhood="Jardim Botânico", @city="Curitiba", @street="Rua José Ananias Mauad", @state="Paraná", @state_abbreviation="PR">

Burocracia::CPF.valid?("10880423971")
=> false

Burocracia::CNPJ.format("92583745000149")
=> "92.583.745/0001-49"

Burocracia::CNPJ.sanitize("92.583.745/0001-49")
=> "92583745000149"

Read the full documentation here.

Contributing

1. Fork it ( https://github.com/vinibrsl/burocracia.cr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Please, don't forget to document the code and run crystal docs to apply the changes to /docs folder.

Contributors

• vinibrsl Vinicius Brasil - creator, maintainer

burocracia.cr's Issues

CNPJ validation, generation and formatting

Is your feature request related to a problem? Please describe.
The CNPJ is one of the Brazilian most important documents, used to identify companies.

Describe the solution you'd like
The CNPJ should be just like the CPF module, but with the correspondent validation algorithm.

Module to cover Brazilian phone numbers

Brazilians phone numbers can be hard to generate, validate and format, seen that there are at least three types of phone numbers in Brazil:

• Landline phones, eg.: +55 XX 3XXX-XXXX
• Mobile phones, eg.: +55 XX 9XXXX-XXXX or +55 XX 9XXX-XXXX
• Non-geographic phones, eg.: 0X00 XXX XXXX

It would be great to provide methods to:

• Validate phone numbers by type
• Generate phone numbers by type
• Recognize phone number types
• Format phone numbers