From 8f30c5716f332ebf1d53e574b600c3f5941cff25 Mon Sep 17 00:00:00 2001 From: "Baard H. Rehn Johansen" Date: Fri, 3 Aug 2018 15:12:58 +0200 Subject: [PATCH] Initial commit --- Dockerfile | 15 +++ LICENCE | 201 +++++++++++++++++++++++++++++++++++++++ README.md | 98 +++++++++++++++++++ service/dotdictify.py | 60 ++++++++++++ service/logger.py | 12 +++ service/requirements.txt | 3 + service/service.py | 67 +++++++++++++ 7 files changed, 456 insertions(+) create mode 100644 Dockerfile create mode 100644 LICENCE create mode 100644 README.md create mode 100644 service/dotdictify.py create mode 100644 service/logger.py create mode 100644 service/requirements.txt create mode 100644 service/service.py diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..55c89f3 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,15 @@ +FROM python:3-alpine +MAINTAINER Baard H. Rehn Johansen "ashkan.vahidishams@sesam.io" + +RUN apk update +RUN apk add openssl-dev libffi-dev musl-dev gcc make + +RUN pip install --upgrade pip + +COPY ./service/requirements.txt /service/requirements.txt +RUN pip install -r /service/requirements.txt +COPY ./service /service + +EXPOSE 5000/tcp + +CMD ["python3", "-u", "./service/service.py"] \ No newline at end of file diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..9c8f3ea --- /dev/null +++ b/LICENCE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb5681a --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +# XML parser and renderer + +Supports parsing and rendering of XML files. + +## Example System Config +``` +{ + "_id": "xml-service", + "type": "system:microservice", + "docker": { + "image": "sesamcommunity/xml:latest", + "port": 5000 + } +}, +{ + "_id": "my-ssh-server", + "type": "system:microservice", + "docker": { + "image": "sesamcommunity/sshfs:latest", + [..] + "port": 5000 + } +} +``` + +## Parsing XML +``` +{ + "_id": "my-xml-source", + "type": "pipe", + "source": { + "type": "json", + "system": "xml-service", + "url": "/?url=http://my-ssh-server/some-input-file.xml&xml_path=customerRecords.customerRecord&updated_path=system.customerChangeDateTime&since=2001-12-17T09:30:47%2B02:00", + "transform": { + "type": "dtl", + "rules": { + "default": [ + ["add", "_id","path.to.id"], + ["copy", "*"] + ] + } + } +} +``` +It supports updated path if it exists, if not; remove updated_path and since from url. + +``` + +Hei + +``` + +will be converted to + +``` +[ + { + "html": { + "bar": "Hello" + } + } +] + +``` + +## Rendering XML +``` +{ + "_id": "my-xml-sink", + "type": "pipe", + "source": { + "type": "dataset", + "dataset": "some_dataset" + }, + "sink": { + "type": "json", + "system": "xml-service", + "url": "/?url=http://my-ssh-server/some-output-file.xml" + } +} +``` + +``` + { + "html": { + "bar": "Hello" + } + } +``` + +will be rendered as + +``` + +Hei + +``` diff --git a/service/dotdictify.py b/service/dotdictify.py new file mode 100644 index 0000000..725ff5f --- /dev/null +++ b/service/dotdictify.py @@ -0,0 +1,60 @@ +# turn dict into an object that allows access to nested keys via dot notation +# from http://stackoverflow.com/questions/3797957/python-easily-access-deeply-nested-dict-get-and-set +# made three modifications: +# --added `get()` method +# --added `if not dict.__contains__...` to `__contains__()` +# --can now accept None as key +class Dotdictify(dict): + def __init__(self, value=None): + if value is None: + pass + elif isinstance(value, dict): + for key in value: + self.__setitem__(key, value[key]) + else: + raise TypeError('expected dict') + + def __setitem__(self, key, value): + if key is not None and '.' in key: + myKey, restOfKey = key.split('.', 1) + target = self.setdefault(myKey, Dotdictify()) + if not isinstance(target, Dotdictify): + raise KeyError('cannot set "%s" in "%s" (%s)' % (restOfKey, myKey, repr(target))) + target[restOfKey] = value + else: + if isinstance(value, dict) and not isinstance(value, Dotdictify): + value = Dotdictify(value) + dict.__setitem__(self, key, value) + + def __getitem__(self, key): + if key is None or '.' not in key: + return dict.__getitem__(self, key) + myKey, restOfKey = key.split('.', 1) + target = dict.__getitem__(self, myKey) + if not isinstance(target, Dotdictify): + raise KeyError('cannot get "%s" in "%s" (%s)' % (restOfKey, myKey, repr(target))) + return target[restOfKey] + + def __contains__(self, key): + if key is None or '.' not in key: + return dict.__contains__(self, key) + myKey, restOfKey = key.split('.', 1) + if not dict.__contains__(self, myKey): + return False + target = dict.__getitem__(self, myKey) + if not isinstance(target, Dotdictify): + return False + return restOfKey in target + + def setdefault(self, key, default): + if key not in self: + self[key] = default + return self[key] + + def get(self, k, d=None): + if Dotdictify.__contains__(self, k): + return Dotdictify.__getitem__(self, k) + return d + + __setattr__ = __setitem__ + __getattr__ = __getitem__ \ No newline at end of file diff --git a/service/logger.py b/service/logger.py new file mode 100644 index 0000000..357d0ec --- /dev/null +++ b/service/logger.py @@ -0,0 +1,12 @@ +import logging + +def Logger(logger_name): + format_string = '%(asctime)s - %(name)s - %(levelname)s - %(message)s' + logger = logging.getLogger(logger_name) + + # Log to stdout + stdout_handler = logging.StreamHandler() + stdout_handler.setFormatter(logging.Formatter(format_string)) + logger.addHandler(stdout_handler) + logger.setLevel(logging.DEBUG) + return logger \ No newline at end of file diff --git a/service/requirements.txt b/service/requirements.txt new file mode 100644 index 0000000..056c29e --- /dev/null +++ b/service/requirements.txt @@ -0,0 +1,3 @@ +xmltodict==0.11.0 +requests==2.10.0 +Flask==0.11 diff --git a/service/service.py b/service/service.py new file mode 100644 index 0000000..c04de12 --- /dev/null +++ b/service/service.py @@ -0,0 +1,67 @@ +import json +import xmltodict + +from flask import Flask, request, Response +import os +import requests + +import logger +from dotdictify import Dotdictify + +app = Flask(__name__) + +logger = logger.Logger('xml') + +class XmlParser: + def __init__(self, args): + self._xml_path = args.get("xml_path") + self._updated_path = args.get("updated_path") + self._since = args.get("since") + + def parse(self, stream): + root_element = xmltodict.parse(stream) + + if self._xml_path is not None: + + if isinstance(list(Dotdictify(root_element).get(self._xml_path))[0], dict): + l = list(Dotdictify(root_element).get(self._xml_path)) + else: + l = [Dotdictify(root_element).get(self._xml_path)] + else: + l = [root_element] + if self._updated_path is not None: + for entity in l: + b = Dotdictify(entity) + entity["_updated"] = b.get(self._updated_path) + if self._since is not None: + logger.info("Fetching data since: %s" % self._since) + return list(filter(l, self._since)) + return l + + def filter(l, since): + for e in l: + if e.get("_updated") > since: + yield e + + +@app.route("/", methods=["GET"]) +def get(): + parser = XmlParser(request.args) + url = request.args["url"] + xml = requests.get(url).text + return Response(response=json.dumps(parser.parse(xml)), mimetype='application/json') + + +@app.route('/', methods=["POST"]) +def post(): + url = request.args["url"] + xml = xmltodict.unparse(request.get_json(), pretty=True, full_document=False).encode('utf-8') + r = requests.post(url, xml) + if r.status_code != 200: + return Response(response=r.text, status=r.status_code) + else: + return Response(response="Great Success!") + + +if __name__ == '__main__': + app.run(debug=True, host='0.0.0.0', port=int(os.environ.get('PORT',5000)))