phones 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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jarred Sumner
+
+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,61 @@
+# Phones
+
+Phones is a barebones phone parsing and formatting library. If the phone is number is outside of the United States, it must include the country code prefixed with a "+"
+
+It can parse phone numbers like:
+- (555) 555-5555
+- 555-555-5555
+- 555.555.5555
+- 555-555.5555
+- 19252008843
+- 1-(925)-200-8843
+- +49 69 6900
+- +49696900
+- +19252008843
+
+And any combination between those.
+
+## Installation
+
+First, install it:
+```bash
+gem install phones
+```
+
+In your Gemfile:
+```ruby
+gem 'phones', :require => 'phones'
+```
+
+## Usage
+
+It adds a ```to_phone``` method to ```String```, so you can just do:
+```ruby
+"1-(925)-200-8843".to_phone
+=> +19252008843
+```
+
+Pretty printing phone numbers:
+```ruby
+"1-(925)-200-8843".to_phone.pretty
+=> "(925) 200-8843"
+```
+
+Country code, area code, local code:
+```ruby
+phone = "1-(925)-200-8843".to_phone
+=> +19252008843
+phone.country_code
+=> "+1"
+phone.area_code
+=> "925"
+phone.local_code
+=> "2008843"
+```
+
+Note: ```area_code``` and ```local_code``` is currently only supported for US phone numbers. International phone numbers will have a ```nil``` area_code and ```local_code``` will contain the rest of the phone number. ```country_code``` should work for every country code. 
+
+It'll return nil if it couldn't detect a valid phone number.
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/phones/parser.rb

@@ -0,0 +1,80 @@
+# Supported formats (ignore initial dash): 
+# - (555) 555-5555
+# - 555-555-5555
+# - 555.555.5555
+# - 555 555 5555
+# - +1 555 555 5555
+# - +44 844 335 1801
+# - 0844 335 1801
+# - +49696900
+# - +19252008843
+# - +448443351801
+
+require 'phones/phone'
+module Phones
+	class Parser
+		IGNORABLE_CHARACTERS = /[a-zA-Z]|\-|\s|\.|\(|\)|\;|\:|\*|\&|\%|\$|\#|\@|\!/.freeze
+		def self.parse(options)
+			# Let's figure out what the phone number is
+			if options.class == Hash
+				@number = options[:phone] || options[:number]
+			elsif options.class == String
+				@number = options
+			else
+				raise ArgumentError, "Pass a hash of options including a \"number\" key, or just a phone number"
+			end
+
+			# Now, let's remove all the characters we can ignore
+			strip!
+
+			# "+19252008843" or "19252008843" or "9252008843" are all common
+			@phone = try_without_delimiters!
+
+			@phone
+		end
+
+		def self.number
+			@number
+		end
+
+		private
+
+		def self.try_without_delimiters!
+			parts = []
+			# Let's find out if there is a country code
+			country_code = "+1"
+			# It's easiest to tell when it starts with a plus, so let's start with that
+			if self.number[0] == "+"
+				# Estados Unidos!
+				if self.number[1] == '1' && self.number.length == "+19252008843".length
+					parts = [self.number[2..4], self.number[5..-1]]
+				# 3 Digit country code?
+				elsif COUNTRY_CODES.include?(self.number[1..4])
+					country_code = self.number[0..4]
+					parts 			 = [nil, self.number[5..-1]]
+				# 2 Digit country code?
+				elsif COUNTRY_CODES.include?(self.number[1..2])
+					country_code = self.number[0..2]
+					parts 			 = [nil, self.number[4..-1]]
+				else
+					# IDK, man
+					raise ArgumentError, "Can't parse phone number"
+				end
+			elsif self.number[0] == '1' && self.number.length == "19252008843".length
+				parts = [self.number[1..3], self.number[4..-1]]
+			elsif self.number.length == "9252008843".length
+				parts = [self.number[0..2], self.number[3..-1]]
+			end
+
+			Phones::Phone.new(:country_code => country_code, :area_code => parts[0], :local_code => parts[1])
+		rescue
+		end
+
+		def self.strip!
+			self.number.gsub!(IGNORABLE_CHARACTERS, '')
+		end
+
+		# Source: http://en.wikipedia.org/wiki/List_of_country_calling_codes
+		COUNTRY_CODES = %w(20 210 211 212 213 216 218 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 260 261 262 263 264 265 266 267 268 269 27 290 291 297 298 299 30 31 32 33 34 350 351 352 353 354 355 356 357 358 359 36 370 371 372 373 374 375 376 377 378 379 380 381 382 385 386 387 388 389 40 41 420 421 423 43 44 45 46 47 48 49 500 501 502 503 504 505 506 507 508 509 51 52 53 54 55 56 57 58 590 591 592 593 594 595 596 597 598 599 60 61 62 63 64 65 66 670 672 673 674 675 676 677 678 679 680 681 682 683 685 686 687 688 689 690 691 692 800 808 81 82 84 850 852 853 855 856 86 870 878 880 881 882 883 886 888 90 91 92 93 94 95 960 961 962 963 964 965 966 967 968 970 971 972 973 974 975 976 977 979 98 991 992 993 994 995 996 998).freeze
+	end
+end

