countries-phone_numbers 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86db77726a2eb98b11c2aef026b1d121d3dcd184
-  data.tar.gz: b0083df537fe9839eb25f25a1a19148d4b581e2d
+  metadata.gz: 6e01743be9db3b672170580db4f87af93098682b
+  data.tar.gz: f7ee78a09bebc978aa02c1260d29e86e1fec35e7
 SHA512:
-  metadata.gz: db79a2bdc029e69156295bc0790c4034e4c213dc72d60ed70bff13ff3a972541dfbf7b94f6effc150f3d946774143ca3202fdcb57c908dbdc058d0917f41e8d9
-  data.tar.gz: 2058fb544e19f9da9b3f9734f6112ec8043fa78e51513c9db3b6a524873ef705aa7f1ad7b842100498b21998f45c43c780bb54177f25dbb92196e3732848e837
+  metadata.gz: 7ef8f13cbb4faae29eb73b7bdcdaf163de76f6695648aa9545e0fcd1b1aa8f9e3feac59aa3f4b5d28a41858e273872eaa72abe18e68eb5a223d2ac3b0580c689
+  data.tar.gz: 017cd3072663ce7c2c39905adde84874f5a02959030c884d379c6566e892a0f80864bd4bbde511c9926871fb9718ceebf06c2c3da3d5e3bfd10758701f040810

data/README.md

