phonelib 0.6.46 → 0.6.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f5702cfd1fd7ef6eecf8c589701a8be3879ffc29147df0915f05c40199ee43d
-  data.tar.gz: 694c0a043d7d2681652dd4a9e0ea3a668ccd35e300813acc8cfac2d6980caa3a
+  metadata.gz: 461ed2f679d7bae69dac1e7b1a34881d2c707402b9e9ee58af9bb2c66efc0976
+  data.tar.gz: c8f28d5c23bede4ef25c902437b1ee5d2f15b92cf193b5f5c82948ca70cca1c0
 SHA512:
-  metadata.gz: 37ea9d924c98e51c2879a395a7e56050ee63060ace543a60c69a6df7d4b92054af945532ec0b559bcbc298eca4597eb471d845a853caaae1538928e25b929b83
-  data.tar.gz: 69df60d5eeecc7747cca844b12adcac43d03396d676749d49ee5b381c8fc4f7b2b44543ad5605cf2772302820c087e37482a4dc43c826a925f4135772649d5ec
+  metadata.gz: fd41588b26a3fca412c750b1747fddb5f06aa433909a7557276f1f73f1a676c0452e143d4b27c99e74c0f5649c876a7d7f86dd869c7f61c53d085d36672e2899
+  data.tar.gz: ce69360d6fb7a926f29f48751f8fe4fbdc51ec84aea060e96163da5a8c0cf5fd207d5b1a66810c79971f1dde8d66408c49e45a9c3bab332df34301e7dc9e3d49

data/README.md

