torasup 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/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+ - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Wilkie
+
+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,135 @@
+# Torasup
+
+Retuns metadata about a phone number such as operator info, area code and more.
+
+[![Build Status](https://travis-ci.org/dwilkie/torasup.png)](https://travis-ci.org/dwilkie/torasup)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'torasup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install torasup
+
+## Usage
+
+### Examples
+
+    $ irb
+
+    > require 'torasup'
+    > pn = Torasup::PhoneNumber.new("+855 (0) 62 451 234")
+
+    > pn.number
+    => "85562451234"
+
+    > pn.country_code
+    => "855"
+
+    > pn.country_id
+    => "kh"
+
+    > pn.area_code
+    => "62"
+
+    > pn.prefix
+    => "45"
+
+    > pn.local_number
+    => "1234"
+
+    > loc = pn.location
+    > loc.area
+    => "Kampong Thom"
+
+    > op = pn.operator
+
+    > op.id
+    => "smart"
+
+    > op.name
+    => "Smart"
+
+## Configuration
+
+### Overriding Data
+
+Sometimes it maybe necessary to override the data that Torasup provides. For example you may want to provide custom attributes for different operators. In order to achieve this you can provide a custom [psdn](http://en.wikipedia.org/wiki/Public_switched_telephone_network) data file. See the format of the [pstn data files](https://github.com/dwilkie/torasup/tree/master/lib/torasup/data) for more info. e.g.
+
+    # my_pstn_data.yaml
+    ---
+    kh:
+      area_codes:
+        "45": "New Province"
+      operators:
+        hello:
+          metadata:
+            name: Hello
+            my_custom_property: hello-foo
+          prefixes:
+          - '15'
+          - '16'
+          - '81'
+          - '87'
+          area_code_prefixes:
+          - '45'
+
+    > Torasup.configure do |config|
+    >   custom_pstn_data_file = "my_pstn_data.yaml"
+    > end
+
+    > pn = Torasup::PhoneNumber.new("+855 (0) 62 451 234")
+    > op = pn.operator
+
+    > op.id
+    => "hello"
+
+    > op.name
+    => "Hello"
+
+    > op.my_custom_property
+    => "hello-foo"
+
+### Registering Operators
+
+Sometimes you may only be interested in certain prefixes. For example let's say you want to match phone numbers from a certain operator from the database. You can register operators for this purpose. e.g.
+
+    > Torasup.configure do |config|
+    >   register_operators("kh", "metfone")
+    > end
+
+    > Torasup::Operator.registered_prefixes
+    =>  ["85597", "85588"]
+
+### Default Operators
+
+By default the following counties will take precedence: `["US", "GB", "AU", "IT", "RU", "NO"]`. This means that `Torasup::PhoneNumber.new(+1 415-234 567).country_id` will return `"us"` and not `ca`. To override use the following configuration setting.
+
+    > Torasup.configure do |config|
+    >   config.default_countries = ["CA"]
+    > end
+
+Now `Torasup::PhoneNumber.new(+1 415-234 567).country_id` will return `"ca"`
+
+## 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
+
+When contributing data please ensure that you create or edit an entry in the [pstn spec](https://github.com/dwilkie/torasup/tree/master/spec/torasup/spec/support_pstn_spec.rb). This ensures the integrity of the data.
+
+Please also include a link to Wikipedia article which verifies your data. See the [current psdn spec](https://github.com/dwilkie/torasup/blob/master/spec/support/pstn_spec.yaml) for an example that links to [Wikipedia](http://en.wikipedia.org/wiki/Telecommunications_in_Cambodia#Mobile_networks).
+
+If you obtained operator prefixes from another source please clearly add these prefixes to the appropriate Wikipedia article and reference it if necessary. This helps ensure the accuracy of the gem.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]

data/lib/torasup/configuration.rb

@@ -0,0 +1,32 @@
+class Configuration
+  DEFAULT_COUNTRIES = ["US", "GB", "AU", "IT", "RU", "NO"]
+  attr_accessor :registered_operators, :default_countries, :custom_pstn_data_file
+
+  def initialize
+    @default_countries = DEFAULT_COUNTRIES
+  end
+
+  def default_countries=(value)
+    @default_countries = value
+    Torasup.load_international_dialing_codes!
+  end
+
+  def custom_pstn_data_file=(value)
+    @custom_pstn_data_file = value
+    Torasup.load_pstn_data!
+  end
+
+  def register_operators(country_code, *operators)
+    registered_operators[country_code] = operators
+    Torasup.load_pstn_data!
+  end
+
+  def registered_operators=(value)
+    @registered_operators = value
+    Torasup.load_pstn_data!
+  end
+
+  def registered_operators
+    @registered_operators ||= {}
+  end
+end

data/lib/torasup/data/pstn.yaml

@@ -0,0 +1,89 @@
+---
+kh:
+  # http://en.wikipedia.org/wiki/Telephone_numbers_in_Cambodia
+  international_dialing_code: "855"
+  area_codes:
+    "23": "Phnom Penh"
+    "24": "Kandal"
+    "25": "Kampong Speu"
+    "26": "Kampong Chhnang"
+    "32": "Takeo"
+    "33": "Kampot"
+    "34": "Sihanoukville"
+    "35": "Koh Kong"
+    "36": "Kep"
+    "42": "Kampong Cham"
+    "43": "Prey Veng"
+    "44": "Svay Rieng"
+    "52": "Pursat"
+    "53": "Battambang"
+    "54": "Banteay Meanchey"
+    "55": "Pailin"
+    "62": "Kampong Thom"
+    "63": "Siem Reap"
+    "64": "Preah Vihear"
+    "65": "Oddar Meanchey"
+    "72": "Kratie"
+    "73": "Mondulkiri"
+    "74": "Stung Treng"
+    "75": "Ratanakiri"
+  operators:
+    # http://en.wikipedia.org/wiki/Telecommunications_in_Cambodia#Mobile_networks
+    smart:
+      metadata:
+        name: "Smart"
+      prefixes:
+        - "10"
+        - "15"
+        - "16"
+        - "69"
+        - "70"
+        - "81"
+        - "86"
+        - "87"
+        - "93"
+        - "96"
+        - "98"
+      area_code_prefixes:
+        - "45"
+    beeline:
+      metadata:
+        name: "Beeline"
+      prefixes:
+        - "60"
+        - "66"
+        - "67"
+        - "68"
+        - "90"
+      area_code_prefixes:
+        - "46"
+    mobitel:
+      metadata:
+        name: "Mobitel"
+      prefixes:
+        - '12'
+        - '17'
+        - '77'
+        - '78'
+        - '89'
+        - '92'
+        - '95'
+        - '11'
+        - '61'
+        - '76'
+        - '85'
+        - '99'
+    metfone:
+      metadata:
+        name: "Metfone"
+      prefixes:
+        - '97'
+        - '88'
+    qb:
+      metadata:
+        name: "Qb"
+      prefixes:
+        - '13'
+        - '80'
+        - '83'
+        - '84'

data/lib/torasup/location.rb

@@ -0,0 +1,11 @@
+module Torasup
+  class Location
+    attr_accessor :country_id, :area_code, :area
+
+    def initialize(country_id, area_code)
+      @country_id = country_id
+      @area = Torasup.area_code(country_id, area_code)
+      @area_code = area_code if @area
+    end
+  end
+end

data/lib/torasup/operator.rb

@@ -0,0 +1,42 @@
+module Torasup
+  class Operator
+    attr_accessor :prefix, :local_number, :area_code, :country_code
+
+    def initialize(country_code, area_code_or_prefix, unresolved_local_number)
+      @country_code = country_code
+      parse_phone_number(area_code_or_prefix, unresolved_local_number)
+    end
+
+    def method_missing(method)
+      Torasup.prefix_data(full_prefix)[method.to_s]
+    end
+
+    def self.registered_prefixes
+      Torasup.registered_prefixes
+    end
+
+    private
+
+    def parse_phone_number(area_code_or_prefix, unresolved_local_number)
+      if Torasup.prefix_data(full_prefix(area_code_or_prefix, local_number_parts(unresolved_local_number)[0])).any?
+        @area_code = area_code_or_prefix
+        @prefix = local_number_parts(unresolved_local_number)[0]
+        @local_number = local_number_parts(unresolved_local_number)[1]
+      elsif Torasup.prefix_data(full_prefix(area_code_or_prefix)).any?
+        @prefix = area_code_or_prefix
+        @local_number = unresolved_local_number
+      else
+        @local_number = area_code_or_prefix + unresolved_local_number
+      end
+    end
+
+    def local_number_parts(number)
+      [number[0..1], number[2..-1]]
+    end
+
+    def full_prefix(*parts)
+      parts = [@area_code, @prefix] if parts.empty?
+      @country_code + parts.join
+    end
+  end
+end

data/lib/torasup/phone_number.rb

@@ -0,0 +1,29 @@
+module Torasup
+  class PhoneNumber
+    attr_reader :number, :country_code, :country_id, :area_code, :prefix, :local_number, :location, :operator
+
+    def initialize(phone_number)
+      parse_phone_number(phone_number)
+    end
+
+    private
+
+    def parse_phone_number(number)
+      @number = Phony.normalize(number)
+      number_parts = split_number
+      @country_code = number_parts.shift
+      @country_id = Torasup.country_id(@country_code)
+      area_code_or_prefix = number_parts.shift
+      local_number = number_parts.join
+      @location = Location.new(@country_id, area_code_or_prefix)
+      @area_code = @location.area_code
+      @operator = Operator.new(@country_code, area_code_or_prefix, local_number)
+      @prefix = @operator.prefix
+      @local_number = operator.local_number
+    end
+
+    def split_number
+      Phony.split(@number).reject { |part| part == false }
+    end
+  end
+end

data/lib/torasup/version.rb

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

data/lib/torasup.rb

@@ -0,0 +1,131 @@
+require "torasup/version"
+require "torasup/configuration"
+require "torasup/phone_number"
+require "torasup/operator"
+require "torasup/location"
+
+module Torasup
+  require 'yaml'
+  require 'phony'
+  require 'countries'
+  require 'deep_merge/rails_compat'
+
+  class << self
+    def configure(&block)
+      yield(configuration)
+    end
+
+    def load_international_dialing_codes!
+      @international_dialing_codes = {}
+      ISO3166::Country.all.each do |name, country_id|
+        dialing_code = ISO3166::Country[country_id].country_code
+        @international_dialing_codes[dialing_code] = country_id unless @international_dialing_codes[dialing_code] && !configuration.default_countries.include?(country_id)
+      end
+    end
+
+    def load_pstn_data!
+      @pstn_data = load_yaml_file(File.join(File.dirname(__FILE__), 'torasup/data/pstn.yaml')).deeper_merge(
+        load_yaml_file(configuration.custom_pstn_data_file)
+      )
+      load_pstn_prefixes!
+    end
+
+    def country_id(country_code)
+      @international_dialing_codes[country_code].downcase if @international_dialing_codes[country_code]
+    end
+
+    def area_code(country_id, code)
+      area_codes(country_id)[code]
+    end
+
+    def prefix_data(prefix)
+      @pstn_prefixes[prefix] || {}
+    end
+
+    def registered_prefixes
+      @registered_pstn_prefixes.keys
+    end
+
+    private
+
+    def load_pstn_prefixes!
+      @pstn_prefixes = {}
+      @registered_pstn_prefixes = {}
+      @pstn_data.each do |country_id, country_properties|
+        operators(country_id).each do |operator, operator_properties|
+          operator_prefixes(country_id, operator).each do |operator_prefix, prefix_data|
+            prefix_properties = operator_metadata(country_id, operator).merge(prefix_data)
+            @pstn_prefixes[operator_prefix] = prefix_properties
+            @registered_pstn_prefixes[operator_prefix] = prefix_properties if operator_registered?(country_id, operator)
+          end
+        end
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def load_yaml_file(file_to_load)
+      file_to_load ? YAML.load_file(file_to_load) : {}
+    end
+
+    def operator_registered?(country_id, operator)
+      (configuration.registered_operators[country_id] || []).include?(operator)
+    end
+
+    def country_data(country_id)
+      @pstn_data[country_id] || {}
+    end
+
+    def international_dialing_code(country_id)
+      country_data(country_id)["international_dialing_code"]
+    end
+
+    def area_codes(country_id)
+      country_data(country_id)["area_codes"] || {}
+    end
+
+    def operators(country_id)
+      country_data(country_id)["operators"] || {}
+    end
+
+    def operator_data(country_id, operator)
+      operators(country_id)[operator] || {}
+    end
+
+    def operator_metadata(country_id, operator)
+      {"id" => operator}.merge(operator_data(country_id, operator)["metadata"] || {})
+    end
+
+    def operator_area_code_prefixes(country_id, operator)
+      operator_data(country_id, operator)["area_code_prefixes"] || {}
+    end
+
+    def operator_mobile_prefixes(country_id, operator)
+      full_prefixes = {}
+      mobile_prefixes = operator_data(country_id, operator)["prefixes"] || {}
+      mobile_prefixes.each do |mobile_prefix|
+        full_prefixes[operator_full_prefix(country_id, mobile_prefix)] = {"prefix" => mobile_prefix}
+      end
+      full_prefixes
+    end
+
+    def operator_full_prefix(country_id, *prefixes)
+      international_dialing_code(country_id) + prefixes.join
+    end
+
+    def operator_prefixes(country_id, operator)
+      operator_prefixes = operator_mobile_prefixes(country_id, operator)
+      operator_area_code_prefixes(country_id, operator).each do |operator_area_code_prefix|
+        area_codes(country_id).each do |area_code, area|
+          operator_prefixes[operator_full_prefix(country_id, area_code, operator_area_code_prefix)] = {"prefix" => operator_area_code_prefix}
+        end
+      end
+      operator_prefixes
+    end
+  end
+
+  load_international_dialing_codes!
+  load_pstn_data!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'torasup'
+
+RSpec.configure do |config|
+  Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/support/custom_pstn.yaml

@@ -0,0 +1,17 @@
+# this file is a sample file which can be used to override the standard pstn data
+---
+kh:
+  area_codes:
+    "45": "New Province"
+  operators:
+    hello:
+      metadata:
+        name: Hello
+        my_custom_property: hello-foo
+      prefixes:
+      - '15'
+      - '16'
+      - '81'
+      - '87'
+      area_code_prefixes:
+      - '45'

data/spec/support/custom_pstn_spec.yaml

@@ -0,0 +1,19 @@
+# this file is used to test the functionality of overriding the standard pstn data
+# with the data in spec/support/custom_pstn.data
+
+---
+kh:
+  area_codes:
+    '45': New Province
+  operators:
+    hello:
+      assertions:
+        name: Hello
+        my_custom_property: hello-foo
+      prefixes:
+      - '15'
+      - '16'
+      - '81'
+      - '87'
+      area_code_prefixes:
+      - '45'

data/spec/support/pstn_helpers.rb

@@ -0,0 +1,142 @@
+module PstnHelpers
+  private
+
+  def load_yaml_file(file_to_load)
+    file_to_load ? YAML.load_file(File.join(File.dirname(__FILE__), "/#{file_to_load}")) : {}
+  end
+
+  def pstn_data(with_custom_pstn_data = false)
+    data = load_yaml_file("pstn_spec.yaml")
+    with_custom_pstn_data ? data.deeper_merge(load_yaml_file("custom_pstn_spec.yaml")) : data
+  end
+
+  def with_phone_numbers(options = {}, &block)
+    phone_number_assertions = {}
+    with_pstn_data(options) do |country_id, country_data, country_prefix|
+      area_code_or_prefix = (10 + rand(100 - 10)).to_s
+      local_number = [(100 + rand(1000 - 100)).to_s, (100 + rand(1000 - 100)).to_s]
+      sample_number = "+#{country_prefix} (0) #{area_code_or_prefix}-#{local_number[0]}-#{local_number[1]}"
+      normalized_number = country_prefix + area_code_or_prefix + local_number[0] + local_number[1]
+      phone_number_assertions[sample_number] = {
+        "number" => normalized_number, "country_id" => country_id, "country_code" => country_prefix,
+        "area_code_or_prefix" => area_code_or_prefix, "local_number" => local_number.join
+      }
+    end
+    phone_number_assertions.each do |sample_number, assertions|
+      yield sample_number, assertions
+    end
+  end
+
+  def with_locations(options = {}, &block)
+    location_assertions = {}
+    with_pstn_data(options) do |country_id, country_data|
+      default_assertions = {"country_id" => country_id}
+      location_assertions[country_id] = {}
+      country_data["area_codes"].each do |area_code, area|
+        location_assertions[country_id][area_code] = default_assertions.merge("area_code" => area_code, "area" => area)
+      end
+    end
+    location_assertions.each do |country_id, area_code_assertions|
+      area_code_assertions.each do |area_code, assertions|
+        yield country_id, area_code, assertions
+      end
+    end
+  end
+
+  def with_operators(options = {}, &block)
+    operator_assertions = {}
+    with_pstn_data(options) do |country_id, country_data, country_prefix|
+      operator_assertions[country_prefix] = {}
+      default_assertions = {"country_code" => country_prefix}
+      with_operator_data(country_data) do |operator, operator_data|
+        default_assertions.merge!("id" => operator).merge!(operator_data["assertions"])
+        with_operator_area_codes(country_data, operator_data) do |area_code_prefix, area_code, area|
+          operator_assertions[country_prefix][area_code] = {}
+          local_number = ("0" * (6 - area_code_prefix.length))
+          unresolved_number = area_code_prefix + local_number
+          operator_assertions[country_prefix][area_code][unresolved_number] = default_assertions.merge(
+            "area_code" => area_code, "prefix" => area_code_prefix, "local_number" => local_number
+          )
+        end
+        with_operator_prefixes(operator_data) do |prefix|
+          operator_assertions[country_prefix][prefix] = {}
+          local_number = ("0" * 6)
+          operator_assertions[country_prefix][prefix][local_number] = default_assertions.merge(
+            "prefix" => prefix, "area_code" => nil
+          )
+        end
+      end
+    end
+    operator_assertions.each do |country_prefix, country_assertions|
+      country_assertions.each do |area_code_or_prefix, area_code_or_prefix_assertions|
+        area_code_or_prefix_assertions.each do |unresolved_local_number, assertions|
+          yield country_prefix, area_code_or_prefix, unresolved_local_number, assertions
+        end
+      end
+    end
+  end
+
+  def sample_operator
+    country = pstn_data.first
+    [country.first, country.last["operators"].first.first]
+  end
+
+  def prefixes(country_id, operator)
+    prefix_data = []
+    country_data = pstn_data[country_id]
+    country_prefix = country_data["prefix"]
+    operator_data = country_data["operators"][operator]
+    with_operator_area_codes(country_data, operator_data) do |area_code_prefix, area_code|
+      prefix_data << (country_prefix + area_code + area_code_prefix)
+    end
+    with_operator_prefixes(operator_data) do |prefix|
+      prefix_data << (country_prefix + prefix)
+    end
+    prefix_data
+  end
+
+  def with_pstn_data(options = {}, &block)
+    pstn_data(options[:with_custom_pstn_data]).each do |country_id, country_data|
+      yield country_id, country_data, country_data["prefix"]
+    end
+  end
+
+  def with_operator_data(country_data, &block)
+    country_data["operators"].each do |operator, operator_data|
+      yield operator, operator_data
+    end
+  end
+
+  def with_operator_prefixes(operator_data, &block)
+    operator_data["prefixes"].each do |prefix|
+      yield prefix
+    end
+  end
+
+  def with_operator_area_codes(country_data, operator_data, &block)
+    (operator_data["area_code_prefixes"] || {}).each do |area_code_prefix|
+      country_data["area_codes"].each do |area_code, area|
+        yield area_code_prefix, area_code, area
+      end
+    end
+  end
+
+  def configure_with_custom_data(custom_data = true)
+    custom_data_file = File.join(File.dirname(__FILE__), "../support", "/custom_pstn.yaml") if custom_data
+    Torasup.configure do |config|
+      config.custom_pstn_data_file = custom_data_file
+    end
+  end
+
+  def configure_registered_operators(country_id, *operators)
+    Torasup.configure do |config|
+      config.register_operators(country_id, *operators)
+    end
+  end
+
+  def clear_registered_operators
+    Torasup.configure do |config|
+      config.registered_operators = {}
+    end
+  end
+end

data/spec/support/pstn_spec.yaml

@@ -0,0 +1,91 @@
+# this file is used to test the gem against the data in lib/torasup/data/pstn.yaml
+# add examples to this file in order to test the integrity of the data
+---
+kh:
+  # http://en.wikipedia.org/wiki/Telephone_numbers_in_Cambodia
+  prefix: '855'
+  area_codes:
+    '23': Phnom Penh
+    '24': Kandal
+    '25': Kampong Speu
+    '26': Kampong Chhnang
+    '32': Takeo
+    '33': Kampot
+    '34': Sihanoukville
+    '35': Koh Kong
+    '36': Kep
+    '42': Kampong Cham
+    '43': Prey Veng
+    '44': Svay Rieng
+    '52': Pursat
+    '53': Battambang
+    '54': Banteay Meanchey
+    '55': Pailin
+    '62': Kampong Thom
+    '63': Siem Reap
+    '64': Preah Vihear
+    '65': Oddar Meanchey
+    '72': Kratie
+    '73': Mondulkiri
+    '74': Stung Treng
+    '75': Ratanakiri
+  operators:
+    # http://en.wikipedia.org/wiki/Telecommunications_in_Cambodia#Mobile_networks
+    smart:
+      assertions:
+        name: Smart
+      prefixes:
+        - '10'
+        - '15'
+        - '16'
+        - '69'
+        - '70'
+        - '81'
+        - '86'
+        - '87'
+        - '93'
+        - '96'
+        - '98'
+      area_code_prefixes:
+        - '45'
+    beeline:
+      assertions:
+        name: Beeline
+      prefixes:
+        - '60'
+        - '66'
+        - '67'
+        - '68'
+        - '90'
+      area_code_prefixes:
+        - '46'
+    mobitel:
+      assertions:
+        name: Mobitel
+      prefixes:
+        - '12'
+        - '17'
+        - '77'
+        - '78'
+        - '89'
+        - '92'
+        - '95'
+        - '11'
+        - '61'
+        - '76'
+        - '85'
+        - '99'
+    metfone:
+      assertions:
+        name: Metfone
+      prefixes:
+        - '97'
+        - '88'
+    qb:
+      assertions:
+        name: Qb
+      prefixes:
+        - '13'
+        - '80'
+        - '83'
+        - '84'

data/spec/torasup/configuration_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Torasup do
+  describe ".configure" do
+    describe "#registered_operators=" do
+      before do
+        Torasup.stub(:load_pstn_data!)
+      end
+
+      it "should set the registered operators and clear" do
+        Torasup.configure do |config|
+          Torasup.should_receive(:load_pstn_data!)
+          config.registered_operators.should == {}
+          config.registered_operators = {"foo" => "bar"}
+          config.registered_operators.should == {"foo" => "bar"}
+        end
+      end
+    end
+
+    describe "#register_operators(country_id, *operators)" do
+      before do
+        Torasup.stub(:load_pstn_data!)
+      end
+
+      it "should set the registered operators" do
+        Torasup.configure do |config|
+          Torasup.should_receive(:load_pstn_data!)
+          config.registered_operators = {}
+          config.register_operators("kh", "smart", "beeline")
+          config.registered_operators.should == {"kh" => ["smart", "beeline"]}
+        end
+      end
+    end
+
+    describe "#default_countries=('['US', 'AU']')" do
+      before do
+        Torasup.stub(:load_international_dialing_codes!)
+      end
+
+      it "should set the default countries and reload the data" do
+        Torasup.configure do |config|
+          Torasup.should_receive(:load_international_dialing_codes!)
+          config.default_countries.should == ["US", "GB", "AU", "IT", "RU", "NO"]
+          config.default_countries = ["US", "GB"]
+          config.default_countries.should == ["US", "GB"]
+        end
+      end
+    end
+
+    describe "#custom_pstn_data_file=('path_to_yaml_file.yaml')" do
+      before do
+        Torasup.stub(:load_pstn_data!)
+      end
+
+      it "should set a custom pstn data file and reload the data" do
+        Torasup.configure do |config|
+          Torasup.should_receive(:load_pstn_data!)
+          config.custom_pstn_data_file.should be_nil
+          config.custom_pstn_data_file = "foo.yaml"
+          config.custom_pstn_data_file.should == "foo.yaml"
+        end
+      end
+    end
+  end
+end

data/spec/torasup/location_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Torasup
+  describe Location do
+    include PstnHelpers
+
+    shared_examples_for "a location" do
+      it "should return all the location attributes" do
+        with_locations(options) do |country_id, area_code, assertions|
+          subject = Location.new(country_id, area_code)
+          assertions.each do |method, assertion|
+            result = subject.send(method)
+            result_error = result.nil? ? "nil" : "'#{result}'"
+            result.should(eq(assertion), "expected Location.new('#{country_id}', '#{area_code}').#{method} to return '#{assertion}' but got #{result_error}")
+          end
+        end
+      end
+    end
+
+    context "using the standard data" do
+      before do
+        configure_with_custom_data(false)
+      end
+
+      it_should_behave_like "a location" do
+        let(:options) { {} }
+      end
+    end
+
+    context "using overridden data" do
+      before do
+        configure_with_custom_data
+      end
+
+      it_should_behave_like "a location" do
+        let(:options) { { :with_custom_pstn_data => true } }
+      end
+    end
+  end
+end

data/spec/torasup/operator_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module Torasup
+  describe Operator do
+    include PstnHelpers
+
+    describe ".registered_prefixes" do
+      context "given no operators have been registered" do
+        before do
+          clear_registered_operators
+        end
+
+        it "should return an empty array" do
+          Operator.registered_prefixes.should == []
+        end
+      end
+
+      context "given one operator has been registered" do
+        let(:operator) { sample_operator }
+
+        before do
+          configure_registered_operators(operator[0], operator[1])
+          configure_with_custom_data(false)
+        end
+
+        it "should the prefixes for that operator" do
+          Operator.registered_prefixes.should =~ prefixes(operator[0], operator[1])
+        end
+      end
+    end
+
+    shared_examples_for "an operator" do
+      it "should return all the operator metadata" do
+        with_operators(options) do |country_code, area_code_or_prefix, unresolved_local_number, assertions|
+          subject = Operator.new(country_code, area_code_or_prefix, unresolved_local_number)
+          assertions.each do |method, assertion|
+            result = subject.send(method)
+            result_error = result.nil? ? "nil" : "'#{result}'"
+            result.should(eq(assertion), "expected Operator.new('#{country_code}', '#{area_code_or_prefix}', '#{unresolved_local_number}').#{method} to return '#{assertion}' but got #{result_error}")
+          end
+        end
+      end
+    end
+
+    context "using the standard data" do
+      before do
+        configure_with_custom_data(false)
+      end
+
+      it_should_behave_like "an operator" do
+        let(:options) { {} }
+      end
+    end
+
+    context "using overridden data" do
+      before do
+        configure_with_custom_data
+      end
+
+      it_should_behave_like "an operator" do
+        let(:options) { { :with_custom_pstn_data => true } }
+      end
+    end
+  end
+end

data/spec/torasup/phone_number_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+module Torasup
+  describe PhoneNumber do
+    include PstnHelpers
+
+    subject { PhoneNumber.new("123456789") }
+    let(:location) { mock(Torasup::Location).as_null_object }
+    let(:operator) { mock(Torasup::Operator).as_null_object }
+
+    describe "#location" do
+      it "should return an instance of Torasup::Location" do
+        subject.location.should be_a(Torasup::Location)
+      end
+    end
+
+    describe "#operator" do
+      it "should return an instance of Torasup::Operator" do
+        subject.operator.should be_a(Torasup::Operator)
+      end
+    end
+
+    describe "#area_code" do
+      before do
+        location.stub(:area_code).and_return("123")
+        Torasup::Location.stub(:new).and_return(location)
+      end
+
+      it "should delegate to location" do
+        subject.area_code.should == "123"
+      end
+    end
+
+    describe "#prefix" do
+      before do
+        operator.stub(:prefix).and_return("12")
+        Torasup::Operator.stub(:new).and_return(operator)
+      end
+
+      it "should delegate to operator" do
+        subject.prefix.should == "12"
+      end
+    end
+
+    describe "#local_number" do
+      before do
+        operator.stub(:local_number).and_return("234567")
+        Torasup::Operator.stub(:new).and_return(operator)
+      end
+
+      it "should delegate to operator" do
+        subject.local_number.should == "234567"
+      end
+    end
+
+    shared_examples_for "a phone number" do
+
+      before do
+        Torasup::Location.stub(:new).and_return(location)
+        Torasup::Operator.stub(:new).and_return(operator)
+      end
+
+      it "should return all the phone number attributes" do
+        with_phone_numbers(options) do |sample_number, assertions|
+          area_code_or_prefix = assertions.delete("area_code_or_prefix")
+          local_number = assertions.delete("local_number")
+
+          Torasup::Location.should_receive(:new).with(assertions["country_id"], area_code_or_prefix)
+          Torasup::Operator.should_receive(:new).with(assertions["country_code"], area_code_or_prefix, local_number)
+
+          subject = PhoneNumber.new(sample_number)
+
+          assertions.each do |method, assertion|
+            result = subject.send(method)
+            result_error = result.nil? ? "nil" : "'#{result}'"
+            result.should(eq(assertion), "expected PhoneNumber.new('#{sample_number}').#{method} to return '#{assertion}' but got #{result_error}")
+          end
+        end
+      end
+    end
+
+    context "using the standard data" do
+      before do
+        configure_with_custom_data(false)
+      end
+
+      it_should_behave_like "a phone number" do
+        let(:options) { {} }
+      end
+    end
+
+    context "using overridden data" do
+      before do
+        configure_with_custom_data
+      end
+
+      it_should_behave_like "a phone number" do
+        let(:options) { { :with_custom_pstn_data => true } }
+      end
+    end
+  end
+end

data/spec/torasup_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Torasup do
+end

data/torasup.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'torasup/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "torasup"
+  gem.version       = Torasup::VERSION
+  gem.authors       = ["David Wilkie"]
+  gem.email         = ["dwilkie@gmail.com"]
+  gem.description   = %q{"Retuns metadata about a phone number such as operator, area code and more"}
+  gem.summary       = %q{"Retuns metadata about a phone number such as operator, area code and more"}
+  gem.homepage      = "https://github.com/dwilkie/torasup/"
+
+  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_runtime_dependency "countries"
+  gem.add_runtime_dependency "phony"
+  gem.add_runtime_dependency "deep_merge"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"  
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: torasup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Wilkie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: phony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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'
+description: ! '"Retuns metadata about a phone number such as operator, area code
+  and more"'
+email:
+- dwilkie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/torasup.rb
+- lib/torasup/configuration.rb
+- lib/torasup/data/pstn.yaml
+- lib/torasup/location.rb
+- lib/torasup/operator.rb
+- lib/torasup/phone_number.rb
+- lib/torasup/version.rb
+- spec/spec_helper.rb
+- spec/support/custom_pstn.yaml
+- spec/support/custom_pstn_spec.yaml
+- spec/support/pstn_helpers.rb
+- spec/support/pstn_spec.yaml
+- spec/torasup/configuration_spec.rb
+- spec/torasup/location_spec.rb
+- spec/torasup/operator_spec.rb
+- spec/torasup/phone_number_spec.rb
+- spec/torasup_spec.rb
+- torasup.gemspec
+homepage: https://github.com/dwilkie/torasup/
+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: -1036375537
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1036375537
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! '"Retuns metadata about a phone number such as operator, area code and
+  more"'
+test_files:
+- spec/spec_helper.rb
+- spec/support/custom_pstn.yaml
+- spec/support/custom_pstn_spec.yaml
+- spec/support/pstn_helpers.rb
+- spec/support/pstn_spec.yaml
+- spec/torasup/configuration_spec.rb
+- spec/torasup/location_spec.rb
+- spec/torasup/operator_spec.rb
+- spec/torasup/phone_number_spec.rb
+- spec/torasup_spec.rb