telephone_number 1.2.2 → 1.2.3

data/lib/importers/time_zone_data_importer.rb

@@ -0,0 +1,13 @@
+module TelephoneNumber
+  class TimeZoneDataImporter
+    def self.load_data!
+      master_data = {}
+      File.open('data/timezones/map_data.txt', 'rb').each do |row|
+        number_prefix, timezone = row.split('|').map(&:strip)
+        master_data[number_prefix] = timezone
+      end
+
+      File.open('data/timezones/map_data.dat', 'wb') { |file| file << Marshal.dump(master_data) }
+    end
+  end
+end

data/lib/telephone_number.rb

@@ -8,13 +8,15 @@ module TelephoneNumber
   autoload :Country,                 'telephone_number/country'
   autoload :Formatter,               'telephone_number/formatter'
   autoload :GeoLocator,              'telephone_number/geo_locator'
+  autoload :GeoLocationDataImporter, 'importers/geo_location_data_importer'
   autoload :Number,                  'telephone_number/number'
   autoload :NumberFormat,            'telephone_number/number_format'
   autoload :NumberValidation,        'telephone_number/number_validation'
   autoload :Parser,                  'telephone_number/parser'
-  autoload :GeoLocationDataImporter, 'importers/geo_location_data_importer'
   autoload :PhoneDataImporter,       'importers/phone_data_importer'
   autoload :TestDataImporter,        'importers/test_data_importer'
+  autoload :TimeZoneDataImporter,    'importers/time_zone_data_importer'
+  autoload :TimeZoneDetector,        'telephone_number/time_zone_detector'
 
   extend ClassMethods
 end

data/lib/telephone_number/country.rb

@@ -1,26 +1,25 @@
 module TelephoneNumber
   class Country
-    attr_reader :country_code, :national_prefix, :national_prefix_formatting_rule,
-                :national_prefix_for_parsing, :national_prefix_transform_rule, :international_prefix,
-                :formats, :validations, :mobile_token, :country_id, :general_validation, :main_country_for_code
+    attr_reader :country_code, :national_prefix, :national_prefix_for_parsing,
+                :national_prefix_transform_rule, :international_prefix, :formats,
+                :validations, :mobile_token, :country_id, :general_validation, :main_country_for_code
 
     MOBILE_TOKEN_COUNTRIES = { AR: '9' }.freeze
 
     def initialize(data_hash)
       @country_code = data_hash[:country_code]
       @country_id = data_hash[:id]
-      @formats = data_hash.fetch(:formats, []).map { |format| NumberFormat.new(format) }
       @general_validation = NumberValidation.new(:general_desc, data_hash[:validations][:general_desc]) if data_hash.fetch(:validations, {})[:general_desc]
       @international_prefix = Regexp.new(data_hash[:international_prefix]) if data_hash[:international_prefix]
       @main_country_for_code = data_hash[:main_country_for_code] == 'true'
       @mobile_token = MOBILE_TOKEN_COUNTRIES[@country_id.to_sym]
       @national_prefix = data_hash[:national_prefix]
-      @national_prefix_formatting_rule = data_hash[:national_prefix_formatting_rule]
       @national_prefix_for_parsing = Regexp.new(data_hash[:national_prefix_for_parsing]) if data_hash[:national_prefix_for_parsing]
       @national_prefix_transform_rule = data_hash[:national_prefix_transform_rule]
       @validations = data_hash.fetch(:validations, {})
                               .except(:general_desc, :area_code_optional)
                               .map { |name, data| NumberValidation.new(name, data) }
+      @formats = data_hash.fetch(:formats, []).map { |format| NumberFormat.new(format, data_hash[:national_prefix_formatting_rule]) }
     end
 
     def detect_format(number)

data/lib/telephone_number/formatter.rb

@@ -35,13 +35,12 @@ module TelephoneNumber
 
     def build_national_number(formatted: true)
       captures = normalized_number.match(number_format.pattern).captures
-      national_prefix_formatting_rule = number_format.national_prefix_formatting_rule || country.national_prefix_formatting_rule
 
       formatted_string = format(ruby_format_string(number_format.format), *captures)
       captures.delete(country.mobile_token)
 
-      if national_prefix_formatting_rule
-        national_prefix_string = national_prefix_formatting_rule.dup
+      if number_format.national_prefix_formatting_rule
+        national_prefix_string = number_format.national_prefix_formatting_rule.dup
         national_prefix_string.gsub!(/\$NP/, country.national_prefix)
         national_prefix_string.gsub!(/\$FG/, captures[0])
         formatted_string.sub!(captures[0], national_prefix_string)

data/lib/telephone_number/geo_locator.rb

@@ -1,6 +1,6 @@
 module TelephoneNumber
   class GeoLocator
-    attr_accessor :phone_number, :normalized_number, :location, :locale
+    attr_reader :phone_number, :normalized_number, :location, :locale
 
     # initialize with a phone_number object
     def initialize(phone_number, locale)
@@ -10,7 +10,6 @@ module TelephoneNumber
     end
 
     def location
-      return unless phone_number.valid?
       @location ||= find_location
     end
 

data/lib/telephone_number/number.rb

