number_recognizer 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wes Oldenbeuving
+
+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,60 @@
+NumberRecognizer
+================
+
+NumberRecognizer is library to recognize mobile phone numbers. It can make educated guesses to correct local numbers into numbers in international format.
+
+Examples
+--------
+
+    require "number_recognizer"
+    @nc = NumberRecognizer.new("0612345678")
+    @nc.valid_or_correct_mobile?  # => true
+    @nc.country_name              # => "Netherlands"
+    @nc.country                   # => "31"
+    @nc.prefix                    # => "31"
+    @nc.local_number              # => "612345678"
+    @nc.normalized_number         # => "31612345678"
+
+Supported countries
+-------------------
+
+It does not aim for worldwide coverage and correction, as that is not the problem I'm trying to solve.
+If you want to add a country, feel free to send me a pull request or create a feature request.
+
+* Australia (614xxxxxxxx)
+* Belgium (324xxxxxxxx)
+* England (447xxxxxxxx, 447xxxxxxxxx)
+* Germany (491xxxxxxxxx, 491xxxxxxxxxx)
+* Netherlands (316xxxxxxxx)
+* Portugal (3519xxxxxxxx)
+* Spain (346xxxxxxxx, 347xxxxxxxx)
+
+Some countries have some number ranges not covered. The regular expressions cover those, so check [lib/number_recognizer.rb](http://github.com/Narnach/number_recognizer/blob/master/lib/number_recognizer.rb) for the details.
+
+It is also possible to add your own custom format:
+
+    NumberRecognizer.add_format :country => "Utopia", :mobile=>true, :format => /(99)(9\d{8})/, :country_code=>999
+  
+Installation
+------------
+
+Simply install the gem from rubygems:
+
+    gem install number_recognizer
+  
+If you use Bundler, add it to your Gemfile and the do a bundle install:
+
+    gem "number_recognizer"
+
+Bug tracking / feature requests
+-------------------------------
+
+I use Github issues for this: https://github.com/Narnach/number_recognizer/issues
+
+Disclaimer
+----------
+
+It scratches my own itch and does not aim to solve everyone's problems.
+If it works for you, great! If it does not; fork it, patch it and send me a pull request.
+
+Written by Wes 'Narnach' Oldenbeuving in 2009. Licensed under the MIT license.

data/lib/number_recognizer.rb

@@ -0,0 +1,125 @@
+# -*- encoding : utf-8 -*-
+require_relative "number_recognizer/format_dsl"
+
+class NumberRecognizer
+  include FormatDsl
+
+  # Input
+  attr_accessor :number, :old_number, :country_name, :country, :local_number, :prefix
+
+  add_format :country => "Netherlands", :mobile=>true, :format => /(31)(6\d{8})/
+  add_format :country => "Belgium",     :mobile=>true, :format => /(32)(4\d{8})/
+  add_format :country => "Germany",     :mobile=>true, :format => /(49)(1([567])\d{8,9})/     # http://en.wikipedia.org/wiki/Phone_numbers_in_Germany
+  add_format :country => "England",     :mobile=>true, :format => /(44)(7\d{8,9})/            # http://en.wikipedia.org/wiki/Telephone_numbers_in_England
+  add_format :country => "Australia",   :mobile=>true, :format => /(61)(4\d{8})/              # http://en.wikipedia.org/wiki/Telephone_numbers_in_Australia
+  add_format :country => "Portugal",    :mobile=>true, :format => /(351)(9\d{8})/
+  add_format :country => "Spain",       :mobile=>true, :format => /(34)((6\d|7[1-9])\d{7})/   # http://en.wikipedia.org/wiki/Telephone_numbers_in_Spain
+
+  add_format :country => "Netherlands",     :mobile=>false, :format => /(31)([123457890]\d{8})/
+  add_format :country => "Germany",         :mobile=>false, :format => /(49)(\d([0123489])\d{8,9})/
+  add_format :country => "Suriname",        :mobile=>false, :format => /(597)(\d{7,7})/
+  add_format :country => "Dutch Antilles",  :mobile=>false, :format => /(599)(\d{7,7})/
+  add_format :country => "England",         :mobile=>false, :format => /(44)([0-68-9]\d{8,9})/
+  add_format :country => "Australia",       :mobile=>false, :format => /(61)([1-35-9]\d{8})/
+
+  def initialize(number)
+    @number = number
+    @parsed = false
+    @corrected = false
+
+    @valid = nil
+    @mobile = nil
+  end
+
+  def mobile?
+    parse unless @parsed
+    @mobile
+  end
+
+  def valid?
+    parse unless @parsed
+    @valid
+  end
+
+  def valid_or_correct_mobile?(country_bias=nil)
+    correct(country_bias)
+    valid? && mobile?
+  end
+
+  def normalized_number
+    parse unless @parsed
+    "#{prefix}#{local_number}"
+  end
+
+  def correct(country_bias=nil)
+    @corrected = false
+    old_number = number
+    case number
+    when /^0?9([136]\d{7})$/ #this must come before NL !
+      self.number = "3519#{$1}"
+    when /^0?7([1-9]\d{7})$/ # 07 can't be followed by a 0 in spain. It's legal in England.
+      prefix = pick_biased_country([44,34], country_bias)
+      self.number = "#{prefix}7#{$1}"
+    when /^0?7(0\d{7})$/ # 07 can't be followed by a 0 in spain. It's legal in England.
+      prefix = pick_biased_country([44], country_bias)
+      self.number = "#{prefix}7#{$1}"
+    when /^0?7(\d{9})$/ # Spanish numbers have 8 digits after the 07. English numbers can also have 9 digits after the 07.
+      prefix = pick_biased_country([44], country_bias)
+      self.number = "#{prefix}7#{$1}"
+    when /^0?6+(\d{8})$/
+      prefix = pick_biased_country([31,34], country_bias)
+      self.number = "#{prefix}6#{$1}"
+    when /^0?4(\d{8})$/
+      prefix = pick_biased_country([32,61], country_bias)
+      self.number = "#{prefix}4#{$1}"
+    else
+      # No correction, so no need re-parse
+      @corrected = true
+      return valid?
+    end
+    self.old_number = old_number
+    @parsed = false
+    @corrected = true
+    valid?
+  end
+
+  def type
+    return nil unless valid?
+    "#{country_name} #{mobile? ? "mobile" : "landline"}"
+  end
+
+  def country=(country)
+    @country = country.to_s
+  end
+
+  def prefix=(prefix)
+    @prefix = prefix.to_s
+  end
+
+  private
+
+  def parse
+    @parsed = true
+    @valid = false
+    number = self.number.to_s.sub(/^0+/,'')
+    format = self.class.formats.find {|format| number.match(format[:format])}
+    unless format
+      return
+    end
+    @mobile = format[:mobile]
+    self.country_name = format[:country]
+
+    match = number.match(format[:format])
+    self.prefix = match[1]
+    self.country = format[:country_code] || self.prefix
+    self.local_number = match[2]
+    @valid = true
+    nil
+  end
+
+  def pick_biased_country(allowed_countries, bias=nil)
+    country_bias = [bias].flatten.compact
+    whitelisted_bias = country_bias & allowed_countries
+    return whitelisted_bias.first || allowed_countries.first
+  end
+end

data/lib/number_recognizer/format_dsl.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+class NumberRecognizer
+  module FormatDsl
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def add_format(options={})
+        formats << {:country=>options[:country], :mobile=>options[:mobile], :format=>options[:format], :country_code=>options[:country_code]}
+      end
+
+      def formats
+        @formats ||= []
+      end
+    end
+  end
+end

data/number_recognizer.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  # Project
+  s.name         = 'number_recognizer'
+  s.summary      = "NumberRecognizer is library to recognize mobile phone numbers. It can make educated guesses to correct local numbers into numbers in international format."
+  s.description  = s.summary
+  s.version      = '1.0.0'
+  s.date         = '2012-03-27'
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Wes Oldenbeuving"]
+  s.email        = "narnach@me.com"
+  s.homepage     = "http://www.github.com/narnach/number_recognizer"
+
+  # Files
+  root_files     = %w[Readme.md number_recognizer.gemspec MIT-LICENSE]
+  bin_files      = []
+  lib_files      = %w[number_recognizer number_recognizer/format_dsl]
+  s.bindir       = "bin"
+  s.require_path = "lib"
+  s.executables  = bin_files
+  s.test_files   = %w[number_recognizer].map{|f| "spec/#{f}_spec.rb"}
+  s.files        = root_files + s.test_files + bin_files.map {|f| 'bin/%s' % f} + lib_files.map {|f| 'lib/%s.rb' % f} + %w[spec/spec_helper.rb]
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ Readme.md]
+  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'Readme.md'
+
+  # Requirements
+  s.required_ruby_version = ">= 1.8.0"
+end

