# =================================================================
#
# Authors: Rob van Loon <borrob@me.com>
#
# Copyright (c) 2021 Rob van Loon
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================
from GeoHealthCheck.geocoder import Geocoder
[docs]class FixedLocation(Geocoder):
"""
Spoof getting a geolocation for a server by provinding a fixed lat, lon
result. The lat, lon can be specified in the initialisation parameters.
When omitted: default to 0, 0.
"""
NAME = 'Fixed geolocation'
DESCRIPTION = 'Geolocator service returning a fixed position (so ' \
'actually no real geolocation).'
LATITUDE = 0
"""
Parameter with the default latitude position. This is overruled when the
latitude option is provided in the init step.
"""
LONGITUDE = 0
"""
Parameter with the default longitude position. This is overruled when the
longitude option is provided in the init step.
"""
def __init__(self):
super().__init__()
self._lat = self.LATITUDE
self._lon = self.LONGITUDE
[docs] def init(self, geocode_vars={}):
"""
Initialise the geocoder service with an optional dictionary.
When the dictionary contains the element `lat` and/or `lon`, then these
values are used to position the server.
"""
super().init(geocode_vars)
self._lat = geocode_vars.get('lat', self.LATITUDE)
self._lon = geocode_vars.get('lon', self.LONGITUDE)
[docs] def locate(self, _=None):
"""
Perform a geocoding to locate a server. In this case it will render a
fixed position, so provinding the adress of the server is optional.
"""
return (self._lat, self._lon)