-
Notifications
You must be signed in to change notification settings - Fork 3
/
client.py
226 lines (196 loc) · 7.49 KB
/
client.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
"""
This module contains utility functions for interacting with AGIV SOAP services.
.. versionadded:: 0.1.0
"""
import logging
import requests
from requests import RequestException
from suds.client import Client
log = logging.getLogger(__name__)
def crab_factory(**kwargs):
"""
Factory that generates a CRAB client.
A few parameters will be handled by the factory, other parameters will
be passed on to the client.
:param wsdl: `Optional.` Allows overriding the default CRAB wsdl url.
:param proxy: `Optional.` A dictionary of proxy information that is passed
to the underlying :class:`suds.client.Client`
:rtype: :class:`suds.client.Client`
"""
if "wsdl" in kwargs:
wsdl = kwargs["wsdl"]
del kwargs["wsdl"]
else:
wsdl = "http://crab.agiv.be/wscrab/wscrab.svc?wsdl"
log.info("Creating CRAB client with wsdl: %s", wsdl)
c = Client(wsdl, **kwargs)
return c
def crab_request(client, action, *args):
"""
Utility function that helps making requests to the CRAB service.
:param client: A :class:`suds.client.Client` for the CRAB service.
:param string action: Which method to call, eg. `ListGewesten`
:returns: Result of the SOAP call.
.. versionadded:: 0.3.0
"""
log.debug("Calling %s on CRAB service.", action)
return getattr(client.service, action)(*args)
class AdressenRegisterClientException(Exception):
pass
class AdressenRegisterClient:
def __init__(self, base_url, api_key):
super().__init__()
self.session = requests.Session()
self.v1_header = {"Accept": "application/json", "x-api-key": api_key}
self.v2_header = {"Accept": "application/ld+json", "x-api-key": api_key}
self.base_url = base_url[:-1] if base_url.endswith("/") else base_url
def _get_list(self, url, response_key, params=None):
if params is None:
params = {}
if "limit" not in params:
params["limit"] = 500
result = []
response = {"volgende": f"{self.base_url}{url}"}
try:
while "volgende" in response:
url = response["volgende"]
# Originele params komen mee in de volgende url vanaf 2de request
if "?" in url:
params = None
response = self.session.get(
url,
params=params,
headers=self.v2_header if "v2" in url else self.v1_header,
)
response.raise_for_status()
response = response.json()
result.extend(response[response_key])
except RequestException as e:
raise AdressenRegisterClientException from e
return result
def _get(self, url, params=None):
try:
response = self.session.get(
f"{self.base_url}{url}",
params=params,
headers=self.v2_header if "v2" in url else self.v1_header,
)
response.raise_for_status()
return response.json()
except RequestException as e:
raise AdressenRegisterClientException from e
def get_gemeente(self, gemeente_id):
return self._get(f"/v2/gemeenten/{gemeente_id}")
def get_gemeenten(self, gemeentenaam=None, status=None):
params = {}
if gemeentenaam is not None:
params["gemeentenaam"] = gemeentenaam
if status is not None:
params["status"] = status
return self._get_list("/v2/gemeenten", "gemeenten", params=params)
def get_postinfo(self, postinfo_id):
return self._get(f"/v2/postinfo/{postinfo_id}")
def get_postinfos(self, gemeentenaam=None, postnaam=None):
params = {}
if gemeentenaam is not None:
params["gemeentenaam"] = gemeentenaam
if postnaam is not None:
params["postnaam"] = postnaam
return self._get_list("/v2/postinfo", "postInfoObjecten", params=params)
def get_straatnaam(self, straatnaam_id):
return self._get(f"/v2/straatnamen/{straatnaam_id}")
def get_straatnamen(
self, straatnaam=None, gemeentenaam=None, niscode=None, status=None
):
params = {}
if straatnaam is not None:
params["straatnaam"] = straatnaam
if gemeentenaam is not None:
params["gemeentenaam"] = gemeentenaam
if niscode is not None:
params["nisCode"] = niscode
if status is not None:
params["status"] = status
return self._get_list("/v2/straatnamen", "straatnamen", params=params)
def get_adres_match(
self,
gemeentenaam=None,
niscode=None,
postcode=None,
kadaster_straatcode=None,
rr_straatcode=None,
straatnaam=None,
huisnummer=None,
index=None,
busnummer=None,
):
params = {}
if gemeentenaam is not None:
params["gemeentenaam"] = gemeentenaam
if niscode is not None:
params["niscode"] = niscode
if postcode is not None:
params["postcode"] = postcode
if kadaster_straatcode is not None:
params["kadStraatcode"] = kadaster_straatcode
if rr_straatcode is not None:
params["rrStraatcode"] = rr_straatcode
if straatnaam is not None:
params["straatnaam"] = straatnaam
if huisnummer is not None:
params["huisnummer"] = huisnummer
if index is not None:
params["index"] = index
if busnummer is not None:
params["busnummer"] = busnummer
return self._get("/v1/adresmatch", params=params)
def get_adres(self, adres_id):
return self._get(f"/v2/adressen/{adres_id}")
def get_adressen(
self,
gemeentenaam=None,
postcode=None,
straatnaam=None,
homoniem_toevoeging=None,
huisnummer=None,
busnummer=None,
niscode=None,
status=None,
straatnaamObjectId=None,
):
params = {}
if gemeentenaam is not None:
params["gemeentenaam"] = gemeentenaam
if postcode is not None:
params["postcode"] = postcode
if straatnaam is not None:
params["straatnaam"] = straatnaam
if homoniem_toevoeging is not None:
params["homoniemToevoeging"] = homoniem_toevoeging
if huisnummer is not None:
params["huisnummer"] = huisnummer
if busnummer is not None:
params["busnummer"] = busnummer
if niscode is not None:
params["niscode"] = niscode
if status is not None:
params["status"] = status
if straatnaamObjectId is not None:
params["straatnaamObjectId"] = straatnaamObjectId
return self._get_list("/v2/adressen", "adressen", params=params)
def get_perceel(self, perceel_id):
return self._get(f"/v2/percelen/{perceel_id}")
def get_percelen(self, status=None, adresObjectId=None):
params = {}
if status is not None:
params["status"] = status
if adresObjectId is not None:
params["adresObjectId"] = adresObjectId
return self._get_list("/v2/percelen", "percelen", params=params)
def get_gebouw(self, gebouw_id):
return self._get(f"/v2/gebouwen/{gebouw_id}")
def get_gebouwen(self, status=None):
params = {}
if status is not None:
params["status"] = status
return self._get_list("/v2/gebouwen", "gebouwen", params=params)