piliponi 1.0.0

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rspec
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+#vim temp files
+*.un~
+*.swp
+*.swo
+
+#rvm files
+.rvmrc
+.ruby-version
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ace Dimasuhid
+
+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,75 @@
+# Piliponi
+
+Simple mobile phone formatter for the Philippines
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'piliponi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install piliponi
+
+## Usage
+Include piliponi to your class to use its methods
+
+    class Dummy
+      include Piliponi
+    end
+
+    dummy = Dummy.new
+
+###Plausible
+Check if the number is a probable mobile number
+
+    dummy.plausible? "091700000001"   #true
+    dummy.plausible? "NotaNumber"   #false
+
+###Clean
+Removes Non-numeric characters
+
+    dummy.clean "+639-17-000-0001" #639170000001
+
+###Telco
+Returns local Telco coverage of a given number
+
+    dummy.telco "09170000001" #globe
+
+###Normalization
+Returns formatted numbers as specified
+
+####Local
+    dummy.normalize("0917-000-0000", format: :local) #09170000000
+
+####International
+    dummy.normalize("0917-000-0000", format: :international) #+639170000000
+
+####Pure
+    dummy.normalize("0917-000-0000", format: :pure) #9170000000
+
+####Erroneous Numbers
+    dummy.normalize("wat", format: :pure) #Piliponi::InvalidPhoneNumberException
+
+####Wrong format
+    dummy.normalize("0917-000-0000", format: :none) #Piliponi::FormatNotRecognizedException
+
+##Needs
+
+Accepting Integers
+<br>
+Thorough testing
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add Rspec Tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/piliponi.rb

@@ -0,0 +1,58 @@
+require "piliponi/version"
+require "piliponi/piliponi_api"
+
+module Piliponi
+  class ::FormatNotRecognizedException < Exception; end;
+  class ::InvalidPhoneNumberException < Exception; end;
+
+  def plausible? number
+    clean_num = clean(number)
+    size = clean_num.size
+
+    (clean_num[0] == "9" && size == 10) ||
+    (clean_num[0..1] == "63" && size == 12) ||
+    (clean_num[0..1] == "09" && size == 11)
+  end
+
+  def normalize(number, options={})
+    formats = [:pure, :local, :international]
+    format = options[:format].intern
+
+    raise FormatNotRecognizedException unless formats.include?(format)
+
+    return send "_nf_#{format}", clean(number) if plausible?(number)
+    raise InvalidPhoneNumberException
+  end
+
+  def clean(number=nil)
+    number.tr('^0-9','') if number
+  end
+
+  def telco? number=nil
+    PiliponiApi.new.lookup prefix(clean number)
+  end
+
+  def prefix number=nil
+    hash = { '0' => [0,3], '6' => [2,4], '9' => [0,2] }
+    start, finish = hash[number[0]].first, hash[number[0]].last
+    clean_prefix(number[start..finish])
+  end
+
+  def clean_prefix(number)
+    number = "0#{number}" if number[0] != '0'; number
+  end
+
+  private
+
+    def _nf_pure(number)
+      number[-10..-1]
+    end
+
+    def _nf_local(number)
+      '0' << _nf_pure(number)
+    end
+
+    def _nf_international(number)
+      '+63' << _nf_pure(number)
+    end
+end

data/lib/piliponi/piliponi_api.rb

@@ -0,0 +1,21 @@
+module Piliponi
+  class PiliponiApi
+    def lookup(prefix)
+      smart = %w{0813 0918 0947 0998 0999 0907 0908 0909 0910 0912 0919 0921
+      0928 0929 0949 0989 0920 0930 0938 0939 0946}
+      globe = %w{0817 0917 0994 0905 0915 0916 0926 0927 0935 0936 0937 0996 0997}
+      sun = %w{0922 0923 0925 0932 0933 0934 0942 0943}
+
+      if smart.include? prefix
+        "smart"
+      elsif globe.include? prefix
+        "globe"
+      elsif sun.include? prefix
+        "sun"
+      else
+        "unknown"
+      end
+    end
+
+  end
+end

