phone_parser 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e477e414e9550627dd6f8b39efdccfe4854aa4d
-  data.tar.gz: 3859f2d8be696a39f017c7036b48f9fceeeb1b09
+  metadata.gz: 87f79272eff9c337110401fe623934a2a60ce695
+  data.tar.gz: 892757c73bab635c270e52afe8a69a36d84ec450
 SHA512:
-  metadata.gz: 9c3bac96917f84cb381782152cf6433ecb8c9dd5805c0a2d0a5610efabedc70e38729d16fd3abfc5d885d588f71906d5b360c3d61b404b702ffaa24ea85df01c
-  data.tar.gz: b41ec3ba71cf4ecd4ced2b03d1001079e1998d717a55276428db7bb10b0546d49178c9e8bf22d8363e8f24cbbe43be6a5c21f2172c8eac4c44a1afdf69178de4
+  metadata.gz: ec8bf45930b7f85bf45df8d0ee3f8ba8108f18f842142a2cb8bf1bfd41546f75d970ec6334e3e5b3e7b29fcd4db2b2332609a5ec15d5dd8339d2697a6b9bd203
+  data.tar.gz: 7978a8508ba920b34709ab8e021eadfb3f535262ba7ca3e032b464b02ff7807631d8468d86cd71477a64be734da8a2db7168a426af176ef84f7882eb5b2f7e6d

data/README.md

@@ -1,8 +1,6 @@
 # PhoneParser
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/phone_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A phone parsing gem that takes in phone numbers and removes any formatting to ensure uniform phone numbers. It also includes a country code validation component.
 
 ## Installation
 
@@ -22,34 +20,55 @@ Or install it yourself as:
 
 ## Usage
 
-To parse phone numbers without an area code:
+To parse phone numbers without a country code, a default country code of `1` is assumed:
 
 ```ruby
-PhoneParser.parse('555-555-5555') # => '5555555555'
-PhoneParser.parse('5555555555') # => '5555555555'
-PhoneParser.parse('(555) 555-5555') # => '5555555555'
-PhoneParser.parse('555.555.5555') # => '5555555555'
-PhoneParser.parse('555 555.5555') # => '5555555555'
-PhoneParser.parse('555 555.5555') # => '5555555555'
+PhoneParser.parse('555-555-5555')   # => '15555555555'
+PhoneParser.parse('5555555555')     # => '15555555555'
+PhoneParser.parse('(555) 555-5555') # => '15555555555'
+PhoneParser.parse('555.555.5555')   # => '15555555555'
+PhoneParser.parse('555 555.5555')   # => '15555555555'
+PhoneParser.parse('555 555.5555')   # => '15555555555'
 ```
 
 It will throw an error if an invalid phone number is passed to the parser:
 
 ```ruby
 PhoneParser.parse('5555555') # => PhoneLengthError
-PhoneParser.parse('') # => PhoneLengthError
+PhoneParser.parse('')        # => PhoneLengthError
 ```
 
 If a country code is supplied, the parser will verify that the code is valid, it will throw a `CountryCodeError` if the country code isn't valid:
 
 ```ruby
-PhoneParser.parse('+15555555555') # => '15555555555'
-PhoneParser.parse('1-7845555555555') # => '17845555555555'
+PhoneParser.parse('+15555555555')                            # => '15555555555'
+PhoneParser.parse('1-7845555555555')                         # => '17845555555555'
 PhoneParser.parse('Country Code: 379, Phone:  555-555-5555') # => '3795555555555'
-PhoneParser.parse('3795555555555') # => '3795555555555'
-PhoneParser.parse('999 555 555 5555') # => CountryCodeError
+PhoneParser.parse('3795555555555')                           # => '3795555555555'
+PhoneParser.parse('999 555 555 5555')                        # => CountryCodeError
+```
+
+If you want to supply a different default country code, you can pass in an optional argument, this will not override country codes found in the provided number, it will only be used if a country code is not found.
+
+```ruby
+PhoneParser.parse('5555555555', country_code: '379') # => '3795555555555'
+```
+
+You can also check to see if a phone number is from a specific country using it's country code abbreviation, as shown below:
+
+```ruby
+CountryCodes.va?('379 555-555-5555') # => true
+CountryCodes.us?('379 555-555-5555') # => false
 ```
 
+Alternatively, if you want to extract the country code, you can query it directly from the phone number:
+
+```ruby
+CountryCodes.country_code('379 555-555-5555') # => '379'
+CountryCodes.country_code('1 555-555-5555')   # => '1'
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/phone_parser.rb

@@ -2,32 +2,15 @@ require "phone_parser/version"
 require "phone_parser/country_codes"
 
 module PhoneParser
-  include CountryCodes
-
   def self.parse(number, country_code: '1')
     number.delete!("^0-9")
     digit_length_validator(number)
-    country_code_validator(number, country_code)
+    CountryCodes.country_code_validator(number, country_code)
   end
 
   def self.digit_length_validator number
     number.length < 10 ? (raise PhoneLengthError) : (number)
   end
-
-  def self.country_code_validator number, country_code
-    if number.length == 10
-      country_code + number
-    else
-      extracted_number = number[-10..-1]
-      country_code = number.gsub(extracted_number, '')
-
-      country_codes.include?(country_code) ? (number) : (raise CountryCodeError)
-    end
-  end
-
-  def self.country_codes
-    CountryCodes.code_array.flatten.keep_if { |e| e =~ /\d+/ }
-  end
 end
 
 class PhoneLengthError < StandardError
@@ -36,8 +19,3 @@ class PhoneLengthError < StandardError
   end
 end
 
-class CountryCodeError < StandardError
-  def message
-    'Country code not recognized'
-  end
-end

data/lib/phone_parser/country_codes.rb

@@ -1,4 +1,4 @@
-module CountryCodes
+class CountryCodes
   def self.code_array
     [
       ["93", "AF"],
@@ -246,4 +246,48 @@ module CountryCodes
       ["263", "ZW"]
     ]
   end
+
+  def self.country_code_validator number, country_code
+    if number.length == 10
+      country_code + number
+    else
+      extracted_number = number[-10..-1]
+      country_code = number.gsub(extracted_number, '')
+
+      country_codes.include?(country_code) ? (number) : (raise CountryCodeError)
+    end
+  end
+
+  def self.country_codes
+    code_array.flatten.keep_if { |e| e =~ /\d+/ }
+  end
+
+  def self.country_code number
+    number.delete!("^0-9")
+    country_code_validator(number, nil)
+    extracted_number = number[-10..-1]
+    country_code = number.gsub(extracted_number, '')
+  end
+
+  def self.method_missing(method_name, *arguments, &block)
+    if method_name.to_s =~ /(.*)?/
+      if code_array.map(&:last).index(method_name.to_s[0..-2].upcase) == code_array.map(&:first).index(country_code(arguments.first))
+        true
+      else
+        false
+      end
+    else
+      super
+    end
+  end
+
+  def self.respond_to_missing?(method_name, include_private = false)
+    method_name.to_s.end_with?('?') || super
+  end
+end
+
+class CountryCodeError < StandardError
+  def message
+    'Country code not recognized'
+  end
 end

data/lib/phone_parser/version.rb

@@ -1,3 +1,3 @@
 module PhoneParser
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phone_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jordan Hudgens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler