aus_phones 0.9.1

data/lib/aus_phones.rb

@@ -0,0 +1,192 @@
+require 'aus_phones/version'
+require 'ostruct'
+require 'yaml'
+require 'active_support/core_ext/hash/keys'
+
+class AusPhones
+  attr_reader :input, :phone_number
+
+  CNF = OpenStruct.new(YAML::load_file(File.join(__dir__, '../config/phones.yml')).deep_symbolize_keys)
+
+  def initialize(input='')
+    raise RuntimeError.new('Not a string') unless input.is_a? String
+    @input        = input
+    @phone_number = build
+  end
+
+  def is_valid?
+    phone_number.is_valid
+  end
+
+  def is_form_valid?
+    phone_number.is_form_valid
+  end
+
+  def is_emergency?
+    phone_number.type == 'emergency'
+  end
+
+  def is_mobile?
+    phone_number.type == 'mobile'
+  end
+
+  def is_landline?
+    phone_number.type == 'landline'
+  end
+
+  def is_satellite?
+    phone_number.type == 'satellite'
+  end
+
+  def is_voip?
+    phone_number.type == 'voip'
+  end
+
+  def is_data?
+    phone_number.type == 'data'
+  end
+
+  def is_nongeo?
+    phone_number.type == 'nongeo'
+  end
+
+  def is_test?
+    phone_number.type == 'test'
+  end
+
+  def is_fictitious?
+    phone_number.type == 'fictitious'
+  end
+
+  def type
+    phone_number.type
+  end
+
+  def region
+    phone_number.region
+  end
+
+  def carrier
+    phone_number.carrier
+  end
+
+  def description
+    phone_number.description
+  end
+
+  def area_code
+    phone_number.area_code
+  end
+
+  def dial_local
+    phone_number.number
+  end
+
+  def dial_domestic
+    if (phone_number.number.to_s.size == 0)
+      return nil
+    else
+      "#{phone_number.area_code}#{phone_number.number}"
+    end
+  end
+
+  def dial_international
+    if (phone_number.area_code.start_with?('0') || phone_number.number.start_with?('0'))
+      dial = "#{phone_number.area_code}#{phone_number.number}"
+      return dial.sub(/^0/, CNF.prefix)
+    else
+      return nil
+    end
+  end
+
+  def format_local
+    if (phone_number.number.to_s.size == 0)
+      return nil
+    elsif (phone_number.number.to_s.size == 12)
+      return phone_number.number.sub(/^([0-9]{4})([0-9]{4})([0-9]{4})$/, '\1 \2 \3')
+    elsif (phone_number.number.to_s.size == 11)
+      return phone_number.number.sub(/^([0-9]{4})([0-9]{3})([0-9]{4})$/, '\1 \2 \3')
+    elsif (phone_number.number.to_s.size == 10)
+      return phone_number.number.sub(/^([0-9]{4})([0-9]{3})([0-9]{3})$/, '\1 \2 \3')
+    elsif (phone_number.number.to_s.size == 9)
+      return phone_number.number.sub(/^([0-9]{3})([0-9]{3})([0-9]{3})$/, '\1 \2 \3')
+    elsif (phone_number.number.to_s.size == 8)
+      return phone_number.number.sub(/^([0-9]{4})([0-9]{4})$/, '\1 \2')
+    elsif (phone_number.number.to_s.size == 7)
+      return phone_number.number.sub(/^([0-9]{3})([0-9]{4})$/, '\1 \2')
+    elsif (phone_number.number.to_s.size == 6)
+      return phone_number.number.sub(/^([0-9]{3})([0-9]{3})$/, '\1 \2')
+    elsif (phone_number.number.to_s.size < 6)
+      return phone_number.number
+    end
+  end
+
+  def format_domestic
+    if phone_number.number.to_s.size == 0
+      nil
+    else
+      if phone_number.area_code.to_s.size == 0
+        format_local
+      else
+        "(#{phone_number.area_code}) #{format_local}"
+      end
+    end
+  end
+
+  def format_international
+    if phone_number.area_code.start_with?('0')
+      area_code = phone_number.area_code.sub(/^0/, '')
+      number = format_local
+      return "+#{CNF.prefix} (#{area_code}) #{number}"
+    elsif phone_number.number.start_with?('0')
+      number = format_local
+      number = number.sub(/^0/, '')
+      return "+#{CNF.prefix} #{number}"
+   else
+      return nil
+    end
+  end
+
+
+  private
+
+  def build
+    # Create a data structure
+    phone_number = OpenStruct.new(
+        is_valid:      false,
+        is_form_valid: false,
+        type:          nil,
+        region:        nil,
+        carrier:       nil,
+        description:   nil,
+        area_code:     nil,
+        number:        nil
+    )
+
+    # Clean out non standard characters
+    cleaned      = input.gsub(/[^0-9\+]/, '')
+
+    # Remove international prefix
+    cleaned      = cleaned.gsub(/\+#{CNF.prefix}/, '0')
+
+    # Match Number to profile
+    CNF.phones.each do |profile|
+      m = Regexp.new(profile[:pattern]).match(cleaned)
+      if m then
+        phone_number.is_valid      = true
+        phone_number.is_form_valid = profile[:valid]
+        phone_number.area_code     = profile[:area_code]
+        phone_number.type          = profile[:type]
+        phone_number.carrier       = profile[:carrier]
+        phone_number.state         = profile[:state]
+        phone_number.region        = profile[:region]
+        phone_number.description   = profile[:description]
+        phone_number.number        = m[1]
+      end
+    end
+
+    phone_number
+  end
+
+
+end

data/lib/aus_phones/version.rb

@@ -0,0 +1,3 @@
+class AusPhones
+  VERSION = "0.9.1"
+end

data/spec/aus_phones_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+RSpec.describe AusPhones do
+#  before :all do
+#    @phone = AusPhones.new '+61 2 9900 0000'
+#  end
+
+  let(:phone) {AusPhones.new '+61 2 9900 0000'}
+
+  it 'takes one parameter and returns an AusPhones' do
+    expect(phone).to be_instance_of(AusPhones)
+  end
+
+  it 'recognises emergency numbers' do
+    expect(AusPhones.new('000').is_emergency?).to eq(true)
+    expect(AusPhones.new('999').is_emergency?).to eq(true)
+  end
+
+  it 'recognises emergency numbers as invalid' do
+    expect(AusPhones.new('000').is_valid?).to eq(true)
+    expect(AusPhones.new('999').is_valid?).to eq(true)
+    expect(AusPhones.new('000').is_form_valid?).to eq(false)
+    expect(AusPhones.new('999').is_form_valid?).to eq(false)
+  end
+
+  it 'validates central east region phone number as true' do
+    expect(AusPhones.new('+61 2 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('02 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('(02) 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('02-3300-0000').is_form_valid?).to eq(true)
+  end
+
+  it 'validates south east region phone number as true' do
+    expect(AusPhones.new('+61 3 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('03 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('(03) 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('03-3300-0000').is_form_valid?).to eq(true)
+  end
+
+  it 'validates north east region phone number as true' do
+    expect(AusPhones.new('+61 7 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('07 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('(07) 3300 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('07-3300-0000').is_form_valid?).to eq(true)
+  end
+
+  it 'validates central and west region phone number as true' do
+    expect(AusPhones.new('+61 8 2500 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('08 2500 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('(08) 2500 0000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('08-2500-0000').is_form_valid?).to eq(true)
+  end
+
+  it 'validates mobile number' do
+    expect(AusPhones.new('+61 488 000 000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('0488 000 000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('(0488) 000 000').is_form_valid?).to eq(true)
+    expect(AusPhones.new('(0)488 000 000').is_form_valid?).to eq(true)
+  end
+
+  it 'validates phone number as mobile' do
+    expect(AusPhones.new('+61 488 000 000').is_mobile?).to eq(true)
+  end
+
+  it 'validates mobile carrier' do
+    expect(AusPhones.new('0400 000 000').carrier).to eq('Telstra')
+    expect(AusPhones.new('0401 000 000').carrier).to eq('Optus')
+    expect(AusPhones.new('0404 000 000').carrier).to eq('Vodafone')
+    expect(AusPhones.new('0420 000 000').carrier).to eq('Rail Corporation New South Wales')
+    expect(AusPhones.new('0420 020 000').carrier).to eq('Dialogue Communications Pty Limited')
+    expect(AusPhones.new('0420 030 000').carrier).to eq('Symbio Network Pty Ltd')
+    expect(AusPhones.new('0420 100 000').carrier).to eq('Pivotel Satellite Pty Limited')
+    expect(AusPhones.new('0420 119 000').carrier).to eq('COMPATEL Limited')
+    expect(AusPhones.new('0469 000 000').carrier).to eq('Lycamobile')
+    expect(AusPhones.new('0488 800 000').carrier).to eq('My Number Pty Ltd')
+    expect(AusPhones.new('0489 840 000').carrier).to eq('Victorian Rail Track')
+    expect(AusPhones.new('0489 900 000').carrier).to eq('Novatel Telephony Pty Ltd')
+  end
+
+  it 'validates phone number as satellite' do
+    expect(AusPhones.new('014 000 000').is_satellite?).to eq(true)
+  end
+
+  it 'validates phone number as voip' do
+    expect(AusPhones.new('0550 000 000').is_voip?).to eq(true)
+  end
+
+  it 'validates phone number as data' do
+    expect(AusPhones.new('0198 000 000').is_data?).to eq(true)
+  end
+
+  it 'validates fictitious numbers' do
+    expect(AusPhones.new('+61 1 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 1 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 1 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 1 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 2 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 2 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 2 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 2 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 3 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 3 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 3 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 3 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 4 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 4 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 4 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 4 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 5 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 5 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 5 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 5 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 6 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 6 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 6 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 6 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 7 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 7 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 7 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 7 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 8 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 8 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 8 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 8 701 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 9 5550 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 9 555 000 000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 9 7010 0000').is_fictitious?).to eq(true)
+    expect(AusPhones.new('+61 9 701 000 000').is_fictitious?).to eq(true)
+  end
+
+  it 'validates phone number as test' do
+    expect(AusPhones.new('12711').is_test?).to eq(true)
+    expect(AusPhones.new('12722123').is_test?).to eq(true)
+    expect(AusPhones.new('1272312').is_test?).to eq(true)
+  end
+
+  it 'validates test number carriers' do
+    expect(AusPhones.new('12722123').carrier).to eq('Telstra')
+    expect(AusPhones.new('1272312').carrier).to eq('Optus')
+  end
+
+  it 'correctly identifies invalid phone numbers' do
+    expect(AusPhones.new('+61 2 9900 +0000').is_valid?).to eq(false)
+    expect(AusPhones.new('+61 2 9900 +0000').is_form_valid?).to eq(false)
+  end
+
+  it 'identifies correct area codes' do
+    expect(AusPhones.new('+61 (2) 3300 0000').area_code).to eq('02')
+    expect(AusPhones.new('(02) 3300 0000').area_code).to eq('02')
+  end
+
+  it 'generates number for dialing local' do
+    expect(AusPhones.new('(02) 3300 0000').dial_local).to eq('33000000')
+    expect(AusPhones.new('(0)488 000 000').dial_local).to eq('0488000000')
+    expect(AusPhones.new('1800 801 920').dial_local).to eq('1800801920')
+  end
+
+  it 'generates number for dialing domestic' do
+    expect(AusPhones.new('(02) 3300 0000').dial_domestic).to eq('0233000000')
+    expect(AusPhones.new('(0)488 000 000').dial_domestic).to eq('0488000000')
+    expect(AusPhones.new('1800 801 920').dial_domestic).to eq('1800801920')
+  end
+
+  it 'generates number for dialing international' do
+    expect(AusPhones.new('(02) 3300 0000').dial_international).to eq('61233000000')
+    expect(AusPhones.new('(0)488 000 000').dial_international).to eq('61488000000')
+    expect(AusPhones.new('1800 801 920').dial_international).to eq(nil)
+  end
+
+
+  it 'format numbers for dialing local' do
+    expect(AusPhones.new('(02) 3300 0000').format_local).to eq('3300 0000')
+    expect(AusPhones.new('(0)488 000 000').format_local).to eq('0488 000 000')
+  end
+
+  it 'format numbers for dialing domestic' do
+    expect(AusPhones.new('(02) 3300 0000').format_domestic).to eq('(02) 3300 0000')
+    expect(AusPhones.new('(0)488 000 000').format_domestic).to eq('0488 000 000')
+  end
+
+  it 'format numbers for international dialing' do
+    expect(AusPhones.new('(02) 3300 0000').format_international).to eq('+61 (2) 3300 0000')
+    expect(AusPhones.new('(0)488 000 000').format_international).to eq('+61 488 000 000')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'aus_phones'
+require 'awesome_print'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: aus_phones
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- bevans157
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'AusPhones validates and identifies Australian phone numbers by region
+  and type (mobile, land-line etc) '
+email:
+- ben.s.evans@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/aus_phones.iml"
+- ".idea/codeStyleSettings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aus_phones.gemspec
+- config/phones.yml
+- lib/aus_phones.rb
+- lib/aus_phones/version.rb
+- spec/aus_phones_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/bevans157/aus_phone
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Australian phone number validator
+test_files:
+- spec/aus_phones_spec.rb
+- spec/spec_helper.rb