rails_client_timezone 0.7.0

data/lib/rails_client_timezone/active_support_ext.rb

@@ -0,0 +1,163 @@
+module RailsClientTimezone
+  # ActiveSupport class for mapping tz info identifiers to rails identifiers
+  class ActiveSupportExt
+    TIMEZONE_MAPPING = {
+      "Pacific/Midway"=>"International Date Line West",
+      "Pacific/Midway"=>"Midway Island",
+      "Pacific/Pago_Pago"=>"American Samoa",
+      "Pacific/Honolulu"=>"Hawaii",
+      "America/Juneau"=>"Alaska",
+      "America/Los_Angeles"=>"Pacific Time (US & Canada)",
+      "America/Tijuana"=>"Tijuana",
+      "America/Denver"=>"Mountain Time (US & Canada)",
+      "America/Phoenix"=>"Arizona",
+      "America/Chihuahua"=>"Chihuahua",
+      "America/Mazatlan"=>"Mazatlan",
+      "America/Chicago"=>"Central Time (US & Canada)",
+      "America/Regina"=>"Saskatchewan",
+      "America/Mexico_City"=>"Mexico City",
+      "America/Monterrey"=>"Monterrey",
+      "America/Guatemala"=>"Central America",
+      "America/New_York"=>"Eastern Time (US & Canada)",
+      "America/Indianapolis"=>"Indiana (East)",
+      "America/Indiana/Indianapolis"=>"Indiana (East)",
+      "America/Bogota"=>"Bogota",
+      "America/Lima"=>"Quito",
+      "America/Halifax"=>"Atlantic Time (Canada)",
+      "America/Caracas"=>"Caracas",
+      "America/La_Paz"=>"La Paz",
+      "America/Santiago"=>"Santiago",
+      "America/Santo_Domingo"=>"Santiago",
+      "America/St_Johns"=>"Newfoundland",
+      "America/Sao_Paulo"=>"Brasilia",
+      "America/Argentina/Buenos_Aires"=>"Buenos Aires",
+      "America/Montevideo"=>"Montevideo",
+      "America/Argentina/San_Juan"=>"Georgetown",
+      "America/Guyana"=>"Georgetown",
+      "America/Godthab"=>"Greenland",
+      "Atlantic/South_Georgia"=>"Mid-Atlantic",
+      "Atlantic/Azores"=>"Azores",
+      "Atlantic/Cape_Verde"=>"Cape Verde Is.",
+      "Europe/Dublin"=>"Dublin",
+      "Europe/London"=>"London",
+      "Europe/Lisbon"=>"Lisbon",
+      "Africa/Casablanca"=>"Casablanca",
+      "Africa/Monrovia"=>"Monrovia",
+      "Etc/UTC"=>"UTC",
+      "Europe/Belgrade"=>"Belgrade",
+      "Europe/Bratislava"=>"Bratislava",
+      "Europe/Budapest"=>"Budapest",
+      "Europe/Ljubljana"=>"Ljubljana",
+      "Europe/Prague"=>"Prague",
+      "Europe/Sarajevo"=>"Sarajevo",
+      "Europe/Skopje"=>"Skopje",
+      "Europe/Warsaw"=>"Warsaw",
+      "Europe/Zagreb"=>"Zagreb",
+      "Europe/Brussels"=>"Brussels",
+      "Europe/Copenhagen"=>"Copenhagen",
+      "Europe/Madrid"=>"Madrid",
+      "Europe/Paris"=>"Paris",
+      "Europe/Amsterdam"=>"Amsterdam",
+      "Europe/Berlin"=>"Bern",
+      "Europe/Rome"=>"Rome",
+      "Europe/Stockholm"=>"Stockholm",
+      "Europe/Vienna"=>"Vienna",
+      "Africa/Algiers"=>"West Central Africa",
+      "Europe/Bucharest"=>"Bucharest",
+      "Africa/Cairo"=>"Cairo",
+      "Africa/Kinshasa"=>"West Central Africa",
+      "Europe/Helsinki"=>"Helsinki",
+      "Europe/Kiev"=>"Kyev",
+      "Europe/Riga"=>"Riga",
+      "Europe/Sofia"=>"Sofia",
+      "Europe/Tallinn"=>"Tallinn",
+      "Europe/Vilnius"=>"Vilnius",
+      "Europe/Athens"=>"Athens",
+      "Europe/Istanbul"=>"Istanbul",
+      "Europe/Minsk"=>"Minsk",
+      "Asia/Jerusalem"=>"Jerusalem",
+      "Africa/Harare"=>"Harare",
+      "Africa/Johannesburg"=>"Pretoria",
+      "Europe/Kaliningrad"=>"Kaliningrad",
+      "Europe/Moscow"=>"Moscow",
+      "Europe/Volgograd"=>"Volgograd",
+      "Europe/Samara"=>"Samara",
+      "Asia/Kuwait"=>"Kuwait",
+      "Asia/Riyadh"=>"Riyadh",
+      "Africa/Nairobi"=>"Nairobi",
+      "Asia/Baghdad"=>"Baghdad",
+      "Asia/Tehran"=>"Tehran",
+      "Asia/Muscat"=>"Abu Dhabi",
+      "Asia/Muscat"=>"Muscat",
+      "Asia/Baku"=>"Baku",
+      "Asia/Tbilisi"=>"Tbilisi",
+      "Asia/Yerevan"=>"Yerevan",
+      "Asia/Kabul"=>"Kabul",
+      "Asia/Yekaterinburg"=>"Ekaterinburg",
+      "Asia/Karachi"=>"Karachi",
+      "Asia/Tashkent"=>"Tashkent",
+      "Asia/Kolkata"=>"Chennai",
+      "Asia/Calcutta"=>"New Delhi",
+      "Asia/Kathmandu"=>"Kathmandu",
+      "Asia/Katmandu"=>"Kathmandu",
+      "Asia/Dhaka"=>"Dhaka",
+      "Asia/Colombo"=>"Sri Jayawardenepura",
+      "Asia/Almaty"=>"Almaty",
+      "Asia/Qyzylorda"=>"Almaty",
+      "Asia/Novosibirsk"=>"Novosibirsk",
+      "Asia/Bangkok"=>"Bangkok",
+      "Asia/Jakarta"=>"Jakarta",
+      "Asia/Krasnoyarsk"=>"Krasnoyarsk",
+      "Asia/Shanghai"=>"Beijing",
+      "Asia/Chongqing"=>"Chongqing",
+      "Asia/Hong_Kong"=>"Hong Kong",
+      "Asia/Urumqi"=>"Urumqi",
+      "Asia/Kuala_Lumpur"=>"Kuala Lumpur",
+      "Asia/Rangoon"=>"Rangoon",
+      "Asia/Singapore"=>"Singapore",
+      "Asia/Taipei"=>"Taipei",
+      "Asia/Irkutsk"=>"Irkutsk",
+      "Asia/Ulaanbaatar"=>"Ulaanbaatar",
+      "Asia/Seoul"=>"Seoul",
+      "Asia/Tokyo"=>"Tokyo",
+      "Asia/Yakutsk"=>"Yakutsk",
+      "Australia/Darwin"=>"Darwin",
+      "Australia/Adelaide"=>"Adelaide",
+      "Australia/Melbourne"=>"Melbourne",
+      "Australia/Lord_Howe"=>"Melbourne",
+      "Australia/Queensland"=>"Brisbane",
+      "Australia/Victoria"=>"Melbourne",
+      "Australia/NSW"=>"Melbourne",
+      "Australia/Sydney"=>"Sydney",
+      "Australia/Brisbane"=>"Brisbane",
+      "Australia/Hobart"=>"Hobart",
+      "Australia/Currie"=>"Melbourne",
+      "Australia/Broken_Hill"=>"Adelaide",
+      "Australia/Lindeman"=>"Brisbane",
+      "Australia/Perth"=>"Perth",
+      "Australia/Eucla"=>"Perth",
+      "Asia/Vladivostok"=>"Vladivostok",
+      "Pacific/Guam"=>"Guam",
+      "Pacific/Port_Moresby"=>"Port Moresby",
+      "Asia/Magadan"=>"Magadan",
+      "Asia/Srednekolymsk"=>"Srednekolymsk",
+      "Pacific/Guadalcanal"=>"Solomon Is.",
+      "Pacific/Noumea"=>"New Caledonia",
+      "Pacific/Fiji"=>"Fiji",
+      "Asia/Kamchatka"=>"Kamchatka",
+      "Pacific/Majuro"=>"Marshall Is.",
+      "Pacific/Auckland"=>"Auckland",
+      "Pacific/Auckland"=>"Wellington",
+      "Pacific/Tongatapu"=>"Nuku'alofa",
+      "Pacific/Fakaofo"=>"Tokelau Is.",
+      "Pacific/Chatham"=>"Chatham Is.",
+      "Pacific/Pago_Pago"=>"Samoa",
+      "Pacific/Galapagos"=>"Samoa",
+      "Pacific/Apia"=>"Samoa"
+    }
+
+    def self.format(zone)
+      TIMEZONE_MAPPING[zone] || nil
+    end
+  end
+end

