cleverua-client_timezone_detection 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Boris Babusenko
+
+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,65 @@
+= Client Timezone Detection Rails plugin
+
+* http://github.com/cleverua/client_timezone_detection
+
+== DESCRIPTION:
+
+A Ruby On Rails gem aimed to simplify user timezone detection. It gets TZ 
+information from user browser, saves it in cookie and then applies the TZ in
+controller. That way you always have application TZ set up for the region user is
+actually in.
+
+
+=== USAGE
+
+All you have to do is to include gem's javascripts in your application layout.
+Just drop the following somewhere in the page head section:
+
+  <%= javascript_include_tz_detection %>
+
+That's all. Now using some before_filter magick the gem will have set
+request's time zone to match the one received in cookies. That will be the
+timezone user's browser is configured for.
+
+== HOW TO SKIP THE TIMEZONE DETECTION:
+
+It is sometimes necessary to skip timezone detection and setup, say you
+implement a general purpose web service within your app. You can skip it in your
+controller like this:
+
+  skip_before_filter :set_client_time_zone
+
+== IMPORTANT ASSUMPTION
+
+It assumes you use the excellent jQuery library in your application. You use it,
+right? That's the assumption :)
+
+== INSTALL:
+  
+  Put this string in your Gemfile:
+  gem 'client_timezone_detection', :git => git://github.com/cleverua/client_timezone_detection.git
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 CleverUA
+
+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,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cleverua-client_timezone_detection"
+  gem.homepage = "http://github.com/cleverua/client_timezone_detection"
+  gem.license = "MIT"
+  gem.summary = %Q{A rails gem aimed to simplify user timezone detection}
+  gem.description = %Q{The gem gets timezone information from user browser, saves it in a cookie and then applies the TZ in controller. That way you always have application TZ set up for the region user is actually in.}
+  gem.email = "info@cleverua.com"
+  gem.authors = ["Pavlo Lysov, Boris Babusenko"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#end
+
+#task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "client_timezone_detection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/client_timezone_detection.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{client_timezone_detection}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pavlo Lysov, Boris Babusenko"]
+  s.date = %q{2010-12-10}
+  s.description = %q{See README}
+  s.email = %q{boris@cleverua.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "client_timezone_detection.gemspec",
+    "js_files/jquery.cookie.js",
+    "js_files/time_zone_detection.js",
+    "lib/client_timezone_detection.rb",
+    "lib/client_timezone_detection/client_timezone_railtie.rb",
+    "lib/client_timezone_detection/controller_helpers.rb",
+    "lib/client_timezone_detection/view_helpers.rb",
+    "lib/client_timezone_detection_install.rb",
+    "test/helper.rb",
+    "test/test_time_zone_detection.rb",
+    "time_zone_detection.gemspec"
+  ]
+  s.homepage = %q{http://github.com/cleverua/client_timezone_detection}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Gem for detection client time zone}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_time_zone_detection.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+  end
+end
+

data/js_files/jquery.cookie.js

@@ -0,0 +1,96 @@
+/**
+ * Cookie plugin
+ *
+ * Copyright (c) 2006 Klaus Hartl (stilbuero.de)
+ * Dual licensed under the MIT and GPL licenses:
+ * http://www.opensource.org/licenses/mit-license.php
+ * http://www.gnu.org/licenses/gpl.html
+ *
+ */
+
+/**
+ * Create a cookie with the given name and value and other optional parameters.
+ *
+ * @example $.cookie('the_cookie', 'the_value');
+ * @desc Set the value of a cookie.
+ * @example $.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });
+ * @desc Create a cookie with all available options.
+ * @example $.cookie('the_cookie', 'the_value');
+ * @desc Create a session cookie.
+ * @example $.cookie('the_cookie', null);
+ * @desc Delete a cookie by passing null as value. Keep in mind that you have to use the same path and domain
+ *       used when the cookie was set.
+ *
+ * @param String name The name of the cookie.
+ * @param String value The value of the cookie.
+ * @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
+ * @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
+ *                             If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
+ *                             If set to null or omitted, the cookie will be a session cookie and will not be retained
+ *                             when the the browser exits.
+ * @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
+ * @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
+ * @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
+ *                        require a secure protocol (like HTTPS).
+ * @type undefined
+ *
+ * @name $.cookie
+ * @cat Plugins/Cookie
+ * @author Klaus Hartl/klaus.hartl@stilbuero.de
+ */
+
+/**
+ * Get the value of a cookie with the given name.
+ *
+ * @example $.cookie('the_cookie');
+ * @desc Get the value of a cookie.
+ *
+ * @param String name The name of the cookie.
+ * @return The value of the cookie.
+ * @type String
+ *
+ * @name $.cookie
+ * @cat Plugins/Cookie
+ * @author Klaus Hartl/klaus.hartl@stilbuero.de
+ */
+jQuery.cookie = function(name, value, options) {
+    if (typeof value != 'undefined') { // name and value given, set cookie
+        options = options || {};
+        if (value === null) {
+            value = '';
+            options.expires = -1;
+        }
+        var expires = '';
+        if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {
+            var date;
+            if (typeof options.expires == 'number') {
+                date = new Date();
+                date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));
+            } else {
+                date = options.expires;
+            }
+            expires = '; expires=' + date.toUTCString(); // use expires attribute, max-age is not supported by IE
+        }
+        // CAUTION: Needed to parenthesize options.path and options.domain
+        // in the following expressions, otherwise they evaluate to undefined
+        // in the packed version for some reason...
+        var path = options.path ? '; path=' + (options.path) : '';
+        var domain = options.domain ? '; domain=' + (options.domain) : '';
+        var secure = options.secure ? '; secure' : '';
+        document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join('');
+    } else { // only name given, get cookie
+        var cookieValue = null;
+        if (document.cookie && document.cookie != '') {
+            var cookies = document.cookie.split(';');
+            for (var i = 0; i < cookies.length; i++) {
+                var cookie = jQuery.trim(cookies[i]);
+                // Does this cookie string begin with the name we want?
+                if (cookie.substring(0, name.length + 1) == (name + '=')) {
+                    cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
+                    break;
+                }
+            }
+        }
+        return cookieValue;
+    }
+};

