Merge branch 'doorbell' into 'master'

Handle a doorbell.io configuration

Closes #681

See merge request !1276

arkindex/project/config.py

@@ -75,6 +75,10 @@ def get_settings_parser(base_dir):
     influxdb_parser = parser.add_subparser('influxdb', default={})
     influxdb_parser.add_option('api_url', type=str, default='http://localhost:8086/')
 
+    doorbell_parser = parser.add_subparser('doorbell', default={})
+    doorbell_parser.add_option('id', type=str, default=None)
+    doorbell_parser.add_option('appkey', type=str, default=None)
+
     transkribus_parser = parser.add_subparser('transkribus', default={})
     transkribus_parser.add_option('email', type=str, default=None)
     transkribus_parser.add_option('password', type=str, default=None)

arkindex/project/settings.py

@@ -527,11 +527,18 @@ MIRADOR_URL = conf['static']['mirador_url']
 UNIVERSAL_VIEWER_URL = conf['static']['universal_viewer_url']
 
 # Feature flags
-ARKINDEX_FEATURES = conf['features']
+ARKINDEX_FEATURES = {
+    **conf['features'],
+    # Enable doorbell feature if credentials are defined
+    'doorbell': bool(conf['doorbell'].get('id') and conf['doorbell'].get('appkey'))
+}
 
 SENTRY_DSN = conf['sentry']['dsn']
 FRONTEND_SENTRY_DSN = conf['sentry']['frontend_dsn']
 
+# https://doorbell.io settings
+FRONTEND_DOORBELL = conf['doorbell']
+
 # Specific setting to enable GitLab webhook when using PageKite, it should not be used in production.
 # It is used to change GitLab webhook URLs to go through a specified PageKite domain instead of localhost.
 # None by default.

arkindex/project/tests/config_samples/defaults.yaml

@@ -24,6 +24,9 @@ database:
   user: devuser
 docker:
   tasks_image: registry.gitlab.com/arkindex/tasks
+doorbell:
+  appkey: null
+  id: null
 elasticsearch:
   hosts:
   - localhost

arkindex/project/tests/config_samples/override.yaml

@@ -32,6 +32,9 @@ database:
   user: littlebobbytables
 docker:
   tasks_image: registry.gitlab.com/arkindex/stonks
+doorbell:
+  appkey: doorbellappkey
+  id: '123456'
 elasticsearch:
   hosts:
   - google

arkindex/project/views.py

@@ -36,6 +36,7 @@ class CdnHome(CachedViewMixin, TemplateView):
         ctx['version'] = settings.VERSION
         ctx['frontend_version'] = settings.FRONTEND_VERSION
         ctx['frontend_sentry_dsn'] = settings.FRONTEND_SENTRY_DSN
+        ctx['frontend_doorbell'] = settings.ARKINDEX_FEATURES['doorbell'] and settings.FRONTEND_DOORBELL
         return ctx
 
 

arkindex/templates/index.html

@@ -10,6 +10,10 @@
     {% if mirador_url %}<meta name="mirador_url" content="{{ mirador_url }}">{% endif %}
     {% if universal_viewer_url %}<meta name="universal_viewer_url" content="{{ universal_viewer_url }}">{% endif %}
     {% if frontend_sentry_dsn %}<meta name="sentry_dsn" content="{{ frontend_sentry_dsn }}">{% endif %}
+    {% if frontend_doorbell %}
+    <meta name="doorbell_id" content="{{ frontend_doorbell.id }}">
+    <meta name="doorbell_appkey" content="{{ frontend_doorbell.appkey }}">
+    {% endif %}
     <title>ArkIndex {{ frontend_version }}</title>
     <link href="{{ cdn_assets_url }}/{{ frontend_version }}/arkindex-{{ frontend_version }}.css" rel="stylesheet">
   </head>