area_codex 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Cummer
+
+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,42 @@
+# AreaCodex
+
+A ruby gem for determining whether or not a given phone area code is in
+a particular country or region.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'area_codex'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install area_codex
+
+## Usage
+
+### By Country
+
+Currently only Canada, Mexico and the United States are supported.
+
+    AreaCodex::Country.new(:canada).include?(604)  # => true
+    AreaCodex::Country.new(:canada).exclude?(213)  # => true
+
+### By Region
+
+Currently only North America is supported.
+
+    AreaCodex::Region.new(:north_america).include?(604)  # => true
+    AreaCodex::Region.new(:north_america).exclude?(213)  # => 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/area_codex'
+  t.test_files = FileList['test/lib/area_codex/*_test.rb']
+  t.verbose = true
+end
+task default: :test

data/area_codex.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'area_codex/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "area_codex"
+  gem.version       = AreaCodex::VERSION
+  gem.authors       = ["Chris Cummer"]
+  gem.email         = ["chris@unbounce.com"]
+  gem.description   = %q{Phone number area code lookup by region.}
+  gem.summary       = %q{A list of phone number area codes by country. Currently only supports Canada, the United States, and Mexico.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'shoulda'
+end

data/lib/area_codex.rb

@@ -0,0 +1,9 @@
+module AreaCodex
+end
+
+require 'area_codex/concerns/with_area_codes'
+require 'area_codex/base'
+require 'area_codex/area_code_list'
+require 'area_codex/country'
+require 'area_codex/region'
+require 'area_codex/version'

data/lib/area_codex/area_code_list.rb

@@ -0,0 +1,34 @@
+require 'set'
+
+module AreaCodex
+  class AreaCodeList
+    extend Forwardable
+
+    attr_reader :area_codes
+
+    def initialize(*area_code_files)
+      @area_codes = Set.new
+      load_area_codes(area_code_files.flatten)
+    end
+
+    def_delegator :@area_codes, :include?, :include?
+
+    def exclude?(area_code)
+      !include?(area_code)
+    end
+
+    private
+
+      def load_area_codes(area_code_files)
+        area_code_files.each do |file_name|
+          file_path = File.expand_path("../../data/#{file_name}", __FILE__)
+
+          if File.exists?( file_path )
+            File.open( file_path ) do |file|
+              @area_codes.merge( Set.new( file.readlines.map { |code| code.chop.to_i } ) )
+            end
+          end
+        end
+      end
+  end
+end

data/lib/area_codex/base.rb

@@ -0,0 +1,13 @@
+module AreaCodex
+  class Base
+
+    def initialize
+      @area_code_list = AreaCodeList.new(area_code_files)
+    end
+
+    def area_code_files
+      raise 'Subclasses must define this method.'
+    end
+
+  end
+end

data/lib/area_codex/concerns/with_area_codes.rb

@@ -0,0 +1,9 @@
+module AreaCodex
+  module WithAreaCodes
+    extend Forwardable
+
+    def_delegator :@area_code_list, :include?, :include?
+    def_delegator :@area_code_list, :exclude?, :exclude?
+    def_delegator :@area_code_list, :area_codes, :area_codes
+  end
+end

data/lib/area_codex/country.rb

@@ -0,0 +1,20 @@
+module AreaCodex
+  class Country < Base
+    include WithAreaCodes
+
+    def initialize(name)
+      @name = normalize(name)
+      super()
+    end
+
+    private
+
+      def normalize(country_name)
+        country_name.to_s.downcase.gsub(' ', '_').to_sym
+      end
+
+      def area_code_files
+        "#{@name}.txt"
+      end
+  end
+end

data/lib/area_codex/region.rb

@@ -0,0 +1,24 @@
+module AreaCodex
+  class Region < Base
+    include WithAreaCodes
+
+    NORTH_AMERICA = [:canada, :mexico, :united_states]
+
+    def initialize(name)
+      @name = constantize(name)
+      super()
+    end
+
+    private
+
+      def constantize(region_name)
+        name = region_name.to_s.upcase.gsub(' ', '_')
+        klass = self.class
+        klass.const_defined?(name) ? klass.const_get(name) : klass.const_missing(name)
+      end
+
+      def area_code_files
+        @name.map { |sym| "#{sym}.txt" }
+      end
+  end
+end

data/lib/area_codex/version.rb

@@ -0,0 +1,3 @@
+module AreaCodex
+  VERSION = "0.0.1"
+end

data/lib/data/canada.txt

@@ -0,0 +1,28 @@
+204
+226
+236
+250
+289
+306
+403
+416
+418
+431
+438
+450
+506
+514
+519
+581
+587
+604
+613
+647
+705
+709
+778
+807
+819
+867
+902
+905

data/lib/data/mexico.txt

@@ -0,0 +1,21 @@
+222
+229
+322
+444
+461
+508
+614
+622
+656
+664
+665
+669
+671
+682
+686
+744
+833
+871
+987
+998
+999

data/lib/data/united_states.txt

@@ -0,0 +1,83 @@
+201
+202
+207
+208
+211
+217
+218
+231
+242
+246
+278
+285
+302
+304
+307
+308
+309
+311
+315
+320
+341
+345
+369
+401
+402
+406
+411
+413
+417
+442
+456
+470
+475
+500
+507
+509
+511
+518
+555
+600
+603
+605
+607
+608
+611
+618
+627
+628
+649
+670
+684
+700
+701
+710
+711
+712
+715
+719
+740
+764
+800
+802
+806
+808
+811
+812
+814
+831
+849
+869
+870
+880
+881
+882
+898
+900
+906
+907
+908
+911
+927
+957
+976

data/test/lib/area_codex/area_code_list_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../test_helper'
+
+class TestAreaCodeList < MiniTest::Unit::TestCase
+
+  def setup
+    @single = 'canada.txt'
+    @multiple = ['canada.txt', 'mexico.txt']
+  end
+
+  def list(file_names)
+    AreaCodex::AreaCodeList.new(file_names)
+  end
+
+  def test_initialize
+    [@single, @multiple].each do |list_size|
+      assert_equal( true, list(list_size).area_codes.instance_of?(Set) )
+      assert_equal( false, list(list_size).area_codes.empty? )
+    end
+  end
+
+  def test_include?
+    [@single, @multiple].each do |list_size|
+      assert_equal( true, list(list_size).include?(604) )
+      assert_equal( false, list(list_size).include?(666) )
+    end
+  end
+
+  def test_exclude?
+    [@single, @multiple].each do |list_size|
+      assert_equal( false, list(list_size).exclude?(604) )
+      assert_equal( true, list(list_size).exclude?(666) )
+    end
+  end
+end

data/test/lib/area_codex/country_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../test_helper'
+
+class TestCounty < MiniTest::Unit::TestCase
+  
+    def setup
+      @fake_name = 'Freeside'
+      @real_name = 'Canada'
+    end
+
+    def country(name)
+      AreaCodex::Country.new(name)
+    end
+
+    def test_initialize
+      assert_equal( true, country(@fake_name).instance_of?(AreaCodex::Country) )
+      assert_equal( true, country(@real_name).instance_of?(AreaCodex::Country) )
+    end
+
+    def test_include?
+      [@fake_name, @fake_name.to_sym].each do |name|
+        assert_equal( false, country(name).include?(604) )
+        assert_equal( false, country(name).include?(666) )
+      end
+
+      [@real_name, @real_name.to_s].each do |name|
+        assert_equal( true, country(name).include?(604) )
+        assert_equal( false, country(name).include?(666) )
+      end
+    end
+
+    def test_exclude?
+      assert_equal( true, country(@fake_name).exclude?(604) )
+      assert_equal( true, country(@fake_name).exclude?(666) )
+
+      assert_equal( false, country(@real_name).exclude?(604) )
+      assert_equal( true, country(@real_name).exclude?(666) )
+    end
+
+end

data/test/lib/area_codex/region_test.rb

@@ -0,0 +1,32 @@
+require_relative '../../test_helper'
+
+class TestRegion < MiniTest::Unit::TestCase
+
+  def setup
+    @fake_name = 'Freeside'
+    @real_name = 'North America'
+  end
+
+  def region(name)
+    AreaCodex::Region.new(name)
+  end
+
+  def test_initialize
+    assert_raises( NameError ) { AreaCodex::Region.new(@fake_name) }
+    assert_equal( true, region(@real_name).instance_of?(AreaCodex::Region) )
+  end
+
+  def test_include?
+    [@real_name, @real_name.to_sym].each do |name|
+      assert_equal( true, region(name).include?(604) )
+      assert_equal( false, region(name).include?(666) )
+    end
+  end
+
+  def test_exclude?
+    [@real_name, @real_name.to_sym].each do |name|
+      assert_equal( false, region(name).exclude?(604) )
+      assert_equal( true, region(name).exclude?(666) )
+    end
+  end
+end

data/test/lib/area_codex/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+class TestVersion < MiniTest::Unit::TestCase
+
+  def test_version
+    assert_equal( false, AreaCodex::VERSION.nil? )
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require File.expand_path('../../lib/area_codex.rb', __FILE__)
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'area_codex'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: area_codex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Cummer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Phone number area code lookup by region.
+email:
+- chris@unbounce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- area_codex.gemspec
+- lib/area_codex.rb
+- lib/area_codex/area_code_list.rb
+- lib/area_codex/base.rb
+- lib/area_codex/concerns/with_area_codes.rb
+- lib/area_codex/country.rb
+- lib/area_codex/region.rb
+- lib/area_codex/version.rb
+- lib/data/canada.txt
+- lib/data/mexico.txt
+- lib/data/united_states.txt
+- test/lib/area_codex/area_code_list_test.rb
+- test/lib/area_codex/country_test.rb
+- test/lib/area_codex/region_test.rb
+- test/lib/area_codex/version_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2225134602112427650
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2225134602112427650
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A list of phone number area codes by country. Currently only supports Canada,
+  the United States, and Mexico.
+test_files:
+- test/lib/area_codex/area_code_list_test.rb
+- test/lib/area_codex/country_test.rb
+- test/lib/area_codex/region_test.rb
+- test/lib/area_codex/version_test.rb
+- test/test_helper.rb