timezone 0.0.3 → 0.1.0

data/README.markdown

@@ -1,6 +1,6 @@
 # Timezone
 
-A simple way to get accurate current and historical timezone information based on zone or latitude and longitude coordinates. This gem uses the tz database (http://www.twinsun.com/tz/tz-link.htm) for historical timezone information. It also uses the geonames API for timezone latitude and longitude lookup (http://www.geonames.org/export/web-services.html).
+A simple way to get accurate current and historical timezone information based on zone or latitude and longitude coordinates. This gem uses the [tz database](http://www.twinsun.com/tz/tz-link.htm) for historical timezone information. It also uses the [geonames API](http://www.geonames.org/export/web-services.html) for timezone latitude and longitude lookup.
 
 ## Installation
 

data/lib/timezone.rb

@@ -1,105 +1,3 @@
-require 'json'
-require 'date'
-require 'time'
-require 'net/http'
+require File.expand_path('../timezone/zone', __FILE__)
 
-class Timezone
-  attr_accessor :rules, :zone
-
-  # Configuration class for the Timezone gem.
-  #
-  # Timezone::Configure.begin do |c| ... end
-  # c.username = username - the geonames username you use to access the geonames timezone API.
-  #
-  # Signup for a geonames username at http://www.geonames.org/login. Use that username to configure
-  # your application for latitude and longitude based timezone searches. If you aren't going to
-  # initialize timezone objects based on latitude and longitude then this configuration is not necessary.
-  class Configure
-    def self.username
-      @@username
-    end
-    
-    def self.username= username
-      @@username = username
-    end
-    
-    def self.begin
-      yield self
-    end
-  end
-
-  # Error messages that can be raised by this gem. To catch any related error message, simply use Error::Base.
-  #
-  # begin
-  #   ...
-  # rescue Timezone::Error::Base => e
-  #   puts "Timezone Error: #{e.message}"
-  # end
-  module Error
-    class Base < StandardError; end
-    class InvalidZone < Base; end
-    class NilZone < Base; end
-    class GeoNames < Base; end
-    class ParseTime < Base; end
-  end
-    
-  # Create a new Timezone object.
-  # 
-  # Timezone.new(options)
-  # :zone       - The actual name of the zone. For example, Australia/Sydney or Americas/Los_Angeles.
-  # :lat, :lon  - The latitude and longitude of the location.
-  # :latlon     - The array of latitude and longitude of the location.
-  #
-  # If a latitude and longitude is passed in, the Timezone object will do a lookup for the actual zone
-  # name and then use that as a reference. It will then load the appropriate json timezone information
-  # for that zone, and compile a list of the timezone rules.
-  def initialize options
-    if options.has_key?(:lat) && options.has_key?(:lon)
-      options[:zone] = timezone_id options[:lat], options[:lon]
-    elsif options.has_key?(:latlon)
-      options[:zone] = timezone_id *options[:latlon]
-    end
-    
-    raise Error::NilZone, 'No zone was found. Please specify a zone.' if options[:zone].nil?
-    
-    file = File.join File.expand_path(File.dirname(__FILE__)+'/../data'), "#{options[:zone]}.json"
-    raise Error::InvalidZone, "'#{options[:zone]}' is not a valid zone." unless File.exists?(file)
-
-    data = JSON.parse(open(file).read)
-    @rules = data['zone']
-    @zone = data['_zone'] || options[:zone]
-  end
-  
-  # Determine the time in the timezone.
-  #
-  # timezone.time(reference)
-  # reference - The Time you want to convert.
-  #
-  # The reference is converted to a UTC equivalent. That UTC equivalent is then used to lookup the appropriate
-  # offset in the timezone rules. Once the offset has been found that offset is added to the reference UTC time
-  # to calculate the reference time in the timezone.
-  def time reference
-    reference = reference.utc
-    rule = rules.detect{ |rule| _parsetime(rule['_from']) <= reference && _parsetime(rule['_to']) >= reference }
-    reference + rule['offset']
-  end
-  
-  private
-  
-  def timezone_id lat, lon #:nodoc:
-    begin
-      response = Net::HTTP.get('ws.geonames.org', "/timezoneJSON?lat=#{lat}&lng=#{lon}&username=#{Configure.username}")
-      JSON.parse(response)['timezoneId']
-    rescue Exception => e
-      raise Error::GeoNames, e.message
-    end
-  end
-  
-  def _parsetime time #:nodoc:
-    begin
-      Time.strptime(time, "%Y-%m-%dT%H:%M:%SZ")
-    rescue Exception => e
-      raise Error::ParseTime, e.message
-    end
-  end
-end
+module Timezone; end

data/lib/timezone/configure.rb

@@ -0,0 +1,24 @@
+module Timezone
+  # Configuration class for the Timezone gem.
+  #
+  #   Timezone::Configure.begin do |c| ... end
+  #
+  # c.username = username - the geonames username you use to access the geonames timezone API.
+  #
+  # Signup for a geonames username at http://www.geonames.org/login. Use that username to configure
+  # your application for latitude and longitude based timezone searches. If you aren't going to
+  # initialize timezone objects based on latitude and longitude then this configuration is not necessary.
+  class Configure
+    def self.username
+      @@username
+    end
+    
+    def self.username= username
+      @@username = username
+    end
+    
+    def self.begin
+      yield self
+    end
+  end
+end

data/lib/timezone/error.rb

@@ -0,0 +1,16 @@
+module Timezone
+  # Error messages that can be raised by this gem. To catch any related error message, simply use Error::Base.
+  #
+  #   begin
+  #     ...
+  #   rescue Timezone::Error::Base => e
+  #     puts "Timezone Error: #{e.message}"
+  #   end
+  module Error
+    class Base < StandardError; end
+    class InvalidZone < Base; end
+    class NilZone < Base; end
+    class GeoNames < Base; end
+    class ParseTime < Base; end
+  end
+end

data/lib/timezone/version.rb

@@ -1,3 +1,3 @@
 module Timezone
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/timezone/zone.rb

@@ -0,0 +1,74 @@
+require 'json'
+require 'date'
+require 'time'
+require 'net/http'
+require 'timezone/error'
+require 'timezone/configure'
+
+module Timezone
+  class Zone
+    attr_accessor :rules, :zone
+    
+    # Create a new Timezone object.
+    # 
+    #   Timezone.new(options)
+    #
+    # :zone       - The actual name of the zone. For example, Australia/Sydney or Americas/Los_Angeles.
+    # :lat, :lon  - The latitude and longitude of the location.
+    # :latlon     - The array of latitude and longitude of the location.
+    #
+    # If a latitude and longitude is passed in, the Timezone object will do a lookup for the actual zone
+    # name and then use that as a reference. It will then load the appropriate json timezone information
+    # for that zone, and compile a list of the timezone rules.
+    def initialize options
+      if options.has_key?(:lat) && options.has_key?(:lon)
+        options[:zone] = timezone_id options[:lat], options[:lon]
+      elsif options.has_key?(:latlon)
+        options[:zone] = timezone_id *options[:latlon]
+      end
+
+      raise Timezone::Error::NilZone, 'No zone was found. Please specify a zone.' if options[:zone].nil?
+
+      file = File.join File.expand_path(File.dirname(__FILE__)+'/../../data'), "#{options[:zone]}.json"
+      raise Timezone::Error::InvalidZone, "'#{options[:zone]}' is not a valid zone." unless File.exists?(file)
+
+      data = JSON.parse(open(file).read)
+      @rules = data['zone']
+      @zone = data['_zone'] || options[:zone]
+    end
+
+    # Determine the time in the timezone.
+    #
+    #   timezone.time(reference)
+    #
+    # reference - The Time you want to convert.
+    #
+    # The reference is converted to a UTC equivalent. That UTC equivalent is then used to lookup the appropriate
+    # offset in the timezone rules. Once the offset has been found that offset is added to the reference UTC time
+    # to calculate the reference time in the timezone.
+    def time reference
+      reference = reference.utc
+      rule = rules.detect{ |rule| _parsetime(rule['_from']) <= reference && _parsetime(rule['_to']) >= reference }
+      reference + rule['offset']
+    end
+
+    private
+
+    def timezone_id lat, lon #:nodoc:
+      begin
+        response = Net::HTTP.get('ws.geonames.org', "/timezoneJSON?lat=#{lat}&lng=#{lon}&username=#{Timezone::Configure.username}")
+        JSON.parse(response)['timezoneId']
+      rescue Exception => e
+        raise Timezone::Error::GeoNames, e.message
+      end
+    end
+
+    def _parsetime time #:nodoc:
+      begin
+        Time.strptime(time, "%Y-%m-%dT%H:%M:%SZ")
+      rescue Exception => e
+        raise Timezone::Error::ParseTime, e.message
+      end
+    end
+  end
+end

data/test/timezone_test.rb

@@ -1,40 +1,43 @@
 require File.expand_path(File.dirname(__FILE__) + '/../lib/timezone')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/timezone/zone')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/timezone/error')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/timezone/configure')
 require 'test/unit'
 
 class TimezoneTest < Test::Unit::TestCase
 
   def test_valid_timezone
     assert_nothing_raised do
-      Timezone.new :zone => 'Australia/Sydney'
+      Timezone::Zone.new :zone => 'Australia/Sydney'
     end
   end
   
   def test_nil_timezone
     assert_raise Timezone::Error::NilZone do
-      Timezone.new :zone => nil
+      Timezone::Zone.new :zone => nil
     end
   end
   
   def test_invalid_timezone
     assert_raise Timezone::Error::InvalidZone do
-      Timezone.new :zone => 'Foo/Bar'
+      Timezone::Zone.new :zone => 'Foo/Bar'
     end
   end
   
   def test_loading_GMT_timezone
-    timezone = Timezone.new :zone => 'GMT'
+    timezone = Timezone::Zone.new :zone => 'GMT'
     assert_equal Time.now.utc.to_i, timezone.time(Time.now).to_i
   end
   
   def test_loading_historical_time
-    timezone = Timezone.new :zone => 'America/Los_Angeles'
+    timezone = Timezone::Zone.new :zone => 'America/Los_Angeles'
     local = Time.strptime('2011-02-11T13:20:00Z', '%Y-%m-%dT%H:%M:%SZ')
     utc = Time.strptime('2011-02-11T21:20:00Z', '%Y-%m-%dT%H:%M:%SZ')
     assert_equal local.to_i, timezone.time(utc).to_i
   end
   
   def test_loading_half_hour_timezone
-    timezone = Timezone.new :zone => 'Asia/Kathmandu'
+    timezone = Timezone::Zone.new :zone => 'Asia/Kathmandu'
     utc = Time.utc(2011, 1, 4, 3, 51, 29)
     local = Time.utc(2011, 1, 4, 9, 36, 29)
     assert_equal local.to_i, timezone.time(utc).to_i
@@ -42,12 +45,12 @@ class TimezoneTest < Test::Unit::TestCase
   
   def test_using_lat_lon_coordinates
     Timezone::Configure.begin { |c| c.username = 'timezone' }
-    timezone = Timezone.new :latlon => [-34.92771808058, 138.477041423321]
+    timezone = Timezone::Zone.new :latlon => [-34.92771808058, 138.477041423321]
     assert_equal 'Australia/Adelaide', timezone.zone
   end
   
   def test_australian_timezone_with_dst
-    timezone = Timezone.new :zone => 'Australia/Adelaide'
+    timezone = Timezone::Zone.new :zone => 'Australia/Adelaide'
     utc = Time.utc(2010, 12, 23, 19, 37, 15)
     local = Time.utc(2010, 12, 24, 6, 7, 15)
     assert_equal local.to_i, timezone.time(utc).to_i

metadata

@@ -2,7 +2,7 @@
 name: timezone
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Pan Thomakos
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -08:00
+date: 2011-02-12 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -490,7 +490,10 @@ files:
 - data/Pacific/Wallis.json
 - data/WET.json
 - lib/timezone.rb
+- lib/timezone/configure.rb
+- lib/timezone/error.rb
 - lib/timezone/version.rb
+- lib/timezone/zone.rb
 - test/timezone_test.rb
 - timezone.gemspec
 has_rdoc: true
@@ -520,6 +523,6 @@ rubyforge_project: timezone
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: timezone-0.0.3
+summary: timezone-0.1.0
 test_files: 
 - test/timezone_test.rb