Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RequestHandlerDelegate.contentTypes and RequestHandler.links #8

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

RequestHandlerDelegate.contentTypes and RequestHandler.links #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e00020
Add RequestHandlerDelegate.contentTypes to return the list of content…
rldhont Sep 3, 2021
33d1ae1
Add RequestHandler.links to get the self and alternate links for the …
rldhont Sep 3, 2021
4f466fc
Use RequestHandler.links method in cache manager API
rldhont Sep 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 28 additions & 12 deletions tests/test_wmts_cachemngrapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@ def test_wmts_cachemngrapi_empty_cache(client):

json_content = json.loads(rv.content)
assert 'links' in json_content
assert len(json_content['links']) == 1
assert json_content['links'][0]['title'] == 'Cache collections'
assert len(json_content['links']) == 2
assert json_content['links'][0]['title'] == 'WMTS Cache manager LandingPage as JSON'
assert json_content['links'][0]['rel'] == 'self'
assert json_content['links'][1]['title'] == 'WMTS Cache manager Collections as JSON'
assert json_content['links'][1]['rel'] == 'data'

qs = "/wmtscache/collections"
rv = client.get(qs)
Expand All @@ -47,6 +50,9 @@ def test_wmts_cachemngrapi_empty_cache(client):
assert 'collections' in json_content
assert len(json_content['collections']) == 0
assert 'links' in json_content
assert len(json_content['links']) == 1
assert json_content['links'][0]['title'] == 'WMTS Cache manager Collections as JSON'
assert json_content['links'][0]['rel'] == 'self'


def test_wmts_cachemngrapi_cache_info(client):
Expand Down Expand Up @@ -112,7 +118,7 @@ def test_wmts_cachemngrapi_cache_info(client):
"TILEMATRIX": "0",
"TILEROW": "0",
"TILECOL": "0",
"FORMAT": "image/png"
"FORMAT": "image/png"
}

# Get the cached path from the request parameters
Expand Down Expand Up @@ -148,7 +154,9 @@ def test_wmts_cachemngrapi_cache_info(client):
assert len(json_content['collections']) == 1

assert 'links' in json_content
assert len(json_content['links']) == 0
assert len(json_content['links']) == 1
assert json_content['links'][0]['title'] == 'WMTS Cache manager Collections as JSON'
assert json_content['links'][0]['rel'] == 'self'

collection = json_content['collections'][0]
assert 'id' in collection
Expand All @@ -169,7 +177,9 @@ def test_wmts_cachemngrapi_cache_info(client):
assert json_content['project'] == client.getprojectpath("france_parts.qgs").strpath

assert 'links' in json_content
assert len(json_content['links']) == 2
assert len(json_content['links']) == 3
assert json_content['links'][0]['title'] == 'WMTS Cache manager ProjectCollection as JSON'
assert json_content['links'][0]['rel'] == 'self'

qs = "/wmtscache/collections/{}/docs".format(collection['id'])
rv = client.get(qs)
Expand All @@ -187,7 +197,9 @@ def test_wmts_cachemngrapi_cache_info(client):
assert json_content['documents'] == 1

assert 'links' in json_content
assert len(json_content['links']) == 0
assert len(json_content['links']) == 1
assert json_content['links'][0]['title'] == 'WMTS Cache manager DocumentCollection as JSON'
assert json_content['links'][0]['rel'] == 'self'

qs = "/wmtscache/collections/{}/layers".format(collection['id'])
rv = client.get(qs)
Expand All @@ -205,7 +217,9 @@ def test_wmts_cachemngrapi_cache_info(client):
assert len(json_content['layers']) == 1

assert 'links' in json_content
assert len(json_content['links']) == 0
assert len(json_content['links']) == 1
assert json_content['links'][0]['title'] == 'WMTS Cache manager LayerCollection as JSON'
assert json_content['links'][0]['rel'] == 'self'

layer = json_content['layers'][0]
assert 'id' in layer
Expand All @@ -221,7 +235,9 @@ def test_wmts_cachemngrapi_cache_info(client):
assert json_content['id'] == layer['id']

assert 'links' in json_content
assert len(json_content['links']) == 0
assert len(json_content['links']) == 1
assert json_content['links'][0]['title'] == 'WMTS Cache manager LayerCache as JSON'
assert json_content['links'][0]['rel'] == 'self'


