e164 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,84 @@
+E164
+====
+
+E164 is a standard for formatting and routing international phone numbers. The goal of this gem is to make working with these numbers simpler. The E164 standard is composed of the following parts:
+
+* International Access Code (IAC)
+* Country Code (CC)
+* National Destination Code (NDC)
+* Subscriber Number (SN)
+
+Right now the gem has the ability to parse out these 4 fields and normalize them to a standard format. It also contains country information scraped from wikipedia. Information has been scraped for the North American Numbering Plan (NANP), Austria and Germany as well. Right now this is just basic information and I hope to expand it in the future.
+
+Warning!
+--------
+
+This gem is both incomplete and very US/NANP centric. So check the results before using in production. If you have information on formatting or route data either fork and add it or contact me. The biggest challenge is going to be keeping data used for parsing up to date.
+
+Installation
+------------
+
+E164 is hosted on GemCutter, so simply run the following:
+
+    gem sources -a http://gemcutter.org
+    sudo gem install inherited_resources
+    
+Use It!
+-------
+
+E164 contains two main methods on the E164 module. The *parse* method takes a phone number as a string and returns an array containing CC,NDC and SN. If no IAC is found a default country is presumed. Right now the IAC's looked for are ['+','011'] and the default CC is 1 (NANP). Options to override the defaults will be coming soon.
+
+    E164.parse('3035559850') #=> ['1','303','5559850']
+    E164.parse('13035559850') #=> ['1','303','5559850']
+    E164.parse('+203035559850') #=> ['20','30','35559850']
+    E164.parse('011203035559850') #=> ['20','30','35559850']
+    
+The *normalize* method also takes a number as a string but returns it in the standard format. All it is really doing is parsing it and then joining the pieces.
+
+    E164.normalize('3035559850') #=> '+13035559850'
+    E164.normalize('13035559850') #=> '+13035559850'
+    E164.normalize('+203035559850') #=> '+203035559850'
+    E164.normalize('011203035559850') #=> '+203035559850'
+    
+Country info is stored in a hash of hashes with the CC being the key.
+
+    E164::CountryCodes['1'] #=> {:national_destination_codes => 3, :abbreviation => 'NANP', :description => 'North American Numbering Plan', :info => 'en.wikipedia.com.org/wiki/NANP'}
+    
+NDC information is available for:
+
+* NANP
+* Austria
+* Germany
+
+Just like the CountryCodes, NDC info is stored in a hash of hashes and accessed through a constant. Some NDCs will have more information than others.
+
+    E164::NANP('303') #=> {:abbreviation => 'Colorado', :description => '[Colorado] (Boulder, Longmont, Aurora, Denver and central Colorado, overlays with [720])', :info => 'en.wikipedia.com.org/wiki/Area_codes_303_and_720'}
+    
+    E164::Austria['1'] => {:description => 'Wient'}
+    
+    E164::Germany['10'] => {:description => 'Call-By-Call'}
+
+ToDo
+----
+
+* Country specific formatting
+* Add overrides for default options
+* Add data for more areas
+* Link to additional info for countries (currency, timezone, etc.)
+
+Note on Patches/Pull Requests
+-----------------------------
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2009 hexorx. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/e164.gemspec

@@ -5,24 +5,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{e164}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hexorx"]
-  s.date = %q{2009-12-15}
+  s.date = %q{2009-12-16}
   s.description = %q{The e164 gem can parse and normalize numbers into the e164 format.
       It provides extra information on the Country Code and National Destination Codes.
       It can be used standalone or mixed into a model.}
   s.email = %q{hexorx@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "e164.gemspec",

data/lib/e164/country_codes.rb

@@ -1,7 +1,7 @@
 Dir.glob(File.join(File.dirname(__FILE__), 'national_destination_codes/*.rb')).each {|f| require f }
 
 CountryCodes = {
-  '1' => {:national_destination_codes => NANP, :abbreviation => 'NANP', :description => 'USA/NANP', :info => 'en.wikipedia.com.org/wiki/NANP'},
+  '1' => {:national_destination_codes => 3, :abbreviation => 'NANP', :description => 'North American Numbering Plan', :info => 'en.wikipedia.com.org/wiki/NANP'},
   '7' => {:national_destination_codes => 3, :abbreviation => '', :description => 'Russia', :info => 'en.wikipedia.com.org/wiki/Russia'},
   
   '20' => {:national_destination_codes => 2, :abbreviation => '', :description => 'Egypt', :info => 'en.wikipedia.com.org/wiki/Egypt'},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: e164
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - hexorx
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 -07:00
+date: 2009-12-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,12 +43,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - e164.gemspec

data/README.rdoc

@@ -1,18 +0,0 @@
-= e164
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 hexorx. See LICENSE for details.