mobile_number_normalizer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+script: "rspec spec"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mobile_number_normalizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dominik Masur
+
+MIT License
+
+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,35 @@
+# MobileNumberNormalizer
+[![Build Status](https://secure.travis-ci.org/TBAA/mobile_number_normalizer.png?branch=master)](http://travis-ci.org/TBAA/mobile_number_normalizer)
+This Gem introduce a MobileNumberNormalizer. It normalize mobile phone numbers and was tested againt
+many german and international mobile numbers.
+
+Numbers without international area prefix will be prefixed with 0049 for germany.
+
+Please take a look at the spec file for many examples.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mobile_number_normalizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mobile_number_normalizer
+
+## Usage
+
+MobileNumberNormalizer.get_number("01771234567")
+# => "00491771234567"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mobile_number_normalizer/version.rb

@@ -0,0 +1,3 @@
+class MobileNumberNormalizer
+  VERSION = "0.0.1"
+end

data/lib/mobile_number_normalizer.rb

@@ -0,0 +1,200 @@
+# -*- encoding : utf-8 -*-
+##
+# Normalize Mobile Numbers
+#
+# @author dmasur
+class MobileNumberNormalizer
+  ##
+  # Minimal Length of a Mobile Number
+  # 0049 => 4
+  # 177  => 3
+  # xxxxxx => minimal 4
+  #
+  # @author dmasur
+  MIN_MOBILE_NUMBER_LENGTH = 11
+  ##
+  # Array of String of International Area Codes
+  #
+  # @author dmasur
+  VALID_INTERNATIONAL_AREA_CODE = [ '001', '001809', '0020', '00212', '00213', '00216', '00218',
+                                    '00220', '00221', '00222', '00223', '00224', '00225', '00226',
+                                    '00227', '00228', '00229', '00230', '00231', '00232', '00233',
+                                    '00234', '00235', '00236', '00237', '00238', '00239', '00240',
+                                    '00241', '00242', '00243', '00244', '00245', '00247', '00248',
+                                    '00249', '00250', '00251', '00252', '00253', '00254', '00255',
+                                    '00256', '00257', '00258', '00260', '00261', '00262', '00263',
+                                    '00264', '00265', '00266', '00267', '00268', '00269', '0027',
+                                    '00290', '00291', '00297', '00298', '00299', '0030', '0031',
+                                    '0032', '0033', '0034', '00350', '00351', '00352', '00353',
+                                    '00354', '00355', '00356', '00357', '00358', '00359', '0036',
+                                    '00370', '00371', '00372', '00373', '00376', '00378', '0038',
+                                    '00385', '00387', '00389', '0039', '00396', '0040', '0041',
+                                    '0042', '0043', '0044', '0045', '0046', '0047', '0048', '00500',
+                                    '00501', '00502', '00503', '00504', '00505', '00506', '00507',
+                                    '00508', '00509', '0051', '0052', '0053', '0054', '0055',
+                                    '0056', '0057', '0058', '00590', '00591', '00592', '00593',
+                                    '00594', '00595', '00596', '00597', '00598', '00599', '0060',
+                                    '0061', '0062', '0063', '0064', '0065', '0066', '00670',
+                                    '00671', '00673', '00674', '00675', '00676', '00677', '00678',
+                                    '00679', '00680', '00682', '00684', '00685', '00686', '00687',
+                                    '00689', '00691', '00692', '007', '0081', '0084', '00850',
+                                    '00852', '00853', '00855', '00856', '0086', '00880', '00886',
+                                    '0090', '0091', '0092', '0094', '0095', '00960', '00961',
+                                    '00962', '00963', '00964', '00965', '00966', '00967', '00968',
+                                    '00971', '00972', '00973', '00974', '00975', '00976', '00977',
+                                    '0098', '00994' ]
+  def initialize(mobile_number)
+    @mobile_number = mobile_number
+  end
+
+  ##
+  # Return the correct mobile number as Class
+  #
+  # @author dmasur
+  def self.get_number number
+    $delete_mobile_numbers ||= []
+    number = new(number).get_number
+    return number
+  end
+
+  ##
+  # Return the correct mobile number
+  #
+  # @author dmasur
+  def get_number
+    org_num = @mobile_number
+    #puts "Full Number: #{@mobile_number}"
+    correct_typos_in_mobile_number
+    #puts "Typofix: #{@mobile_number}"
+    filter_part
+    #puts "After Filter: #{@mobile_number}"
+    clean_mobile_number
+    #puts "After clean: #{@mobile_number}"
+    mobile_number = "" unless has_valid_area_code?
+    $delete_mobile_numbers << org_num if @mobile_number.blank? && !org_num.blank?
+    return @mobile_number
+  end
+
+  ##
+  # Normalize mobile number
+  #
+  # @author dmasur
+  def clean_mobile_number
+    @mobile_number = MobileNumberNormalizer.clean_number @mobile_number
+  end
+
+  ##
+  # Try to fix typos in the mobile number
+  #
+  # @author dmasur
+  def correct_typos_in_mobile_number
+    @mobile_number.strip!
+    @mobile_number.gsub!(/[ßo]/, '0')
+    @mobile_number.gsub!(/[\(\)\.]/, '')
+    @mobile_number.gsub!(/\s(\d{2})\s/, '\1')
+    @mobile_number.gsub!(/[a-zA-Z\-]/, '')
+  end
+
+  ##
+  # Try to guess the right part of the mobile number
+  #
+  # @author dmasur
+  def filter_part
+    good_guess = nil
+    #puts splits
+    splits.each do |split|
+      good_guess = split if MobileNumberNormalizer.looks_like_a_mobile_number(split.strip)
+    end
+    #puts "Guess: #{good_guess}"
+    @mobile_number = good_guess unless good_guess.blank?
+  end
+
+  ##
+  # Split the number in uniq Parts
+  #
+  # @return [Array] Possible Numbers
+  # @author dmasur
+  def splits
+    split_chars = [/\s/,/\s{2}/, ':', ',', '/', '//', ')', '.', ' 0 ', ';']
+    return split_chars.map { |split_char| @mobile_number.split(split_char) }.flatten.uniq
+  end
+
+  ##
+  # Determinate if the number could be a mobile number
+  #
+  # @param [String] number Mobile number
+  # @return [Boolean] is valild number?
+  # @author dmasur
+  def self.looks_like_a_mobile_number number
+    if !number.blank?
+      #puts "Dirty Part: #{number}"
+      clean_number = MobileNumberNormalizer.clean_number(number)
+      #puts "Clean Part: #{number}: #{clean_number}"
+      if !clean_number.blank? && clean_number.length > MIN_MOBILE_NUMBER_LENGTH
+        #puts "Nice Part: #{number}"
+        return /^00491/ =~ clean_number
+      end
+    end
+  end
+
+  ##
+  # Clean a mobile number
+  #
+  # @param [String] mobile_number Mobile Number
+  # @return [String] Mobile Number
+  # @author dmasur
+  def self.clean_number mobile_number
+    mobile_number.strip!
+    mobile_number = replace_prefix mobile_number
+    #puts mobile_number
+    mobile_number = remove_superflouid_chars mobile_number
+    #puts mobile_number
+    mobile_number = "0049#{mobile_number[1..-1]}" if /^0[1-9]/ =~ mobile_number
+    delete_invalid_numbers mobile_number
+  end
+
+  ##
+  # Deletes the number if it is invalid
+  #
+  # @param [String] mobile_number Mobile Number
+  # @return [String] Mobile Number
+  # @author dmasur
+  def self.delete_invalid_numbers mobile_number
+    mobile_number = "" unless mobile_number.length.between?(MIN_MOBILE_NUMBER_LENGTH, 20)
+    mobile_number = "" if /^[^0]/ =~ mobile_number
+    return mobile_number
+  end
+
+  def has_valid_area_code?
+    VALID_INTERNATIONAL_AREA_CODE.any? do |area_code|
+      Regexp.new("^#{area_code}") =~ @mobile_number
+    end
+  end
+  ##
+  # Replace the different number prefix
+  #
+  # @param [String] mobile_number Mobile Number
+  # @return [String] Mobile Number
+  # @author dmasur
+  def self.replace_prefix mobile_number
+    mobile_number = "0#{mobile_number}" if /^1/ =~ mobile_number
+    mobile_number.sub!(/^49/, '0049')
+    mobile_number.sub!(/\+/, '00')
+    VALID_INTERNATIONAL_AREA_CODE.each do |area_code|
+      if mobile_number.start_with?(area_code[2..-1])
+        mobile_number = "00#{mobile_number}"
+      end
+    end
+    return mobile_number
+  end
+
+  ##
+  # Removed support characters in numbers
+  #
+  # @return [String] Mobile *Number*
+  # @author dmasur
+  def self.remove_superflouid_chars mobile_number
+    mobile_number.gsub!(/[\(\)\.:´+*^&]/,'')
+    mobile_number.gsub! /[^0-9]*/, ''
+  end
+end

data/mobile_number_normalizer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mobile_number_normalizer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dominik Masur"]
+  gem.email         = ["dominik.masur@googlemail.com"]
+  gem.description   = %q{Normalize mobile Phone Numbers}
+  gem.summary       = %q{Normalize mobile Phone Numbers}
+  gem.homepage      = "https://github.com/TBAA/mobile_number_normalizer"
+  gem.version       = MobileNumberNormalizer::VERSION
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mobile_number_normalizer"
+  gem.require_paths = ["lib"]
+  gem.version       = MobileNumberNormalizer::VERSION
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "active_support"
+  gem.add_development_dependency "rake"
+end

data/spec/lib/mobile_number_normalizer_spec.rb

@@ -0,0 +1,178 @@
+# -*- encoding : utf-8 -*-
+# All Testcases are derived from real mobile numbers
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/mobile_number_normalizer')
+require 'active_support/core_ext/object/blank'
+describe MobileNumberNormalizer do
+
+  describe "should parse number" do
+    it "without international area prefix" do
+      MobileNumberNormalizer.get_number("01771234567").should == "00491771234567"
+    end
+    it "with + in front as 00" do
+      MobileNumberNormalizer.get_number("+49 1771234567").should == "00491771234567"
+    end
+    it "with space in it" do
+      MobileNumberNormalizer.get_number("01520 1234567").should == "004915201234567"
+    end
+    it "without 00 of international prefix" do
+      MobileNumberNormalizer.get_number("321234567").should == "00321234567"
+    end
+    it "with , sperated" do
+      MobileNumberNormalizer.get_number("0049176-12345678,0178-1234567").should == "00491781234567"
+    end
+    it "with / in the number" do
+      MobileNumberNormalizer.get_number("0049177/1234567").should == "00491771234567"
+    end
+    it "with ß as 0 in the end (german typo)" do
+      MobileNumberNormalizer.get_number("0049178123456ß").should == "00491781234560"
+    end
+    it "with ß as 0 at front (german typo)" do
+      MobileNumberNormalizer.get_number("ß1761234567").should == "00491761234567"
+    end
+    it "0 to blank" do
+      MobileNumberNormalizer.get_number("0").should be_blank
+    end
+    it "00000000000000000000000000000000000 to blank" do
+      MobileNumberNormalizer.get_number("00000000000000000000000000000000000").should be_blank
+    end
+    it "with prefix in () and first number is a 9" do
+      MobileNumberNormalizer.get_number("(0160) 923 456 78 ").should == "004916092345678"
+    end
+    it "with prefix in () and first number is a 1" do
+      MobileNumberNormalizer.get_number("(0160) 123 456 78 ").should == "004916012345678"
+    end
+    it "with . in the middle and first number is a 9" do
+      MobileNumberNormalizer.get_number("0049176.92345678").should == "004917692345678"
+    end
+    it "with . in the middle and first number is a 1" do
+      MobileNumberNormalizer.get_number("0049176.12345678").should == "004917612345678"
+    end
+    it "with a Tel string in the middle of two numbers" do
+      MobileNumberNormalizer.get_number("017746 12345    Tel: 0221 1234567").
+        should == "00491774612345"
+    end
+    it "with a prefix of Mobil:" do
+      MobileNumberNormalizer.get_number(" Mobil:015712345678 ").should == "004915712345678"
+    end
+    it "with a - in the middle and spaces between numbers" do
+      MobileNumberNormalizer.get_number(" 0172 - 12 345 67").should == "00491721234567"
+    end
+    it "with a ´ in the middle" do
+      MobileNumberNormalizer.get_number("004917´12345678").should == "00491712345678"
+    end
+    it "with a o as 0" do
+      MobileNumberNormalizer.get_number("o1721234567").should == "00491721234567"
+    end
+    it "without a 0 at front" do
+      MobileNumberNormalizer.get_number("163/1234567").should == "00491631234567"
+    end
+    it "with two ++ in the front" do
+      MobileNumberNormalizer.get_number("++491601234567").should == "00491601234567"
+    end
+    it "with * in it to blank" do
+      MobileNumberNormalizer.get_number("0049176******").should == ""
+    end
+    it "with a ^ at the end" do
+      MobileNumberNormalizer.get_number("004915212345678^").should == "004915212345678"
+    end
+    it "with a & in the middle" do
+      MobileNumberNormalizer.get_number("0049162&1234567").should == "00491621234567"
+    end
+    it "without 00 in the area prefix" do
+      MobileNumberNormalizer.get_number("49 1 768 123 4567").should == "004917681234567"
+    end
+    it "with a prefix that is seperated with /" do
+      MobileNumberNormalizer.get_number("/0157/ 923-456-78").should == "004915792345678"
+    end
+    xit "with a prefix that is seperated with / and a number starting with 1" do
+      MobileNumberNormalizer.get_number("/0157/ 123-456-78").should == "004915712345678"
+    end
+    it "with %§$= to blank" do
+      MobileNumberNormalizer.get_number("0049173%§$=").should == ""
+    end
+    it "with numbers seperated with spaces" do
+      MobileNumberNormalizer.get_number("+44 742 123 4567").should == "00447421234567"
+    end
+    it "with two numbers sperated by / " do
+      MobileNumberNormalizer.get_number("015771234567 / 0031611234567").should == "004915771234567"
+    end
+    it "with one number in ()" do
+      input = "0177-1234567 (001-123-456-7890)"
+      MobileNumberNormalizer.get_number(input).should == "00491771234567"
+    end
+    it "with many spaces in the middle" do
+      MobileNumberNormalizer.get_number("030/ 123 45 67      (0176 1234567)").
+        should == "00491761234567"
+    end
+    it "with prefox Mobil Nr." do
+      MobileNumberNormalizer.get_number("Mobil Nr. 0177-1234567").should == "00491771234567"
+    end
+    it "with two numbers sperated by space" do
+      MobileNumberNormalizer.get_number("06131-1234567 0174-1234567").should == "00491741234567"
+    end
+    it "with two prefixed numbers" do
+      MobileNumberNormalizer.get_number("Handy: 01731234567 Tel.: 1234567").
+        should == "00491731234567"
+    end
+    it "with two numbers sperated by /" do
+      MobileNumberNormalizer.get_number("0049 1631234567 / 0031 123456789").
+        should == "00491631234567"
+    end
+    it "with two numbers sperated by / and spaces" do
+      MobileNumberNormalizer.get_number("030 123 456 78 / 0162 123 4567").should == "00491621234567"
+    end
+    it "with two numbers sperated by /" do
+      MobileNumberNormalizer.get_number("015212345678 / 017612345678").should == "004917612345678"
+    end
+    it "with two numbers sperated by 0" do
+      MobileNumberNormalizer.get_number("030 12345678 0 0176 12345678").should == "004917612345678"
+    end
+    it "with a area prefix in ()" do
+      MobileNumberNormalizer.get_number("(+49)176-12345678").should == "004917612345678"
+    end
+    it "with two numbers and postfixes in ()" do
+      MobileNumberNormalizer.get_number("+493012345678 () / +4915712345678 (0)").
+        should == "0049157123456780"
+    end
+    it "with three numbers seperated by //" do
+      MobileNumberNormalizer.get_number("0221/1234567 // 0160/12345678//0151/12345678").
+        should == "004915112345678"
+    end
+    it "with a /[:space:] in it" do
+      MobileNumberNormalizer.get_number("0049/ 17612345678").
+        should == "004917612345678"
+    end
+    it "with two numbers and a ) at the end" do
+      MobileNumberNormalizer.get_number("02323 123456 ) 0173 1234567 )").
+        should == "00491731234567"
+    end
+    it "without 00 at the beginning of area prefix" do
+      MobileNumberNormalizer.get_number("420771234567").
+        should == "00420771234567"
+    end
+    it "with two numbers seperated by a ." do
+      MobileNumberNormalizer.get_number("02233 / 923456 . 0172 / 9234567").
+        should == "00491729234567"
+    end
+    xit "with two numbers seperated by a ." do
+      MobileNumberNormalizer.get_number("02233 / 123456 . 0172 / 1234567").
+        should == "00491721234567"
+    end
+    it "with two numbers seperated by a 0" do
+      MobileNumberNormalizer.get_number("0531 1234567 0 0173 1234567").
+        should == "00491731234567"
+    end
+    it "with two numbers seperated by a ;" do
+      MobileNumberNormalizer.get_number("0049 176 12345678; 0043 6712345678").
+        should == "004917612345678"
+    end
+  end
+  describe "area codes" do
+    it "should accept right area code" do
+      MobileNumberNormalizer.get_number("0018091234567111").should == "0018091234567111"
+    end
+    it "should reject wrong area code" do
+      MobileNumberNormalizer.get_number("0018091234567111").should == "0018091234567111"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: mobile_number_normalizer
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dominik Masur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Normalize mobile Phone Numbers
+email: 
+- dominik.masur@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mobile_number_normalizer.rb
+- lib/mobile_number_normalizer/version.rb
+- mobile_number_normalizer.gemspec
+- spec/lib/mobile_number_normalizer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/TBAA/mobile_number_normalizer
+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.8.10
+signing_key: 
+specification_version: 3
+summary: Normalize mobile Phone Numbers
+test_files: 
+- spec/lib/mobile_number_normalizer_spec.rb
+- spec/spec_helper.rb