phonelib 0.2.4 → 0.2.5

data/lib/phonelib.rb

@@ -1,3 +1,4 @@
+# main module definition
 module Phonelib
   # load gem classes
   autoload :Core, 'phonelib/core'
@@ -8,6 +9,6 @@ module Phonelib
   }
 end
 
-if defined?(Rails)
+if defined?(ActiveModel)
   autoload :PhoneValidator, 'validators/phone_validator'
 end

data/lib/phonelib/core.rb

@@ -16,25 +16,25 @@ module Phonelib
     def default_country=(country)
       @@default_country = country
     end
-    
+
     # gem constants definition
     # constants for phone types
 
     # Validation patterns keys constants
     # General pattern for country key
-    GENERAL = :generalDesc
+    GENERAL = :general_desc
     # Freephone line pattern key
-    PREMIUM_RATE = :premiumRate
+    PREMIUM_RATE = :premium_rate
     # Freephone line pattern key
-    TOLL_FREE = :tollFree
+    TOLL_FREE = :toll_free
     # Shared cost pattern key. The cost of this call is shared between caller
     # and recipient, and is hence typically less than PREMIUM_RATE calls
-    SHARED_COST = :sharedCost
-    # Voice over IP pattern key. This includes TSoIP (Telephony Service over IP)
+    SHARED_COST = :shared_cost
+    # VoIP pattern key. This includes TSoIP (Telephony Service over IP)
     VOIP = :voip
     # A personal number is associated with a particular person, and may be
     # routed to either a MOBILE or FIXED_LINE number.
-    PERSONAL_NUMBER = :personalNumber
+    PERSONAL_NUMBER = :personal_number
     # Pager phone number pattern key
     PAGER = :pager
     # Used for 'Universal Access Numbers' or 'Company Numbers'. They may be
@@ -44,48 +44,48 @@ module Phonelib
     # Used for 'Voice Mail Access Numbers'.
     VOICEMAIL = :voicemail
     # Fixed line pattern key
-    FIXED_LINE = :fixedLine
+    FIXED_LINE = :fixed_line
     # Mobile phone number pattern key
     MOBILE = :mobile
     # In case MOBILE and FIXED patterns are the same, this type is returned
-    FIXED_OR_MOBILE = :fixedOrMobile
+    FIXED_OR_MOBILE = :fixed_or_mobile
 
     # Internal use keys for validations
     # Valid regex pattern key
-    VALID_PATTERN = :nationalNumberPattern
+    VALID_PATTERN = :national_number_pattern
     # Possible regex pattern key
-    POSSIBLE_PATTERN = :possibleNumberPattern
+    POSSIBLE_PATTERN = :possible_number_pattern
     # National prefix key
-    NATIONAL_PREFIX = :nationalPrefix
+    NATIONAL_PREFIX = :national_prefix
     # National prefix rule key
-    NATIONAL_PREFIX_RULE = :nationalPrefixFormattingRule
+    NATIONAL_PREFIX_RULE = :national_prefix_formatting_rule
     # Country code key
-    COUNTRY_CODE = :countryCode
+    COUNTRY_CODE = :country_code
 
     # Default number formatting data hash
     DEFAULT_NUMBER_FORMAT = {
-      pattern: "(\\d+)(\\d{3})(\\d{4})",
-      format: "$1 $2 $3"
+      pattern: '(\\d+)(\\d{3})(\\d{4})',
+      format: '$1 $2 $3'
     }
 
     # hash of all phone types with human representation
     TYPES = {
-      generalDesc: 'General Pattern',
-      premiumRate: 'Premium Rate',
-      tollFree: 'Toll Free',
-      sharedCost: 'Shared Cost',
+      general_desc: 'General Pattern',
+      premium_rate: 'Premium Rate',
+      toll_free: 'Toll Free',
+      shared_cost: 'Shared Cost',
       voip: 'VoIP',
-      personalNumber: 'Personal Number',
+      personal_number: 'Personal Number',
       pager: 'Pager',
       uan: 'UAN',
       voicemail: 'VoiceMail',
-      fixedLine: 'Fixed Line',
+      fixed_line: 'Fixed Line',
       mobile: 'Mobile',
-      fixedOrMobile: 'Fixed Line or Mobile'
+      fixed_or_mobile: 'Fixed Line or Mobile'
     }
 
     # array of types not included for validation check in cycle
-    NOT_FOR_CHECK = [ :generalDesc, :fixedLine, :mobile, :fixedOrMobile ]
+    NOT_FOR_CHECK = [:general_desc, :fixed_line, :mobile, :fixed_or_mobile]
 
     # method for parsing phone number.
     # On first run fills @@phone_data with data present in yaml file
