Class: Eztz::TimeZoneResponse

Inherits:

Object

• Object
• Eztz::TimeZoneResponse

Defined in:

lib/eztz/response.rb

Overview

Encapsulates the data from the timezone api

Instance Attribute Summary

• #dst_offset ⇒ Integer readonly

  The offset for daylight-savings time in seconds.

• #error_message ⇒ String readonly

  More detailed information about the reasons behind the given status code, if other than OK.

• #id ⇒ String readonly

  A string containing the ID of the time zone, such as “America/Los_Angeles” or “Australia/Sydney”.

• #name ⇒ String readonly

  A string containing the long form name of the time zone.

• #raw_offset ⇒ Integer readonly

  The offset from UTC (in seconds) for the given location.

• #status ⇒ String readonly

  A string indicating the status of the response.

• #timestamp ⇒ Object readonly

  Returns the value of attribute timestamp.

Instance Method Summary

• #initialize(timestamp, response) ⇒ TimeZoneResponse constructor

  A new instance of TimeZoneResponse.

• #local_time ⇒ Time

  The local time of the location is the sum of the :timestamp, :dst_offset and :raw_offset.

• #success? ⇒ Boolean
• #to_h ⇒ Hash

  The object as a Hash.

Constructor Details

#initialize(timestamp, response) ⇒ TimeZoneResponse

# File 'lib/eztz/response.rb', line 43

def initialize(timestamp, response)
  @timestamp = timestamp
  @dst_offset, @error_message, @raw_offset, @status, @id, @name =
    response.values_at(
      'dstOffset', 'error_message', 'rawOffset', 'status', 'timeZoneId',
      'timeZoneName'
    )
end

Instance Attribute Details

#dst_offset ⇒ Integer (readonly)

# File 'lib/eztz/response.rb', line 38

def dst_offset
  @dst_offset
end

#error_message ⇒ String (readonly)

# File 'lib/eztz/response.rb', line 38

attr_reader :dst_offset, :error_message, :id, :name,
:raw_offset, :status, :timestamp

#id ⇒ String (readonly)

# File 'lib/eztz/response.rb', line 38

attr_reader :dst_offset, :error_message, :id, :name,
:raw_offset, :status, :timestamp

#name ⇒ String (readonly)

# File 'lib/eztz/response.rb', line 38

attr_reader :dst_offset, :error_message, :id, :name,
:raw_offset, :status, :timestamp

#raw_offset ⇒ Integer (readonly)

# File 'lib/eztz/response.rb', line 38

attr_reader :dst_offset, :error_message, :id, :name,
:raw_offset, :status, :timestamp

#status ⇒ String (readonly)

# File 'lib/eztz/response.rb', line 38

attr_reader :dst_offset, :error_message, :id, :name,
:raw_offset, :status, :timestamp

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.

# File 'lib/eztz/response.rb', line 38

attr_reader :dst_offset, :error_message, :id, :name,
:raw_offset, :status, :timestamp

Instance Method Details

#local_time ⇒ Time

The local time of the location is the sum of the :timestamp, :dst_offset and :raw_offset.

# File 'lib/eztz/response.rb', line 59

def local_time
  Time.at(timestamp.to_i + dst_offset.to_i + raw_offset.to_i)
end

#success? ⇒ Boolean

# File 'lib/eztz/response.rb', line 52

def success?
  status == 'OK'
end

#to_h ⇒ Hash

The object as a Hash.

# File 'lib/eztz/response.rb', line 65

def to_h
  {
    dst_offset:    dst_offset,
    error_message: error_message,
    id:            id,
    name:          name,
    raw_offset:    raw_offset,
    status:        status,
    timestamp:     timestamp
  }
end