Skip to content

Commit

Permalink
Merge pull request #211 from OnroerendErfgoed/develop
Browse files Browse the repository at this point in the history 
Develop
  • Loading branch information
@claeyswo
claeyswo authored Dec 13, 2023
2 parents 827d784 + e73fb64 commit f9ef0d8
Show file tree
Hide file tree
Showing 9 changed files with 134 additions and 1,611 deletions.
5 changes: 5 additions & 0 deletions CHANGES.rst
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
2.0.0 (13-12-2023)
------------------

- Remove crab (#208)

1.8.0 (12-12-2023)
------------------

Expand Down
218 changes: 84 additions & 134 deletions crabpy_pyramid/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
import logging
import os
from collections.abc import Sequence
from collections.abc import Sequence

from crabpy.client import AdressenRegisterClient
from crabpy.client import crab_factory
from crabpy.gateway.adressenregister import Gateway
from crabpy.gateway.capakey import CapakeyRestGateway
from crabpy.gateway.crab import CrabGateway
from pyramid.config import Configurator
from pyramid.settings import asbool
from zope.interface import Interface

from crabpy_pyramid.renderers.adressenregister import \
json_item_renderer as adresreg_json_item_renderer
from crabpy_pyramid.renderers.adressenregister import \
json_list_renderer as adresreg_json_list_renderer
from crabpy_pyramid.renderers.capakey import \
json_item_renderer as capakey_json_item_renderer
from crabpy_pyramid.renderers.capakey import \
json_list_renderer as capakey_json_list_renderer
from crabpy_pyramid.renderers.crab import json_item_renderer as crab_json_item_renderer
from crabpy_pyramid.renderers.crab import json_list_renderer as crab_json_list_renderer
from crabpy_pyramid.renderers.adressenregister import (
json_item_renderer as adresreg_json_item_renderer,
)
from crabpy_pyramid.renderers.adressenregister import (
json_list_renderer as adresreg_json_list_renderer,
)
from crabpy_pyramid.renderers.capakey import (
json_item_renderer as capakey_json_item_renderer,
)
from crabpy_pyramid.renderers.capakey import (
json_list_renderer as capakey_json_list_renderer,
)

log = logging.getLogger(__name__)
GENERATE_ETAG_ROUTE_NAMES = set()
Expand All @@ -30,69 +30,61 @@ class ICapakey(Interface):
pass


class ICrab(Interface):
pass


class IAdressenregister(Interface):
pass


def _parse_settings(settings):
defaults = {
'capakey.include': False,
'crab.include': True,
'adressenregister.include': True,
'adressenregister.base_url': 'https://api.basisregisters.vlaanderen.be',
'adressenregister.api_key': None,
'cache.file.root': '/tmp/dogpile_data',
"capakey.include": False,
"adressenregister.include": True,
"adressenregister.base_url": "https://api.basisregisters.vlaanderen.be",
"adressenregister.api_key": None,
"cache.file.root": "/tmp/dogpile_data",
}
args = defaults.copy()
if 'crabpy.adressenregister.api_key' not in settings:
if "crabpy.adressenregister.api_key" not in settings:
log.warning(
"No adressenregister.api_key set in settings. "
"The api might stop working after reaching the limit of x requests per day."
)

# booelean settings
for short_key_name in ('capakey.include', 'crab.include', 'adressenregister.include'):
for short_key_name in (
"capakey.include",
"adressenregister.include",
):
key_name = "crabpy.%s" % short_key_name
if key_name in settings:
args[short_key_name] = asbool(settings.get(
key_name, defaults.get(short_key_name)
))
args[short_key_name] = asbool(
settings.get(key_name, defaults.get(short_key_name))
)

# string setting
for short_key_name in (
'proxy.http',
'proxy.https',
'cache.file.root',
'adressenregister.base_url',
'adressenregister.api_key'
"proxy.http",
"proxy.https",
"cache.file.root",
"adressenregister.base_url",
"adressenregister.api_key",
):
key_name = "crabpy.%s" % short_key_name
if key_name in settings:
args[short_key_name] = settings.get(key_name)

# cache configuration
for short_key_name in (
'crab.cache_config',
'capakey.cache_config',
'adressenregister.cache_config'
"capakey.cache_config",
"adressenregister.cache_config",
):
key_name = "crabpy.%s." % short_key_name
cache_config = {}
for skey in settings.keys():
if skey.startswith(key_name):
cache_config[skey[len(key_name):]] = settings.get(skey)
cache_config[skey[len(key_name) :]] = settings.get(skey)
if cache_config:
args[short_key_name] = cache_config

# crab wsdl settings
for short_key_name in ('crab.wsdl',):
key_name = "crabpy.%s" % short_key_name
if key_name in settings:
args[short_key_name] = settings.get(key_name)

log.debug(settings)
log.debug(args)
return args
Expand All @@ -109,7 +101,7 @@ def _filter_settings(settings, prefix):
ret = {}
for skey in settings.keys():
if skey.startswith(prefix):
key = skey[len(prefix):]
key = skey[len(prefix) :]
ret[key] = settings[skey]
return ret

Expand All @@ -118,9 +110,9 @@ def _build_capakey(registry, settings):
capakey = registry.queryUtility(ICapakey)
if capakey is not None:
return capakey
if 'cache_config' in settings:
cache_config = settings['cache_config']
del settings['cache_config']
if "cache_config" in settings:
cache_config = settings["cache_config"]
del settings["cache_config"]
else:
cache_config = {}
gateway = CapakeyRestGateway(cache_config=cache_config)
Expand All @@ -129,34 +121,18 @@ def _build_capakey(registry, settings):
return registry.queryUtility(ICapakey)


def _build_crab(registry, settings):
crab = registry.queryUtility(ICrab)
if crab is not None:
return crab
if 'cache_config' in settings:
cache_config = settings['cache_config']
del settings['cache_config']
else:
cache_config = {}
factory = crab_factory(**settings)
gateway = CrabGateway(factory, cache_config=cache_config)

registry.registerUtility(gateway, ICrab)
return registry.queryUtility(ICrab)


def _build_adressenregister(registry, settings):
adressenregister = registry.queryUtility(IAdressenregister)
if adressenregister is not None:
return adressenregister
if 'cache_config' in settings:
cache_config = settings['cache_config']
del settings['cache_config']
if "cache_config" in settings:
cache_config = settings["cache_config"]
del settings["cache_config"]
else:
cache_config = None
gateway = Gateway(
client=AdressenRegisterClient(settings["base_url"], settings["api_key"]),
cache_settings=cache_config
cache_settings=cache_config,
)

registry.registerUtility(gateway, IAdressenregister)
Expand All @@ -170,28 +146,13 @@ def get_capakey(registry):
:rtype: :class:`crabpy.gateway.capakey.CapakeyRestGateway`
"""
# argument might be a config or a request
regis = getattr(registry, 'registry', None)
regis = getattr(registry, "registry", None)
if regis is None:
regis = registry

return regis.queryUtility(ICapakey)


def get_crab(registry):
"""
Get the Crab Gateway
:rtype: :class:`crabpy.gateway.crab.CrabGateway`
# argument might be a config or a request
"""
# argument might be a config or a request
regis = getattr(registry, 'registry', None)
if regis is None:
regis = registry

return regis.queryUtility(ICrab)


def get_adressenregister(registry):
"""
Get the Adresssenregister Gateway
Expand All @@ -200,7 +161,7 @@ def get_adressenregister(registry):
# argument might be a config or a request
"""
# argument might be a config or a request
regis = getattr(registry, 'registry', None)
regis = getattr(registry, "registry", None)
if regis is None:
regis = registry

Expand All @@ -209,16 +170,16 @@ def get_adressenregister(registry):

def _get_proxy_settings(settings):
base_settings = {}
http = settings.get('proxy.http', None)
https = settings.get('proxy.https', None)
if (http or https):
http = settings.get("proxy.http", None)
https = settings.get("proxy.https", None)
if http or https:
base_settings["proxy"] = {}
if "proxy.http" in settings:
base_settings["proxy"]["http"] = settings["proxy.http"]
log.info('HTTP proxy: %s' % base_settings["proxy"]["http"])
log.info("HTTP proxy: %s" % base_settings["proxy"]["http"])
if "proxy.https" in settings:
base_settings["proxy"]["https"] = settings["proxy.https"]
log.info('HTTPS proxy: %s' % base_settings["proxy"]["https"])
log.info("HTTPS proxy: %s" % base_settings["proxy"]["https"])
return base_settings


Expand All @@ -236,12 +197,12 @@ def add_route(config, name, pattern, *args, **kwargs):

def conditional_http_tween_factory(handler, registry):
"""
Tween that adds ETag headers and tells Pyramid to enable
Tween that adds ETag headers and tells Pyramid to enable
conditional responses where appropriate.
"""
settings = registry.settings if hasattr(registry, 'settings') else {}
if 'generate_etag_for.list' in settings:
route_names = settings.get('generate_etag_for.list').split()
settings = registry.settings if hasattr(registry, "settings") else {}
if "generate_etag_for.list" in settings:
route_names = settings.get("generate_etag_for.list").split()
GENERATE_ETAG_ROUTE_NAMES.update(route_names)

def conditional_http_tween(request):
Expand All @@ -261,8 +222,9 @@ def conditional_http_tween(request):
# buffered response and can generate the ETag header ourself.
if response.etag is not None:
response.conditional_response = True
elif (isinstance(response.app_iter, Sequence) and
len(response.app_iter) == 1) and response.body is not None:
elif (
isinstance(response.app_iter, Sequence) and len(response.app_iter) == 1
) and response.body is not None:
response.conditional_response = True
response.md5_etag()

Expand All @@ -282,62 +244,50 @@ def includeme(config):
base_settings = _get_proxy_settings(settings)

# http caching tween
if not settings.get('etag_tween_disabled', False):
config.add_tween('crabpy_pyramid.conditional_http_tween_factory')
if not settings.get("etag_tween_disabled", False):
config.add_tween("crabpy_pyramid.conditional_http_tween_factory")

# create cache
root = settings.get('cache.file.root', '/tmp/dogpile_data')
root = settings.get("cache.file.root", "/tmp/dogpile_data")
if not os.path.exists(root):
os.makedirs(root)

capakey_settings = dict(_filter_settings(settings, 'capakey.'),
**base_settings)
if 'include' in capakey_settings:
log.info("The 'capakey.include' setting is deprecated. Capakey will "
"always be included.")
log.info('Adding CAPAKEY Gateway.')
config.add_renderer('capakey_listjson', capakey_json_list_renderer)
config.add_renderer('capakey_itemjson', capakey_json_item_renderer)
capakey_settings = dict(_filter_settings(settings, "capakey."), **base_settings)
if "include" in capakey_settings:
log.info(
"The 'capakey.include' setting is deprecated. Capakey will "
"always be included."
)
log.info("Adding CAPAKEY Gateway.")
config.add_renderer("capakey_listjson", capakey_json_list_renderer)
config.add_renderer("capakey_itemjson", capakey_json_item_renderer)
_build_capakey(config.registry, capakey_settings)
config.add_request_method(get_capakey, 'capakey_gateway')
config.add_directive('get_capakey', get_capakey)
config.include('crabpy_pyramid.routes.capakey')
config.scan('crabpy_pyramid.views.capakey')

crab_settings = dict(_filter_settings(settings, 'crab.'), **base_settings)
if crab_settings['include']:
log.info('Adding CRAB Gateway.')
del crab_settings['include']
config.add_renderer('crab_listjson', crab_json_list_renderer)
config.add_renderer('crab_itemjson', crab_json_item_renderer)
_build_crab(config.registry, crab_settings)
config.add_directive('get_crab', get_crab)
config.add_request_method(get_crab, 'crab_gateway')
config.include('crabpy_pyramid.routes.crab')
config.scan('crabpy_pyramid.views.crab')
config.add_request_method(get_capakey, "capakey_gateway")
config.add_directive("get_capakey", get_capakey)
config.include("crabpy_pyramid.routes.capakey")
config.scan("crabpy_pyramid.views.capakey")

# adressenregister wordt afgekort tot adresreg
adresreg_settings = dict(
_filter_settings(settings, 'adressenregister.'),
**base_settings
_filter_settings(settings, "adressenregister."), **base_settings
)

if adresreg_settings['include']:
log.info('Adding adressen register Gateway.')
del adresreg_settings['include']
config.add_renderer('adresreg_listjson', adresreg_json_list_renderer)
config.add_renderer('adresreg_itemjson', adresreg_json_item_renderer)
if adresreg_settings["include"]:
log.info("Adding adressen register Gateway.")
del adresreg_settings["include"]
config.add_renderer("adresreg_listjson", adresreg_json_list_renderer)
config.add_renderer("adresreg_itemjson", adresreg_json_item_renderer)
_build_adressenregister(config.registry, adresreg_settings)
config.add_directive('get_adressenregister', get_adressenregister)
config.add_request_method(get_adressenregister, 'adressenregister_gateway')
config.include('crabpy_pyramid.routes.adressenregister')
config.scan('crabpy_pyramid.views.adressenregister')
config.add_directive("get_adressenregister", get_adressenregister)
config.add_request_method(get_adressenregister, "adressenregister_gateway")
config.include("crabpy_pyramid.routes.adressenregister")
config.scan("crabpy_pyramid.views.adressenregister")
config.scan("crabpy_pyramid.views.exceptions")


def main(global_config, **settings):
"""
This function returns a Pyramid WSGI application.
This function returns a Pyramid WSGI application.
"""
config = Configurator(settings=settings)

Expand Down
Loading

0 comments on commit f9ef0d8

Please sign in to comment.