class EarthTools::Result::TimeZone

The Time Zone result.

@see www.earthtools.org/webservices.htm#timezone

Public Instance Methods

dst() click to toggle source

Whether or not the {#local_time} and {#iso_time} is currently in DST. If they do, the value of this element will be ‘True’. If they do not, the value will be ‘False’. If it can’t be determined whether or not daylight saving time should be used, the value will be ‘Unknown’. @return [String] ‘True’ || ‘False’ || ‘Unknown’

# File lib/earth_tools/result/time_zone.rb, line 14
def dst
  @data['dst']
end
dst?() click to toggle source

Whether or not the {#local_time} and {#iso_time} is currently in DST @return [boolean] true || false || nil

# File lib/earth_tools/result/time_zone.rb, line 21
def dst?
  case dst
  when 'True' then 
    true
  when 'False'
    false
  else
    nil
  end
end
iso_time() click to toggle source

The same value as {#local_time} but in ISO 8601 format instead See {en.wikipedia.org/wiki/ISO_8601}. @return [String] the ISO time

# File lib/earth_tools/result/time_zone.rb, line 36
def iso_time
  create_time @data['isotime']
end
local_time() click to toggle source

The local time taking into account the time zone offset and any local daylight saving time in effect @return [String] the local time

# File lib/earth_tools/result/time_zone.rb, line 43
def local_time
  iso_time
end
suffix() click to toggle source

The nautical suffix for the time zone See {en.wikipedia.org/wiki/Nautical_time} @return [String] the nautical suffix for the time zone

# File lib/earth_tools/result/time_zone.rb, line 59
def suffix
  @data['suffix']
end
utc_offset() click to toggle source

The number of hours offset from UTC disregarding any correction for daylight saving time See {en.wikipedia.org/wiki/UTC_offset}. @return [Integer] the UTC offset

# File lib/earth_tools/result/time_zone.rb, line 51
def utc_offset
  @data['offset'].to_i
end
utc_time() click to toggle source

The reference UTC time See {en.wikipedia.org/wiki/Coordinated_Universal_Time}. @return [String] the UTC time

# File lib/earth_tools/result/time_zone.rb, line 67
def utc_time
  create_time @data['utctime'], "%Y-%m-%d %H:%M:%S"
end

Private Instance Methods

create_time(time, format = "%Y-%m-%d %H:%M:%S %z") click to toggle source
# File lib/earth_tools/result/time_zone.rb, line 73
def create_time(time, format = "%Y-%m-%d %H:%M:%S %z")
  require 'date'
  DateTime.strptime(time, format).to_time
end