Class: GoogleMapsPlatform::PlacesDetailsStatus

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

Overview

Status codes returned by service. - OK indicating the API request was successful. - ZERO_RESULTS indicating that the referenced location, place_id, was valid but no longer refers to a valid result. This may occur if the establishment is no longer in business. - NOT_FOUND indicating that that the referenced location, place_id, was not found in the Places database. - INVALID_REQUEST indicating the API request was malformed. - OVER_QUERY_LIMIT indicating any of the following: - You have exceeded the QPS limits. - Billing has not been enabled on your account. - The monthly $200 credit, or a self-imposed usage cap, has been exceeded. - The provided method of payment is no longer valid (for example, a credit card has expired). See the [Maps FAQ](developers.google.com/maps/faq#over-limit-key-error) for more information about how to resolve this error. - REQUEST_DENIED indicating that your request was denied, generally because: - The request is missing an API key. - The key parameter is invalid. - UNKNOWN_ERROR indicating an unknown error.

Constant Summary collapse

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

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

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

  # TODO: Write general description for NOT_FOUND
  NOT_FOUND = 'NOT_FOUND'.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 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/google_maps_platform/models/places_details_status.rb', line 53

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 'zero_results' then ZERO_RESULTS
  when 'invalid_request' then INVALID_REQUEST
  when 'not_found' then NOT_FOUND
  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 



47
48
49
50
51
 
# File 'lib/google_maps_platform/models/places_details_status.rb', line 47

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

  PLACES_DETAILS_STATUS.include?(value)
end