@@ -6,7 +6,7 @@ Integrate phone number to country lookup functionality into the ever-popular [Co
 
 Add this line to your application's Gemfile:
 
-    gem 'countries-plus-phonenumbers'
+    gem 'countries-phone_numbers'
 
 And then execute:
 
@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install countries-plus-phonenumbers
+    $ gem install countries-phone_numbers
 
 ## Usage
 
@@ -35,7 +35,7 @@ This gives you the normal country object. Treat it like you would any other sear
 
 ## What about countries that share the same Country Code?
 
-When multiple countries share a single country code - for instance, the North American Number Plan (NANP) - CountryDetectors are employed to provide additional analysis and intepretation. These detectors are not perfect, but they should catch most ambiguous situations.
+When multiple countries share a single country code - for instance, the North American Number Plan (NANP) - CountryDetectors are employed to provide additional intepretation. These detectors are not perfect, but they should catch many ambiguous situations.
 
 The detectors are configured in `country_detectors.yaml`.
 

data/countries-phone_numbers.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'countries', '>= 0.9'
-  spec.add_dependency 'phony', '>= 1.9'
+  spec.add_dependency 'countries', '~> 0.9'
+  spec.add_dependency 'phony', '~> 2.2'
   
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/countries/phone_numbers.rb

@@ -5,16 +5,37 @@ require 'countries'
 require 'phony'
 
 # Country::PhoneNumber
+require 'countries/phone_numbers/extensions'
 require 'countries/phone_numbers/detector_factory'
-require 'countries/phone_numbers/country_detector'
-require 'countries/phone_numbers/one_of_country_detector'
-require 'countries/phone_numbers/start_with_country_detector'
+require 'countries/phone_numbers/detector'
+require 'countries/phone_numbers/one_of_detector'
+require 'countries/phone_numbers/start_with_detector'
 
 # Gem extensions
-require 'countries/iso3166'
+# require 'countries/iso3166'
 
 module Countries
   module PhoneNumbers
+    extend Extensions::ClassMethods
     DATA_FILE = File.join( 'lib', 'countries', 'phone_numbers', 'detectors.yaml' )
+
+    ##
+    # Find all countries with shared country codes.
+    def self.shared_country_codes
+      codes = Country.all.map { |cc| Country[cc[1]].country_code }.uniq
+      shared = codes.each_with_object({}){ |cc,h| h[cc] = Country.find_all_countries_by_country_code(cc) }
+      shared.reject!{ |key,entry| entry.nil? or entry.count <= 1 }
+      shared.each{ |cc,countries| shared[cc] = countries.map{ |c| c.name } }
+    end
+  
+    ##
+    # Find all countries with shared country codes and do not have a dedicated detector.
+    def self.unresolved_country_codes
+      shared_country_codes.reject{ |key,value| self.phone_number_detector_factory.detector_for? key or key == '' }
+    end
+
   end
 end
+
+# Merge the phone number extensions into the base Country object.
+require 'countries/phone_numbers/ext'

data/lib/countries/phone_numbers/{country_detector.rb → detector.rb}

@@ -1,4 +1,4 @@
-class Countries::PhoneNumbers::CountryDetector
+class Countries::PhoneNumbers::Detector
 
   attr_accessor :country_codes, :applies_to, :default
   

data/lib/countries/phone_numbers/detector_factory.rb

@@ -38,11 +38,11 @@ class Countries::PhoneNumbers::DetectorFactory
     # Build a new config tool based on the given strategy
     return case
       when config.include?('start_with')
-        Countries::PhoneNumbers::StartWithCountryDetector.new config
+        Countries::PhoneNumbers::StartWithDetector.new config
       when config.include?('one_of')
-        Countries::PhoneNumbers::OneOfCountryDetector.new config
+        Countries::PhoneNumbers::OneOfDetector.new config
       else
-        Countries::PhoneNumbers::CountryDetector.new config
+        Countries::PhoneNumbers::Detector.new config
       end
   end
 

data/lib/countries/phone_numbers/ext.rb

@@ -0,0 +1,5 @@
+require 'countries/phone_numbers'
+
+class ISO3166::Country
+  include Countries::PhoneNumbers::Extensions
+end

data/lib/countries/phone_numbers/extensions.rb

@@ -0,0 +1,95 @@
+module Countries::PhoneNumbers::Extensions
+
+  def self.included( base )
+    base.extend ClassMethods
+  end
+  
+  def format_phone_number( number, options={} )
+    Phony.formatted( number, options )
+  end
+  
+  def format_local_phone_number( number, options={} )
+    format_phone_number( number, {format: :local}.merge(options) )
+  end
+  
+  def format_international_phone_number( number, options={} )
+    format_phone_number( number, {format: :international}.merge(options) )
+  end
+  
+  def format_national_phone_number( number, options={} )
+    format_phone_number( number, {format: :national}.merge(options) )
+  end
+  
+  module ClassMethods
+    def normalize_phone_number( number )
+      Phony.normalize( number )
+    end
+  
+    def tokenize_phone_number( number )
+      Phony.split( normalize_phone_number( number ) )
+    end
+  
+    ##
+    # Find the first country by the given telephone number. Returns an array of country code and data
+    def find_by_phone_number( number )
+      found = find_all_by_phone_number(number)
+      found.nil? ? nil : found.first
+    end
+  
+    ##
+    # Find all possible countries for the given telephone number.
+    # Generally we try to eliminate duplicates by using country code specific detectors.
+    def find_all_by_phone_number( number )
+      normalised_number = tokenize_phone_number( number )
+      country_code = normalised_number.first
+      
+      # Is this a detector country?
+      detector = phone_number_detector_factory.detector_for( country_code )
+      if detector
+        return detector.find_all_by_phone_number( normalised_number )
+       
+      # Otherwise ask the general code base for the number
+      else
+        return Country.find_all_by_country_code( country_code )
+      end
+  
+    rescue
+     return nil
+    end
+    
+    ##
+    # Find the first country by the given telephone number. Returns the country object itself.
+    def find_country_by_phone_number( number )
+      found = Country.find_all_countries_by_phone_number(number)
+      found.nil? ? nil : found.first
+    end
+    
+    ##
+    # Find all possible countries for the given telephone number.
+    # Generally we try to eliminate duplicates by using country code specific detectors.
+    def find_all_countries_by_phone_number( number )
+      normalised_number = tokenize_phone_number( number )
+      country_code = normalised_number.first
+      
+      # Is this a detector country?
+      detector = phone_number_detector_factory.detector_for( country_code )
+      if detector
+        return detector.find_all_countries_by_phone_number( normalised_number )
+       
+      # Otherwise ask Country for the number
+      else
+        return Country.find_all_countries_by_country_code( country_code )
+      end
+  
+    rescue
+     return nil
+    end
+    
+  protected
+  
+    def phone_number_detector_factory
+      @@phone_number_detector_factory ||= Countries::PhoneNumbers::DetectorFactory.new
+    end
+  end
+
+end

data/lib/countries/phone_numbers/{one_of_country_detector.rb → one_of_detector.rb}

@@ -1,4 +1,4 @@
-class Countries::PhoneNumbers::OneOfCountryDetector < Countries::PhoneNumbers::CountryDetector
+class Countries::PhoneNumbers::OneOfDetector < Countries::PhoneNumbers::Detector
 
   def initialize( config )
     super config

data/lib/countries/phone_numbers/{start_with_country_detector.rb → start_with_detector.rb}

@@ -1,4 +1,4 @@
-class Countries::PhoneNumbers::StartWithCountryDetector < Countries::PhoneNumbers::CountryDetector
+class Countries::PhoneNumbers::StartWithDetector < Countries::PhoneNumbers::Detector
 
   def initialize( config )
     super config

data/lib/countries/phone_numbers/version.rb

@@ -1,5 +1,5 @@
 module Countries
   module PhoneNumbers
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
   end
 end

data/spec/countries/country_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'countries/phone_numbers'
 
 describe ISO3166::Country, '#find_*_by_phone_number' do
   subject { Country }
@@ -14,7 +13,7 @@ describe ISO3166::Country, '#find_*_by_phone_number' do
     Country.find_country_by_phone_number( 'abc' ).should == nil
   end
   
-  # Test all data given in the 'TEST' block above
+  # Test all data given in the 'TEST' block (defined in the spec helper)
   TEST_DATA.each do |alpha2, numbers|
     numbers.each do |number|
       it "recognises #{number} as #{alpha2.to_s}" do
@@ -27,12 +26,4 @@ describe ISO3166::Country, '#find_*_by_phone_number' do
     end
   end
   
-  Country.unresolved_country_codes.each do |country_code, countries|
-    pending "Need to resolve CC: #{country_code} for #{countries.join(', ')}."
-  end
-  
-  (Country.all.map{ |country| country[1] } - TEST_DATA.keys).each do |alpha2|
-    pending "No tests for #{Country[alpha2].name} (#{alpha2})."
-  end
-  
 end

data/spec/countries/phone_numbers/detector_factory_spec.rb

@@ -13,7 +13,7 @@ describe Countries::PhoneNumbers::DetectorFactory do
   let(:one_of_config)     { { 'applies_to' => applies_to, 'default' => default_country, 'one_of' => { alternate_country => [ one_of_prefix ] } } }
   let(:start_with_config) { { 'applies_to' => applies_to, 'default' => default_country, 'start_with' => { alternate_country => [ start_with_prefix ] } } }
 
-  let(:default_detector)  { Countries::PhoneNumbers::CountryDetector.new(default_config) }
+  let(:default_detector)  { Countries::PhoneNumbers::Detector.new(default_config) }
   
   describe '.new' do
 
@@ -96,15 +96,15 @@ describe Countries::PhoneNumbers::DetectorFactory do
   
   describe '#build_detector' do
     it 'returns a generic detector' do
-      expect( subject.send(:build_detector, default_config) ).to be_a(Countries::PhoneNumbers::CountryDetector)
+      expect( subject.send(:build_detector, default_config) ).to be_a(Countries::PhoneNumbers::Detector)
     end
     
     it 'returns a one-of detector' do
-      expect( subject.send(:build_detector, one_of_config) ).to be_a(Countries::PhoneNumbers::OneOfCountryDetector)
+      expect( subject.send(:build_detector, one_of_config) ).to be_a(Countries::PhoneNumbers::OneOfDetector)
     end
     
     it 'returns a start-with detector' do
-      expect( subject.send(:build_detector, start_with_config) ).to be_a(Countries::PhoneNumbers::StartWithCountryDetector)
+      expect( subject.send(:build_detector, start_with_config) ).to be_a(Countries::PhoneNumbers::StartWithDetector)
     end
   end
 

data/spec/countries/phone_numbers_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'countries/phone_numbers'
+
+describe Countries::PhoneNumbers, '#find_*_by_phone_number' do
+  subject { Countries::PhoneNumbers }
+
+  # Test a bogus phone number
+  it 'ignores bogus phone numbers (single digit)' do
+    subject.find_country_by_phone_number( '5' ).should == nil
+  end
+  
+  # Test another bogus phone number
+  it 'ignores bogus phone numbers (text)' do
+    subject.find_country_by_phone_number( 'abc' ).should == nil
+  end
+  
+  # Test all data given in the 'TEST' block above
+  TEST_DATA.each do |alpha2, numbers|
+    numbers.each do |number|
+      it "recognises #{number} as #{alpha2.to_s}" do
+        subject.find_country_by_phone_number(number).should_not be_nil
+        subject.find_country_by_phone_number(number).alpha2.should == alpha2.to_s
+      end
+      it "returns only one country for #{number}" do
+        subject.find_all_countries_by_phone_number(number).should have(1).country
+      end
+    end
+  end
+  
+  Countries::PhoneNumbers.unresolved_country_codes.each do |country_code, countries|
+    pending "Need to resolve CC: #{country_code} for #{countries.join(', ')}."
+  end
+  
+  (Country.all.map{ |country| country[1] } - TEST_DATA.keys).each do |alpha2|
+    pending "No tests for #{Country[alpha2].name} (#{alpha2})."
+  end
+  
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: countries-phone_numbers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ian Lloyd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2014-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: countries
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: phony
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,16 +122,18 @@ files:
 - README.md
 - Rakefile
 - countries-phone_numbers.gemspec
-- lib/countries/iso3166.rb
 - lib/countries/phone_numbers.rb
-- lib/countries/phone_numbers/country_detector.rb
+- lib/countries/phone_numbers/detector.rb
 - lib/countries/phone_numbers/detector_factory.rb
 - lib/countries/phone_numbers/detectors.yaml
-- lib/countries/phone_numbers/one_of_country_detector.rb
-- lib/countries/phone_numbers/start_with_country_detector.rb
+- lib/countries/phone_numbers/ext.rb
+- lib/countries/phone_numbers/extensions.rb
+- lib/countries/phone_numbers/one_of_detector.rb
+- lib/countries/phone_numbers/start_with_detector.rb
 - lib/countries/phone_numbers/version.rb
 - spec/countries/country_spec.rb
 - spec/countries/phone_numbers/detector_factory_spec.rb
+- spec/countries/phone_numbers_spec.rb
 - spec/spec_helper.rb
 - spec/test_data.yaml
 homepage: http://github.com/illoyd/countries-phone_numbers
@@ -161,5 +163,6 @@ summary: Integrate phone number searching into the Country gem using Phony
 test_files:
 - spec/countries/country_spec.rb
 - spec/countries/phone_numbers/detector_factory_spec.rb
+- spec/countries/phone_numbers_spec.rb
 - spec/spec_helper.rb
 - spec/test_data.yaml

data/lib/countries/iso3166.rb

@@ -1,91 +0,0 @@
-require 'countries'
-require 'phony'
-
-class ISO3166::Country
-
-  def self.normalize_phone_number( number )
-    Phony.normalize( number )
-  end
-
-  def self.tokenize_phone_number( number )
-    Phony.split( normalize_phone_number( number ) )
-  end
-
-  ##
-  # Find the first country by the given telephone number. Returns an array of country code and data
-  def self.find_by_phone_number( number )
-    found = find_all_by_phone_number(number)
-    found.nil? ? nil : found.first
-  end
-
-  ##
-  # Find all possible countries for the given telephone number.
-  # Generally we try to eliminate duplicates by using country code specific detectors.
-  def self.find_all_by_phone_number( number )
-    normalised_number = tokenize_phone_number( number )
-    country_code = normalised_number.first
-    
-    # Is this a detector country?
-    detector = phone_number_detector_factory.detector_for( country_code )
-    if detector
-      return detector.find_all_by_phone_number( normalised_number )
-     
-    # Otherwise ask the general code base for the number
-    else
-      return find_all_by_country_code( country_code )
-    end
-
-  rescue
-   return nil
-  end
-  
-  ##
-  # Find the first country by the given telephone number. Returns the country object itself.
-  def self.find_country_by_phone_number( number )
-    found = find_all_countries_by_phone_number(number)
-    found.nil? ? nil : found.first
-  end
-  
-  ##
-  # Find all possible countries for the given telephone number.
-  # Generally we try to eliminate duplicates by using country code specific detectors.
-  def self.find_all_countries_by_phone_number( number )
-    normalised_number = tokenize_phone_number( number )
-    country_code = normalised_number.first
-    
-    # Is this a detector country?
-    detector = phone_number_detector_factory.detector_for( country_code )
-    if detector
-      return detector.find_all_countries_by_phone_number( normalised_number )
-     
-    # Otherwise ask the general code base for the number
-    else
-      return find_all_countries_by_country_code( country_code )
-    end
-
-  rescue
-   return nil
-  end
-
-  ##
-  # Find all countries with shared country codes.
-  def self.shared_country_codes
-    codes = Country.all.map { |cc| Country[cc[1]].country_code }.uniq
-    shared = codes.each_with_object({}){ |cc,h| h[cc] = Country.find_all_countries_by_country_code(cc) }
-    shared.reject!{ |key,entry| entry.nil? or entry.count <= 1 }
-    shared.each{ |cc,countries| shared[cc] = countries.map{ |c| c.name } }
-  end
-
-  ##
-  # Find all countries with shared country codes and do not have a dedicated detector.
-  def self.unresolved_country_codes
-    self.shared_country_codes.reject{ |key,value| self.phone_number_detector_factory.detector_for? key or key == '' }
-  end
-  
-protected
-
-  def self.phone_number_detector_factory
-    @@phone_number_detector_factory ||= Countries::PhoneNumbers::DetectorFactory.new
-  end
-  
-end