phone_classifier 0.0.1

data/README.md

@@ -0,0 +1,81 @@
+Phone Classifier
+================
+
+Used to quickly classifiy a phone number into :landline, :mobile or :forbidden
+
+Installation
+------------
+
+    gem install phone_classifier
+
+Usage
+-----
+
+    PhoneClassifier.new('41791234567').kind        # => :mobile
+    PhoneClassifier.new('41791234567').mobile?     # => true
+    PhoneClassifier.new('41791234567').forbidden?  # => false
+
+
+Supported Countries
+-------------------
+
+* +1, USA (will only reject service numbers, all other numbers considered mobile). Blame the US numbering systems
+* +6, Greece
+* +31, Netherlands
+* +30, Greece
+* +31, Netherlands
+* +32, Belgium
+* +33, France
+* +34, Spain
+* +36, Hungary
+* +39, Italy
+* +40, Romania
+* +41, Switerzland
+* +43, Austria
+* +44, UK
+* +45, Denmark
+* +46, Sweden
+* +47, Norway
+* +48, Poland
+* +49, Germany
+* +212, Morocco
+* +213, Algeria
+* +233, Ghana
+* +234, Nigeria
+* +249, Sudan
+* +350, Gibraltar
+* +351, Portugal
+* +352, Luxembourg
+* +353, Ireland
+* +354, Iceland
+* +356, Malta
+* +357, Cyprus
+* +358, Finland
+* +359, Bulgaria
+* +370, Lithuania
+* +372, Estonia
+* +377, Monaco
+* +386, Slovenia
+* +420, Czech Republic
+* +421, Slovakia
+
+
+Where is it used
+----------------
+
+Used in Mobino[http://mobino.com], a mobile payment service, to classifiy client phone numbers
+
+Related
+-------
+
+PhoneClassifier uses the fantastic 'Phony'[http://github.com/floere/phony.git] library to normalize numbers. Phony is
+the tool of choice if you need to work with phone numbers in Ruby.
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create new Pull Request

data/lib/phone_classifier.rb

@@ -0,0 +1,127 @@
+require 'phony'
+
+class PhoneClassifier
+
+  # authorative info: http://www.itu.int/oth/T0202.aspx?parent=T0202
+  # Numbering schemes for mobile numbers
+  #
+  @@mobile = {
+      '1' => %w{ [2-9].. }, # USA
+      '30' => %w{ 6.. }, # Greece
+      '31' => %w{6}, # Netherlands
+      '32' => %w{4..}, # Belgium
+      '33' => %w{6 7}, # France
+      '34' => %w{6. 7.}, # Spain
+      '36' => %w{ 20 30 31 70 }, # Hungary
+      '39' => %w{3...}, # Italy
+      '40' => %w{ 7. }, # Romania
+      '41' => %w{ 7[6-9] }, # Switerzland
+      '43' => %w{ 67 68 644 65. 66. }, # Austria
+      '44' => %w{ 7[4-9].. }, # UK
+      '45' => %w{ 2[0-9] 30 31 40 41 42 5[0-3] 60 61 71 81 9[1-3] }, # Denmark
+      '46' => %w{ 70 72 73 76 }, # Sweden
+      '47' => %w{ 9.. 4.. 58. 59. }, # Norway
+      '48' => %w{50. 51. 53. 60. 66. 69. 72. 78. 79. 88.}, # Poland
+      '49' => %w{ 151 152 157 159 160 162 163 17[0-9] }, # Germany
+      '212' => %w{ 6.  }, # Morocco
+      '213' => %w{ 55 66 697 699 77 790 796 }, # Algeria
+      '233' => %w{ 20 23 24 26 27 28 50 54 57 },
+      '234' => %w{ 702[1-9] 70[3-9] 8[01][2-9] },
+      '249' => %w{ 9.  }, # Sudan
+      '350' => %w{ 5. 6. }, # Gibraltar
+      '351' => %w{ 9. }, # Portugal
+      '352' => %w{ 621 628 661 668 691 698 }, # Luxembourg
+      '353' => %w{ 8[2-9] }, # Ireland
+      '354' => %w{ 6.. 7.. 8..}, # Iceland
+      '356' => %w{ 77 79 98 99 }, # Malta
+      '357' => %w{ 95 96 97 99 }, # Cyprus
+      '358' => %w{ 4. 50 }, # Finland
+      '359' => %w{ 430 87. 88. 89. 98. }, # Bulgaria
+      '370' => %w{ 6.. }, # Lithuania
+      '372' => %w{ 5.. 81. 82.}, # Estonia
+      '377' => %w{ 4. 6 }, # Monaco
+      '386' => %w{ 30 40 31 41 51 71 70 64}, # Slovenia
+      '420' => %w{ 60[1-8] 72. 73. 77. 79. 91 }, # Czech Republic
+      '421' => %w{ 9.. }, # Slovakia
+  }
+
+  @@forbidden = {
+      '1' => %w{ 1.. }, # USA
+      '30' => %w{ 8.. 9.. }, # Greece
+      '31' => %w{84 85 87 88 91 112 676 800 900 906 909}, # Netherlands
+      '32' => %w{70 800 90[0-9]}, # Belgium
+      '33' => %w{8}, # France
+      '34' => %w{10 11 80 90}, # Spain
+      '36' => %w{ 40 41 50 55 60 71 80 90 91 }, # Hungary
+      '39' => %w{1 7 8}, # Italy
+      '40' => %w{ 8. 9. }, # Romania
+      '41' => %w{ 74 800 840 842 844 848 860 868 900 901 906 }, # Switzerland
+      '43' => %w{ 718 720 780 8.. 9.. }, # Austria
+      '44' => %w{800 808 842 843 844 845 870 871 872 873 900 908 909 982}, # UK
+      '45' => %w{10 11 18 70 80 90}, # Denmark
+      '46' => %w{ 900 939 944 99. },
+      '47' => %w{ 8.. }, # Norway
+      '48' => %w{70., 80.}, # Poland
+      '49' => %w{ 1. 164 168 169 180 181 19[0-4] 800 900 }, # Germany
+      '212' => %w{ 8. }, # Morocco
+      '213' => %w{ 8.. 9.. }, # Algeria
+      '233' => %w{ 1 4 6 7 8 9 },
+      '234' => %w{ 8.. 9.. },
+      '249' => %w{ }, # Sudan
+      '350' => %w{ 8... }, # Gibraltar
+      '351' => %w{ 800 80. }, # Portugal
+      '352' => %w{ 118 12 13 800 801 900 901 905 }, # Luxembourg
+      '353' => %w{ 76 80 81 800 }, # Ireland
+      '354' => %w{ 8.. 9.. }, # Iceland
+      '356' => %w{ }, # Malta
+      '357' => %w{ 80 90 }, # Cyprus
+      '358' => %w{ 6.. 7.. 8.. }, # Finland
+      '359' => %w{ 800 900 }, # Bulgaria
+      '370' => %w{ 800 9.. }, # Lithuania
+      '372' => %w{ 1.. 800 }, # Estonia
+      '377' => %w{  }, # Monaco
+      '386' => %w{ 80 89 90 }, # Slovenia
+      '420' => %w{ 8.. 9.. }, # Czech republic
+      '421' => %w{ }, # Slovakia
+  }
+
+  def initialize number
+    @number = number
+  end
+
+  def kind
+    case
+      when self.mobile? then
+        :mobile
+      when self.forbidden? then
+        :forbidden
+      else
+        :landline
+    end
+  end
+
+  def mobile?
+    return is_number_of_type @@mobile
+  end
+
+
+  def forbidden?
+    return is_number_of_type @@forbidden
+  end
+
+  def is_number_of_type numbers
+    parts = Phony.split Phony.normalize(@number)
+    forbidden_numbers = numbers[parts.shift]
+    prefix = parts.shift
+
+    # This is a hotfix for strange behaviour.
+    # I don't know why but some numbers are split ["45", false, "40", "53", "25", "77"]
+    until prefix.is_a? String
+      prefix = parts.shift
+    end
+
+    forbidden_numbers.each { |n| return true if prefix.match(/^#{n}$/) } unless forbidden_numbers.nil?
+    false
+  end
+
+end

data/spec/phone_classifier_spec.rb

@@ -0,0 +1,297 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+
+describe PhoneClassifier do
+
+  context "it classifies a phone number" do
+
+    let(:phone_number) { "41791234567" }
+
+    context "mobile numbers" do
+      it "correctly classifies a mobile number" do
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "correctly classifies a mobile number" do
+        PhoneClassifier.new(phone_number).mobile?.should == true
+      end
+
+
+    end
+
+    context "forbidden numbers" do
+      let(:phone_number) { "4180012345" }
+      it "correctly classifies a forbidden number" do
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+      it "correctly classifies a forbidden number" do
+        PhoneClassifier.new(phone_number).forbidden?.should == true
+      end
+    end
+
+  end
+
+
+  context "kinds of numbers" do
+
+
+    context "Belgium Numbers" do
+
+      it "should set BE mobile numbers" do
+        phone_number = "32497546747"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set BE land numbers" do
+        phone_number = "326279584"
+            PhoneClassifier.new(phone_number).kind.should == :landline
+
+      end
+
+    end
+
+    context "Swiss Numbers" do
+
+      it "should set CH mobile numbers" do
+        phone_number = "41791234567"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+
+      end
+
+      it "should set CH land numbers" do
+        phone_number =  "41444010930"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+    end
+
+    context "German Numbers" do
+
+      it "should set DE mobile numbers" do
+        phone_number = "49170123456"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set DE land numbers" do
+        phone_number =  "4977317983830"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+      it "should set DE service and paid numbers" do
+        phone_number = "491805878323"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+    end
+
+    context "Danish Numbers" do
+
+      it "should set DK mobile numbers" do
+        phone_number = "4540532577"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set DK mobile numbers" do
+        phone_number = "4529727515"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set DK forbidden numbers" do
+        phone_number = "4580727515"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+      it "should set DK land numbers" do
+        phone_number = "4545862577"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+    end
+
+    context "French Numbers" do
+
+      it "should set FR forbidden numbers" do
+        phone_number =  "33810459827"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+      it "should set FR mobile numbers (6)" do
+        phone_number = "33653832227"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set FR mobile numbers (7)" do
+        phone_number = "33753832227"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set FR land numbers" do
+        phone_number = "33953832227"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+    end
+
+    context "Italian Numbers" do
+
+      it "should set IT mobile numbers" do
+        phone_number = "393357210499"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set IT land numbers" do
+        phone_number = "390117210499"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+    end
+
+    context "Netherlands Numbers" do
+
+      it "should set NL mobile numbers" do
+        phone_number = "31612345678"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set NL land numbers" do
+        phone_number = "31201234567"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+      it "should set NL forbidden numbers" do
+        phone_number = "318001234567"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+    end
+
+    context "Polish Numbers" do
+
+      it "should set PL mobile numbers" do
+        phone_number = "48501224455"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set PL land numbers" do
+        phone_number = "48121123123"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+      it "should set PL forbidden numbers" do
+        phone_number =  "488001234567"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+    end
+
+    context "Spanish Numbers" do
+
+      it "should set ES mobile numbers" do
+        phone_number = "34 611 123 123"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set ES forbidden numbers (800)" do
+        phone_number = "34800 123 123"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+      it "should set ES forbidden numbers (900)" do
+        phone_number =  "34901 123 123"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+      it "should set ES land numbers" do
+        phone_number = "34822 123 123"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+    end
+
+    context "UK Numbers" do
+
+      it "should set UK mobile numbers" do
+        phone_number = "447412121314"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set UK mobile numbers" do
+        phone_number = "44778533097"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set UK land numbers" do
+        phone_number = "442012121314"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+      it "should set UK forbidden numbers" do
+        phone_number = "4480012121314"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+    end
+
+
+    context "Nigerian Numbers" do
+
+      it "should set Nigeria mobile numbers" do
+        phone_number = "2347021 555 5555"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set Nigeria mobile numbers" do
+        phone_number = "234704 555 5555"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set Nigeria mobile numbers (80x)" do
+        phone_number = "234804 555 5555"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set Nigeria mobile numbers (81x)" do
+        phone_number = "234815 555 5555"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set Nigeria land numbers" do
+        phone_number = "2341 555 5555"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+      it "should set Nigeria forbidden numbers" do
+        phone_number = "234800 555 5555"
+        PhoneClassifier.new(phone_number).kind.should == :forbidden
+      end
+
+    end
+
+
+    context "Luxemborgian Numbers" do
+
+      it "should set Luxembourg mobile numbers" do
+        phone_number = "352661 555 555"
+        PhoneClassifier.new(phone_number).kind.should == :mobile
+      end
+
+      it "should set Luxemborgian land numbers" do
+        phone_number = "3522467 55 55 55"
+        PhoneClassifier.new(phone_number).kind.should == :landline
+      end
+
+      #it "should set Luxemborgian forbidden numbers" do
+      #  phone_number = TelephoneNumber.make(:base_number => "800 5 55 55",
+      #                                          :country_code => "352",
+      #                                          :telephonable => @client)
+      #  phone_number.valid?
+      #  phone_number.kind.should == :forbidden
+      #end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: phone_classifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jens-Christian Fischer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Classifies some countries phone numbers into :mobile, :forbidden and
+  :landline
+email: jcf+phone_classifier@mobino.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/phone_classifier.rb
+- README.md
+- spec/phone_classifier_spec.rb
+homepage: http://github.com/mobino/phone_classifier
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Classification of phone numbers
+test_files:
+- spec/phone_classifier_spec.rb