Class: UspsApi::TrackingEventType

Inherits:
Object
  • Object
show all
Defined in:
lib/usps_api/models/tracking_event_type.rb

Overview

TrackingEventType.

Constant Summary collapse

TRACKING_EVENT_TYPE = 
[
  # TODO: Write general description for ALL
  ALL = 'ALL'.freeze,

  # TODO: Write general description for PACKAGE_DELIVERED
  PACKAGE_DELIVERED = 'PACKAGE_DELIVERED'.freeze,

  # TODO: Write general description for AVAILABLE_FOR_PICKUP
  AVAILABLE_FOR_PICKUP = 'AVAILABLE_FOR_PICKUP'.freeze,

  # TODO: Write general description for DELIVERY_EXCEPTION_UPDATES
  DELIVERY_EXCEPTION_UPDATES = 'DELIVERY_EXCEPTION_UPDATES'.freeze,

  # TODO: Write general description for PACKAGE_IN_TRANSIT_UPDATES
  PACKAGE_IN_TRANSIT_UPDATES = 'PACKAGE_IN_TRANSIT_UPDATES'.freeze,

  # TODO: Write general description for PACKAGE_DELAYED
  PACKAGE_DELAYED = 'PACKAGE_DELAYED'.freeze,

  # TODO: Write general description for DEFAULT
  DEFAULT = 'DEFAULT'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ALL) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/usps_api/models/tracking_event_type.rb', line 38

def self.from_value(value, default_value = ALL)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'all' then ALL
  when 'package_delivered' then PACKAGE_DELIVERED
  when 'available_for_pickup' then AVAILABLE_FOR_PICKUP
  when 'delivery_exception_updates' then DELIVERY_EXCEPTION_UPDATES
  when 'package_in_transit_updates' then PACKAGE_IN_TRANSIT_UPDATES
  when 'package_delayed' then PACKAGE_DELAYED
  when 'default' then DEFAULT
  else
    default_value
  end
end

.validate(value) ⇒ Object 



32
33
34
35
36
 
# File 'lib/usps_api/models/tracking_event_type.rb', line 32

def self.validate(value)
  return false if value.nil?

  TRACKING_EVENT_TYPE.include?(value)
end