ziptz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb930df6f8932cd9123377c28e9f0d7e2ef3e789
+  data.tar.gz: 9d787ed2c6559b2667bc655611dce94365508512
+SHA512:
+  metadata.gz: 832a18781ef3bdef3e06ba98ad0bcd5b9c1a32a846babcaa76d04705315aadc2f3e215d6bbf0c2fad0ee3b92b04f7387c56bf094330ab1e6740cdc32aacd8013
+  data.tar.gz: 879033d897582ae100bd66d0253424b1e617306cf762d4e6dc4360af5b5770a87828e1cd1638fe19cd9634bf699d4ba3bc85409181f326295b4fe27b56169e0d

data/Gemfile

@@ -0,0 +1,10 @@
+gemspec
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'activerecord'
+  gem 'mysql2'
+  gem 'rspec'
+  gem 'guard'
+  gem 'guard-rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    ziptz (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.1)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.7.0)
+    mysql2 (0.3.18)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  guard
+  guard-rspec
+  mysql2
+  rspec
+  ziptz!

data/Gemfile.travis

@@ -0,0 +1,6 @@
+gemspec
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014-2015 Keith Morrison <keithm@infused.org>
+
+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,71 @@
+# Ziptz
+<!-- [![Version](http://img.shields.io/gem/v/ziptz.svg?style=flat)](https://rubygems.org/gems/ziptz) -->
+[![Build Status](http://img.shields.io/travis/infused/ziptz/master.svg?style=flat)](http://travis-ci.org/infused/ziptz)
+[![Issues](https://img.shields.io/github/issues/infused/ziptz.svg)](https://github.com/infused/ziptz/issues)
+[![Total Downloads](https://img.shields.io/gem/dt/ziptz.svg)](https://rubygems.org/gems/ziptz/)
+
+Get the time zone for any US ZIP code.
+
+<i>ZIP codes are up to date as of <b>June 2015</b>.</i>
+
+## Installation
+
+Add the gem to your Gemfile:
+
+    gem 'ziptz'
+
+
+## Usage
+
+Get the time zone name for any ZIP code:
+
+    z = Ziptz.new
+    z.time_zone_name('97213') #=> "Pacific"
+
+Get the time zone offset for any ZIP code:
+
+    z.time_zone_offset('97213') #=> -8
+
+<i>Please note that offsets do not include daylight savings time.<i>
+
+
+Get all the zip codes in a time zone:
+
+    z.zips('American Samoa') #=> ["96799", "96941", "96942", "96943", "96944"]
+
+
+## Supported Time Zones
+
+* "Mountain" GMT -07:00
+* "Pacific" GMT -08:00
+* "Alaska" GMT -09:00
+* "Hawaii-Aleutian Islands" GMT -10:00
+* "American Samoa" GMT -11:00
+* "Marshall Islands" GMT +12:00
+* "Guam" GMT +10:00
+* "Palau" GMT +09:00
+
+## License
+
+  Copyright (c) 2015 Keith Morrison <<keithm@infused.org>>
+
+  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/Rakefile

@@ -0,0 +1,52 @@
+require 'bundler/setup';
+Bundler.setup(:default, :development)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec do |t|
+  t.rspec_opts = %w(--color)
+end
+
+RSpec::Core::RakeTask.new :specdoc do |t|
+  t.rspec_opts = %w(-fl)
+end
+
+task :default => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r ziptz.rb"
+end
+
+desc 'Create ziptz.yml from zipcodes database'
+task :create_ziptz do
+  require 'yaml'
+  require 'active_record'
+
+  db_config = YAML::load(File.open('database.yml'))
+  ActiveRecord::Base.establish_connection(db_config)
+
+  class ZipCode < ActiveRecord::Base
+    self.table_name = 'ZIPCodes'
+    self.primary_key = 'ZipCode'
+
+    alias_attribute :zip_code, :ZipCode
+    alias_attribute :time_zone, :TimeZone
+  end
+
+  puts "Retrieving zip codes from database"
+
+  data = {}
+  ZipCode.find_each do |zip|
+    data[zip.zip_code] ||= zip.time_zone
+  end
+
+  puts "Writing ziptz.data"
+
+  lines = data.map {|k, v| "#{k}=#{v}"}
+  lines.sort!
+
+  File.open('ziptz.data', 'w') do |f|
+    lines.each {|line| f.puts line}
+  end
+
+end

data/database.yml

@@ -0,0 +1,3 @@
+adapter: mysql2
+username: root
+database: zip_codes

data/lib/ziptz/version.rb

@@ -0,0 +1,3 @@
+module ZipTZ
+  VERSION = '1.0.0'
+end

data/lib/ziptz.rb

@@ -0,0 +1,65 @@
+require 'yaml'
+
+class Ziptz
+  TZ_INFO = {
+    '4'  => {name: 'Atlantic', offset: -4},
+    '5'  => {name: 'Eastern', offset: -5},
+    '6'  => {name: 'Central', offset: -6},
+    '7'  => {name: 'Mountain', offset: -7},
+    '8'  => {name: 'Pacific', offset: -8},
+    '9'  => {name: 'Alaska', offset: -9},
+    '10' => {name: 'Hawaii-Aleutian Islands', offset: -10},
+    '11' => {name: 'American Samoa', offset: -11},
+    '13' => {name: 'Marshall Islands', offset: 12},
+    '14' => {name: 'Guam', offset: 10},
+    '15' => {name: 'Palau', offset: 9}
+  }
+
+  def initialize
+    @zips = load_data
+  end
+
+  def time_zone_name(zip)
+    hash = time_zone_hash(zip)
+    hash && hash[:name]
+  end
+
+  def time_zone_offset(zip)
+    tz = time_zone_hash(zip)
+    tz && tz[:offset]
+  end
+
+  def zips(tz_name)
+    tz_code = tz_name_to_code[tz_name.downcase]
+    tz_code && zips_by_code(tz_code)
+  end
+
+  protected
+
+  def zips_by_code(tz_code)
+    selected = @zips.select { |_, v| v == tz_code.to_s }
+    selected.keys.sort
+  end
+
+  def time_zone_hash(zip)
+    TZ_INFO[@zips[zip.to_s]]
+  end
+
+  def tz_name_to_code
+    @tz_name_to_code ||= TZ_INFO.inject({}) do |data, (code, tz)|
+      data[tz[:name].downcase] = code
+      data
+    end
+  end
+
+  def data_path
+    File.join(File.dirname(__FILE__), '..', 'ziptz.data')
+  end
+
+  def load_data
+    File.foreach(data_path).with_object({}) do |line, data|
+      zip, tz = line.split('=').map(&:strip)
+      data[zip] = tz
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'ziptz'
+require 'yaml'
+require 'rspec'
+
+Encoding.default_external = 'UTF-8' if defined?(Encoding)
+
+RSpec.configure do |config|
+
+end

data/spec/ziptz_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Ziptz do
+  describe '#time_zone_name' do
+    let(:ziptz) { Ziptz.new }
+
+    context 'when given a 5-digit zipcode' do
+      it 'returns the time zone number' do
+        expect(ziptz.time_zone_name('97034')).to eq 'Pacific'
+      end
+    end
+
+    context 'when there is no matching zipcode' do
+      it 'returns nil' do
+        expect(ziptz.time_zone_name('xyz')).to be_nil
+      end
+    end
+  end
+
+  describe '#time_zone_offset' do
+    let(:ziptz) { Ziptz.new }
+
+    context 'when given a 5-digit zipcode' do
+      it 'returns the time zone number' do
+        expect(ziptz.time_zone_offset('97034')).to eq -8
+      end
+    end
+
+    context 'when there is no matching zipcode' do
+      it 'returns nil' do
+        expect(ziptz.time_zone_offset('xyz')).to be_nil
+      end
+    end
+  end
+
+  describe '#zips' do
+    context 'when given a time zone' do
+      let(:ziptz) { Ziptz.new }
+
+      it 'returns an array of zip codes' do
+        expect(ziptz.zips('American Samoa')).to eq %w(96799 96941 96942 96943 96944)
+      end
+
+      it 'is case-insensitive' do
+        expect(ziptz.zips('american samoa')).to eq %w(96799 96941 96942 96943 96944)
+      end
+
+      it 'returns nil for unknown time zones' do
+        expect(ziptz.zips('Glark')).to be_nil
+      end
+    end
+  end
+end