data/js_files/time_zone_detection.js

@@ -0,0 +1,8 @@
+$(document).ready(function() {
+    var TZ_COOKIE_NAME = 'tzoffset';
+    var options = {
+        path: '/',
+        expires: 10
+    };
+    jQuery.cookie(TZ_COOKIE_NAME, new Date().getTimezoneOffset(), options);
+});

data/lib/client_timezone_detection.rb

@@ -0,0 +1,3 @@
+if defined? Rails
+  require 'client_timezone_detection/client_timezone_railtie'
+end

data/lib/client_timezone_detection/client_timezone_railtie.rb

@@ -0,0 +1,24 @@
+require 'rails'
+require 'client_timezone_detection'
+require 'client_timezone_detection/view_helpers'
+require 'client_timezone_detection/controller_helpers'
+
+
+class ClientTimezoneRailtie < ::Rails::Railtie
+  config.to_prepare do
+    require 'client_timezone_detection_install'	
+     module ClientTimezoneDetection
+      class << self
+        def enable_action_view_extensions
+	  ActionView::Base.send(:include, ViewHelpers)
+        end
+        def enable_controller_extensions
+ 	  ApplicationController.send(:include, ControllerHelpers) 
+        end
+      end
+     end
+
+     ClientTimezoneDetection.enable_action_view_extensions
+     ClientTimezoneDetection.enable_controller_extensions
+  end	    
+end

data/lib/client_timezone_detection/controller_helpers.rb

@@ -0,0 +1,19 @@
+module ControllerHelpers
+  def self.included(base)
+   base.class_eval("before_filter :set_client_time_zone")
+  end
+
+  private
+  def set_client_time_zone
+    Time.zone = browser_timezone.nil? ? "UTC" : browser_timezone
+    logger.info("--- Client Timezone set: #{Time.zone}")
+  end
+
+  def browser_timezone
+    return nil if cookies[:tzoffset].blank?
+    @browser_timezone ||= begin
+    min = cookies[:tzoffset].to_i
+    ActiveSupport::TimeZone[-min.minutes]
+    end
+  end
+end

data/lib/client_timezone_detection/view_helpers.rb

@@ -0,0 +1,5 @@
+module ViewHelpers
+  def javascript_include_tz_detection
+    javascript_include_tag 'jquery.cookie', 'time_zone_detection'
+  end
+end

data/lib/client_timezone_detection_install.rb

@@ -0,0 +1,8 @@
+src_path = File.join(File.expand_path("../../", __FILE__), "js_files/.")
+dest_file = ::Rails.root.join("public", "javascripts")
+
+unless File.exist?(::Rails.root.join("public", "javascripts", "jquery.cookie.js")) && File.exist?(::Rails.root.join("public", "javascripts", "time_zone_detection.js"))
+  puts "Copying files required for ClientTimezoneDetection..."
+  FileUtils.cp_r(src_path, dest_file)
+  puts "ClientTimezoneDetection installed successfully"
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'time_zone_detection'
+
+class Test::Unit::TestCase
+end

data/test/test_time_zone_detection.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTimeZoneDetection < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/time_zone_detection.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{time_zone_detection}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pavlo Lysov, Boris Babusenko"]
+  s.date = %q{2010-12-10}
+  s.description = %q{See README}
+  s.email = %q{boris@cleverua.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "js_files/jquery.cookie.js",
+    "js_files/time_zone_detection.js",
+    "lib/client_timezone_detection.rb",
+    "lib/client_timezone_detection/client_timezone_railtie.rb",
+    "lib/client_timezone_detection/controller_helpers.rb",
+    "lib/client_timezone_detection/view_helpers.rb",
+    "lib/client_timezone_detection_install.rb",
+    "test/helper.rb",
+    "test/test_time_zone_detection.rb"
+  ]
+  s.homepage = %q{http://github.com/cleverua/time_zone_detection}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Gem for detection client time zone}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_time_zone_detection.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+  end
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: cleverua-client_timezone_detection
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Pavlo Lysov, Boris Babusenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  version_requirements: *id002
+description: The gem gets timezone information from user browser, saves it in a cookie and then applies the TZ in controller. That way you always have application TZ set up for the region user is actually in.
+email: info@cleverua.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- client_timezone_detection.gemspec
+- js_files/jquery.cookie.js
+- js_files/time_zone_detection.js
+- lib/client_timezone_detection.rb
+- lib/client_timezone_detection/client_timezone_railtie.rb
+- lib/client_timezone_detection/controller_helpers.rb
+- lib/client_timezone_detection/view_helpers.rb
+- lib/client_timezone_detection_install.rb
+- test/helper.rb
+- test/test_time_zone_detection.rb
+- time_zone_detection.gemspec
+has_rdoc: true
+homepage: http://github.com/cleverua/client_timezone_detection
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A rails gem aimed to simplify user timezone detection
+test_files: 
+- test/helper.rb
+- test/test_time_zone_detection.rb