@@ -137,6 +137,7 @@ module Phonelib
     end
 
     private
+
     # Load data file into memory
     def load_data
       require 'yaml'
@@ -152,18 +153,18 @@ module Phonelib
 
     # Get Phone instance for provided phone with country specified
     def detect_and_parse_by_country(phone, country)
-      detected = @@phone_data.detect { |data| data[:id] == country }
-      if !!detected
+      detected = @@phone_data.find { |data| data[:id] == country }
+      if detected
         phone = convert_phone_to_e164(phone,
-                                      detected[:countryCode],
-                                      detected[:nationalPrefix])
+                                      detected[:country_code],
+                                      detected[:national_prefix])
       end
       Phonelib::Phone.new(phone, [detected])
     end
 
     # Create phone representation in e164 format
     def convert_phone_to_e164(phone, prefix, national_prefix)
-      return phone if phone.gsub('+','').start_with?(prefix)
+      return phone if phone.gsub('+', '').start_with?(prefix)
       if !!national_prefix && phone.start_with?(national_prefix)
         phone = phone[1..phone.length]
       end

data/lib/phonelib/phone.rb

@@ -21,7 +21,7 @@ module Phonelib
 
     # Returns all phone types that matched valid patterns
     def types
-      @analyzed_data.flat_map {|iso2, data| data[:valid]}.uniq
+      @analyzed_data.flat_map { |iso2, data| data[:valid] }.uniq
     end
 
     # Returns first phone type that matched
@@ -29,21 +29,40 @@ module Phonelib
       types.first
     end
 
+    # Returns human representation of all matched phone types
+    def human_types
+      types.map { |type| Core::TYPES[type] }
+    end
+
+    # Return human representation of phone type
+    def human_type
+      Core::TYPES[type]
+    end
+
     # Returns all countries that matched valid patterns
     def countries
-      @analyzed_data.map {|iso2, data| iso2}
+      @analyzed_data.map { |iso2, data| iso2 }
+    end
+
+    # Return countries with valid patterns
+    def valid_countries
+      @valid_countries ||= countries.select do |iso2|
+        @analyzed_data[iso2][:valid].any?
+      end
     end
 
     # Returns first country that matched valid patterns
     def country
-      @country ||= countries.detect do |iso2|
-        !@analyzed_data[iso2][:valid].empty?
+      @country ||= begin
+        valid_countries.find do |iso2|
+          @analyzed_data[iso2][:main_country_for_code] == 'true'
+        end || valid_countries.first
       end
     end
 
     # Returns whether a current parsed phone number is valid
     def valid?
-      @analyzed_data.select {|iso2, data| data[:valid].any? }.any?
+      @analyzed_data.select { |iso2, data| data[:valid].any? }.any?
     end
 
     # Returns whether a current parsed phone number is invalid
@@ -53,7 +72,7 @@ module Phonelib
 
     # Returns whether a current parsed phone number is possible
     def possible?
-      @analyzed_data.select {|iso2, data| data[:possible].any? }.any?
+      @analyzed_data.select { |iso2, data| data[:possible].any? }.any?
     end
 
     # Returns whether a current parsed phone number is impossible
@@ -68,11 +87,11 @@ module Phonelib
 
       # add space to format groups, change first group to rule,
       # change rule's constants to values
