add basic connector

This commit is contained in:
Frédéric Péters 2017-12-15 08:43:09 +01:00
parent 52ca3fb475
commit 986ce01d5c
7 changed files with 231 additions and 0 deletions

5
MANIFEST.in Normal file
View File

@ -0,0 +1,5 @@
recursive-include passerelle_imio_liege_rn/locale *.po *.mo
include MANIFEST.in
include COPYING
include VERSION
include README

26
README Normal file
View File

@ -0,0 +1,26 @@
Passerelle connector to Liege national register webservices
===========================================================
Installation
------------
- add to Passerelle installed apps settings:
INSTALLED_APPS += ('passerelle_imio_liege_rn',)
Usage
-----
- create and configure new connector
- Title/description: whatever you want
- URL: https://e-services.liege.be:8443/...
- Certificate check: uncheck if the service has no valid certificate
Usage in w.c.s.
---------------
- configure a webservice with
- URL: [passerelle_url]imio-liege-rn/<slug>/data/[form_var_rn]/
- create a form with a first page asking for the nrn (-> [form_var_rn])
- on later pages, use prefill with Python expressions, for example
webservice.rn.get('rue')

View File

View File

@ -0,0 +1,30 @@
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('base', '0005_resourcelog'),
]
operations = [
migrations.CreateModel(
name='ImioLiegeRn',
fields=[
('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
('title', models.CharField(max_length=50, verbose_name='Title')),
('slug', models.SlugField(verbose_name='Identifier')),
('description', models.TextField(verbose_name='Description')),
('log_level', models.CharField(default=b'INFO', max_length=10, verbose_name='Log Level', choices=[(b'NOTSET', b'NOTSET'), (b'DEBUG', b'DEBUG'), (b'INFO', b'INFO'), (b'WARNING', b'WARNING'), (b'ERROR', b'ERROR'), (b'CRITICAL', b'CRITICAL'), (b'FATAL', b'FATAL')])),
('service_url', models.CharField(help_text='Gateway Web Service URL', max_length=128, verbose_name='Service URL')),
('verify_cert', models.BooleanField(default=True, verbose_name='Check HTTPS Certificate validity')),
('users', models.ManyToManyField(to='base.ApiUser', blank=True)),
],
options={
'verbose_name': 'Liege RN Services',
},
),
]

View File

@ -0,0 +1,65 @@
# passerelle-imio-liege-rn - passerelle connector to Liege NR webservices
# Copyright (C) 2017 Entr'ouvert
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from django.db import models
from django.utils.translation import ugettext_lazy as _
from passerelle.base.models import BaseResource
from passerelle.utils.api import endpoint
class ImioLiegeRn(BaseResource):
service_url = models.CharField(max_length=128, blank=False,
verbose_name=_('Service URL'),
help_text=_('Gateway Web Service URL'))
verify_cert = models.BooleanField(default=True,
verbose_name=_('Check HTTPS Certificate validity'))
category = _('Misc')
class Meta:
verbose_name = _('Liege RN Services')
@classmethod
def get_connector_slug(cls):
return 'imio-liege-rn'
@endpoint(perm='can_access', pattern='^(?P<nrn>\d+)/$',
example_pattern='{nrn}/',
parameters={
'nrn': {'description': _('National Register Number'),
'example_value': '79061607381'}
})
def data(self, request, nrn):
response = self.requests.get(self.service_url + nrn,
verify=self.verify_cert,
timeout=5)
if response.status_code != 200:
return {}
attributes = response.json()
# remove junk from street name
if attributes.get('rue'):
attributes['rue'] = attributes['rue'].split('(')[0]
# use dd/mm/yyyy as date format for birthday
if attributes.get('dateNaissance'):
attributes['dateNaissance'] = attributes['dateNaissance'].replace('.', '/')
# assume all unspecified answers are for Belgium, this may not actually be true
if not attributes.get('pays'):
attributes['pays'] = 'Belgique'
return attributes

105
setup.py Normal file
View File

@ -0,0 +1,105 @@
#! /usr/bin/env python
# -*- coding: utf-8 -*-
import glob
import os
import re
import subprocess
import sys
from setuptools.command.install_lib import install_lib as _install_lib
from distutils.command.build import build as _build
from distutils.command.sdist import sdist
from distutils.cmd import Command
from setuptools import setup, find_packages
class eo_sdist(sdist):
def run(self):
if os.path.exists('VERSION'):
os.remove('VERSION')
version = get_version()
version_file = open('VERSION', 'w')
version_file.write(version)
version_file.close()
sdist.run(self)
if os.path.exists('VERSION'):
os.remove('VERSION')
def get_version():
if os.path.exists('VERSION'):
version_file = open('VERSION', 'r')
version = version_file.read()
version_file.close()
return version
if os.path.exists('.git'):
p = subprocess.Popen(['git', 'describe', '--dirty', '--match=v*'], stdout=subprocess.PIPE)
result = p.communicate()[0]
if p.returncode == 0:
version = result.split()[0][1:]
version = version.replace('-', '.')
return version
return '0'
class compile_translations(Command):
description = 'compile message catalogs to MO files via django compilemessages'
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
try:
from django.core.management import call_command
for path, dirs, files in os.walk('passerelle_imio_liege_rn'):
if 'locale' not in dirs:
continue
curdir = os.getcwd()
os.chdir(os.path.realpath(path))
call_command('compilemessages')
os.chdir(curdir)
except ImportError:
sys.stderr.write('!!! Please install Django >= 1.4 to build translations\n')
class build(_build):
sub_commands = [('compile_translations', None)] + _build.sub_commands
class install_lib(_install_lib):
def run(self):
self.run_command('compile_translations')
_install_lib.run(self)
setup(
name='passerelle-liege-imio-rn',
version=get_version(),
author='Frederic Peters',
author_email='fpeters@entrouvert.com',
packages=find_packages(),
include_package_data=True,
url='https://dev.entrouvert.org/projects/imio/',
classifiers=[
'Development Status :: 2 - Pre-Alpha',
'Environment :: Web Environment',
'Framework :: Django',
'Intended Audience :: Developers',
'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
],
install_requires=['django>=1.8',
],
zip_safe=False,
cmdclass={
'build': build,
'compile_translations': compile_translations,
'install_lib': install_lib,
'sdist': eo_sdist,
}
)