@@ -2,7 +2,7 @@
 
 [![Built in integration with JetBrains RubyMine](https://github.com/daddyz/phonelib/blob/master/icon_RubyMine.png?raw=true)](https://www.jetbrains.com/ruby/)
 [![Gem Version](https://badge.fury.io/rb/phonelib.svg)](http://badge.fury.io/rb/phonelib)
-[![Build Status](https://travis-ci.org/daddyz/phonelib.png?branch=master)](http://travis-ci.org/daddyz/phonelib)
+[![Build Status](https://travis-ci.com/daddyz/phonelib.svg?branch=master)](http://travis-ci.com/daddyz/phonelib)
 [![](https://codeclimate.com/github/daddyz/phonelib/badges/coverage.svg)](https://codeclimate.com/github/daddyz/phonelib/coverage)
 [![](https://codeclimate.com/github/daddyz/phonelib/badges/gpa.svg)](https://codeclimate.com/github/daddyz/phonelib)
 [![Inline docs](http://inch-ci.org/github/daddyz/phonelib.svg?branch=master)](http://inch-ci.org/github/daddyz/phonelib)
@@ -61,6 +61,12 @@ To disable sanitizing of passed phone number (keeping digits only)
 Phonelib.strict_check = true
 ```
 
+To change sanitized symbols on parsed number, so non-specified symbols won't be wiped and will fail the parsing
+
+``` ruby
+Phonelib.sanitize_regex = '[\.\-\(\) \;\+]'
+```
+
 To disable sanitizing of double prefix on passed phone number
 
 ```ruby
@@ -86,6 +92,21 @@ In case you need to overwrite some Google's libphonenumber library data, you nee
 Phonelib.override_phone_data = '/path/to/override_phone_data.dat'
 ```
 
+In case you want to add some custom or still not updated regex patterns for certain type you can use additional regexes feature in a following way:
+
+``` ruby
+Phonelib.add_additional_regex :us, Phonelib::Core::MOBILE, '[5]{10}' # this will add number 1-555-555-5555 to be valid
+Phonelib.add_additional_regex :gb, Phonelib::Core::MOBILE, '[1]{5}' # this will add number 44-11-111 to be valid
+# you can also specify all regexes using this method
+Phonelib.additional_regexes = [[:us, :mobile, "[5]{10}"], [:gb, :mobile, "[1]{5}"]]
+# or just use dump method to keep them altogether
+Phonelib.dump_additional_regexes # => [["US", :mobile, "[5]{10}"], ["GB", :mobile, "[1]{5}"]
+```
+
+(!) For a list of available types refer to this readme.
+
+(!) Please note that regex should be added as string
+
 In case phone number that was passed for parsing has "+" sign in the beginning, library will try to detect a country regarding the provided one.
 
 ### ActiveRecord Integration

data/lib/phonelib.rb

@@ -12,5 +12,9 @@ module Phonelib
 end
 
 if defined?(ActiveModel) || defined?(Rails)
-  autoload :PhoneValidator, 'validators/phone_validator'
+  if RUBY_VERSION >= '3.0.0'
+    autoload :PhoneValidator, 'validators/phone_validator3'
+  else
+    autoload :PhoneValidator, 'validators/phone_validator'
+  end
 end

data/lib/phonelib/core.rb

@@ -107,6 +107,22 @@ module Phonelib
       @@strict_check = strict
     end
 
+    # @private sanitizing regex, matching symbols will get removed from parsed number, must be string
+    @@sanitize_regex = '[^0-9]+'
+
+    # getter for sanitize regex
+    # @return [String] regex of symbols to wipe from parsed number
+    def sanitize_regex
+      @@sanitize_regex
+    end
+
+    # setter for sanitize regex
+    # @param regex [String] symbols to wipe from parsed number
+    # @return [String] regex of symbols to wipe from parsed number
+    def sanitize_regex=(regex)
+      @@sanitize_regex = regex.is_a?(String) ? regex : regex.to_s
+    end
+
     # @private strict double prefix check for validator, doesn't sanitize number
     @@strict_double_prefix_check = false
 
@@ -133,6 +149,42 @@ module Phonelib
       @@override_phone_data
     end
 
+    @@additional_regexes = {}
+    # setter for data file to use
+    def additional_regexes=(data)
+      return unless data.is_a?(Array)
+      @@additional_regexes = {}
+      data.each do |row|
+        next if row.size != 3
+        add_additional_regex(*row)
+      end
+    end
+
+    def add_additional_regex(country, type, national_regex)
+      return unless Phonelib::Core::TYPES_DESC.keys.include?(type.to_sym)
+      return unless national_regex.is_a?(String)
+      @@phone_data = nil
+      @@additional_regexes[country.to_s.upcase] ||= {}
+      @@additional_regexes[country.to_s.upcase][type] ||= []
+      @@additional_regexes[country.to_s.upcase][type] << national_regex
+    end
+
+    def dump_additional_regexes
+      rows = []
+      @@additional_regexes.each do |country, types|
+        types.each do |type, regexes|
+          regexes.each do |regex|
+            rows << [country, type, regex]
+          end
+        end
+      end
+      rows
+    end
+
+    def additional_regexes
+      @@additional_regexes
+    end
+
     @@vanity_conversion = false
     # setter for vanity phone numbers chars replacement
     def vanity_conversion=(value)
@@ -377,6 +429,21 @@ module Phonelib
         override_data_file = Marshal.load(File.binread(override_phone_data))
         default_data.merge!(override_data_file)
       end
+      additional_regexes.each do |country, types|
+        types.each do |type, regex|
+          default_data[country][Core::TYPES][type] ||= {}
+          [Core::VALID_PATTERN, Core::POSSIBLE_PATTERN].each do |key|
+            if default_data[country][Core::TYPES][type][key]
+              default_data[country][Core::TYPES][type][key] << "|#{regex.join('|')}"
+            else
+              default_data[country][Core::TYPES][type][key] = regex.join('|')
+            end
+            if type != Core::GENERAL
+              default_data[country][Core::TYPES][Core::GENERAL][key] << "|#{regex.join('|')}"
+            end
+          end
+        end
+      end
       default_data
     end
 

data/lib/phonelib/data_importer.rb

@@ -145,10 +145,10 @@ module Phonelib
 
         require 'open-uri'
         require 'csv'
-        io = open('http://download.geonames.org/export/dump/countryInfo.txt')
+        io = open('http://api.geonames.org/countryInfoCSV?username=demo&style=full')
         csv = CSV.new(io, {col_sep: "\t"})
         csv.each do |row|
-          next if row[0].start_with?('#') || row[0].empty?
+          next if row[0].nil? || row[0].start_with?('#') || row[0].empty?
 
           @countries[row[0]] = row[4]
         end

data/lib/phonelib/phone.rb

@@ -51,7 +51,7 @@ module Phonelib
     def sanitized
       @sanitized ||=
           vanity_converted(@original).gsub(
-              Phonelib.strict_check ? cr('^\+') : cr('[^0-9]+'),
+              Phonelib.strict_check ? cr('^\+') : cr(Phonelib.sanitize_regex),
               '')
     end
 

data/lib/phonelib/phone_extended_data.rb

@@ -58,7 +58,7 @@ module Phonelib
 
     # @private returns extended data ids for current number
     def ext_data
-      return @ext_data if @ext_data
+      return @ext_data if defined?(@ext_data) && @ext_data
 
       result = default_ext_data
       return result unless possible?

data/lib/phonelib/version.rb

@@ -1,4 +1,4 @@
 module Phonelib
   # @private
-  VERSION = '0.6.46'
+  VERSION = '0.6.51'
 end

data/lib/validators/phone_validator3.rb

@@ -0,0 +1,130 @@
+# Validator class for phone validations
+#
+# ==== Examples
+#
+# Validates that attribute is a valid phone number.
+# If empty value passed for attribute it fails.
+#
+#   class Phone < ActiveRecord::Base
+#     attr_accessible :number
+#     validates :number, phone: true
+#   end
+#
+# Validates that attribute is a possible phone number.
+# If empty value passed for attribute it fails.
+#
+#   class Phone < ActiveRecord::Base
+#     attr_accessible :number
+#     validates :number, phone: { possible: true }
+#   end
+#
+# Validates that attribute is a valid phone number.
+# Empty value is allowed to be passed.
+#
+#   class Phone < ActiveRecord::Base
+#     attr_accessible :number
+#     validates :number, phone: { allow_blank: true }
+#   end
+#
+# Validates that attribute is a valid phone number of specified type(s).
+# It is also possible to check that attribute is a possible number of specified
+# type(s). Symbol or array accepted.
+#
+#   class Phone < ActiveRecord::Base
+#     attr_accessible :number, :mobile
+#     validates :number, phone: { types: [:mobile, :fixed], allow_blank: true }
+#     validates :mobile, phone: { possible: true, types: :mobile  }
+#   end
+#
+# validates that phone is valid and it is from specified country or countries
+#
+#   class Phone < ActiveRecord::Base
+#     attr_accessible :number
+#     validates :number, phone: { countries: [:us, :ca] }
+#   end
+#
+# Validates that attribute does not include an extension.
+# The default setting is to allow extensions
+#
+#   class Phone < ActiveRecord::Base
+#     attr_accessible :number
+#     validates :number, phone: { extensions: false }
+#   end
+#
+class PhoneValidator < ActiveModel::EachValidator
+  # Include all core methods
+  include Phonelib::Core
+
+  # Validation method
+  def validate_each(record, attribute, value)
+    return if options[:allow_blank] && value.blank?
+
+    @phone = parse(value, specified_country(record))
+    valid = phone_valid? && valid_types? && valid_country? && valid_extensions?
+
+    record.errors.add(attribute, message, **options) unless valid
+  end
+
+  private
+
+  def message
+    options[:message] || :invalid
+  end
+
+  def phone_valid?
+    @phone.send(options[:possible] ? :possible? : :valid?)
+  end
+
+  def valid_types?
+    return true unless options[:types]
+    (phone_types & types).size > 0
+  end
+
+  def valid_country?
+    return true unless options[:countries]
+    (phone_countries & countries).size > 0
+  end
+
+  def valid_extensions?
+    return true if !options.has_key?(:extensions) || options[:extensions]
+    @phone.extension.empty?
+  end
+
+  def specified_country(record)
+    return unless options[:country_specifier]
+
+    if options[:country_specifier].is_a?(Symbol)
+      record.send(options[:country_specifier])
+    else
+      options[:country_specifier].call(record)
+    end
+  end
+
+  # @private
+  def phone_types
+    method = options[:possible] ? :possible_types : :types
+    phone_types = @phone.send(method)
+    if (phone_types & [Phonelib::Core::FIXED_OR_MOBILE]).size > 0
+      phone_types += [Phonelib::Core::FIXED_LINE, Phonelib::Core::MOBILE]
+    end
+    phone_types
+  end
+
+  # @private
+  def phone_countries
+    method = options[:possible] ? :countries : :valid_countries
+    @phone.send(method)
+  end
+
+  # @private
+  def types
+    types = options[:types].is_a?(Array) ? options[:types] : [options[:types]]
+    types.map(&:to_sym)
+  end
+
+  # @private
+  def countries
+    countries = options[:countries].is_a?(Array) ? options[:countries] : [options[:countries]]
+    countries.map { |c| c.to_s.upcase }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phonelib
 version: !ruby/object:Gem::Version
-  version: 0.6.46
+  version: 0.6.51
 platform: ruby
 authors:
 - Vadim Senderovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -148,6 +148,7 @@ files:
 - lib/phonelib/version.rb
 - lib/tasks/phonelib_tasks.rake
 - lib/validators/phone_validator.rb
+- lib/validators/phone_validator3.rb
 homepage: https://github.com/daddyz/phonelib
 licenses:
 - MIT
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Gem validates phone numbers with Google libphonenumber database