-      format_string = format[:format].gsub(/(\d)\$/, "\\1 $").gsub('$1', rule).
-          gsub(/(\$NP|\$FG)/, { '$NP' => prefix, '$FG' => '$1' })
+      format_string = format[:format].gsub(/(\d)\$/, '\\1 $').gsub('$1', rule)
+          .gsub(/(\$NP|\$FG)/, '$NP' => prefix, '$FG' => '$1')
 
       matches = @national_number.match(/#{format[:pattern]}/)
-      format_string.gsub(/\$\d/) {|el| matches[el[1].to_i] }
+      format_string.gsub(/\$\d/) { |el| matches[el[1].to_i] }
     end
 
     # Returns e164 formatted phone number
@@ -93,12 +112,14 @@ module Phonelib
     #
     # ==== Attributes
     #
-    # * +country+ - ISO code of country (2 letters) like 'US', 'us' or :us for United States
+    # * +country+ - ISO code of country (2 letters) like 'US', 'us' or :us
+    #               for United States
     #
     def valid_for_country?(country)
       country = country.to_s.upcase
-      @analyzed_data.select {|iso2, data| country == iso2 &&
-          data[:valid].any? }.any?
+      @analyzed_data.select do |iso2, data|
+        country == iso2 && data[:valid].any?
+      end.any?
     end
 
     # Returns whether a current parsed phone number is invalid for specified
@@ -106,13 +127,15 @@ module Phonelib
     #
     # ==== Attributes
     #
-    # * +country+ - ISO code of country (2 letters) like 'US', 'us' or :us for United States
+    # * +country+ - ISO code of country (2 letters) like 'US', 'us' or :us
+    #               for United States
     #
     def invalid_for_country?(country)
       !valid_for_country?(country)
     end
 
     private
+
     # Get needable data for formatting phone as national number
     def get_formatting_data
       format = @analyzed_data[country][:format]
@@ -126,13 +149,15 @@ module Phonelib
     # Analyze current phone with provided data hash
     def analyze_phone(country_data)
       country_data.each do |data|
-        if @sanitized.start_with? "#{data[:countryCode]}#{data[:leadingDigits]}"
-          possible, valid = get_patterns(data[:types][Core::GENERAL])
-          next unless /^#{data[:countryCode]}#{valid}$/ =~ @sanitized
+        phone_code = "#{data[:country_code]}#{data[:leading_digits]}"
+        if @sanitized.start_with? phone_code
+          _possible, valid = get_patterns(data[:types][Core::GENERAL])
+          next unless /^#{data[:country_code]}#{valid}$/ =~ @sanitized
 
-          @national_number = @sanitized[data[:countryCode].length..-1]
+          @national_number = @sanitized[data[:country_code].length..-1]
           @analyzed_data[data[:id]] = data
-          @analyzed_data[data[:id]][:format] = get_number_format(data[:formats])
+          @analyzed_data[data[:id]][:format] =
+              get_number_format(data[:formats])
           @analyzed_data[data[:id]].merge! all_number_types(data[:types])
         end
       end
@@ -141,16 +166,11 @@ module Phonelib
     # Returns all valid and possible phone number types for currently parsed
     # phone for provided data hash.
     def all_number_types(data)
-      response = {valid: [], possible: []}
-
-      additional_types = check_same_types(data)
-      (Core::TYPES.keys - Core::NOT_FOR_CHECK + additional_types).each do |type|
-        check_type = case type
-                     when Core::FIXED_OR_MOBILE
-                       Core::FIXED_LINE
-                     else
-                       type
-                     end
+      response = { valid: [], possible: [] }
+
+      additional = check_same_types(data)
+      (Core::TYPES.keys - Core::NOT_FOR_CHECK + additional).each do |type|
+        check_type = (type == Core::FIXED_OR_MOBILE ? Core::FIXED_LINE : type)
         possible, valid = get_patterns(data[check_type])
 
         response[:possible] << type if number_possible?(possible)
@@ -164,8 +184,8 @@ module Phonelib
     def get_number_format(format_data)
       if format_data
         format_data.find do |format|
-          (format[:leadingDigits].nil? \
-              || /^#{format[:leadingDigits]}/ =~ @national_number) \
+          (format[:leading_digits].nil? \
+              || /^#{format[:leading_digits]}/ =~ @national_number) \
           && /^#{format[:pattern]}$/ =~ @national_number
         end
       else
@@ -176,9 +196,9 @@ module Phonelib
     # Checks if fixed line pattern and mobile pattern are the same
     def check_same_types(data)
       if data[Core::FIXED_LINE] == data[Core::MOBILE]
-        [ Core::FIXED_OR_MOBILE ]
+        [Core::FIXED_OR_MOBILE]
       else
-        [ Core::FIXED_LINE, Core::MOBILE ]
+        [Core::FIXED_LINE, Core::MOBILE]
       end
     end
 

data/lib/phonelib/version.rb

@@ -1,4 +1,5 @@
+# :nodoc:
 module Phonelib
   # :nodoc:
-  VERSION = "0.2.4"
+  VERSION = '0.2.5'
 end

data/lib/tasks/phonelib_tasks.rake

@@ -1,6 +1,6 @@
 namespace :phonelib do
 
-  desc "Import and reparse original data file from Google libphonenumber"
+  desc 'Import and reparse original data file from Google libphonenumber'
   task :import_data do
     require 'net/http'
     require 'yaml'
@@ -11,7 +11,7 @@ namespace :phonelib do
     xml_data = Net::HTTP.get_response(URI.parse(url)).body
 
     # save in file for debug
-    File.open("data/PhoneNumberMetaData.xml", "w+") do |f|
+    File.open('data/PhoneNumberMetaData.xml', 'w+') do |f|
       f.write(xml_data)
     end
 
@@ -24,20 +24,20 @@ namespace :phonelib do
       # each country
       country = {}
       el.attributes.each do |k, v|
-        country[k.to_sym] = v.to_s.tr(" \n", "")
+        country[camel2snake(k).to_sym] = v.to_s.tr(" \n", '')
       end
 
       country[:types] = {}
 
       el.children.each do | phone_type |
         if !%w(comment text).include?(phone_type.name)
-          phone_type_sym = phone_type.name.to_sym
+          phone_type_sym = camel2snake(phone_type.name).to_sym
 
           if phone_type.name != 'availableFormats'
             country[:types][phone_type_sym] = {}
             phone_type.elements.each do |pattern|
-              country[:types][phone_type_sym][pattern.name.to_sym] =
-                  pattern.children.first.to_s.tr(" \n", "")
+              country[:types][phone_type_sym][camel2snake(pattern.name).to_sym] =
+                  pattern.children.first.to_s.tr(" \n", '')
             end
           else
             country[:formats] = []
@@ -46,12 +46,13 @@ namespace :phonelib do
               if !%w(comment text).include?(format.name)
                 current_format = {}
                 format.each do |f|
-                  current_format[f[0].to_sym] = f[1]
+                  current_format[camel2snake(f[0]).to_sym] = f[1]
                 end
 
                 format.children.each do |f|
                   if f.name != 'text'
-                    current_format[f.name.to_sym] = f.children.first.to_s.gsub(/\n\s+/, "")
+                    current_format[camel2snake(f.name).to_sym] =
+                        f.children.first.to_s.gsub(/\n\s+/, '')
                   end
                 end
 
@@ -66,8 +67,12 @@ namespace :phonelib do
       countries.push(country)
     end
     target = 'data/phone_data.yml'
-    File.open(target, "w+") do |f|
+    File.open(target, 'w+') do |f|
       f.write(countries.to_yaml)
     end
   end
+
+  def camel2snake(s)
+    s.gsub(/[A-Z]+/) { |m| "_#{m.downcase}" }
+  end
 end

data/lib/validators/phone_validator.rb

@@ -24,7 +24,7 @@
 #   class Phone < ActiveRecord::Base
 #     attr_accessible :number
 #     validates :number, phone: { allow_blank: true }
-#   end 
+#   end
 class PhoneValidator < ActiveModel::EachValidator
   # Include all core methods
   include Phonelib::Core

data/test/dummy/Rakefile

@@ -3,5 +3,6 @@
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require File.expand_path('../config/application', __FILE__)
-
+require 'rake/dsl_definition'
+require 'rake'
 Dummy::Application.load_tasks

data/test/dummy/log/development.log

@@ -1,31 +1,19 @@
 Connecting to database specified by database.yml
-   (0.1ms)  select sqlite_version(*)
-   (7.4ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
-   (2.8ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-Migrating to CreatePhones (20130121173847)
-   (0.1ms)  begin transaction
-   (0.8ms)  CREATE TABLE "phones" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "number" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
-   (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20130121173847')
-   (4.1ms)  commit transaction
-Migrating to AddPossibleNumberToPhone (20130122075331)
-   (0.1ms)  begin transaction
-   (0.6ms)  ALTER TABLE "phones" ADD "possible_number" varchar(255)
-   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20130122075331')
-   (2.7ms)  commit transaction
-   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.9ms)  select sqlite_version(*)
+   (6.8ms)  CREATE TABLE "phones" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "number" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "possible_number" varchar(255)) 
+   (1.4ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.6ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (3.2ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130122075331')
+   (1.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130121173847')
+   (0.7ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
 Connecting to database specified by database.yml
-   (0.7ms)  select sqlite_version(*)
-   (5.1ms)  DROP TABLE "phones"
-   (3.3ms)  CREATE TABLE "phones" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "number" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "possible_number" varchar(255)) 
-   (0.2ms)  SELECT version FROM "schema_migrations"
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-Connecting to database specified by database.yml
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-   (0.3ms)  select sqlite_version(*)
-   (5.1ms)  CREATE TABLE "phones" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "number" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "possible_number" varchar(255)) 
-   (2.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
-   (3.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.6ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (3.7ms)  CREATE TABLE "phones" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "number" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "possible_number" varchar(255)) 
+   (1.4ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
    (0.1ms)  SELECT version FROM "schema_migrations"
-   (2.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130122075331')
-   (3.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130121173847')
+   (1.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130122075331')
+   (4.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130121173847')
+Connecting to database specified by database.yml