data/lib/phones/phone.rb

@@ -0,0 +1,66 @@
+module Phones
+	class Phone
+		RESTRICTED_CHARACTERS = /\-|\(|\)|\.|\s|[a-zA-Z]/.freeze
+		attr_reader :country_code, :area_code, :local_code
+
+		def initialize(opts = {})
+			self.country_code = opts[:country_code]
+			self.area_code    = opts[:area_code]
+			self.local_code 	= opts[:local_code]
+		end
+
+		def country_code=(val)
+			@country_code = val
+			validate_country_code!
+		end
+
+		def area_code=(val)
+			@area_code = val
+			validate_area_code!
+		end
+
+		def local_code=(val)
+			if val.class == Array
+				@local_code = val.join("")
+			else
+				@local_code = val
+			end
+			validate_local_code!
+		end
+
+		def pretty
+			if self.united_states?
+				"(#{self.area_code}) #{self.local_code[0..2]}-#{self.local_code[3..-1]}"
+			else
+				self.to_s
+			end
+		end
+
+		def to_s
+			"#{self.country_code}#{self.area_code}#{self.local_code}"
+		end
+
+		def united_states?
+			self.country_code == "+1"
+		end
+
+		private
+
+		# We know that this isn't a phone number because certain characters don't exist in phone numbers.
+		# These validations check for that.
+
+		def validate_country_code!
+			raise ArgumentError, "Country code: #{@country_code} contains restricted characters" if self.country_code =~ RESTRICTED_CHARACTERS && self.country_code.length > 3
+		end
+
+		def validate_area_code!
+			raise ArgumentError, "Area code: #{@area_code} contains restricted characters" if self.area_code =~ RESTRICTED_CHARACTERS
+		end
+
+		def validate_local_code!
+			raise ArgumentError, "Local code: #{@local_code} contains restricted characters" if self.local_code =~ RESTRICTED_CHARACTERS
+			raise ArugmentError, "Local code cannot be blank" if self.local_code.nil? || self.local_code.length == 0
+		end
+
+	end
+end

data/lib/phones/version.rb

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

data/lib/phones.rb

@@ -0,0 +1,18 @@
+require "phones/version"
+require 'phones/parser'
+require 'phones/phone'
+
+module Phones
+end
+
+class String
+	def to_phone
+		Phones::Parser.parse(self)
+	end
+end
+
+class NilClass
+	def to_phone
+		nil
+	end
+end

data/phones.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phones/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "phones"
+  gem.version       = Phones::VERSION
+  gem.authors       = ["Jarred Sumner"]
+  gem.email         = ["jarred@jarredsumner.com"]
+  gem.description   = %q{Phones is a barebones phone parsing and formatting library}
+  gem.summary       = %q{Phones is a barebones phone parsing and formatting library}
+  gem.homepage      = ""
+
+  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"]
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: phones
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jarred Sumner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies: []
+description: Phones is a barebones phone parsing and formatting library
+email:
+- jarred@jarredsumner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/phones.rb
+- lib/phones/parser.rb
+- lib/phones/phone.rb
+- lib/phones/version.rb
+- phones.gemspec
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Phones is a barebones phone parsing and formatting library
+test_files: []