def __init__(self,
url,
version='1.0.0',
xml=None,
username=None,
password=None):
"""Initialize."""
self.url = url
self.username = username
self.password = password
self.version = version
self._capabilities = None
# Authentication handled by Reader
reader = SosCapabilitiesReader(version=self.version,
url=self.url,
username=self.username,
password=self.password)
if xml: # read from stored xml
self._capabilities = reader.read_string(xml)
else: # read from server
self._capabilities = reader.read(self.url)
# Avoid building metadata if the response is an Exception
if self._capabilities.tag == nspath_eval("ows:ExceptionReport",
namespaces):
raise ows.ExceptionReport(self._capabilities)
# build metadata objects
self._build_metadata()
def _parse_response(self, response):
'''parse in-memory xml string from a file obj or _invoke
'''
# parse result see if it's XML
self._exml = etree.parse(StringIO.StringIO(response))
# it's XML. Attempt to decipher whether the XML response is CSW-ish """
valid_xpaths = [
util.nspath_eval('ows:ExceptionReport', namespaces),
util.nspath_eval('csw:Capabilities', namespaces),
util.nspath_eval('csw:DescribeRecordResponse', namespaces),
util.nspath_eval('csw:GetDomainResponse', namespaces),
util.nspath_eval('csw:GetRecordsResponse', namespaces),
util.nspath_eval('csw:GetRecordByIdResponse', namespaces),
util.nspath_eval('csw:HarvestResponse', namespaces),
util.nspath_eval('csw:TransactionResponse', namespaces)
]
if self._exml.getroot().tag not in valid_xpaths:
raise RuntimeError('Document is XML, but not CSW-ish')
# check if it's an OGC Exception
val = self._exml.find(util.nspath_eval('ows:Exception', namespaces))
if val is not None:
raise ows.ExceptionReport(self._exml, self.owscommon.namespace)
else:
self.exceptionreport = None
def describe_sensor(self,
outputFormat=None,
procedure=None,
method='Get',
**kwargs):
try:
base_url = next(
(m.get('url')
for m in self.getOperationByName('DescribeSensor').methods
if m.get('type').lower() == method.lower()))
except StopIteration:
base_url = self.url
request = {
'service': 'SOS',
'version': self.version,
'request': 'DescribeSensor'
}
# Required Fields
assert isinstance(outputFormat, str)
request['outputFormat'] = outputFormat
assert isinstance(procedure, str)
request['procedure'] = procedure
url_kwargs = {}
if 'timeout' in kwargs:
url_kwargs['timeout'] = kwargs.pop(
'timeout') # Client specified timeout value
# Optional Fields
if kwargs:
for kw in kwargs:
request[kw] = kwargs[kw]
data = urlencode(request)
response = openURL(base_url,
data,
method,
username=self.username,
password=self.password,
**url_kwargs).read()
tr = etree.fromstring(response)
if tr.tag == nspath_eval("ows:ExceptionReport", namespaces):
raise ows.ExceptionReport(tr)
return response
def get_observation(self,
responseFormat=None,
offerings=None,
observedProperties=None,
eventTime=None,
method='Get',
**kwargs):
"""
Parameters
----------
format : string
Output format. Provide one that is available for all offerings
method : string
Optional. HTTP DCP method name: Get or Post. Must
**kwargs : extra arguments
anything else e.g. vendor specific parameters
"""
try:
base_url = next(
(m.get('url')
for m in self.getOperationByName('GetObservation').methods
if m.get('type').lower() == method.lower()))
except StopIteration:
base_url = self.url
request = {
'service': 'SOS',
'version': self.version,
'request': 'GetObservation'
}
# Required Fields
assert isinstance(offerings, list) and len(offerings) > 0
request['offering'] = ','.join(offerings)
assert isinstance(observedProperties,
list) and len(observedProperties) > 0
request['observedProperty'] = ','.join(observedProperties)
assert isinstance(responseFormat, str)
request['responseFormat'] = responseFormat
# Optional Fields
if eventTime is not None:
request['eventTime'] = eventTime
url_kwargs = {}
if 'timeout' in kwargs:
url_kwargs['timeout'] = kwargs.pop(
'timeout') # Client specified timeout value
if kwargs:
for kw in kwargs:
request[kw] = kwargs[kw]
data = urlencode(request)
response = openURL(base_url,
data,
method,
username=self.username,
password=self.password,
**url_kwargs).read()
try:
tr = etree.fromstring(response)
if tr.tag == nspath_eval("ows:ExceptionReport", namespaces):
raise ows.ExceptionReport(tr)
else:
return response
except ows.ExceptionReport:
raise
except BaseException:
return response