torasup 0.0.1 → 0.0.2

data/README.md

@@ -118,6 +118,48 @@ By default the following counties will take precedence: `["US", "GB", "AU", "IT"
 
 Now `Torasup::PhoneNumber.new(+1 415-234 567).country_id` will return `"ca"`
 
+## Testing
+
+Torasup exposes a few test helpers methods which you can use in your tests. See [the helper module](https://github.com/dwilkie/torasup/blob/master/lib/torasup/test/helpers.rb) for more info.
+
+Here's an example using rspec:
+
+    require 'spec_helper'
+
+    describe User do
+      include Torasup::Test::Helpers
+
+      ASSERTED_REGISTERED_OPERATORS = {"kh" => %w{smart beeline hello}}
+
+      # override this method to return the full path of the yaml spec
+      def yaml_file(filename)
+        File.join(File.dirname(__FILE__), "/#{filename}")
+      end
+
+      # provide a custom spec file for example see:
+      # see https://github.com/dwilkie/torasup/blob/master/spec/support/custom_pstn_spec.yaml
+      def pstn_data(custom_spec = nil)
+        super("custom_operators_spec.yaml")
+      end
+
+      def with_operators(&block)
+        super(:only_registered => ASSERTED_REGISTERED_OPERATORS, &block)
+      end
+
+      describe "#operator" do
+        it "should return the correct operator" do
+          with_operators do |number_parts, assertions|
+            new_user = build(:user, :phone_number => number_parts.join)
+            new_user.operator.should == assertions["name"]
+          end
+        end
+      end
+    end
+
+In this example `with_operators` is used to yield a to block with a sample number (yielded as `number_parts`) and a hash of assertions (yielded as `assertions`) made about that number. The assertions are defined in `custom_operators_spec.yaml` which is in the same directory as this spec file.
+
+Sample numbers and assertions are only yielded for the operators defined in `ASSERTED_REGISTERED_OPERATORS`
+
 ## Contributing
 
 1. Fork it

data/lib/torasup/test/helpers.rb

@@ -0,0 +1,95 @@
+module Torasup
+  module Test
+    module Helpers
+      private
+
+      def yaml_file(filename)
+        raise "Override this method to return the full path of the yaml spec"
+      end
+
+      def load_yaml_file(file_to_load)
+        file_to_load ? YAML.load_file(file_to_load) : {}
+      end
+
+      def pstn_spec(filename)
+        File.join(File.dirname(__FILE__), "../../../spec/support/#{filename}")
+      end
+
+      def pstn_data(custom_spec = nil)
+        return @pstn_data if @pstn_data
+        if custom_spec == true
+          custom_spec = pstn_spec("custom_pstn_spec.yaml")
+        elsif custom_spec
+          custom_spec = yaml_file(custom_spec)
+        end
+        data = load_yaml_file(pstn_spec("pstn_spec.yaml"))
+        @pstn_data = custom_spec ? data.deeper_merge(load_yaml_file(custom_spec)) : data
+      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_id, options) 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 with_pstn_data(options = {}, &block)
+        pstn_data(options[:with_custom_pstn_data]).each do |country_id, country_data|
+          next if options[:only_registered] && !options[:only_registered].include?(country_id)
+          yield country_id, country_data, country_data["prefix"]
+        end
+      end
+
+      def with_operator_data(country_id, options = {}, &block)
+        country_data(country_id, options[:with_custom_pstn_data])["operators"].each do |operator, operator_data|
+          next if options[:only_registered] && !options[:only_registered][country_id].include?(operator)
+          yield operator, operator_data
+        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 with_operator_prefixes(operator_data, &block)
+        operator_data["prefixes"].each do |prefix|
+          yield prefix
+        end
+      end
+
+      def country_data(country_id, custom_file = nil)
+        pstn_data(custom_file)[country_id.to_s] || {}
+      end
+    end
+  end
+end

data/lib/torasup/version.rb

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

data/lib/torasup.rb

@@ -1,3 +1,8 @@
+require 'yaml'
+require 'phony'
+require 'countries'
+require 'deep_merge/rails_compat'
+
 require "torasup/version"
 require "torasup/configuration"
 require "torasup/phone_number"
@@ -5,10 +10,10 @@ require "torasup/operator"
 require "torasup/location"
 
 module Torasup
-  require 'yaml'
-  require 'phony'
-  require 'countries'
-  require 'deep_merge/rails_compat'
+
+  module Test
+    autoload :Helpers, 'torasup/test/helpers'
+  end
 
   class << self
     def configure(&block)

data/spec/support/custom_pstn_spec.yaml

@@ -3,13 +3,10 @@
 
 ---
 kh:
-  area_codes:
-    '45': New Province
   operators:
     hello:
       assertions:
-        name: Hello
-        my_custom_property: hello-foo
+        name: "Hello"
       prefixes:
       - '15'
       - '16'

data/spec/support/pstn_helpers.rb

@@ -1,13 +1,14 @@
 module PstnHelpers
+  include Torasup::Test::Helpers
+
   private
 
-  def load_yaml_file(file_to_load)
-    file_to_load ? YAML.load_file(File.join(File.dirname(__FILE__), "/#{file_to_load}")) : {}
+  def clear_pstn_data
+    @pstn_data = nil
   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
+  def yaml_file(filename)
+    File.join(File.dirname(__FILE__), "../../spec/support/#{filename}")
   end
 
   def with_phone_numbers(options = {}, &block)
@@ -43,82 +44,25 @@ module PstnHelpers
     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)
+  def prefixes(country_id, *operators)
     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
+    operators.each do |operator|
+      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
     end
+    prefix_data
   end
 
   def configure_with_custom_data(custom_data = true)

data/spec/torasup/operator_spec.rb

@@ -31,12 +31,12 @@ module Torasup
 
     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)
+        with_operators(options) do |number_parts, assertions|
+          subject = Operator.new(*number_parts)
           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}")
+            result.should(eq(assertion), "expected Operator.new('#{number_parts}').#{method} to return '#{assertion}' but got #{result_error}")
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: torasup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: countries
@@ -111,6 +111,7 @@ files:
 - lib/torasup/location.rb
 - lib/torasup/operator.rb
 - lib/torasup/phone_number.rb
+- lib/torasup/test/helpers.rb
 - lib/torasup/version.rb
 - spec/spec_helper.rb
 - spec/support/custom_pstn.yaml
@@ -137,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1036375537
+      hash: -60913261
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -146,10 +147,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1036375537
+      hash: -60913261
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! '"Retuns metadata about a phone number such as operator, area code and