@@ -2,7 +2,7 @@ module TelephoneNumber
   class Number
     extend Forwardable
 
-    attr_reader :country, :parser, :formatter, :original_number, :geo_locator
+    attr_reader :country, :parser, :formatter, :original_number, :geo_locator, :time_zone_detector
 
     delegate [:valid?, :valid_types, :normalized_number] => :parser
     delegate [:national_number, :e164_number, :international_number] => :formatter
@@ -15,21 +15,29 @@ module TelephoneNumber
     end
 
     def location(locale = :en)
+      return if !country || !valid?
       @geo_locator ||= GeoLocator.new(self, locale)
       @geo_locator.location
     end
 
+    def timezone
+      return if !country || !valid?
+      @time_zone_detector ||= TimeZoneDetector.new(self)
+      @time_zone_detector.detect_timezone
+    end
+
     private
 
-    def detect_country
+    def eligible_countries
       # note that it is entirely possible for two separate countries to use the same
       # validation scheme. Take Italy and Vatican City for example.
-      eligible_countries = Country.all_countries.select do |country|
+      Country.all_countries.select do |country|
         original_number.start_with?(country.country_code) && self.class.new(original_number, country.country_id).valid?
       end
+    end
 
-      detected_country = eligible_countries.detect(&:main_country_for_code) || eligible_countries.first
-      Country.find(detected_country.country_id.to_sym) if detected_country
+    def detect_country
+      eligible_countries.detect(&:main_country_for_code) || eligible_countries.first
     end
   end
 end

data/lib/telephone_number/number_format.rb

@@ -3,12 +3,12 @@ module TelephoneNumber
 
     attr_reader :pattern, :leading_digits, :format, :national_prefix_formatting_rule, :intl_format
 
-    def initialize(data_hash)
+    def initialize(data_hash, country_prefix_formatting_rule)
       @pattern = Regexp.new(data_hash[:pattern]) if data_hash[:pattern]
       @leading_digits = Regexp.new(data_hash[:leading_digits]) if data_hash[:leading_digits]
       @format = data_hash[:format]
       @intl_format = data_hash[:intl_format]
-      @national_prefix_formatting_rule = data_hash[:national_prefix_formatting_rule]
+      @national_prefix_formatting_rule = data_hash[:national_prefix_formatting_rule] || country_prefix_formatting_rule
     end
   end
 end

data/lib/telephone_number/time_zone_detector.rb

@@ -0,0 +1,35 @@
+module TelephoneNumber
+  class TimeZoneDetector
+    attr_reader :phone_number, :timezone
+
+    def initialize(phone_number)
+      @phone_number = phone_number
+    end
+
+    def detect_timezone
+      normalized_number = build_normalized_number.dup
+      timezone = nil
+      (normalized_number.length - 2).times { break if timezone = data[normalized_number.chop!] }
+      timezone.to_s.split('&').join(', ')
+    end
+
+    def data
+      @data ||= Marshal.load(File.binread(File.expand_path('../../../data/timezones/map_data.dat', __FILE__)))
+    end
+
+    private
+
+    # Google's geocoding data is odd in that it uses a non-standard format for lookups
+    # on countries that have a mobile token. While I don't believe that this is used right now
+    # it will be if/when Google adds more specific data for Argentina. This method safe guards
+    # against that.
+    def build_normalized_number
+      return phone_number.e164_number(formatted: false) unless mobile_token = phone_number.country.mobile_token
+      if phone_number.parser.normalized_number.start_with?(mobile_token)
+        phone_number.e164_number(formatted: false).sub(mobile_token, '')
+      else
+        phone_number.e164_number(formatted: false)
+      end
+    end
+  end
+end

data/lib/telephone_number/version.rb

@@ -1,3 +1,3 @@
 module TelephoneNumber
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telephone_number
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - MOBI Wireless Management
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -373,6 +373,8 @@ files:
 - data/geocoding/en/592.txt
 - data/geocoding/en/599.dat
 - data/geocoding/en/599.txt
+- data/geocoding/en/61.dat
+- data/geocoding/en/61.txt
 - data/geocoding/en/62.dat
 - data/geocoding/en/62.txt
 - data/geocoding/en/64.dat
@@ -581,10 +583,13 @@ files:
 - data/geocoding/zh_Hant/886.txt
 - data/telephone_number_data_file.dat
 - data/telephone_number_data_file.xml
+- data/timezones/map_data.dat
+- data/timezones/map_data.txt
 - lib/active_model/telephone_number_validator.rb
 - lib/importers/geo_location_data_importer.rb
 - lib/importers/phone_data_importer.rb
 - lib/importers/test_data_importer.rb
+- lib/importers/time_zone_data_importer.rb
 - lib/telephone_number.rb
 - lib/telephone_number/class_methods.rb
 - lib/telephone_number/country.rb
@@ -594,6 +599,7 @@ files:
 - lib/telephone_number/number_format.rb
 - lib/telephone_number/number_validation.rb
 - lib/telephone_number/parser.rb
+- lib/telephone_number/time_zone_detector.rb
 - lib/telephone_number/version.rb
 - lib/utilities/hash.rb
 - telephone_number.gemspec