Class: GoogleMapsPlatform::ElevationStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/google_maps_platform/models/elevation_status.rb

Overview

Status codes returned by service. - OK indicating the API request was successful. - DATA_NOT_AVAILABLE indicating that there’s no available data for the input locations. - INVALID_REQUEST indicating the API request was malformed. - OVER_DAILY_LIMIT indicating any of the following: - The API key is missing or invalid. - Billing has not been enabled on your account.

- A self-imposed usage cap has been exceeded.   - The provided method of

payment is no longer valid (for example, a credit card has expired). - OVER_QUERY_LIMIT indicating the requestor has exceeded quota. - REQUEST_DENIED indicating the API did not complete the request. - UNKNOWN_ERROR indicating an unknown error.

Constant Summary collapse

ELEVATION_STATUS = 
[
  # TODO: Write general description for OK
  OK = 'OK'.freeze,

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = OK) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/google_maps_platform/models/elevation_status.rb', line 47

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

  str = value.to_s.strip

  case str.downcase
  when 'ok' then OK
  when 'data_not_available' then DATA_NOT_AVAILABLE
  when 'invalid_request' then INVALID_REQUEST
  when 'over_daily_limit' then OVER_DAILY_LIMIT
  when 'over_query_limit' then OVER_QUERY_LIMIT
  when 'request_denied' then REQUEST_DENIED
  when 'unknown_error' then UNKNOWN_ERROR
  else
    default_value
  end
end

.validate(value) ⇒ Object 



41
42
43
44
45
 
# File 'lib/google_maps_platform/models/elevation_status.rb', line 41

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

  ELEVATION_STATUS.include?(value)
end