data/spec/number_recognizer_spec.rb

@@ -0,0 +1,340 @@
+# -*- encoding : utf-8 -*-
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+require 'number_recognizer'
+
+describe NumberRecognizer do
+  it 'should normalize numbers' do
+    @nc = NumberRecognizer.new('0031612345678')
+    @nc.valid?
+    @nc.country.should == '31'
+    @nc.local_number.should == '612345678'
+    @nc.normalized_number.should == '31612345678'
+  end
+
+  describe 'valid?' do
+    it 'should be false when a nil number is provided' do
+      @nc = NumberRecognizer.new(nil)
+      @nc.should_not be_valid
+      @nc.country_name.should be_nil
+    end
+
+    it 'should recognize 0031612345678' do
+      @nc = NumberRecognizer.new('0031612345678')
+      @nc.should be_valid
+      @nc.country.should == '31'
+      @nc.local_number.should == '612345678'
+      @nc.country_name.should == 'Netherlands'
+    end
+
+    it 'should recognize 0031201234567' do
+      @nc = NumberRecognizer.new('0031201234567')
+      @nc.should be_valid
+      @nc.country.should == '31'
+      @nc.local_number.should == '201234567'
+      @nc.country_name.should == 'Netherlands'
+    end
+
+    it 'should recognize 0032412345678' do
+      @nc = NumberRecognizer.new('0032412345678')
+      @nc.should be_valid
+      @nc.country.should == '32'
+      @nc.local_number.should == '412345678'
+      @nc.country_name.should == 'Belgium'
+    end
+
+    it 'should recognize 005971234567' do
+      @nc = NumberRecognizer.new('005971234567')
+      @nc.should be_valid
+      @nc.country.should == '597'
+      @nc.local_number.should == '1234567'
+      @nc.country_name.should == 'Suriname'
+    end
+
+    it 'should recognize 005991234567' do
+      @nc = NumberRecognizer.new('005991234567')
+      @nc.should be_valid
+      @nc.country.should == '599'
+      @nc.local_number.should == '1234567'
+      @nc.country_name.should == 'Dutch Antilles'
+    end
+
+    it 'should recognize 00441234567890' do
+      @nc = NumberRecognizer.new('00441234567890')
+      @nc.should be_valid
+      @nc.country.should == '44'
+      @nc.local_number.should == '1234567890'
+      @nc.country_name.should == 'England'
+      @nc.should_not be_mobile
+    end
+
+    it 'should recognize 0044123456789' do
+      @nc = NumberRecognizer.new('0044123456789')
+      @nc.should be_valid
+      @nc.country.should == '44'
+      @nc.local_number.should == '123456789'
+      @nc.country_name.should == 'England'
+      @nc.should_not be_mobile
+    end
+
+    it 'should recognize 0044712345678' do
+      @nc = NumberRecognizer.new('0044712345678')
+      @nc.should be_valid
+      @nc.should be_valid_or_correct_mobile
+      @nc.country.should == '44'
+      @nc.local_number.should == '712345678'
+      @nc.country_name.should == 'England'
+      @nc.should be_mobile
+    end
+
+    it 'should recognize 00447123456789' do
+      @nc = NumberRecognizer.new('00447123456789')
+      @nc.should be_valid
+      @nc.should be_valid_or_correct_mobile
+      @nc.country.should == '44'
+      @nc.local_number.should == '7123456789'
+      @nc.country_name.should == 'England'
+      @nc.should be_mobile
+    end
+
+    it 'should recognize 0061451124205' do
+      @nc = NumberRecognizer.new('0061451124205')
+      @nc.should be_valid
+      @nc.country.should == '61'
+      @nc.local_number.should == '451124205'
+      @nc.country_name.should == 'Australia'
+    end
+
+    it 'should recognize 00351927123456' do
+      @nc = NumberRecognizer.new('00351927123456')
+      @nc.should be_valid
+      @nc.country.should == '351'
+      @nc.local_number.should == '927123456'
+      @nc.country_name.should == 'Portugal'
+    end
+
+    it 'should recognize 0034612345678' do
+      @nc = NumberRecognizer.new('0034612345678')
+      @nc.should be_valid
+      @nc.country.should == '34'
+      @nc.should be_mobile
+      @nc.local_number.should == '612345678'
+      @nc.country_name.should == 'Spain'
+    end
+
+    it 'should recognize 0034712345678' do
+      @nc = NumberRecognizer.new('0034712345678')
+      @nc.should be_valid
+      @nc.country.should == '34'
+      @nc.should be_mobile
+      @nc.local_number.should == '712345678'
+      @nc.country_name.should == 'Spain'
+    end
+
+    it 'should recognize 004912345678' do
+      @nc = NumberRecognizer.new('00491512345678')
+      @nc.should be_valid
+      @nc.country.should == '49'
+      @nc.should be_mobile
+      @nc.local_number.should == '1512345678'
+      @nc.country_name.should == 'Germany'
+    end
+
+    it 'should recognize 0049123456789' do
+      @nc = NumberRecognizer.new('004916123456789')
+      @nc.should be_valid
+      @nc.country.should == '49'
+      @nc.should be_mobile
+      @nc.local_number.should == '16123456789'
+      @nc.country_name.should == 'Germany'
+    end
+
+    it 'should NOT recognize 0034702345678 as a Spanish number' do
+      @nc = NumberRecognizer.new('0034702345678')
+      @nc.should_not be_valid_or_correct_mobile(34)
+    end
+  end
+
+  describe "correct" do
+    it 'should correct 06612345678 to 0031612345678' do
+      @nc = NumberRecognizer.new('06612345678')
+      @nc.should_not be_valid
+
+      @nc.correct.should be_true
+      @nc.number.should == '31612345678'
+      @nc.old_number.should == '06612345678'
+    end
+
+    it 'should correct 0612345678 to 0031612345678' do
+      @nc = NumberRecognizer.new('0612345678')
+      @nc.should_not be_valid
+
+      @nc.correct.should be_true
+      @nc.number.should == '31612345678'
+      @nc.old_number.should == '0612345678'
+    end
+
+    it 'should correct 07123456789 to 00447123456789' do
+      @nc = NumberRecognizer.new('07123456789')
+      @nc.should_not be_valid
+
+      @nc.correct.should be_true
+      @nc.number.should == '447123456789'
+      @nc.old_number.should == '07123456789'
+    end
+
+    it 'should correct 7123456789 to 00447123456789' do
+      @nc = NumberRecognizer.new('7123456789')
+      @nc.should_not be_valid
+
+      @nc.correct.should be_true
+      @nc.number.should == '447123456789'
+      @nc.old_number.should == '7123456789'
+    end
+
+    it 'should correct 0412345678 to 32412345678' do
+      @nc = NumberRecognizer.new('0412345678')
+      @nc.should_not be_valid
+
+      @nc.correct.should be_true
+      @nc.number.should == '32412345678'
+      @nc.old_number.should == '0412345678'
+    end
+
+    it 'should correct 0412345678 to 61412345678 given a country-bias for 61' do
+      @nc = NumberRecognizer.new('0412345678')
+      @nc.should_not be_valid
+
+      @nc.correct(61).should be_true
+      @nc.number.should == '61412345678'
+      @nc.old_number.should == '0412345678'
+    end
+
+    it 'should correct 0612345678 to 34612345678 given a country-bias for 34' do
+      @nc = NumberRecognizer.new('0612345678')
+      @nc.should_not be_valid
+
+      @nc.correct(34).should be_true
+      @nc.number.should == '34612345678'
+      @nc.old_number.should == '0612345678'
+    end
+
+    it 'should correct 0712345678 to 34712345678 given a country-bias for 34' do
+      @nc = NumberRecognizer.new('0712345678')
+      @nc.should_not be_valid
+
+      @nc.correct(34).should be_true
+      @nc.number.should == '34712345678'
+      @nc.old_number.should == '0712345678'
+    end
+  end
+
+  describe 'valid or correct mobile' do
+    it 'should correct 0612345678 to 0031612345678' do
+      @nc = NumberRecognizer.new('0612345678')
+      @nc.should be_valid_or_correct_mobile
+
+      @nc.country_name.should == 'Netherlands'
+      @nc.country.should == '31'
+      @nc.local_number.should == '612345678'
+    end
+
+    it 'should correct 612345678 to 0031612345678' do
+      @nc = NumberRecognizer.new('612345678')
+      @nc.should be_valid_or_correct_mobile
+
+      @nc.country_name.should == 'Netherlands'
+      @nc.country.should == '31'
+      @nc.local_number.should == '612345678'
+    end
+
+    it 'should accept 0032412345678' do
+      @nc = NumberRecognizer.new('0032412345678')
+      @nc.should be_valid_or_correct_mobile
+
+      @nc.country_name.should == 'Belgium'
+      @nc.country.should == '32'
+      @nc.local_number.should == '412345678'
+    end
+
+    it 'should accept 0412345678 as Australia given a country-bias for 61' do
+      @nc = NumberRecognizer.new('0412345678')
+      @nc.valid_or_correct_mobile?(61).should be_true
+
+      @nc.country_name.should == 'Australia'
+      @nc.country.should == '61'
+      @nc.local_number.should == '412345678'
+    end
+
+    it 'should accept 412345678 as Australia given a country-bias for 61' do
+      @nc = NumberRecognizer.new('412345678')
+      @nc.valid_or_correct_mobile?(61).should be_true
+
+      @nc.country_name.should == 'Australia'
+      @nc.country.should == '61'
+      @nc.local_number.should == '412345678'
+    end
+
+    it 'should correct 0913773785 to 00351913773785' do
+      @nc = NumberRecognizer.new('0913773785')
+      @nc.should be_valid_or_correct_mobile
+
+      @nc.country_name.should == 'Portugal'
+      @nc.country.should == '351'
+      @nc.local_number.should == '913773785'
+    end
+
+    it 'should correct 913773785 to 00351913773785' do
+      @nc = NumberRecognizer.new('913773785')
+      @nc.should be_valid_or_correct_mobile
+
+      @nc.country_name.should == 'Portugal'
+      @nc.country.should == '351'
+      @nc.local_number.should == '913773785'
+    end
+
+    it "should return false for a landline number" do
+      @nc = NumberRecognizer.new('31201234567')
+      @nc.should_not be_valid_or_correct_mobile
+    end
+
+    it "should return false for a corrupted mobile number" do
+      @nc = NumberRecognizer.new('061234567')
+      @nc.should_not be_valid_or_correct_mobile
+    end
+  end
+
+  describe 'mobile?' do
+    it 'should recognize 31612345678 as a mobile number' do
+      @nc = NumberRecognizer.new('0031612345678')
+      @nc.should be_mobile
+    end
+
+    it 'should recognize 31201234567 as not mobile number' do
+      @nc = NumberRecognizer.new('31201234567')
+      @nc.should_not be_mobile
+    end
+  end
+
+  describe "type" do
+    it "should compose country and mobile/landline status" do
+      @nc = NumberRecognizer.new('31612345678')
+      @nc.type.should == "Netherlands mobile"
+      @nc = NumberRecognizer.new('31201234567')
+      @nc.type.should == "Netherlands landline"
+    end
+  end
+
+  describe "custom format" do
+    it 'should use the custom country' do
+      NumberRecognizer.add_format :country => "Utopia", :mobile=>true, :format => /(999)(\d{8})/, :country_code=>99
+      @nc = NumberRecognizer.new('0099912345678')
+      @nc.should be_valid
+      @nc.should be_mobile
+      @nc.country.should == '99'
+      @nc.prefix.should == '999'
+      @nc.local_number.should == '12345678'
+      @nc.country_name.should == 'Utopia'
+      @nc.normalized_number.should == "99912345678"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# -*- encoding : utf-8 -*-
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir)

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: number_recognizer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Wes Oldenbeuving
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-27 00:00:00.000000000 Z
+dependencies: []
+description: NumberRecognizer is library to recognize mobile phone numbers. It can
+  make educated guesses to correct local numbers into numbers in international format.
+email: narnach@me.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Readme.md
+files:
+- Readme.md
+- number_recognizer.gemspec
+- MIT-LICENSE
+- spec/number_recognizer_spec.rb
+- lib/number_recognizer.rb
+- lib/number_recognizer/format_dsl.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/narnach/number_recognizer
+licenses: []
+post_install_message: 
+rdoc_options:
+- --inline-source
+- --line-numbers
+- --main
+- Readme.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: NumberRecognizer is library to recognize mobile phone numbers. It can make
+  educated guesses to correct local numbers into numbers in international format.
+test_files:
+- spec/number_recognizer_spec.rb
+has_rdoc: true