rails_browser_timezone 0.2.0

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+source 'http://gems.github.com/'
+
+# Specify your gem's dependencies in rails_browser_timezone.gemspec
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+rails_browser_timezone
+======================
+
+The purpose of this gem is to track browser's timezone and run rails controller code in the time zone
+detected for each request.
+
+For background and thoughts, please refer - http://developerstream.blogspot.in/2015/09/handling-requests-in-browser-time-zone.html
+
+Instructions to use
+==================
+
+Installation -
+--------------------
+
+```
+  gem 'rails_browser_timezone', '0.2.0', :git => 'https://github.com/udayakiran/rails_browser_timezone'
+```
+
+Usage -
+---------
+
+ 1) Create a file in your initializers and set baseline year. This step is optional. This means we are worried about time zone changes that occurred till this year. My suggesstion is to keep this year same as either the year you are starting this project or the year when your rails version is released.
+Use "current" as the value if you want to stay on the edge. But, note that rails and your browsers need to be supporting this as well.
+
+``` 
+# Say in config/initializers/rails_browser_tz_init.rb
+RailsBrowserTimezone::Setting.baseline_year = 2014 #default value is 2011. Accepted values - any valid year or string - "current"
+```
+
+ 2) Include the around filter in every controller that needs to run code in user's timezone. If you need it for all controllers obviously add it to the application controller.
+
+```
+ #Rails 4.1.x or earlier (inlcuding Rails 2,3 and 4)
+
+ class MyTimeZoneController < ApplicationController  #Or in your application_controller.rb
+ 
+   prepend_around_filter RailsBrowserTimezone::Filter
+   	.......
+   	.......
+
+ end
+
+ #Rails 4.2.x or later
+
+ class MyTimeZoneController < ApplicationController  #Or in your application_controller.rb
+
+   prepend_around_action RailsBrowserTimezone::Filter 
+        .......
+        .......
+
+ end
+```
+
+  3) Add the js code that sets the browser offsets in your js files. Code can be found in assets directory based on the js lib you use.
+    If you use jquery, copy the js code from 'assets/set_browser_offset_cokies_jquery.js' and paste it in your js file which is inlcuded in every page.
+    If you use prototypejs, copy the js code 'from assets/set_browser_offset_cokies_prototype.js' and paste it in your js file which is inlcuded in every page.
+
+Saving time zone in the database -
+--------------------------------
+
+If you like to save the last_known_timezone of any user in the database, it can be done by using "Time.zone.name" any where in your controller,
+once 'RailsBrowserTimezone::Filter' is done with the determining of the time zone from offsets.
+
+Practices in your code -
+-------------------------
+
+1. Use Time.zone.* not Time.* :- Most of the scenarios we need to deal with times in the current time zone not in the system time zone on which app is running. So, we should use Time.zone.now, Time.zone.parse and time_obj.in_time_zone(Time.zone) when we are dealing with time information.
+
+2. Use Time.use_zone :- When we need to operate in other time zones than the current system, enlose that code in Time.use_zone block. This sets back the system time zone once the code completes execution or even when exception occurs. Otherwise we should always remember to set the system's time zone back to default.
+
+To do -
+-------
+
+ Add specs and tests.
+
+Contributing -
+----------
+
+Please help with your contribution by filing any issues if found. Pull requests are welcomed :)

data/lib/rails_browser_timezone/filter.rb

@@ -0,0 +1,30 @@
+# Runs the controller code in the user's time zone which is determined through the offsets passed via cookies.
+module RailsBrowserTimezone  
+  class Filter
+  
+    def self.filter(controller, &block)
+      cookies = controller.send(:cookies)
+      last_known_tz = cookies[:last_known_tz] ? cookies[:last_known_tz] : Time.zone_default.name
+      current_time_zone = time_zone_from_utc_offset(cookies[:utc_offset_summer].to_i, cookies[:utc_offset_winter].to_i, last_known_tz)
+      controller.response.set_cookie(:last_known_tz, {:path => "/", :value => current_time_zone.name})
+    
+      Time.use_zone(current_time_zone) do
+        yield
+      end
+    end
+
+    # Returns the time zone based on parsed *utc_offset_summer* and *utc_offset_winter*
+    # Returns the default TimeZone if none is resolved
+    def self.time_zone_from_utc_offset(utc_offset_summer, utc_offset_winter, last_known_tz)
+      # ActiveSupport::TimeZone[offset] - will return the first time zone that matches the offset.
+      # But, we need to get the exact time zone inorder to reflect the daylight savings.
+      # So, we get the user's time zone exactly by matching the summer offset and winter offset both.
+      [ActiveSupport::TimeZone[last_known_tz], ActiveSupport::TimeZone.all].flatten.compact.detect(ifnone = Time.method(:zone_default)) do |zone|
+        Time.use_zone(zone.name) do
+          Time.zone.parse(Setting.mid_summer_date_str).utc_offset == utc_offset_summer && Time.zone.parse(Setting.mid_winter_date_str).utc_offset == utc_offset_winter
+        end
+      end
+    end
+
+  end
+end

data/lib/rails_browser_timezone/setting.rb

@@ -0,0 +1,23 @@
+module RailsBrowserTimezone  
+  class Setting
+   class << self
+      attr_writer :baseline_year
+        
+      def baseline_year
+        @baseline_year ||= 2011
+      end
+      
+      def mid_summer_date_str
+        "#{year}-6-21"
+      end
+      
+      def mid_winter_date_str
+        "#{year}-12-21"
+      end
+      
+      def year
+        (baseline_year.to_sym == :current) ? Time.zone.now.year : baseline_year
+      end
+   end
+  end
+end

data/lib/rails_browser_timezone/version.rb

@@ -0,0 +1,3 @@
+module RailsBrowserTimezone
+  VERSION = "0.2.0"
+end

data/rails_browser_timezone.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_browser_timezone/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_browser_timezone"
+  s.version     = RailsBrowserTimezone::VERSION
+  s.authors     = ["Udaya Kiran"]
+  s.email       = ["udaykiran.vit@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Rails Browser Timezone client gem}
+  s.description = %q{Simple code to detect browser time zone and handle it in rails app}
+  
+  s.rubyforge_project = "rails_browser_timezone"
+
+  s.files         = %w[
+    Gemfile
+    README.md
+    lib/rails_browser_timezone/filter.rb
+    lib/rails_browser_timezone/version.rb
+    lib/rails_browser_timezone/setting.rb
+    rails_browser_timezone.gemspec
+  ]
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport", '> 2'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: rails_browser_timezone
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Udaya Kiran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2015-10-05 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+description: Simple code to detect browser time zone and handle it in rails app
+email: 
+- udaykiran.vit@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- lib/rails_browser_timezone/filter.rb
+- lib/rails_browser_timezone/version.rb
+- lib/rails_browser_timezone/setting.rb
+- rails_browser_timezone.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+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: rails_browser_timezone
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails Browser Timezone client gem
+test_files: []
+