cogi_phony 0.0.2

data/lib/data/mobile_networks.yaml

@@ -0,0 +1,16 @@
+#
+# List of mobile networks in Vietnam.
+#
+# Reference from:
+#   - http://netviettel.com/dau-so-dien-thoai-co-dinh-di-dong-cua-viettel/
+#   - http://www.3gvinaphone.pro.vn/2016/03/cac-dau-so-cua-vinaphone.html
+#   - http://3gmobifone.vn/cac-dau-so-mang-mobifone.html
+#   - http://www.simphongthuy.com.vn/tin-tuc-moi-Danh-sach-cac-dau-so-nha-mang-Gmobile-cid459.html
+
+---
+vi:
+  viettel: '96|97|98|162|163|164|165|166|167|168|169'
+  vinaphone: '88|91|94|123|124|125|127|129'
+  mobifone: '89|90|93|121|122|124|126|128'
+  vietnamobile: '92|186|188'
+  gmobile: '99|199'

data/spec/cogi_phony_spec.rb

@@ -0,0 +1,535 @@
+require 'spec_helper'
+
+describe CogiPhony do
+  subject { CogiPhony.new }
+
+  describe '#hi' do
+    it 'return nil' do
+      expect(CogiPhony.hi).to eq(nil)
+    end
+  end
+
+  describe '#country_codes_hash' do
+    let(:country_codes) { CogiPhony.country_codes_hash }
+
+    it 'return a hash' do
+      expect(country_codes).to be_a(Hash)
+    end
+
+    it 'has countries key' do
+      expect(country_codes['countries']).not_to be_nil
+    end
+
+    it 'return country code 84' do
+      expect(country_codes['countries']['VN']['country_code']).to eq('84')
+    end
+
+    it 'return country name Vietnam' do
+      expect(country_codes['countries']['VN']['name']).to eq('Viet Nam')
+    end
+
+    it 'return nil if invalid iso code' do
+      expect(country_codes['countries']['ZZ']).to be_nil
+    end
+  end
+
+  describe '#mobile_networks' do
+    let(:mobile_networks) { CogiPhony.mobile_networks_hash }
+
+    it 'return a hash' do
+      expect(mobile_networks).to be_a(Hash)
+    end
+
+    it 'return Viettel network' do
+      expect(mobile_networks['vi']['viettel']).to be_a(String)
+    end
+  end
+
+  describe '#gmobile?' do
+    context 'mobile phone begin with 99' do
+      it 'length equal 10 is valid' do
+        expect(CogiPhony.gmobile?('0994567890')).not_to be_nil
+        expect(CogiPhony.gmobile?('84994567890')).not_to be_nil
+        expect(CogiPhony.gmobile?('+84994567890')).not_to be_nil
+      end
+
+      it 'length less than 10 is invalid' do
+        expect(CogiPhony.gmobile?('099456789')).to be_nil
+        expect(CogiPhony.gmobile?('8499456789')).to be_nil
+        expect(CogiPhony.gmobile?('+8499456789')).to be_nil
+      end
+
+      it 'length more than 10 is invalid' do
+        expect(CogiPhony.gmobile?('09945678901')).to be_nil
+        expect(CogiPhony.gmobile?('849945678901')).to be_nil
+        expect(CogiPhony.gmobile?('+849945678901')).to be_nil
+      end
+    end
+
+    context 'mobile phone begin with 199' do
+      it 'length equal 11 is valid' do
+        expect(CogiPhony.gmobile?('01994567890')).not_to be_nil
+        expect(CogiPhony.gmobile?('841994567890')).not_to be_nil
+        expect(CogiPhony.gmobile?('+841994567890')).not_to be_nil
+      end
+
+      it 'length less than 11 is invalid' do
+        expect(CogiPhony.gmobile?('0199456789')).to be_nil
+        expect(CogiPhony.gmobile?('84199456789')).to be_nil
+        expect(CogiPhony.gmobile?('+84199456789')).to be_nil
+      end
+
+      it 'length more than 11 is invalid' do
+        expect(CogiPhony.gmobile?('019945678901')).to be_nil
+        expect(CogiPhony.gmobile?('8419945678901')).to be_nil
+        expect(CogiPhony.gmobile?('+8419945678901')).to be_nil
+      end
+    end
+  end
+
+  describe '#vietnamobile?' do
+    context 'mobile phone begin with 92' do
+      it 'length equal 10 is valid' do
+        expect(CogiPhony.vietnamobile?('0924567890')).not_to be_nil
+        expect(CogiPhony.vietnamobile?('84924567890')).not_to be_nil
+        expect(CogiPhony.vietnamobile?('+84924567890')).not_to be_nil
+      end
+
+      it 'length less than 10 is invalid' do
+        expect(CogiPhony.vietnamobile?('092456789')).to be_nil
+        expect(CogiPhony.vietnamobile?('8492456789')).to be_nil
+        expect(CogiPhony.vietnamobile?('+8492456789')).to be_nil
+      end
+
+      it 'length more than 10 is invalid' do
+        expect(CogiPhony.vietnamobile?('09245678901')).to be_nil
+        expect(CogiPhony.vietnamobile?('849245678901')).to be_nil
+        expect(CogiPhony.vietnamobile?('+849245678901')).to be_nil
+      end
+    end
+
+    context 'mobile phone begin with 186' do
+      it 'length equal 11 is valid' do
+        expect(CogiPhony.vietnamobile?('01864567890')).not_to be_nil
+        expect(CogiPhony.vietnamobile?('841864567890')).not_to be_nil
+        expect(CogiPhony.vietnamobile?('+841864567890')).not_to be_nil
+      end
+
+      it 'length less than 11 is invalid' do
+        expect(CogiPhony.vietnamobile?('0186456789')).to be_nil
+        expect(CogiPhony.vietnamobile?('84186456789')).to be_nil
+        expect(CogiPhony.vietnamobile?('+84186456789')).to be_nil
+      end
+
+      it 'length more than 11 is invalid' do
+        expect(CogiPhony.vietnamobile?('018645678901')).to be_nil
+        expect(CogiPhony.vietnamobile?('8418645678901')).to be_nil
+        expect(CogiPhony.vietnamobile?('+8418645678901')).to be_nil
+      end
+    end
+
+    context 'mobile phone begin with 188' do
+      it 'length equal 11 is valid' do
+        expect(CogiPhony.vietnamobile?('01884567890')).not_to be_nil
+        expect(CogiPhony.vietnamobile?('841884567890')).not_to be_nil
+        expect(CogiPhony.vietnamobile?('+841884567890')).not_to be_nil
+      end
+
+      it 'length less than 11 is invalid' do
+        expect(CogiPhony.vietnamobile?('0188456789')).to be_nil
+        expect(CogiPhony.vietnamobile?('84188456789')).to be_nil
+        expect(CogiPhony.vietnamobile?('+84188456789')).to be_nil
+      end
+
+      it 'length more than 11 is invalid' do
+        expect(CogiPhony.vietnamobile?('018845678901')).to be_nil
+        expect(CogiPhony.vietnamobile?('8418845678901')).to be_nil
+        expect(CogiPhony.vietnamobile?('+8418845678901')).to be_nil
+      end
+    end
+  end
+
+  describe '#mobifone?' do
+    context 'mobile phone begin with 90' do
+      it 'length equal 10 is valid' do
+        expect(CogiPhony.mobifone?('0904567890')).not_to be_nil
+        expect(CogiPhony.mobifone?('84904567890')).not_to be_nil
+        expect(CogiPhony.mobifone?('+84904567890')).not_to be_nil
+      end
+
+      it 'length less than 10 is invalid' do
+        expect(CogiPhony.mobifone?('090456789')).to be_nil
+        expect(CogiPhony.mobifone?('8490456789')).to be_nil
+        expect(CogiPhony.mobifone?('+8490456789')).to be_nil
+      end
+
+      it 'length more than 10 is invalid' do
+        expect(CogiPhony.mobifone?('09045678901')).to be_nil
+        expect(CogiPhony.mobifone?('849045678901')).to be_nil
+        expect(CogiPhony.mobifone?('+849045678901')).to be_nil
+      end
+    end
+
+    context 'mobile phone begin with 121' do
+      it 'length equal 11 is valid' do
+        expect(CogiPhony.mobifone?('01214567890')).not_to be_nil
+        expect(CogiPhony.mobifone?('841214567890')).not_to be_nil
+        expect(CogiPhony.mobifone?('+841214567890')).not_to be_nil
+      end
+
+      it 'length less than 11 is invalid' do
+        expect(CogiPhony.mobifone?('0121456789')).to be_nil
+        expect(CogiPhony.mobifone?('84121456789')).to be_nil
+        expect(CogiPhony.mobifone?('+84121456789')).to be_nil
+      end
+
+      it 'length more than 11 is invalid' do
+        expect(CogiPhony.mobifone?('012145678901')).to be_nil
+        expect(CogiPhony.mobifone?('8412145678901')).to be_nil
+        expect(CogiPhony.mobifone?('+8412145678901')).to be_nil
+      end
+    end
+  end
+
+  describe '#vinaphone?' do
+    context 'mobile phone begin with 91' do
+      it 'length equal 10 is valid' do
+        expect(CogiPhony.vinaphone?('0914567890')).not_to be_nil
+        expect(CogiPhony.vinaphone?('84914567890')).not_to be_nil
+        expect(CogiPhony.vinaphone?('+84914567890')).not_to be_nil
+      end
+
+      it 'length less than 10 is invalid' do
+        expect(CogiPhony.vinaphone?('091456789')).to be_nil
+        expect(CogiPhony.vinaphone?('8491456789')).to be_nil
+        expect(CogiPhony.vinaphone?('+8491456789')).to be_nil
+      end
+
+      it 'length more than 10 is invalid' do
+        expect(CogiPhony.vinaphone?('09145678901')).to be_nil
+        expect(CogiPhony.vinaphone?('849145678901')).to be_nil
+        expect(CogiPhony.vinaphone?('+849145678901')).to be_nil
+      end
+    end
+
+    context 'mobile phone begin with 123' do
+      it 'length equal 11 is valid' do
+        expect(CogiPhony.vinaphone?('01234567890')).not_to be_nil
+        expect(CogiPhony.vinaphone?('841234567890')).not_to be_nil
+        expect(CogiPhony.vinaphone?('+841234567890')).not_to be_nil
+      end
+
+      it 'length less than 11 is invalid' do
+        expect(CogiPhony.vinaphone?('0123456789')).to be_nil
+        expect(CogiPhony.vinaphone?('84123456789')).to be_nil
+        expect(CogiPhony.vinaphone?('+84123456789')).to be_nil
+      end
+
+      it 'length more than 11 is invalid' do
+        expect(CogiPhony.vinaphone?('012345678901')).to be_nil
+        expect(CogiPhony.vinaphone?('8412345678901')).to be_nil
+        expect(CogiPhony.vinaphone?('+8412345678901')).to be_nil
+      end
+    end
+  end
+
+  describe '#viettel?' do
+    context 'mobile phone begin with 98' do
+      it 'length equal 10 is valid' do
+        expect(CogiPhony.viettel?('0984567890')).not_to be_nil
+        expect(CogiPhony.viettel?('84984567890')).not_to be_nil
+        expect(CogiPhony.viettel?('+84984567890')).not_to be_nil
+      end
+
+      it 'length less than 10 is invalid' do
+        expect(CogiPhony.viettel?('098456789')).to be_nil
+        expect(CogiPhony.viettel?('8498456789')).to be_nil
+        expect(CogiPhony.viettel?('+8498456789')).to be_nil
+      end
+
+      it 'length more than 10 is invalid' do
+        expect(CogiPhony.viettel?('09845678901')).to be_nil
+        expect(CogiPhony.viettel?('849845678901')).to be_nil
+        expect(CogiPhony.viettel?('+849845678901')).to be_nil
+      end
+    end
+
+    context 'mobile phone begin with 168' do
+      it 'length equal 11 is valid' do
+        expect(CogiPhony.viettel?('01684567890')).not_to be_nil
+        expect(CogiPhony.viettel?('841684567890')).not_to be_nil
+        expect(CogiPhony.viettel?('+841684567890')).not_to be_nil
+      end
+
+      it 'length less than 11 is invalid' do
+        expect(CogiPhony.viettel?('0168456789')).to be_nil
+        expect(CogiPhony.viettel?('84168456789')).to be_nil
+        expect(CogiPhony.viettel?('+84168456789')).to be_nil
+      end
+
+      it 'length more than 11 is invalid' do
+        expect(CogiPhony.viettel?('016845678901')).to be_nil
+        expect(CogiPhony.viettel?('8416845678901')).to be_nil
+        expect(CogiPhony.viettel?('+8416845678901')).to be_nil
+      end
+    end
+  end
+
+  describe '#phone_to_provider' do
+    it 'return Viettel' do
+      expect(CogiPhony.phone_to_provider('0988091097')).to eq('Viettel')
+      expect(CogiPhony.phone_to_provider('84988091097')).to eq('Viettel')
+      expect(CogiPhony.phone_to_provider('+84988091097')).to eq('Viettel')
+    end
+
+    it 'return Mobifone' do
+      expect(CogiPhony.phone_to_provider('0938091097')).to eq('Mobifone')
+      expect(CogiPhony.phone_to_provider('84938091097')).to eq('Mobifone')
+      expect(CogiPhony.phone_to_provider('+84938091097')).to eq('Mobifone')
+    end
+
+    it 'return Vinaphone' do
+      expect(CogiPhony.phone_to_provider('0918091097')).to eq('Vinaphone')
+      expect(CogiPhony.phone_to_provider('84918091097')).to eq('Vinaphone')
+      expect(CogiPhony.phone_to_provider('+84918091097')).to eq('Vinaphone')
+    end
+
+    it 'return Vietnamobile' do
+      expect(CogiPhony.phone_to_provider('0928091097')).to eq('Vietnamobile')
+      expect(CogiPhony.phone_to_provider('84928091097')).to eq('Vietnamobile')
+      expect(CogiPhony.phone_to_provider('+84928091097')).to eq('Vietnamobile')
+    end
+
+    it 'return Gmobile (Beeline)' do
+      expect(CogiPhony.phone_to_provider('0998091097')).to eq('Gmobile (Beeline)')
+      expect(CogiPhony.phone_to_provider('84998091097')).to eq('Gmobile (Beeline)')
+      expect(CogiPhony.phone_to_provider('+84998091097')).to eq('Gmobile (Beeline)')
+    end
+
+    it 'return Others' do
+      expect(CogiPhony.phone_to_provider('0837621351')).to eq('Others')
+      expect(CogiPhony.phone_to_provider('0643676907')).to eq('Others')
+      expect(CogiPhony.phone_to_provider('+14037089189')).to eq('Others')
+    end
+  end
+
+  describe '#vn_mobile_phone?' do
+    context 'Mobile phone in Vietnam' do
+      it 'begin with 88 and length is 10 return true' do
+        expect(CogiPhony.vn_mobile_phone?('0883081090')).to eq(true)
+        expect(CogiPhony.vn_mobile_phone?('84883081090')).to eq(true)
+        expect(CogiPhony.vn_mobile_phone?('+84883081090')).to eq(true)
+      end
+
+      it 'begin with 8 but is not mobile phone' do
+        expect(CogiPhony.vn_mobile_phone?('84837621350')).to eq(false)
+      end
+
+      it 'begin with 9 and length is 10 return true' do
+        expect(CogiPhony.vn_mobile_phone?('0933081090')).to eq(true)
+        expect(CogiPhony.vn_mobile_phone?('84933081090')).to eq(true)
+        expect(CogiPhony.vn_mobile_phone?('+84933081090')).to eq(true)
+      end
+
+      it 'begin with 1 and length is 11 return true' do
+        expect(CogiPhony.vn_mobile_phone?('01214468866')).to eq(true)
+        expect(CogiPhony.vn_mobile_phone?('841214468866')).to eq(true)
+        expect(CogiPhony.vn_mobile_phone?('+841214468866')).to eq(true)
+      end
+
+      it 'does not a valid mobile phone format' do
+        expect(CogiPhony.vn_mobile_phone?('09330810900')).to eq(false)
+        expect(CogiPhony.vn_mobile_phone?('012144688666')).to eq(false)
+        expect(CogiPhony.vn_mobile_phone?('0933081090a')).to eq(false)
+        expect(CogiPhony.vn_mobile_phone?('093308109-0')).to eq(false)
+        expect(CogiPhony.vn_mobile_phone?('+14037089189')).to eq(false)
+      end
+    end
+
+    context 'Land line in Vietnam' do
+      it 'return false' do
+        expect(CogiPhony.vn_mobile_phone?('0643893907')).to eq(false)
+      end
+    end
+
+    context 'Foreign mobile phone' do
+      it 'return false' do
+        expect(CogiPhony.vn_mobile_phone?('+14037089189')).to eq(false)
+      end
+    end
+  end
+
+  describe '#global_format' do
+    context 'with country code' do
+      it 'format vietnam mobile phone number without plus sign' do
+        expect(CogiPhony.global_format('84933081090')).to eq('+84 93 3081090')
+      end
+
+      it 'format vietnam phone number without plus sign' do
+        expect(CogiPhony.global_format('84837621350')).to eq('+84 8 3762 1350')
+      end
+
+      it 'format international mobile phone number without plus sign' do
+        expect(CogiPhony.global_format('14037089189')).to eq('+1 (403) 708-9189')
+      end
+
+      it 'format vietnam mobile phone number with plus sign' do
+        expect(CogiPhony.global_format('+84933081090')).to eq('+84933081090')
+      end
+    end
+
+    context 'without country code' do
+      it 'return raw phone number' do
+        expect(CogiPhony.global_format('0933081090')).to eq('0933081090')
+      end
+    end
+  end
+
+  describe '#national_format' do
+    it 'format mobile phone number' do
+      expect(CogiPhony.national_format('84933081090')).to eq('093 3081090')
+    end
+
+    it 'format phone number' do
+      expect(CogiPhony.national_format('84837621350')).to eq('08 3762 1350')
+    end
+  end
+
+  describe '#format' do
+    context 'global format' do
+      it 'format vietnam mobile phone number without specify format' do
+        expect(CogiPhony.format('84933081090')).to eq('+84 93 3081090')
+      end
+
+      it 'format vietnam mobile phone number' do
+        expect(CogiPhony.format('84933081090', format: 'global')).to eq('+84 93 3081090')
+      end
+
+      it 'format vietnam phone number' do
+        expect(CogiPhony.format('84837621350', format: 'global')).to eq('+84 8 3762 1350')
+      end
+    end
+
+    context 'vietnam format' do
+      it 'format vietnam mobile phone number' do
+        expect(CogiPhony.format('84933081090', format: 'vietnam')).to eq('093 3081090')
+      end
+
+      it 'format vietnam phone number' do
+        expect(CogiPhony.format('84837621350', format: 'vietnam')).to eq('08 3762 1350')
+      end
+    end
+  end
+
+  describe '#country_code_from_number' do
+    it 'return country code' do
+      expect(CogiPhony.country_code_from_number('+84933081090')).to eq('84')
+      expect(CogiPhony.country_code_from_number('84933081090')).to eq('84')
+    end
+
+    it 'return nil' do
+      expect(CogiPhony.country_code_from_number('0933081090')).to be_nil
+    end
+  end
+
+  describe '#normalize' do
+    context 'Phone with country code' do
+      it 'remove all non-digit characters' do
+        expect(CogiPhony.normalize('+84 933081090 ')).to eq('+84933081090')
+        expect(CogiPhony.normalize('(+84)933081090 ')).to eq('+84933081090')
+        expect(CogiPhony.normalize('+8493-308-1090')).to eq('+84933081090')
+        expect(CogiPhony.normalize('+1 (403) 708-9189')).to eq('+14037089189')
+      end
+
+      it 'add plus sign before' do
+        expect(CogiPhony.normalize('84933081090 ')).to eq('+84933081090')
+      end
+    end
+
+    context 'Phone without country code' do
+      context 'vietnam format' do
+        it 'replace 0 with 84' do
+          expect(CogiPhony.normalize('0933081090', format: 'vietnam')).to eq('+84933081090')
+          expect(CogiPhony.normalize('0837621351', format: 'vietnam')).to eq('+84837621351')
+        end
+
+        it 'insert 84 before mobile phone number' do
+          expect(CogiPhony.normalize('933081090', format: 'vietnam')).to eq('+84933081090')
+          expect(CogiPhony.normalize('988091097', format: 'vietnam')).to eq('+84988091097')
+          expect(CogiPhony.normalize('1214468866', format: 'vietnam')).to eq('+841214468866')
+        end
+      end
+
+      context 'global format' do
+        context 'with default country code' do
+          it 'add country code before phone number' do
+            expect(CogiPhony.normalize('0933081090', default_country_code: '84')).to eq('+84933081090')
+            expect(CogiPhony.normalize('933081090', default_country_code: '84')).to eq('+84933081090')
+            expect(CogiPhony.normalize('093-308-1090', default_country_code: '84')).to eq('+84933081090')
+            expect(CogiPhony.normalize('(403) 708-9189', default_country_code: '1')).to eq('+14037089189')
+          end
+
+          it 'raise error if default country code is not valid' do
+            # expect(CogiPhony.normalize('0933081090', default_country_code: '111111')).to raise_error(CogiPhony::NormalizationError)
+            # expect(CogiPhony.normalize('0933081090', default_country_code: 'abcd')).to raise_error(CogiPhony::NormalizationError)
+          end
+        end
+
+        context 'without default country code' do
+          it 'raise error' do
+            # expect(CogiPhony.normalize('0933081090', format: 'global')).to raise_error(CogiPhony::NormalizationError)
+            # expect(CogiPhony.normalize('0933081090')).to raise_error(CogiPhony::NormalizationError)
+            # expect(CogiPhony.normalize('37621351', format: 'global')).to raise_error(CogiPhony::NormalizationError)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#validate?' do
+    context 'Phone with country code' do
+      it 'vietnam mobile phone with plus sign' do
+        expect(CogiPhony.validate?('+84933081090')).to be_truthy
+      end
+
+      it 'vietnam mobile phone without plus sign' do
+        expect(CogiPhony.validate?('84933081090')).to be_truthy
+      end
+
+      it 'vietnam phone with plus sign' do
+        expect(CogiPhony.validate?('+84837621350')).to be_truthy
+      end
+
+      it 'other country mobile phone with plus sign' do
+        expect(CogiPhony.validate?('+14037089189')).to be_truthy
+      end
+
+      it 'other country mobile phone without plus sign' do
+        expect(CogiPhony.validate?('14037089189')).to be_truthy
+      end
+
+      it 'phone formatted in international format' do
+        expect(CogiPhony.validate?('+1 (403) 708-9189')).to be_truthy
+        expect(CogiPhony.validate?('(408) 974-2042')).to be_truthy
+      end
+
+      it 'phone formatted in national format' do
+        expect(CogiPhony.validate?('093 3081090')).to be_truthy
+      end
+    end
+
+    context 'Phone without country code' do
+      it 'vietnam mobile phone' do
+        expect(CogiPhony.validate?('0933081090')).to be_truthy
+      end
+
+      it 'vietnam phone' do
+        expect(CogiPhony.validate?('0837621350')).to be_truthy
+      end
+
+      it 'vietnam phone without region code' do
+        expect(CogiPhony.validate?('37621350')).to be_truthy
+      end
+    end
+  end
+end