Class: Georeference::GeoLocate::Request

Inherits:
Object
  • Object
show all
Defined in:
app/models/georeference/geo_locate.rb

Constant Summary collapse

REQUEST_PARAMS = 
{
  country:      nil, # name of a country 'USA', or Germany
  state:        nil, # 'IL', or 'illinois' (required in the United States)
  county:       nil, # supply as a parameter, returned as 'Adm='
  locality:     nil, # name of a place 'CHAMPAIGN' (or building, i.e. 'Eiffel Tower')
  enableH2O:    'false',
  hwyX:         'false',
  doUncert:     'true',
  doPoly:       'false',
  displacePoly: 'false',
  languageKey:  '0',
  fmt:          'json' # or geojson ?
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_params) ⇒ Request

Returns a new instance of Request.

Parameters:

  • request_params (ActionController::Parameters) 


302
303
304
305
 
# File 'app/models/georeference/geo_locate.rb', line 302

def initialize(request_params)
  @request_params = REQUEST_PARAMS.merge(request_params)
  @succeeded      = nil
end

Instance Attribute Details

#request_param_string ⇒ Object (readonly)

Returns the value of attribute request_param_string.



299
300
301
 
# File 'app/models/georeference/geo_locate.rb', line 299

def request_param_string
  @request_param_string
end

#request_params ⇒ Object (readonly)

Returns the value of attribute request_params.



299
300
301
 
# File 'app/models/georeference/geo_locate.rb', line 299

def request_params
  @request_params
end

#response ⇒ Georeference::GeoLocate::Response (readonly)

Returns:



329
330
331
 
# File 'app/models/georeference/geo_locate.rb', line 329

def response
  @response
end

#succeeded ⇒ Object

Returns the value of attribute succeeded.



298
299
300
 
# File 'app/models/georeference/geo_locate.rb', line 298

def succeeded
  @succeeded
end

Instance Method Details

#build_param_string ⇒ Object

sets the @request_param_string attribute.



313
314
315
 
# File 'app/models/georeference/geo_locate.rb', line 313

def build_param_string
  @request_param_string ||= @request_params.collect { |key, value| "#{key}=#{value}" }.join('&')
end

#locate ⇒ Object

sets the response attribute.



308
309
310
 
# File 'app/models/georeference/geo_locate.rb', line 308

def locate
  @response = Georeference::GeoLocate::Response.new(self)
end

#request_string ⇒ String

Returns api request string.

Returns:

  • (String) —

    api request string.



318
319
320
321
 
# File 'app/models/georeference/geo_locate.rb', line 318

def request_string
  build_param_string
  API_PATH + @request_param_string
end

#succeeded? ⇒ Boolean

Returns true if request was successful.

Returns:

  • (Boolean) —

    true if request was successful



324
325
326
 
# File 'app/models/georeference/geo_locate.rb', line 324

def succeeded?
  @succeeded
end