= Phone Number Validator

== About

This app is a US phone number-validating RubyGem.

It uses a complex regular expression to validate any United States phone number.

=== Regular Expression

This gem uses the following regular expression:

  PHONE_NUMBER_REGEX = Regexp.new(/^(?:(?:[2-9]11)|(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:\x20+|#|x\.?|ext\.?|extension)\s*(\d+))?)$/, Regexp::IGNORECASE) # US Phone Numbers

== Installing

  $ gem install phone_number_validator

=== Install Required Gems/Dependencies

  $ bundle install

=== Updateing Required Gems/Dependencies

  $ bundle update

== Uninstalling

    $ gem uninstall phone_number_validator

== Testing

  $ rake test

== Usage

=== In command line

  $ phone_number_validator '+1 (949) 355-6244 ext. 198842'
  => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
  => true

=== In Ruby code

  require 'phone_number_validator'

  check_phone_number = PhoneNumberValidator.validate_phone_number('+1 (949) 355-6244 ext. 198842')

  print(check_phone_number)

==== Output

  => '+1 (949) 355-6244 ext. 198842' is a valid phone number.'
  => true