data/lib/piliponi/version.rb

@@ -0,0 +1,3 @@
+module Piliponi
+  VERSION = "1.0.0"
+end

data/piliponi.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'piliponi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "piliponi"
+  spec.version       = Piliponi::VERSION
+  spec.authors       = ["Ace Dimasuhid"]
+  spec.email         = ["ace.dimasuhid@gmail.com"]
+  spec.description   = %q{Philippine Mobile Phone Formatter}
+  spec.summary       = %q{Mobile Phone Number Formatter for the Philippines}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/piliponi_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+class Dummy
+  include Piliponi
+end
+
+describe Piliponi do
+  let!(:dummy) { Dummy.new }
+
+  context "#plausible?" do
+    it "works" do
+      lambda do
+        dummy.plausible?("whatevs")
+      end.should_not raise_error
+    end
+
+    it "returns true given 9170000001" do
+      dummy.plausible?("9170000001").should eq(true)
+    end
+
+    it "returns true given 639170000001" do
+      dummy.plausible?("639170000001").should eq(true)
+    end
+
+    it "returns true given +639170000001" do
+      dummy.plausible?("+639170000001").should eq(true)
+    end
+
+    it "returns false given a non-numerical string" do
+      dummy.plausible?("wawa").should eq(false)
+    end
+
+  end
+
+  context "#clean" do
+    it "removes characters" do
+      dummy.clean("+639170000001").should eq("639170000001")
+    end
+
+    it "returns nil if no number is placed" do
+      dummy.clean.should be_nil
+    end
+  end
+
+  context "#normalize" do
+    let(:number) { '(0919) 363-2598' }
+
+    it "formats to 09XXXXXXXX" do
+      dummy.normalize(number, {format: 'local'}).should eq('09193632598')
+    end
+
+    it "formats to +639XXXXXXX" do
+      dummy.normalize(number, {format: 'international'}).should eq('+639193632598')
+    end
+
+    it "formats to 9XXXXXXX" do
+      dummy.normalize(number, {format: 'pure'}).should eq('9193632598')
+    end
+
+    context "when the format passed is not recognized" do
+      it "raises FormatNotRecognizedException" do
+        expect{
+          dummy.normalize(number, format: :foo)
+        }.to raise_error(FormatNotRecognizedException)
+      end
+    end
+
+    context "when the number is not valid" do
+      it "raises InvalidPhoneNumberException" do
+        expect{
+          dummy.normalize("notanumber", format: :local)
+        }.to raise_error(InvalidPhoneNumberException)
+      end
+    end
+  end
+
+  context "#telco?" do
+    it "returns smart for 09XX" do
+      dummy.telco?('09201234567').should eq('smart')
+    end
+
+    it "returns globe for 09XX" do
+      dummy.telco?("09170000000").should eq("globe")
+    end
+  end
+
+  context '#prefix' do
+    describe '09171231234' do
+      it 'returns 0917' do
+        expect(dummy.prefix('09171231234')).to eq '0917'
+        expect(dummy.prefix('639171231234')).to eq '0917'
+        expect(dummy.prefix('9171231234')).to eq '0917'
+      end
+    end
+  end
+
+  context '#clean_prefix' do
+    describe '0917' do
+      it 'retunrs 0917' do
+        expect(dummy.prefix('0917')).to eq '0917'
+        expect(dummy.prefix('63917')).to eq '0917'
+        expect(dummy.prefix('917')).to eq '0917'
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'piliponi'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: piliponi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ace Dimasuhid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: Philippine Mobile Phone Formatter
+email:
+- ace.dimasuhid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/piliponi.rb
+- lib/piliponi/piliponi_api.rb
+- lib/piliponi/version.rb
+- piliponi.gemspec
+- spec/piliponi_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Mobile Phone Number Formatter for the Philippines
+test_files:
+- spec/piliponi_spec.rb
+- spec/spec_helper.rb