tz_magic 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,75 @@
+= TzMagic
+
+= Description
+
+While every sysadmin worth his or her salt runs their server in the UTC timezone, it is occasionally useful, even necessary, to know the timezone that the end user's browser is set to.  Surprisingly, there isn't an easy way to do this - you'd think that the browser might supply that in a header, but no... getting it is an exercise in plumbing together raw pieces of the internet.  This gem gives that to your average rails app with a minimum of fuss.
+
+
+= How to use it
+
+Its a rails engine.  You install it via a gem, then include various bits.
+
+== add this to your Gemfile with:
+
+<tt>
+gem 'tz-magic'
+</tt>
+
+== then wire it up in your rails app:
+
+add this line to your config/routes.rb file:
+
+<tt>
+mount TzMagic::Engine => "/tz_magic"
+</tt>
+
+add this line to your helpers/application_helper.rb file:
+
+<tt>
+include TzMagic::ApplicationHelper
+</tt>
+
+add this line to your app/assets/javascripts/application.js file:
+
+<tt>
+require tz_magic/application
+</tt>
+
+add this line to the controller that you need to ensure the timezone exists for (application_controller.rb is an acceptable, if brute-force option):
+
+<tt>
+include TzMagic::BeforeFilter
+</tt>
+
+you now have a helper you can refer to in your controllers or views like:
+
+<tt>
+time_zone
+</tt>
+
+or
+
+<tt>
+<%= time_zone.name %>
+</tt>
+
+This is a full fleged TimeZone instance.
+
+= How it works
+
+by including the TzMagic::BeforeFilter into your controller, you are adding a check that the user's session contains a :timezone_name element.  If that element exists, all is fine.  If it doesn't exist:
+
+- we redirect the user to our /timezone/new view
+- this view runs some javascript that determines the user's timezone, then submits it via an ajax push to /timezone
+- this hits our timezone#create method, which sets the cookie and returns the original url the user was going to via a json block.
+- the javascript receives the json payload, extracts the original url, and redirects, with the timezone happily in the session.
+
+= the magic javascript code
+
+
+The javascript at the heart of this Rube Goldberg contraption is Copyright (c) 2012 Jon Nylander, project maintained at
+https://bitbucket.org/pellepim/jstimezonedetect
+
+= contributing
+
+The usual.  Fork, modify, test, pullup request.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TzMagic'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/tz_magic/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/tz_magic/detect_timezone.js

