Skip to content

This gem does some tricks with Brazilian Telephone Numbers. It validates telephone numbers based on its area code, bands of operation and the rules defined by ANATEL.

Notifications You must be signed in to change notification settings

gabrielengel/telefonia_br

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Telefonia BR

This gem does some tricks with Brazilian Telephone Numbers. It validates telephone numbers based on its area code, bands of operation and the rules defined by ANATEL. The implementation of the ninth digit in Brazil has also been taken into account when developing this gem.

API to illustrate its functionality: http://telefonia-br.herokuapp.com?tel=(YY)XXXXXX

Installation

Add this line to your application's Gemfile:

gem "telefonia_br"

And then execute:

$ bundle

Or install it yourself as:

$ gem install telefonia_br

Usage

require "telefonia_br"

tel = TelBr.new("(YY)XXXXXXXX")  

tel.stripped          # Return stripped telephone: YYXXXXXXXX
tel.formatted         # Return formatted telephone: (YY) XXXX-XXXX

tel.ddd               # Return the DDD: YY
tel.state             # Return the state, such as "SP" for DDD 11 to 19
tel.region            # Return the region, such as "São José dos Campos e Região." for DDD 12

tel.number            # return the number: XXXXXXXX

tel.valid?            # Check if a telephone number is valid
tel.error             # Display the error if telephone number is invalid

Error Messages

If a telephone number is invalid you might get one of the following messages:

Invalid telephone
Invalid DDD
Invalid number
Number should have 8 digits
Number should have 9 digits

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-contribution)
  3. Commit your changes (git commit -am "your message")
  4. Push to the branch (git push origin my-contribution)
  5. Create a new Pull Request

About

This gem does some tricks with Brazilian Telephone Numbers. It validates telephone numbers based on its area code, bands of operation and the rules defined by ANATEL.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%