area_code_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3451881fd13882c503bb07c7b00396d76ccb2e01
+  data.tar.gz: 9af20f49875b7e040dffc8d5c58694246aa73fd6
+SHA512:
+  metadata.gz: 990c1e377757babb08366dd14c7ff1bce26900456cd7aff2915871a2541e8ebdd0966f741cf35be4ac08c82b12c5070a1db11f71195a2ffc0a24be9e6d8e6dcb
+  data.tar.gz: f0f36fc8147beac1be835bfc5c361f44cea36cf65f174ac0b04229451492372270d31768e36a928f4c16bbd03166aedd2d6a38ef396d9afaf6f5999f4d72ef55

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in area_code_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Medeiros
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Area Code Validator
+
+Area Code Validator is a small gem that validates a phone numbers area code to a state.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'area_code_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install area_code_validator
+
+## Usage
+
+State can be either abbreviation or full state name
+
+```ruby
+AreaCodeValidator.invalid?('123', 'FL') => true
+AreaCodeValidator.invalid?('813', 'FL') => false
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+end
+
+task :default => [:test]

data/area_code_validator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'area_code_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'area_code_validator'
+  spec.version       = AreaCodeValidator::VERSION
+  spec.authors       = ['Andrew Medeiros']
+  spec.email         = ['amedeiros0920@gmail.com']
+  spec.description   = %q{AreaCodeValidator is a small gem that validates a phone numbers area code to a state.}
+  spec.summary       = %q{AreaCodeValidator is a small gem that validates a phone numbers area code to a state.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'shoulda'
+end

data/lib/area_code_validator/version.rb

@@ -0,0 +1,3 @@
+module AreaCodeValidator
+  VERSION = '0.0.1'
+end

data/lib/area_code_validator.rb

@@ -0,0 +1,41 @@
+require 'area_code_validator/version'
+require 'config/config'
+# TODO: create validator
+# require  'extensions/area_code_invalid_validator' if defined?(Rails)
+
+module AreaCodeValidator
+
+  def self.invalid?(area_code, area_code_state)
+    # Stop here and return true if either area_code or area_code_state are nil
+    return true if area_code.nil? or area_code_state.nil?
+
+    # Upcase and scrub the area_code and area_code_state
+    area_code        = area_code.to_s.upcase.gsub(/(\W|[A-Z]|_)*/, '')
+    area_code_state  = area_code_state.to_s.upcase.gsub(/(\W|\d|_)*/, '')
+
+    # Stop here and return true if the state does not exist
+    return true if !Config::STATES.include?(area_code_state) and !Config::STATES.values.include?(area_code_state)
+
+    # Find the state abbreviation key we need to access our hash of arrays of area codes.
+    key = get_abbreviation_key(area_code_state)
+
+    # If the area code is in our list return false else return true
+    return false if Config::AREA_CODES[key].include?(area_code)
+    true
+  end
+
+
+  # This is moved out into a method to make unit testing easier.
+  def self.get_abbreviation_key(area_code_state)
+    # If the area_code_state is greater than 2 then it is a full state name and we need to find the corresponding abbreviation for that state.
+    key = ''
+    if area_code_state.length > 2
+      Config::STATES.each do |k, v|
+        key = k if v == area_code_state
+      end
+    else
+      key = area_code_state # The area_code_state is already an abbreviated state
+    end
+    key
+  end
+end

data/lib/config/config.rb

@@ -0,0 +1,115 @@
+module AreaCodeValidator
+  class Config
+    # Constant frozen hash of states and abbreviations
+    STATES = {
+        'AL' =>	'ALABAMA',
+        'AK' =>	'ALASKA',
+        'AZ' =>	'ARIZONA',
+        'AR' =>	'ARKANSAS',
+        'CA' =>	'CALIFORNIA',
+        'CO' =>	'COLORADO',
+        'CT' =>	'CONNECTICUT',
+        'DE' =>	'DELAWARE',
+        'DC' =>	'DISTRICT OF COLUMBIA',
+        'FL' =>	'FLORIDA',
+        'GA' =>	'GEORGIA',
+        'HI' =>	'HAWAII',
+        'ID' =>	'IDAHO',
+        'IL' =>	'ILLINOIS',
+        'IN' =>	'INDIANA',
+        'IA' =>	'IOWA',
+        'KS' =>	'KANSAS',
+        'KY' =>	'KENTUCKY',
+        'LA' =>	'LOUISIANA',
+        'ME' =>	'MAINE',
+        'MD' =>	'MARYLAND',
+        'MA' =>	'MASSACHUSETTS',
+        'MI' =>	'MICHIGAN',
+        'MN' =>	'MINNESOTA',
+        'MS' =>	'MISSISSIPPI',
+        'MO' =>	'MISSOURI',
+        'MT' =>	'MONTANA',
+        'NE' =>	'NEBRASKA',
+        'NV' =>	'NEVADA',
+        'NH' =>	'NEW HAMPSHIRE',
+        'NJ' =>	'NEW JERSEY',
+        'NY' =>	'NEW YORK',
+        'NM' =>	'NEW MEXICO',
+        'NC' =>	'NORTH CAROLINA',
+        'ND' =>	'NORTH DAKOTA',
+        'OH' =>	'OHIO',
+        'OK' =>	'OKLAHOMA',
+        'OR' =>	'OREGON',
+        'PA' =>	'PENNSYLVANIA',
+        'PR' => 'PUERTO RICO',
+        'RI' =>	'RHODE ISLAND',
+        'SC' =>	'SOUTH CAROLINA',
+        'SD' =>	'SOUTH DAKOTA',
+        'TN' =>	'TENNESSEE',
+        'TX' =>	'TEXAS',
+        'UT' =>	'UTAH',
+        'VT' =>	'VERMONT',
+        'VI' => 'VIRGIN ISLANDS',
+        'VA' =>	'VIRGINIA',
+        'WA' =>	'WASHINGTON',
+        'WV' =>	'WEST VIRGINIA',
+        'WI' =>	'WISCONSIN',
+        'WY' =>	'WYOMING' }.freeze
+
+    # Hash of arrays of area codes. Say that ten times fast.
+    AREA_CODES = {
+        'AL' => ['205', '251', '256', '334', '938'],
+        'AK' => ['907'],
+        'AZ' => ['480', '520', '602', '623', '928'],
+        'AR' => ['479', '501', '870'],
+        'CA' => ['209', '213', '310', '323', '408', '415', '424', '442', '510', '530', '559', '562', '619', '626', '650', '657', '661', '707', '714', '747', '760', '805', '818', '831', '858', '909', '916', '925', '949', '951'],
+        'CO' => ['303', '719', '720', '970'],
+        'CT' => ['203', '475', '860'],
+        'DE' => ['302'],
+        'DC' => ['202'],
+        'FL' => ['239', '305', '321', '352', '386', '407', '561', '727', '754', '772', '786', '813', '850', '863', '904', '941', '954'],
+        'GA' => ['229', '404', '470', '478', '678', '706', '762', '770', '912'],
+        'HI' => ['808'],
+        'ID' => ['208'],
+        'IL' => ['217', '224', '309', '312', '331', '618', '630', '708', '773', '779', '815', '847', '872'],
+        'IN' => ['219', '260', '317', '574', '765', '812'],
+        'IA' => ['319', '515', '563', '641', '712'],
+        'KS' => ['316', '620', '785', '913'],
+        'KY' => ['270', '502', '606', '859'],
+        'LA' => ['225', '318', '337', '504', '985'],
+        'ME' => ['207'],
+        'MD' => ['240', '301', '410', '443'],
+        'MA' => ['339', '351', '413', '508', '617', '774', '781', '857', '978'],
+        'MI' => ['231', '248', '269', '313', '517', '586', '616', '734', '810', '906', '947', '989'],
+        'MN' => ['218', '320', '507', '612', '651', '763', '952'],
+        'MS' => ['228', '601', '662', '769'],
+        'MO' => ['314', '417', '573', '636', '660', '816'],
+        'MT' => ['406'],
+        'NE' => ['308', '402'],
+        'NV' => ['702', '775'],
+        'NH' => ['603'],
+        'NJ' => ['201', '551', '609', '732', '848', '856', '862', '908', '973'],
+        'NY' => ['212', '315', '347', '516', '518', '585', '607', '631', '646', '716', '718', '845', '914', '917', '929'],
+        'NM' => ['505', '575'],
+        'NC' => ['252', '336', '704', '828', '910', '919', '980'],
+        'ND' => ['701'],
+        'OH' => ['216', '234', '330', '419', '440', '513', '567', '614', '740', '937'],
+        'OK' => ['405', '539', '580', '918'],
+        'OR' => ['458', '503', '541', '971'],
+        'PA' => ['215', '267', '412', '484', '570', '610', '717', '724', '814', '878'],
+        'PR' => ['787', '939'],
+        'RI' => ['401'],
+        'SC' => ['803', '843', '864'],
+        'SD' => ['605'],
+        'TN' => ['423', '615', '731', '865', '901', '931'],
+        'TX' => ['210', '214', '254', '281', '325', '361', '409', '430', '432', '469', '512', '682', '713', '806', '817', '830', '832', '903', '915', '936', '940', '956', '972', '979'],
+        'UT' => ['385', '435', '801'],
+        'VT' => ['802'],
+        'VI' => ['340'],
+        'VA' => ['276', '434', '540', '571', '703', '757', '804'],
+        'WA' => ['206', '253', '360', '425', '509'],
+        'WV' => ['304', '681'],
+        'WI' => ['262', '414', '608', '715', '920'],
+        'WY' => ['307'] }.freeze
+  end
+end

data/lib/extensions/area_code_invalid_validator.rb

@@ -0,0 +1,6 @@
+class AreaCodeInvalidValidator < ActiveModel::Validator
+  def validate(record)
+    # TODO: Create validator
+    # stub for a active model validator
+  end
+end

data/test/test_area_code_validator.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class AreaCodeValidatorTest < Test::Unit::TestCase
+  context AreaCodeValidator do
+    context '#invalid?' do
+
+      Helper::VALID_AREA_CODES.each do |state, area_codes_array|
+        area_codes_array.each_with_index do |area_code, index|
+          should "be a valid area code #{area_code} - #{state} index: #{index}" do
+            assert !AreaCodeValidator.invalid?(area_code, state), state.inspect + ' ' + area_code.inspect
+          end
+        end
+      end
+
+      Helper::VALID_AREA_CODES.each do |state, area_codes_array|
+        area_codes_array.each_with_index do |area_code, index|
+          should "not be a valid area_code #{area_code} - #{state} index: #{index}" do
+            assert AreaCodeValidator.invalid?(area_code + '123', state), state.inspect + ' ' + area_code + '123'
+          end
+        end
+      end
+
+      should 'return true for an undefined state abbreviation' do
+        invalid = AreaCodeValidator.invalid?('123', 'QQ')
+        assert invalid
+      end
+
+      should 'return true for an undefined full state name' do
+        invalid = AreaCodeValidator.invalid?('123', 'BadState')
+        assert invalid
+      end
+
+      should 'handle a state abbreviation with non-word characters' do
+        state = '12}3 F (** __)L @ 5674``' # FL                                                                                                      
+        assert !AreaCodeValidator.invalid?(Helper::VALID_AREA_CODES['FL'].first, state)
+      end
+
+      should 'handle a full state name with non-word characters' do
+        state = '12_3 F (** )L o # R ^ I !!!! DA @   907' # FLORIDA                                                                                  
+        assert !AreaCodeValidator.invalid?(Helper::VALID_AREA_CODES['FL'].first, state)
+      end
+
+      should 'handle a state area_code with non-word characters and word characters' do
+        area_code = 'F / @!!()_hd -=8  %$#1  ?.,;3' # 813
+        assert !AreaCodeValidator.invalid?(area_code, 'FL')
+      end
+
+      should 'return true for a nil area code' do
+        assert AreaCodeValidator.invalid?(area_code=nil, area_code_state='FL')
+      end
+
+      should 'return true for a nil area code state' do
+        assert AreaCodeValidator.invalid?(area_code='813', area_code_state=nil)
+      end
+    end
+
+    context '#get_abbreviation_key' do
+      AreaCodeValidator::Config::STATES.each do |state_abbreviation, state_name|
+        should "return the correct state abbreviation #{state_abbreviation}" do
+          assert_equal state_abbreviation, AreaCodeValidator.get_abbreviation_key(state_name)
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+require 'area_code_validator'
+require 'shoulda'
+
+class Helper
+  VALID_AREA_CODES = {
+      'AL' => ['205', '251', '256', '334', '938'],
+      'AK' => ['907'],
+      'AZ' => ['480', '520', '602', '623', '928'],
+      'AR' => ['479', '501', '870'],
+      'CA' => ['209', '213', '310', '323', '408', '415', '424', '442', '510', '530', '559', '562', '619', '626', '650', '657', '661', '707', '714', '747', '760', '805', '818', '831', '858', '909', '916', '925', '949', '951'],
+      'CO' => ['303', '719', '720', '970'],
+      'CT' => ['203', '475', '860'],
+      'DE' => ['302'],
+      'DC' => ['202'],
+      'FL' => ['239', '305', '321', '352', '386', '407', '561', '727', '754', '772', '786', '813', '850', '863', '904', '941', '954'],
+      'GA' => ['229', '404', '470', '478', '678', '706', '762', '770', '912'],
+      'HI' => ['808'],
+      'ID' => ['208'],
+      'IL' => ['217', '224', '309', '312', '331', '618', '630', '708', '773', '779', '815', '847', '872'],
+      'IN' => ['219', '260', '317', '574', '765', '812'],
+      'IA' => ['319', '515', '563', '641', '712'],
+      'KS' => ['316', '620', '785', '913'],
+      'KY' => ['270', '502', '606', '859'],
+      'LA' => ['225', '318', '337', '504', '985'],
+      'ME' => ['207'],
+      'MD' => ['240', '301', '410', '443'],
+      'MA' => ['339', '351', '413', '508', '617', '774', '781', '857', '978'],
+      'MI' => ['231', '248', '269', '313', '517', '586', '616', '734', '810', '906', '947', '989'],
+      'MN' => ['218', '320', '507', '612', '651', '763', '952'],
+      'MS' => ['228', '601', '662', '769'],
+      'MO' => ['314', '417', '573', '636', '660', '816'],
+      'MT' => ['406'],
+      'NE' => ['308', '402'],
+      'NV' => ['702', '775'],
+      'NH' => ['603'],
+      'NJ' => ['201', '551', '609', '732', '848', '856', '862', '908', '973'],
+      'NY' => ['212', '315', '347', '516', '518', '585', '607', '631', '646', '716', '718', '845', '914', '917', '929'],
+      'NM' => ['505', '575'],
+      'NC' => ['252', '336', '704', '828', '910', '919', '980'],
+      'ND' => ['701'],
+      'OH' => ['216', '234', '330', '419', '440', '513', '567', '614', '740', '937'],
+      'OK' => ['405', '539', '580', '918'],
+      'OR' => ['458', '503', '541', '971'],
+      'PA' => ['215', '267', '412', '484', '570', '610', '717', '724', '814', '878'],
+      'PR' => ['787', '939'],
+      'RI' => ['401'],
+      'SC' => ['803', '843', '864'],
+      'SD' => ['605'],
+      'TN' => ['423', '615', '731', '865', '901', '931'],
+      'TX' => ['210', '214', '254', '281', '325', '361', '409', '430', '432', '469', '512', '682', '713', '806', '817', '830', '832', '903', '915', '936', '940', '956', '972', '979'],
+      'UT' => ['385', '435', '801'],
+      'VT' => ['802'],
+      'VI' => ['340'],
+      'VA' => ['276', '434', '540', '571', '703', '757', '804'],
+      'WA' => ['206', '253', '360', '425', '509'],
+      'WV' => ['304', '681'],
+      'WI' => ['262', '414', '608', '715', '920'],
+      'WY' => ['307'] }
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: area_code_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Medeiros
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AreaCodeValidator is a small gem that validates a phone numbers area
+  code to a state.
+email:
+- amedeiros0920@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- area_code_validator.gemspec
+- lib/area_code_validator.rb
+- lib/area_code_validator/version.rb
+- lib/config/config.rb
+- lib/extensions/area_code_invalid_validator.rb
+- test/test_area_code_validator.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: AreaCodeValidator is a small gem that validates a phone numbers area code
+  to a state.
+test_files:
+- test/test_area_code_validator.rb
+- test/test_helper.rb