big-phoney 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+(c) Copyright 2010 GroupMe, Pat Nakajima, Steve Martocci
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# BIG PHONEY
+
+Parse phone numbers with Ruby.
+
+## It's a work in progress...
+
+But! Here's what you can do:
+
+
+    phone = PhoneNumber.new('20 484-123-1234 x 123')
+    phone.number        # => "4844679726"
+    phone.area_code     # => "484"
+    phone.extension     # => "123"
+    phone.country_code  # => "20"
+    phone.to_s          # => "+20 (484) 123-1234 ext. 123"
+
+Also, check validity:
+
+    phone = PhoneNumber.new('12345')
+    phone.valid? # => false
+    phone.errors # => [:too_short]
+
+The formatting and prefix type splitting stuff is still very US-centric. That will
+change as the need arises (or as you send me a pull request, you awesome developer you).

data/lib/big-phoney.rb

@@ -0,0 +1,103 @@
+MIN_US_LENGTH = 10
+MINLEN        = 7
+EXT           = /\s*(?:(?:ext|ex|xt|x)[\s.:]*(\d+))/i
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__))
+
+require 'big_phoney/country_codes'
+
+class PhoneNumber
+  def self.assume_us? ; @assume_us end
+  def self.assume_us=(us) ; @assume_us = us end
+
+  attr_accessor :country_code, :ext, :number
+
+  def initialize(number)
+    @number = number.strip
+    parse_extension
+    parse_country_code
+  end
+
+  def to_s
+    result = '(%s) %s-%s' % [area_code, prefix, rest]
+
+    if country_code != '1'
+      result = '+%s %s' % [country_code, result]
+    end
+
+    if extension
+      result = '%s ext. %s' % [result, extension]
+    end
+
+    result
+  end
+
+  def valid?
+    errors.empty?
+  end
+
+  def area_code
+    number[0..2]
+  end
+
+  def prefix
+    number[3..5]
+  end
+
+  def rest
+    number[6..9]
+  end
+
+  def errors
+    @errors ||= []
+  end
+
+  alias_method :extension, :ext
+
+  private
+
+  def parse_extension
+    @number =~ EXT
+    if $1 && $1.size > 4
+      errors << :extension
+    else
+      @ext = $1
+      @number.sub!(EXT, '')
+    end
+
+    @number.gsub!(/\D/, '')
+    @number.sub!(/^0+/, '')
+  end
+
+  def parse_country_code
+    if @number.size == 10
+      @number = "1#{@number}"
+    end
+
+    if PhoneNumber.assume_us?
+      if $_ && $_ < MIN_US_LENGTH
+        errors << :too_short
+      else
+        @country_code = "1"
+        @number.sub!(/^1/, '')
+        @num = $_
+      end
+    else
+      0.upto(2) do |len|
+        break if @country_code
+        if COUNTRY_CODES.include?(country_code = @number[0..len])
+          @country_code ||= country_code
+          @number.sub!(/^#{country_code}/, '')
+        end
+      end
+
+      if @country_code.nil?
+        errors << :country_code
+      end
+
+      if @country_code && "#{@country_code}#{@number}".size < MINLEN
+        errors << :too_short
+      end
+    end
+  end
+end

data/lib/big_phoney.rb

@@ -0,0 +1 @@
+require 'big-phoney'

data/lib/big_phoney/country_codes.rb

@@ -0,0 +1,29 @@
+class PhoneNumber
+  COUNTRY_CODES  = %w[
+    1  7  20  27  30  31  32  33  34
+    36  39  40  41  43  44  45  46  47
+    48  49  51  52  53  54  55  56  57
+    58  60  61  62  63  64  65  66  81
+    82  84  86  90  91  92  93  94  95
+    98  212  213  216  218  220  221  222  223
+    224  225  226  227  228  229  230  231  232
+    233  234  235  236  237  238  239  240  241
+    242  243  244  245  246  247  248  249  250
+    251  252  253  254  255  256  257  258  260
+    261  262  263  264  265  266  267  268  269
+    290  291  297  298  299  350  351  352  353
+    354  355  356  357  358  359  370  371  372
+    373  374  375  376  377  378  380  381  385
+    386  387  388  389  420  421  423  500  501
+    502  503  504  505  506  507  508  509  590
+    591  592  593  594  595  596  597  598  599
+    670  672  673  674  675  676  677  678  679
+    680  681  682  683  684  685  686  687  688
+    689  690  691  692  800  808  850  852  853
+    655  856  870  871  872  873  874  878  880
+    881  882  886  960  961  962  963  964  965
+    966  967  968  970  971  972  973  974  975
+    976  977  979  991  992  993  994  995  996
+    998
+  ]
+end

data/spec/big_phoney_spec.rb

@@ -0,0 +1,159 @@
+require 'spec/spec_helper'
+
+describe PhoneNumber do
+  describe "validity" do
+    it "is valid with a valid number" do
+      number = PhoneNumber.new('(484) 123-1234')
+      number.should be_valid
+    end
+
+    it "is invalid with wrong country code" do
+      number = PhoneNumber.new('+29 (484) 123-1234')
+      number.should_not be_valid
+      number.errors.should include(:country_code)
+    end
+
+    it "is invalid with extension that is too long" do
+      number = PhoneNumber.new('(484) 123-1234 x2343423432')
+      number.should_not be_valid
+      number.errors.should include(:extension)
+    end
+
+    it "is invalid when too short" do
+      number = PhoneNumber.new('423432')
+      number.should_not be_valid
+      number.errors.should include(:too_short)
+    end
+  end
+
+  describe "stripping other characters" do
+    it "strips parens" do
+      PhoneNumber.new('(484) 123-1234').number.should == '4841231234'
+    end
+
+    it "allows spaces" do
+      PhoneNumber.new('484 123 1234').number.should == '4841231234'
+    end
+
+    it "allows dashes" do
+      PhoneNumber.new('484-123-1234').number.should == '4841231234'
+    end
+
+    it "allows dots" do
+      PhoneNumber.new('484.123.1234').number.should == '4841231234'
+    end
+
+    it "allows plus signs" do
+      PhoneNumber.new('+1 (484) 123-1234').number.should == '4841231234'
+    end
+  end
+
+  describe "parsing extension" do
+    it "returns nil when there is none" do
+      PhoneNumber.new('4841231234').ext.should be_nil
+    end
+
+    it "when 'ext' (no spaces) is used" do
+      PhoneNumber.new('4841231234ext123').ext.should == '123'
+    end
+
+    it "when ' ext ' (with spaces) is used" do
+      PhoneNumber.new('4841231234 ext 123').ext.should == '123'
+    end
+
+    it "when ' ext. ' (with period) is used" do
+      PhoneNumber.new('4841231234 ext. 123').ext.should == '123'
+    end
+
+    it "when 'ex' (no spaces) is used" do
+      PhoneNumber.new('4841231234ex123').ext.should == '123'
+    end
+
+    it "when ' ex ' (with spaces) is used" do
+      PhoneNumber.new('4841231234 ex 123').ext.should == '123'
+    end
+
+    it "when 'x' (no spaces) is used" do
+      PhoneNumber.new('4841231234x123').ext.should == '123'
+    end
+
+    it "when ' x ' (with spaces) is used" do
+      PhoneNumber.new('4841231234 x 123').ext.should == '123'
+    end
+
+    it "gets removed from number" do
+      PhoneNumber.new('4841231234 x 123').number.should == '4841231234'
+    end
+  end
+
+  describe "country code" do
+    context "when in US-only mode" do
+      before(:each) do
+        PhoneNumber.assume_us = true
+      end
+
+      it "assumes 1" do
+        phone = PhoneNumber.new('4841231234')
+        phone.country_code.should == '1'
+        phone.number.should == '4841231234'
+      end
+
+      it "also parses country code as 1" do
+        phone = PhoneNumber.new('14841231234')
+        phone.country_code.should == '1'
+        phone.number.should == '4841231234'
+      end
+    end
+
+    context "when not in US-only mode" do
+      before(:each) do
+        PhoneNumber.assume_us = false
+      end
+
+      it "parses 1 digit country code" do
+        phone = PhoneNumber.new('74841231234')
+        phone.country_code.should == '7'
+        phone.number.should == '4841231234'
+      end
+
+      it "parses 2 digit country code" do
+        phone = PhoneNumber.new('204841231234')
+        phone.country_code.should == '20'
+        phone.number.should == '4841231234'
+      end
+
+      it "parses 3 digit country code" do
+        phone = PhoneNumber.new('9964841231234')
+        phone.country_code.should == '996'
+        phone.number.should == '4841231234'
+      end
+
+      it "parses international type numbers" do
+        phone = PhoneNumber.new('54-11-4444-3333')
+        phone.country_code.should == '54'
+        phone.number.should == '1144443333'
+      end
+    end
+  end
+
+  describe "area_code" do
+    it "takes the first 3 digits of number" do
+      phone = PhoneNumber.new('4841231234')
+      phone.area_code.should == '484'
+    end
+  end
+
+  describe "formatting" do
+    it "formats with parens by default" do
+      PhoneNumber.new('4841231234').to_s.should == '(484) 123-1234'
+    end
+
+    it "includes country code when not 1" do
+      PhoneNumber.new('544841231234').to_s.should == '+54 (484) 123-1234'
+    end
+
+    it "includes extension" do
+      PhoneNumber.new('4841231234x123').to_s.should == '(484) 123-1234 ext. 123'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'spec'
+require 'rr'
+
+require File.dirname(__FILE__) + '/../lib/big_phoney'
+
+Spec::Runner.configure { |c| c.mock_with(:rr) }

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: big-phoney
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pat Nakajima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-03 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/big-phoney.rb
+- lib/big_phoney.rb
+- lib/big_phoney/.gitignore
+- lib/big_phoney/country_codes.rb
+- spec/big_phoney_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple phone number parsing in Ruby
+test_files: []
+