zip_to_timezone 0.0.2 → 0.0.3

data/README.rdoc

@@ -2,6 +2,34 @@
 
 This gem is designed to map US postal codes to the timezone.  The timezone strings are based on ActiveSupport::TimeZone settings that include basic DST information.  If used with Rails these timezones will handle DST changes on their own.
 
+== Installation
+
+ gem install zip_to_timezone
+
+This gem is hosted on gemcutter so you may need to add it as a source:
+
+ gem install gemcutter
+ gem tumble
+
+== Usage
+
+This is super simple to use:
+
+ ZipToTimezone.get_timezone_for('91304') # => "Pacific Time (US & Canada)"
+
+== How it works
+
+This uses Trei longest prefix matching to speed up the searching.  This means that all zip codes that start with 90 will be in California and therefore are in Pacific Time.  If I need to match on full zip codes in some states to differentiate timezones I can do that (eg: Kansas or Indiana) by just adding more specific entires.
+
+== Note on accuracy
+
+This gem combines two things that kind of suck to make them suck less.  To do this though I had to make a lot of guesses.  Please let me know if there are bad mappings so I can fix them.  My data is imperfect and in some places outright wrong.  The goal of the project was to handle the 95% case and hopefully grow it to be more accurate over time.
+
+== References
+
+* http://www.worldtimezone.com/time-usa12.php
+* http://en.wikipedia.org/wiki/ZIP_code_prefixes
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/zip_to_timezone.rb

@@ -1,9 +1,4 @@
-begin
-  require 'algorithms'
-rescue LoadError
-  require 'rubygems'
-  require 'algorithms'
-end
+require 'algorithms'
 
 class ZipToTimezone
   MAPPINGS = {

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'zip_to_timezone'
 require 'spec'
 require 'spec/autorun'
 
 Spec::Runner.configure do |config|
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zip_to_timezone
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ryan Garver