@@ -0,0 +1,302 @@
+/*jslint undef: true */
+/*global console*/
+/*version 2012-05-10*/
+
+/**
+ * Namespace to hold all the code for timezone detection.
+ */
+var jstz = (function () {
+    'use strict';
+    var HEMISPHERE_SOUTH = 's',
+        
+        /** 
+         * Gets the offset in minutes from UTC for a certain date.
+         * @param {Date} date
+         * @returns {Number}
+         */
+        get_date_offset = function (date) {
+            var offset = -date.getTimezoneOffset();
+            return (offset !== null ? offset : 0);
+        },
+        
+        get_january_offset = function () {
+            return get_date_offset(new Date(2010, 0, 1, 0, 0, 0, 0));
+        },
+    
+        get_june_offset = function () {
+            return get_date_offset(new Date(2010, 5, 1, 0, 0, 0, 0));
+        },
+        
+        /**
+         * Private method.
+         * Checks whether a given date is in daylight savings time.
+         * If the date supplied is after june, we assume that we're checking
+         * for southern hemisphere DST.
+         * @param {Date} date
+         * @returns {Boolean}
+         */
+        date_is_dst = function (date) {
+            var base_offset = ((date.getMonth() > 5 ? get_june_offset() 
+                                                : get_january_offset())),
+                date_offset = get_date_offset(date); 
+            
+            return (base_offset - date_offset) !== 0;
+        },
+    
+        /**
+         * This function does some basic calculations to create information about 
+         * the user's timezone.
+         * 
+         * Returns a key that can be used to do lookups in jstz.olson.timezones.
+         * 
+         * @returns {String}  
+         */
+        
+        lookup_key = function () {
+            var january_offset = get_january_offset(), 
+                june_offset = get_june_offset(), 
+                diff = get_january_offset() - get_june_offset();
+                
+            if (diff < 0) {
+                return january_offset + ",1";
+            } else if (diff > 0) {
+                return june_offset + ",1," + HEMISPHERE_SOUTH;
+            }
+            
+            return january_offset + ",0";
+        },
+    
+        /**
+         * Uses get_timezone_info() to formulate a key to use in the olson.timezones dictionary.
+         * 
+         * Returns a primitive object on the format:
+         * {'timezone': TimeZone, 'key' : 'the key used to find the TimeZone object'}
+         * 
+         * @returns Object 
+         */
+        determine = function () {
+            var key = lookup_key();
+            return new jstz.TimeZone(jstz.olson.timezones[key]);
+        };
+    
+    return {
+        determine_timezone : function () {
+            if (typeof console !== 'undefined') {
+                console.log("jstz.determine_timezone() is deprecated and will be removed in an upcoming version. Please use jstz.determine() instead.");
+            }
+            return determine();
+        },
+        determine: determine,
+        date_is_dst : date_is_dst
+    };
+}());
+
+/**
+ * Simple object to perform ambiguity check and to return name of time zone.
+ */
+jstz.TimeZone = function (tz_name) {
+    'use strict';    
+    var timezone_name = null,
+        
+        name = function () {
+            return timezone_name;
+        },
+        
+        /**
+         * Checks if a timezone has possible ambiguities. I.e timezones that are similar.
+         * 
+         * For example, if the preliminary scan determines that we're in America/Denver. 
+         * We double check here that we're really there and not in America/Mazatlan.
+         * 
+         * This is done by checking known dates for when daylight savings start for different
+         * timezones during 2010 and 2011.
+         */
+        ambiguity_check = function () {
+            var ambiguity_list = jstz.olson.ambiguity_list[timezone_name],
+                length = ambiguity_list.length, 
+                i = 0,
+                tz = ambiguity_list[0];
+            
+            for (; i < length; i += 1) {
+                tz = ambiguity_list[i];
+        
+                if (jstz.date_is_dst(jstz.olson.dst_start_dates[tz])) {
+                    timezone_name = tz;
+                    return;
+                }   
+            }
+        },
+        
+        /**
+         * Checks if it is possible that the timezone is ambiguous.
+         */
+        is_ambiguous = function () {
+            return typeof (jstz.olson.ambiguity_list[timezone_name]) !== 'undefined';
+        };
+        
+        
+    
+    timezone_name = tz_name;
+    if (is_ambiguous()) {
+        ambiguity_check();
+    }
+    
+    return {
+        name: name
+    };
+};
+
+jstz.olson = {};
+
+/*
+ * The keys in this dictionary are comma separated as such:
+ * 
+ * First the offset compared to UTC time in minutes.
+ *  
+ * Then a flag which is 0 if the timezone does not take daylight savings into account and 1 if it 
+ * does.
+ * 
+ * Thirdly an optional 's' signifies that the timezone is in the southern hemisphere, 
+ * only interesting for timezones with DST.
+ * 
+ * The mapped arrays is used for constructing the jstz.TimeZone object from within 
+ * jstz.determine_timezone();
+ */
+jstz.olson.timezones = {
+    '-720,0'   : 'Etc/GMT+12',
+    '-660,0'   : 'Pacific/Pago_Pago',
+    '-600,1'   : 'America/Adak',
+    '-600,0'   : 'Pacific/Honolulu',
+    '-570,0'   : 'Pacific/Marquesas',
+    '-540,0'   : 'Pacific/Gambier',
+    '-540,1'   : 'America/Anchorage',
+    '-480,1'   : 'America/Los_Angeles',
+    '-480,0'   : 'Pacific/Pitcairn',
+    '-420,0'   : 'America/Phoenix',
+    '-420,1'   : 'America/Denver',
+    '-360,0'   : 'America/Guatemala',
+    '-360,1'   : 'America/Chicago',
+    '-360,1,s' : 'Pacific/Easter',
+    '-300,0'   : 'America/Bogota',
+    '-300,1'   : 'America/New_York',
+    '-270,0'   : 'America/Caracas',
+    '-240,1'   : 'America/Halifax',
+    '-240,0'   : 'America/Santo_Domingo',
+    '-240,1,s' : 'America/Asuncion',
+    '-210,1'   : 'America/St_Johns',
+    '-180,1'   : 'America/Godthab',
+    '-180,0'   : 'America/Argentina/Buenos_Aires',
+    '-180,1,s' : 'America/Montevideo',
+    '-120,0'   : 'America/Noronha',
+    '-120,1'   : 'Etc/GMT+2',
+    '-60,1'    : 'Atlantic/Azores',
+    '-60,0'    : 'Atlantic/Cape_Verde',
+    '0,0'      : 'Etc/UTC',
+    '0,1'      : 'Europe/London',
+    '60,1'     : 'Europe/Berlin',
+    '60,0'     : 'Africa/Lagos',
+    '60,1,s'   : 'Africa/Windhoek',
+    '120,1'    : 'Asia/Beirut',
+    '120,0'    : 'Africa/Johannesburg',
+    '180,1'    : 'Europe/Moscow',
+    '180,0'    : 'Asia/Baghdad',
+    '210,1'    : 'Asia/Tehran',
+    '240,0'    : 'Asia/Dubai',
+    '240,1'    : 'Asia/Yerevan',
+    '270,0'    : 'Asia/Kabul',
+    '300,1'    : 'Asia/Yekaterinburg',
+    '300,0'    : 'Asia/Karachi',
+    '330,0'    : 'Asia/Kolkata',
+    '345,0'    : 'Asia/Kathmandu',
+    '360,0'    : 'Asia/Dhaka',
+    '360,1'    : 'Asia/Omsk',
+    '390,0'    : 'Asia/Rangoon',
+    '420,1'    : 'Asia/Krasnoyarsk',
+    '420,0'    : 'Asia/Jakarta',
+    '480,0'    : 'Asia/Shanghai',
+    '480,1'    : 'Asia/Irkutsk',
+    '525,0'    : 'Australia/Eucla',
+    '525,1,s'  : 'Australia/Eucla',
+    '540,1'    : 'Asia/Yakutsk',
+    '540,0'    : 'Asia/Tokyo',
+    '570,0'    : 'Australia/Darwin',
+    '570,1,s'  : 'Australia/Adelaide',
+    '600,0'    : 'Australia/Brisbane',
+    '600,1'    : 'Asia/Vladivostok',
+    '600,1,s'  : 'Australia/Sydney',
+    '630,1,s'  : 'Australia/Lord_Howe',
+    '660,1'    : 'Asia/Kamchatka',
+    '660,0'    : 'Pacific/Noumea',
+    '690,0'    : 'Pacific/Norfolk',
+    '720,1,s'  : 'Pacific/Auckland',
+    '720,0'    : 'Pacific/Tarawa',
+    '765,1,s'  : 'Pacific/Chatham',
+    '780,0'    : 'Pacific/Tongatapu',
+    '780,1,s'  : 'Pacific/Apia',
+    '840,0'    : 'Pacific/Kiritimati'
+};
+
+
+/**
+ * This object contains information on when daylight savings starts for
+ * different timezones.
+ * 
+ * The list is short for a reason. Often we do not have to be very specific
+ * to single out the correct timezone. But when we do, this list comes in
+ * handy.
+ * 
+ * Each value is a date denoting when daylight savings starts for that timezone.
+ */
+jstz.olson.dst_start_dates = {
+    'America/Denver' : new Date(2011, 2, 13, 3, 0, 0, 0),
+    'America/Mazatlan' : new Date(2011, 3, 3, 3, 0, 0, 0),
+    'America/Chicago' : new Date(2011, 2, 13, 3, 0, 0, 0),
+    'America/Mexico_City' : new Date(2011, 3, 3, 3, 0, 0, 0),
+    'Atlantic/Stanley' : new Date(2011, 8, 4, 7, 0, 0, 0),
+    'America/Asuncion' : new Date(2011, 9, 2, 3, 0, 0, 0),
+    'America/Santiago' : new Date(2011, 9, 9, 3, 0, 0, 0),
+    'America/Campo_Grande' : new Date(2011, 9, 16, 5, 0, 0, 0),
+    'America/Montevideo' : new Date(2011, 9, 2, 3, 0, 0, 0),
+    'America/Sao_Paulo' : new Date(2011, 9, 16, 5, 0, 0, 0),
+    'America/Los_Angeles' : new Date(2011, 2, 13, 8, 0, 0, 0),
+    'America/Santa_Isabel' : new Date(2011, 3, 5, 8, 0, 0, 0),
+    'America/Havana' : new Date(2011, 2, 13, 2, 0, 0, 0),
+    'America/New_York' : new Date(2011, 2, 13, 7, 0, 0, 0),
+    'Asia/Gaza' : new Date(2011, 2, 26, 23, 0, 0, 0),
+    'Asia/Beirut' : new Date(2011, 2, 27, 1, 0, 0, 0),
+    'Europe/Minsk' : new Date(2011, 2, 27, 2, 0, 0, 0),
+    'Europe/Helsinki' : new Date(2011, 2, 27, 4, 0, 0, 0),
+    'Europe/Istanbul' : new Date(2011, 2, 28, 5, 0, 0, 0),
+    'Asia/Damascus' : new Date(2011, 3, 1, 2, 0, 0, 0),
+    'Asia/Jerusalem' : new Date(2011, 3, 1, 6, 0, 0, 0),
+    'Africa/Cairo' : new Date(2010, 3, 30, 4, 0, 0, 0),
+    'Asia/Yerevan' : new Date(2011, 2, 27, 4, 0, 0, 0),
+    'Asia/Baku'    : new Date(2011, 2, 27, 8, 0, 0, 0),
+    'Pacific/Auckland' : new Date(2011, 8, 26, 7, 0, 0, 0),
+    'Pacific/Fiji' : new Date(2010, 11, 29, 23, 0, 0, 0),
+    'America/Halifax' : new Date(2011, 2, 13, 6, 0, 0, 0),
+    'America/Goose_Bay' : new Date(2011, 2, 13, 2, 1, 0, 0),
+    'America/Miquelon' : new Date(2011, 2, 13, 5, 0, 0, 0),
+    'America/Godthab' : new Date(2011, 2, 27, 1, 0, 0, 0)
+};
+
+/**
+ * The keys in this object are timezones that we know may be ambiguous after
+ * a preliminary scan through the olson_tz object.
+ * 
+ * The array of timezones to compare must be in the order that daylight savings
+ * starts for the regions.
+ */
+jstz.olson.ambiguity_list = {
+    'America/Denver' : ['America/Denver', 'America/Mazatlan'],
+    'America/Chicago' : ['America/Chicago', 'America/Mexico_City'],
+    'America/Asuncion' : ['Atlantic/Stanley', 'America/Asuncion', 'America/Santiago', 'America/Campo_Grande'],
+    'America/Montevideo' : ['America/Montevideo', 'America/Sao_Paulo'],
+    'Asia/Beirut' : ['Asia/Gaza', 'Asia/Beirut', 'Europe/Minsk', 'Europe/Helsinki', 'Europe/Istanbul', 'Asia/Damascus', 'Asia/Jerusalem', 'Africa/Cairo'],
+    'Asia/Yerevan' : ['Asia/Yerevan', 'Asia/Baku'],
+    'Pacific/Auckland' : ['Pacific/Auckland', 'Pacific/Fiji'],
+    'America/Los_Angeles' : ['America/Los_Angeles', 'America/Santa_Isabel'],
+    'America/New_York' : ['America/Havana', 'America/New_York'],
+    'America/Halifax' : ['America/Goose_Bay', 'America/Halifax'],
+    'America/Godthab' : ['America/Miquelon', 'America/Godthab']
+};