Class: UspsApi::NonDeliveryOption

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

Overview

Requested action in the case a package is undeliverable: * RETURN for the package to be returned to ‘fromAddress`. * REDIRECT to return the package to address specified in the `redirectAddress`. * ABANDON to dispose of the undeliverable package

Constant Summary collapse

NON_DELIVERY_OPTION = 
[
  # TODO: Write general description for RETURN
  RETURN = 'RETURN'.freeze,

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = RETURN) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/usps_api/models/non_delivery_option.rb', line 29

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

  str = value.to_s.strip

  case str.downcase
  when 'return' then RETURN
  when 'redirect' then REDIRECT
  when 'abandon' then ABANDON
  else
    default_value
  end
end

.validate(value) ⇒ Object 



23
24
25
26
27
 
# File 'lib/usps_api/models/non_delivery_option.rb', line 23

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

  NON_DELIVERY_OPTION.include?(value)
end