forked from XeroAPI/xero-python-oauth2-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapp.py
442 lines (368 loc) · 13.2 KB
/
app.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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# -*- coding: utf-8 -*-
import os
from functools import wraps
from io import BytesIO
from logging.config import dictConfig
import datetime
from typing import Optional
import re
from dateutil.relativedelta import relativedelta
from collections import defaultdict
from flask import Flask, url_for, render_template, session, redirect, json, send_file
from flask_oauthlib.contrib.client import OAuth, OAuth2Application
from flask_session import Session
from xero_python.accounting import AccountingApi, ContactPerson, Contact, Contacts
from xero_python.api_client import ApiClient, serialize
from xero_python.api_client.configuration import Configuration
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import AccountingBadRequestException
from xero_python.identity import IdentityApi
from xero_python.utils import getvalue
import logging_settings
from utils import jsonify, serialize_model
dictConfig(logging_settings.default_settings)
# configure main flask application
app = Flask(__name__)
app.config.from_object("default_settings")
app.config.from_pyfile("config.py", silent=True)
if app.config["ENV"] != "production":
# allow oauth2 loop to run over http (used for local testing only)
os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
# configure persistent session cache
Session(app)
# configure flask-oauthlib application
# TODO fetch config from https://identity.xero.com/.well-known/openid-configuration #1
oauth = OAuth(app)
xero = oauth.remote_app(
name="xero",
version="2",
client_id=app.config["CLIENT_ID"],
client_secret=app.config["CLIENT_SECRET"],
endpoint_url="https://api.xero.com/",
authorization_url="https://login.xero.com/identity/connect/authorize",
access_token_url="https://identity.xero.com/connect/token",
refresh_token_url="https://identity.xero.com/connect/token",
scope="offline_access openid profile email accounting.transactions "
"accounting.transactions.read accounting.reports.read "
"accounting.journals.read accounting.settings accounting.settings.read "
"accounting.contacts accounting.contacts.read accounting.attachments "
"accounting.attachments.read assets projects",
) # type: OAuth2Application
# configure xero-python sdk client
api_client = ApiClient(
Configuration(
debug=app.config["DEBUG"],
oauth2_token=OAuth2Token(
client_id=app.config["CLIENT_ID"], client_secret=app.config["CLIENT_SECRET"]
),
),
pool_threads=1,
)
_name_match_res = [
re.compile('(?P<name>[^\/]+) \/[^\(]+\((?P<email_address>[^)]+)\).*'),
re.compile('(?P<name>[^\/(]+) \((?P<email_address>[^)]+)\).*')
]
# configure token persistence and exchange point between flask-oauthlib and xero-python
@xero.tokengetter
@api_client.oauth2_token_getter
def obtain_xero_oauth2_token():
return session.get("token")
@xero.tokensaver
@api_client.oauth2_token_saver
def store_xero_oauth2_token(token):
session["token"] = token
session.modified = True
def xero_token_required(function):
@wraps(function)
def decorator(*args, **kwargs):
xero_token = obtain_xero_oauth2_token()
if not xero_token:
return redirect(url_for("login", _external=True))
return function(*args, **kwargs)
return decorator
@app.route("/")
def index():
xero_access = dict(obtain_xero_oauth2_token() or {})
return render_template(
"code.html",
title="Home | oauth token",
code=json.dumps(xero_access, sort_keys=True, indent=4),
)
@app.route("/tenants")
@xero_token_required
def tenants():
identity_api = IdentityApi(api_client)
accounting_api = AccountingApi(api_client)
available_tenants = []
for connection in identity_api.get_connections():
tenant = serialize(connection)
if connection.tenant_type == "ORGANISATION":
organisations = accounting_api.get_organisations(
xero_tenant_id=connection.tenant_id
)
tenant["organisations"] = serialize(organisations)
available_tenants.append(tenant)
return render_template(
"code.html",
title="Xero Tenants",
code=json.dumps(available_tenants, sort_keys=True, indent=4),
)
@app.route("/create-contact-person")
@xero_token_required
def create_contact_person():
xero_tenant_id = get_xero_tenant_id()
accounting_api = AccountingApi(api_client)
contact_person = ContactPerson(
first_name="John",
last_name="Smith",
email_address="[email protected]",
include_in_emails=True,
)
contact = Contact(
name="FooBar",
first_name="Foo",
last_name="Bar",
email_address="[email protected]",
contact_persons=[contact_person],
)
contacts = Contacts(contacts=[contact])
try:
created_contacts = accounting_api.create_contacts(
xero_tenant_id, contacts=contacts
) # type: Contacts
except AccountingBadRequestException as exception:
sub_title = "Error: " + exception.reason
code = jsonify(exception.error_data)
else:
sub_title = "Contact {} created.".format(
getvalue(created_contacts, "contacts.0.name", "")
)
code = serialize_model(created_contacts)
return render_template(
"code.html", title="Create Contacts", code=code, sub_title=sub_title
)
@app.route("/create-multiple-contacts")
@xero_token_required
def create_multiple_contacts():
xero_tenant_id = get_xero_tenant_id()
accounting_api = AccountingApi(api_client)
contact = Contact(
name="George Jetson",
first_name="George",
last_name="Jetson",
email_address="[email protected]",
)
# Add the same contact twice - the first one will succeed, but the
# second contact will fail with a validation error which we'll show.
contacts = Contacts(contacts=[contact, contact])
try:
created_contacts = accounting_api.create_contacts(
xero_tenant_id, contacts=contacts, summarize_errors=False
) # type: Contacts
except AccountingBadRequestException as exception:
sub_title = "Error: " + exception.reason
result_list = None
code = jsonify(exception.error_data)
else:
sub_title = ""
result_list = []
for contact in created_contacts.contacts:
if contact.has_validation_errors:
error = getvalue(contact.validation_errors, "0.message", "")
result_list.append("Error: {}".format(error))
else:
result_list.append("Contact {} created.".format(contact.name))
code = serialize_model(created_contacts)
return render_template(
"code.html",
title="Create Multiple Contacts",
code=code,
result_list=result_list,
sub_title=sub_title,
)
@app.route("/invoices")
@xero_token_required
def get_invoices():
xero_tenant_id = get_xero_tenant_id()
accounting_api = AccountingApi(api_client)
invoices = accounting_api.get_invoices(
xero_tenant_id, statuses=["DRAFT", "SUBMITTED","AUTHORISED"]
)
code = serialize_model(invoices)
sub_title = "Total invoices found: {}".format(len(invoices.invoices))
return render_template(
"code.html", title="Invoices", code=code, sub_title=sub_title
)
@app.route("/login")
def login():
redirect_url = url_for("oauth_callback", _external=True)
response = xero.authorize(callback_uri=redirect_url)
return response
@app.route("/callback")
def oauth_callback():
try:
response = xero.authorized_response()
except Exception as e:
print(e)
raise
# todo validate state value
if response is None or response.get("access_token") is None:
return "Access denied: response=%s" % response
store_xero_oauth2_token(response)
return redirect(url_for("index", _external=True))
@app.route("/logout")
def logout():
store_xero_oauth2_token(None)
return redirect(url_for("index", _external=True))
@app.route("/export-token")
@xero_token_required
def export_token():
token = obtain_xero_oauth2_token()
buffer = BytesIO("token={!r}".format(token).encode("utf-8"))
buffer.seek(0)
return send_file(
buffer,
mimetype="x.python",
as_attachment=True,
attachment_filename="oauth2_token.py",
)
@app.route("/refresh-token")
@xero_token_required
def refresh_token():
xero_token = obtain_xero_oauth2_token()
new_token = api_client.refresh_oauth2_token()
return render_template(
"code.html",
title="Xero OAuth2 token",
code=jsonify({"Old Token": xero_token, "New token": new_token}),
sub_title="token refreshed",
)
@app.route("/journals-list")
@xero_token_required
def journals_list():
xero_tenant_id = get_xero_tenant_id()
accounting_api = AccountingApi(api_client)
journals = accounting_api.get_journals(
xero_tenant_id=xero_tenant_id,
if_modified_since=datetime.datetime.now() - relativedelta(days=90)
)
return render_template(
"code.html",
title="Journals",
code=serialize_model(journals),
sub_title="For Past 90 days",
)
@app.route("/members-list")
@xero_token_required
def members_list():
xero_tenant_id = get_xero_tenant_id()
accounting_api = AccountingApi(api_client)
sources = defaultdict(list)
member_transactions = defaultdict(list)
# Walk the full journal for the past 90 days for membership items
# and split them based on which type they are, i.e. 'CASHREC' / 'ACCREC'
for journal in get_journals(datetime.datetime.now() - relativedelta(days=90)):
if is_membership_journal(journal):
sources[journal.source_type].append(journal.source_id)
transactions = []
for source, source_ids in sources.items():
if source == 'CASHREC':
for s in source_ids:
transactions.extend(
# get_bank_transactions has to be done individually but there's usually not many of them
accounting_api.get_bank_transaction(xero_tenant_id, s).bank_transactions
)
elif source == 'ACCREC':
transactions.extend(
accounting_api.get_invoices(xero_tenant_id, i_ds=source_ids).invoices
)
else:
raise ValueError(source)
for transaction in transactions:
c = transaction.contact.contact_id
member_transactions[c].append(transaction)
members = accounting_api.get_contacts(xero_tenant_id, i_ds=list(member_transactions.keys())).contacts
contact_sheet = []
for m in members:
contact_sheet.append(
{
**fix_contact(m),
'transactions': len(member_transactions[m.contact_id])
}
)
return render_template(
"code.html",
title="Members",
code=serialize_model(contact_sheet),
sub_title="For Past 90 days",
)
def get_xero_tenant_id():
token = obtain_xero_oauth2_token()
if not token:
return None
identity_api = IdentityApi(api_client)
for connection in identity_api.get_connections():
if connection.tenant_type == "ORGANISATION":
return connection.tenant_id
def get_journals(since:Optional[datetime.datetime]=None):
if since is None:
since = datetime.datetime.now() - relativedelta(days=90)
xero_tenant_id = get_xero_tenant_id()
accounting_api = AccountingApi(api_client)
these = accounting_api.get_journals(
xero_tenant_id=xero_tenant_id,
if_modified_since=since
)
while these and these.journals:
yield from these.journals
offset = these.journals[-1].journal_number
these = accounting_api.get_journals(
xero_tenant_id=xero_tenant_id,
if_modified_since=since,
offset=offset
)
def is_membership_journal(journal):
for line in journal.journal_lines:
if line.account_code == '200':
return True
return False
def _unNone(v):
# `serializer` is an idiot and can't serialise Nones...
if isinstance(v,dict):
return {k:_unNone(_v) for k,_v in v.items()}
else:
return '' if v is None else v
def capitalize_nth(s, n):
return s[:n] + s[n:].capitalize()
def fix_contact(contact):
p = None
if not contact.email_address:
for res in _name_match_res:
m = res.match(contact.name)
if m is not None:
p=m.groupdict()
break
# Nothing Matched, fallback
if p is None:
p = dict(
name=contact.name
)
else:
p = dict(
name=contact.name,
first_name=contact.first_name,
last_name=contact.last_name,
email_address=contact.email_address
)
p['name'] = p['name'].title()
p['email_address'] = p['email_address'].lower() if 'email_address' in p else None
try:
p['first_name'], p['last_name'] = p['name'].split(maxsplit=1)
if p.get('last_name','').startswith('Mc'):
p['last_name'] = capitalize_nth(p['last_name'],2)
except (ValueError, KeyError):
p['first_name'] = p['name']
p['last_name'] = None
return _unNone(p)
if __name__ == "__main__":
app.run()