data/lib/rails_client_timezone/filter.rb

@@ -0,0 +1,60 @@
+# Runs the controller code in the user's time zone which is determined through the offsets passed via cookies.
+module RailsClientTimezone
+  class Filter
+    
+    def self.filter(controller, &block)
+      cookies = controller.send(:cookies)
+      
+      current_time_zone = if Setting.mode == :browser
+        get_time_zone_by_browser_offset(cookies[:utc_offset_summer], cookies[:utc_offset_winter], cookies[:last_known_tz])
+      elsif Setting.mode == :ip
+        get_time_zone_by_ip(controller, cookies[:last_known_tz])
+      else
+        get_time_zone_by_smart(controller, cookies[:utc_offset_summer], cookies[:utc_offset_winter], cookies[:last_known_tz])
+      end
+      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.get_time_zone_by_browser_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.to_s], ActiveSupport::TimeZone.all].flatten.compact.detect(ifnone = Time.method(:zone_default)) do |zone|
+        Time.use_zone(zone.name) do
+          if utc_offset_summer.present? && utc_offset_winter.present?
+            (Time.zone.parse(Setting.mid_summer_date_str).utc_offset == utc_offset_summer.to_i && Time.zone.parse(Setting.mid_winter_date_str).utc_offset == utc_offset_winter.to_i)
+          else
+            (Time.zone.name == last_known_tz.to_s)
+          end
+        end
+      end
+    end
+    
+    # Returns the time zone based on IP address
+    # Returns the default TimeZone if none is resolved
+    def self.get_time_zone_by_ip(controller, last_known_tz = nil)
+      return ActiveSupport::TimeZone[last_known_tz] if last_known_tz && ActiveSupport::TimeZone[last_known_tz]
+      begin
+        ip_addr = controller.request.remote_ip
+        geo_timezone = GeoIP.new(Setting.geoip_data_path).city(ip_addr) ? GeoIP.new(Setting.geoip_data_path).city(ip_addr).timezone : nil
+        timezone_name = geo_timezone && ActiveSupportExt.format(geo_timezone) ? ActiveSupportExt.format(geo_timezone) : Time.zone_default.name
+      rescue Exception => e
+        ActiveSupport::TimeZone[Time.zone_default.name]
+      end
+      ActiveSupport::TimeZone[timezone_name]
+    end
+    
+    # Returns the time zone using both ip address and browser offset
+    # Returns the default TimeZone if none is resolved
+    def self.get_time_zone_by_smart(controller, utc_offset_summer, utc_offset_winter, last_known_tz)
+      last_known_tz_val = last_known_tz ? last_known_tz : get_time_zone_by_ip(controller).name
+      get_time_zone_by_browser_offset(utc_offset_summer, utc_offset_winter, last_known_tz_val)
+    end
+  end
+end

