ckanext-versioned-tiledmap 2.3.0__tar.gz → 2.3.2__tar.gz

{ckanext_versioned_tiledmap-2.3.0/ckanext_versioned_tiledmap.egg-info → ckanext_versioned_tiledmap-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ckanext-versioned-tiledmap
-Version: 2.3.0
+Version: 2.3.2
 Summary: A CKAN extension with a map view for versioned-datastore backed resources.
 Author-email: Natural History Museum <data@nhm.ac.uk>
 License: GPL-3.0-or-later
@@ -19,6 +19,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ckanext-versioned-datastore>=3.7.0
 Requires-Dist: ckantools>=0.3.0
+Requires-Dist: cachetools>=4.2.4
 Provides-Extra: test
 Requires-Dist: mock; extra == "test"
 Requires-Dist: pytest>=4.6.5; extra == "test"
@@ -154,7 +155,7 @@ To run the tests against ckan 2.9.x on Python3:
 
 1. Build the required images:
    ```shell
-   docker-compose build
+   docker compose build
    ```
 
 2. Then run the tests.
@@ -162,7 +163,7 @@ To run the tests against ckan 2.9.x on Python3:
    configuration, so you should only need to rebuild the ckan image if you change the extension's
    dependencies.
    ```shell
-   docker-compose run ckan
+   docker compose run ckan
    ```
 
 <!--testing-end-->

{ckanext_versioned_tiledmap-2.3.0 → ckanext_versioned_tiledmap-2.3.2}/README.md

@@ -127,7 +127,7 @@ To run the tests against ckan 2.9.x on Python3:
 
 1. Build the required images:
    ```shell
-   docker-compose build
+   docker compose build
    ```
 
 2. Then run the tests.
@@ -135,7 +135,7 @@ To run the tests against ckan 2.9.x on Python3:
    configuration, so you should only need to rebuild the ckan image if you change the extension's
    dependencies.
    ```shell
-   docker-compose run ckan
+   docker compose run ckan
    ```
 
 <!--testing-end-->

ckanext_versioned_tiledmap-2.3.2/ckanext/tiledmap/lib/utils.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+# encoding: utf-8
+#
+# This file is part of a project
+# Created by the Natural History Museum in London, UK
+
+from ckan.plugins import toolkit
+import urllib.request
+from cachetools import cached, TTLCache
+
+
+def get_resource_datastore_fields(resource_id):
+    data = {'resource_id': resource_id, 'limit': 0}
+    all_fields = toolkit.get_action('datastore_search')({}, data)['fields']
+    return set(field['id'] for field in all_fields)
+
+
+@cached(cache=TTLCache(maxsize=10, ttl=300))
+def get_tileserver_status():
+    tileserver_url = toolkit.config.get('versioned_tilemap.tile_server')
+
+    tileserver_response_text = 'unknown'
+
+    if tileserver_url:
+        try:
+            with urllib.request.urlopen(tileserver_url + '/status') as response:
+                tileserver_response = response.read().decode()
+        except Exception as e:
+            tileserver_response = ''
+        if tileserver_response == 'OK':
+            tileserver_response_text = 'available'
+        else:
+            tileserver_response_text = 'unavailable'
+
+    return tileserver_response_text

{ckanext_versioned_tiledmap-2.3.0 → ckanext_versioned_tiledmap-2.3.2}/ckanext/tiledmap/plugin.py

@@ -11,7 +11,7 @@ from ckanext.tiledmap import routes
 from ckanext.tiledmap.config import config as plugin_config
 from ckanext.tiledmap.lib import validators
 from ckanext.tiledmap.lib.helpers import mustache_wrapper, dwc_field_title
-from ckanext.tiledmap.lib.utils import get_resource_datastore_fields
+from ckanext.tiledmap.lib.utils import get_resource_datastore_fields, get_tileserver_status
 import urllib.request
 
 try:
@@ -160,28 +160,24 @@ class VersionedTiledMapPlugin(SingletonPlugin):
 
     ## IStatus
     def modify_status_reports(self, status_reports):
-        tileserver_url = toolkit.config.get('versioned_tilemap.tile_server')
-
-        tileserver_text = toolkit._('unknown')
-        tileserver_state = 'neutral'
-
-        if tileserver_url:
-            try:
-                with urllib.request.urlopen(tileserver_url + '/status') as response:
-                    tileserver_response = response.read().decode()
-            except Exception as e:
-                tileserver_response = ''
-            if tileserver_response == 'OK':
-                tileserver_text = toolkit._('available')
-                tileserver_state = 'good'
-            else:
-                tileserver_text = toolkit._('unavailable')
-                tileserver_state = 'bad'
+        tileserver_text = get_tileserver_status()
+
+        # report_value should be the same as toolkit._(tileserver_text) but is defined
+        # explicitly just in case it's returning something unexpected
+        if tileserver_text == 'unknown':
+            report_value = toolkit._('unknown')
+            tileserver_state = 'neutral'
+        elif tileserver_text == 'available':
+            report_value = toolkit._('available')
+            tileserver_state = 'good'
+        else:
+            report_value = toolkit._('unavailable')
+            tileserver_state = 'bad'
 
         status_reports.append(
             {
                 'label': toolkit._('Maps'),
-                'value': tileserver_text,
+                'value': report_value,
                 'help': toolkit._(
                     'Connection to the server that plots data points on maps'
                 ),

{ckanext_versioned_tiledmap-2.3.0 → ckanext_versioned_tiledmap-2.3.2/ckanext_versioned_tiledmap.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ckanext-versioned-tiledmap
-Version: 2.3.0
+Version: 2.3.2
 Summary: A CKAN extension with a map view for versioned-datastore backed resources.
 Author-email: Natural History Museum <data@nhm.ac.uk>
 License: GPL-3.0-or-later
@@ -19,6 +19,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ckanext-versioned-datastore>=3.7.0
 Requires-Dist: ckantools>=0.3.0
+Requires-Dist: cachetools>=4.2.4
 Provides-Extra: test
 Requires-Dist: mock; extra == "test"
 Requires-Dist: pytest>=4.6.5; extra == "test"
@@ -154,7 +155,7 @@ To run the tests against ckan 2.9.x on Python3:
 
 1. Build the required images:
    ```shell
-   docker-compose build
+   docker compose build
    ```
 
 2. Then run the tests.
@@ -162,7 +163,7 @@ To run the tests against ckan 2.9.x on Python3:
    configuration, so you should only need to rebuild the ckan image if you change the extension's
    dependencies.
    ```shell
-   docker-compose run ckan
+   docker compose run ckan
    ```
 
 <!--testing-end-->

{ckanext_versioned_tiledmap-2.3.0 → ckanext_versioned_tiledmap-2.3.2}/ckanext_versioned_tiledmap.egg-info/requires.txt

@@ -1,5 +1,6 @@
 ckanext-versioned-datastore>=3.7.0
 ckantools>=0.3.0
+cachetools>=4.2.4
 
 [test]
 mock

{ckanext_versioned_tiledmap-2.3.0 → ckanext_versioned_tiledmap-2.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ckanext-versioned-tiledmap"
-version = "2.3.0"
+version = "2.3.2"
 description = "A CKAN extension with a map view for versioned-datastore backed resources."
 readme = "README.md"
 requires-python = ">=3.6"
@@ -20,7 +20,8 @@ classifiers = [
 ]
 dependencies = [
     "ckanext-versioned-datastore>=3.7.0",
-    "ckantools>=0.3.0"
+    "ckantools>=0.3.0",
+    "cachetools>=4.2.4"
 ]
 
 [project.optional-dependencies]
@@ -56,7 +57,7 @@ exclude = ["tests", "docs"]
 
 [tool.commitizen]
 name = "cz_nhm"
-version = "2.3.0"
+version = "2.3.2"
 tag_format = "v$version"
 update_changelog_on_bump = true
 changelog_incremental = true

ckanext_versioned_tiledmap-2.3.0/ckanext/tiledmap/lib/utils.py

@@ -1,13 +0,0 @@
-#!/usr/bin/env python
-# encoding: utf-8
-#
-# This file is part of a project
-# Created by the Natural History Museum in London, UK
-
-from ckan.plugins import toolkit
-
-
-def get_resource_datastore_fields(resource_id):
-    data = {'resource_id': resource_id, 'limit': 0}
-    all_fields = toolkit.get_action('datastore_search')({}, data)['fields']
-    return set(field['id'] for field in all_fields)