def test_wmts_cachemngrapi_delete_docs(client):
Expand Down Expand Up @@ -356,7 +372,7 @@ def test_wmts_cachemngrapi_delete_layer(client):
"TILEMATRIX": "0",
"TILEROW": "0",
"TILECOL": "0",
"FORMAT": "image/png"
"FORMAT": "image/png"
}

# Get the cached path from the request parameters
Expand Down Expand Up @@ -478,7 +494,7 @@ def test_wmts_cachemngrapi_delete_layers(client):
"TILEMATRIX": "0",
"TILEROW": "0",
"TILECOL": "0",
"FORMAT": "image/png"
"FORMAT": "image/png"
}

# Get the cached path from the request parameters
Expand Down Expand Up @@ -610,7 +626,7 @@ def test_wmts_cachemngrapi_delete_collection(client):
"TILEMATRIX": "0",
"TILEROW": "0",
"TILECOL": "0",
"FORMAT": "image/png"
"FORMAT": "image/png"
}

# Get the cached path from the request parameters
Expand Down Expand Up @@ -746,7 +762,7 @@ def test_wmts_cachemngrapi_layerid_error(client):
"TILEMATRIX": "0",
"TILEROW": "0",
"TILECOL": "0",
"FORMAT": "image/png"
"FORMAT": "image/png"
}

# Get the cached path from the request parameters
Expand Down
34 changes: 28 additions & 6 deletions wmtsCacheServer/apiutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,25 @@ def prepare(self, **values):
pass

def href(self, path: str="", extension: str="") -> str:
""" Returns an URL to self, to be used for links to the current resources
""" Returns an URL to self, to be used for links to the current resources
and as a base for constructing links to sub-resources
"""
return self._parent.href(self._context,path,extension)
return self._parent.href(self._context, path, extension)

def links(self) -> List[str]:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no point to implement this here, apiutils is not a global library and will never be one because of the way Qgis plugin are distributed (with no dependencies)

"""Returns the self and alternate links for the given request
QgsServerOgcApiHandler::links not available in Python bindings
"""
links = list()
current_ct = self._parent.contentTypeFromRequest(self._request)
for ct in self._parent.contentTypes():
links.append({
'href': self.href('', QgsServerOgcApi.contentTypeToExtension(ct) if ct != QgsServerOgcApi.JSON else ''),
'rel': QgsServerOgcApi.relToString(QgsServerOgcApi.self if ct == current_ct else QgsServerOgcApi.alternate),
"type": QgsServerOgcApi.mimeType(ct),
"title": self._parent.linkTitle()+' as '+QgsServerOgcApi.contentTypeToString(ct),
})
return links

def finish(self, chunk: Optional[Union[str, bytes, dict]] = None) -> None:
""" Terminate the request
Expand Down Expand Up @@ -113,10 +128,10 @@ def send_error(self, status_code: int = 500, **kwargs: Any) -> None:
self.write(dict(status="error" if status_code != 200 else "ok",
httpcode = status_code,
error = { "message": self._reason }))

if status_code > 300:
QgsMessageLog.logMessage(f"Returned HTTP Error {status_code}: {self._reason}" ,"wmtsCacheApi",Qgis.Critical)

if not self._finished:
self.finish()

Expand Down Expand Up @@ -181,23 +196,30 @@ class RequestHandlerDelegate(QgsServerOgcApiHandler):
"""

# XXX We need to preserve instances from garbage
# collection
# collection
__instances = []

def __init__(self, path: str, handler: Type[RequestHandler],
content_types=[QgsServerOgcApi.JSON,],
kwargs: Dict={}):

super().__init__()
self._content_types = []
if content_types:
self.setContentTypes(content_types)
self._content_types = content_types
self._path = QRegularExpression(path)
self._name = handler.__name__
self._handler = handler
self._kwargs = kwargs

self.__instances.append(self)

def contentTypes(self):
""" QgsServerOgcApiHandler::contentTypes not available in Python bindings
"""
return self._content_types

def path(self):
return self._path

Expand All @@ -224,7 +246,7 @@ def parameters(self, context):
return []

def handleRequest(self, context):
"""
"""
"""
handler = self._handler(self,context)
handler.initialize(**self._kwargs)
Expand Down
Loading