data/lib/rails_client_timezone/setting.rb

@@ -0,0 +1,34 @@
+module RailsClientTimezone  
+  class Setting
+   class << self
+      attr_writer :baseline_year
+      attr_writer :mode
+      attr_writer :geoip_data_path
+      
+      #Possible mode values - :ip, :browser, :smart
+      def mode
+        @mode ||= :smart 
+      end
+      
+      def geoip_data_path
+        @geoip_data_path ||= File.expand_path(File.join(File.dirname(__FILE__), '../..', 'data/geoip', 'GeoLiteCity.dat'))
+      end
+      
+      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_client_timezone/version.rb

@@ -0,0 +1,3 @@
+module RailsClientTimezone
+  VERSION = "0.7.0"
+end

data/rails_client_timezone.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_client_timezone/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_client_timezone"
+  s.version     = RailsClientTimezone::VERSION
+  s.authors     = ["Udaya Kiran", "Yamini Devarajan"]
+  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_client_timezone"
+
+  s.files         = %w[
+    Gemfile
+    README.md
+    lib/rails_client_timezone/filter.rb
+    lib/rails_client_timezone/version.rb
+    lib/rails_client_timezone/setting.rb
+    lib/rails_client_timezone/active_support_ext.rb
+    lib/geoip.rb
+    rails_client_timezone.gemspec
+  ]
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport", '> 2'
+  s.add_runtime_dependency "geoip", '1.6.1'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rails_client_timezone
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Udaya Kiran
+- Yamini Devarajan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: geoip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+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/geoip.rb
+- lib/rails_client_timezone/active_support_ext.rb
+- lib/rails_client_timezone/filter.rb
+- lib/rails_client_timezone/setting.rb
+- lib/rails_client_timezone/version.rb
+- rails_client_timezone.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rails_client_timezone
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails Browser Timezone client gem
+test_files: []