numero 0.0.1 → 0.0.2

data/README.markdown

@@ -1,3 +1,50 @@
 # Numero
 
-This tiny gem contains helpers for validating US phone numbers.
+This tiny gem contains helpers for validating North American phone numbers.
+
+Add it to your `Gemfile`, or install as a plugin.
+
+
+## Usage
+
+Ruby:
+
+    Numero.valid_number?('15554442222') #=> true
+    Numero.valid_number?('194512') #=> false
+
+
+Rails Validations:
+
+    class User < ActiveRecord::Base
+      include Numero::Rails::Validations
+    end
+
+    u = User.new(:number => '1234')
+    u.valid? #=> false
+
+
+## The North American Numbering Plan
+
+Numero validates phone numbers based on the
+[North American Numbering Plan](http://en.wikipedia.org/wiki/North_American_Numbering_Plan).
+
+The NANP breaks phone numbers into 4 components:
+
+    |A| B | C | D |
+    +1-555-444-2222
+
+    A. ITU country code
+    B. NPA  - area code
+    C. NXX  - Central Office code (exchange)
+    D. XXXX - Subscriber Number
+
+Each section allows for a specific set of numbers:
+
+* **ITU**: This is always `+1` for North American numbers, although, it is
+  most often written without the `+`.
+* **NPA**: First digit must be in the range `[2-9]`, second and third digit
+  can be any number `[0-9]`.
+* **NXX**: First digit must be in the range `[2-9]`, second and third digit
+  can be any number `[0-9]`.
+* **XXXX**: [0-9] for each digit
+

data/lib/numero.rb

@@ -1,9 +1,10 @@
 module Numero
-  VERSION = Version = '0.0.1'
+  VERSION = Version = '0.0.2'
 
-  VALID_US_NUMBER = /^1?([2-9][0-8][0-9])([2-9][0-9]{2})([0-9]{4})$/
+  # See http://en.wikipedia.org/wiki/North_American_Numbering_Plan
+  VALID_PHONE_NUMBER = /^1?([2-9][0-9]{2})([2-9][0-9]{2})([0-9]{4})$/
 
-  def self.valid_us_number?(number)
-    !! number.to_s.match(VALID_US_NUMBER)
+  def self.valid_number?(number)
+    !! number.to_s.match(VALID_PHONE_NUMBER)
   end
 end

data/lib/numero/rails/validations.rb

@@ -8,14 +8,14 @@ module Numero
           if Numero::Rails.major < 3
             validates_presence_of       :number
             validates_numericality_of   :number, :allow_blank => true
-            validates_format_of         :number, :with => Numero::VALID_US_NUMBER
+            validates_format_of         :number, :with => Numero::VALID_PHONE_NUMBER
 
           # Rails 3
           else
             validates :number,
               :presence     => true,
               :numericality => { :allow_blank => true },
-              :format       => { :with => Numero::VALID_US_NUMBER }
+              :format       => { :with => Numero::VALID_PHONE_NUMBER }
 
           end
         end

data/test/numero_test.rb

@@ -1,13 +1,13 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 context 'Numero' do
-  test 'validates a US number' do
+  test 'validates a North American phone number' do
     valid_number   = 15185554488
-    valid_number10 = 15185554488
-    invalid_number = 199999999999
+    valid_number10 = 5185554488
+    invalid_number = 11456581535
 
-    assert Numero.valid_us_number?(valid_number)
-    assert Numero.valid_us_number?(valid_number10)
-    assert ! Numero.valid_us_number?(invalid_number)
+    assert Numero.valid_number?(valid_number)
+    assert Numero.valid_number?(valid_number10)
+    assert ! Numero.valid_number?(invalid_number)
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Joshua Priddle