pax_global_header00006660000000000000000000000064132202043260014504gustar00rootroot0000000000000052 comment=a07876f2c0d6a99f78d9b151d6156f1828fd2584 python-preparer-0.1.0/000077500000000000000000000000001322020432600146415ustar00rootroot00000000000000python-preparer-0.1.0/.gitignore000066400000000000000000000022051322020432600166300ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python env/ build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ *.egg-info/ .installed.cfg *.egg # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover .hypothesis/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # pyenv .python-version # celery beat schedule file celerybeat-schedule # SageMath parsed files *.sage.py # dotenv .env # virtualenv .venv venv/ ENV/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ python-preparer-0.1.0/.travis.yml000066400000000000000000000003001322020432600167430ustar00rootroot00000000000000language: python python: - "3.5" - "3.6" # command to install dependencies install: - pip install -r requirements-dev.txt # command to run tests script: pytest after_success: codecovpython-preparer-0.1.0/CHANGES.rst000066400000000000000000000000651322020432600164440ustar00rootroot00000000000000Changelog --------- 0.1.0 ~~~~~ * Initial release. python-preparer-0.1.0/LICENSE000066400000000000000000000020611322020432600156450ustar00rootroot00000000000000MIT License Copyright (c) 2017 Allisson Azevedo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. python-preparer-0.1.0/MANIFEST.in000066400000000000000000000000671322020432600164020ustar00rootroot00000000000000include LICENSE include README.rst include CHANGES.rst python-preparer-0.1.0/Makefile000066400000000000000000000007221322020432600163020ustar00rootroot00000000000000.PHONY: clean-pyc default: test clean-pyc: @find . -iname '*.py[co]' -delete @find . -iname '__pycache__' -delete @find . -iname '.coverage' -delete @rm -rf htmlcov/ clean-dist: @rm -rf dist/ @rm -rf build/ @rm -rf *.egg-info clean: clean-pyc clean-dist test: py.test dist: clean python setup.py sdist python setup.py bdist_wheel release: dist git tag `python setup.py -q version` git push origin `python setup.py -q version` twine upload dist/* python-preparer-0.1.0/README.rst000066400000000000000000000173141322020432600163360ustar00rootroot00000000000000Python Preparer =============== |TravisCI Build Status| |Coverage Status| |Requirements Status| ---- Simple way to build a new dict based on fields declaration. How to install -------------- .. code:: shell pip install preparer How to use ---------- .. code:: python from preparer import FieldsPreparer, SubPreparer, CollectionSubPreparer xfiles_game = { 'description': 'As an extension of one of the most long-running...', 'game_id': 1, 'genres': [ { 'genre_category': 'Basic Genres', 'genre_category_id': 1, 'genre_id': 2, 'genre_name': 'Adventure' }, { 'genre_category': 'Perspective', 'genre_category_id': 2, 'genre_id': 7, 'genre_name': '1st-person' }, { 'genre_category': 'Narrative Theme/Topic', 'genre_category_id': 8, 'genre_id': 55, 'genre_name': 'Detective / Mystery' }, { 'genre_category': 'Setting', 'genre_category_id': 10, 'genre_id': 8, 'genre_name': 'Sci-Fi / Futuristic' }, { 'genre_category': 'Other Attributes', 'genre_category_id': 6, 'genre_id': 82, 'genre_name': 'Licensed Title' } ], 'moby_score': 3.8, 'moby_url': 'http://www.mobygames.com/game/x-files-game', 'num_votes': 53, 'official_url': None, 'platforms': [ { 'first_release_date': '1998', 'platform_id': 3, 'platform_name': 'Windows' }, { 'first_release_date': '1998-06', 'platform_id': 74, 'platform_name': 'Macintosh' }, { 'first_release_date': '1999', 'platform_id': 6, 'platform_name': 'PlayStation' } ], 'sample_cover': { 'height': 927, 'image': 'http://www.mobygames.com/images/covers/l/3-the-x-files-game...', 'platforms': [ 'Windows' ], 'thumbnail_image': 'http://www.mobygames.com/images/covers/s/3-the-x-files...', 'width': 800 }, 'sample_screenshots': [ { 'caption': 'Mulder and Special Agent Willmore', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/86087-the-x-files...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/86087-the...', 'width': 640 }, { 'caption': 'Title screen (from intro)', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/313897-the-x-files-game...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/313897-the-x...', 'width': 640 }, { 'caption': 'Gillian Anderson (from intro)', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/313919-the-x-files-game...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/313919-the-x...', 'width': 640 }, { 'caption': 'David Duchovny (from intro)', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/313908-the-x-files-game-windows...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/313908-the-x-files...', 'width': 640 } ], 'title': 'The X-Files Game' } preparer = FieldsPreparer(fields={ 'id': 'game_id', 'title': 'title', 'description': 'description' }) cover_preparer = FieldsPreparer(fields={ 'image': 'image', 'thumbnail': 'thumbnail_image' }) preparer_with_cover = FieldsPreparer(fields={ 'id': 'game_id', 'title': 'title', 'description': 'description', 'cover': SubPreparer('sample_cover', cover_preparer) }) screenshot_preparer = FieldsPreparer(fields={ 'caption': 'caption', 'image': 'image', 'thumbnail': 'thumbnail_image' }) preparer_with_cover_and_screenshots = FieldsPreparer(fields={ 'id': 'game_id', 'title': 'title', 'description': 'description', 'cover': SubPreparer('sample_cover', cover_preparer), 'screenshots': CollectionSubPreparer('sample_screenshots', screenshot_preparer) }) .. code:: python >>> import pprint >>> pp = pprint.PrettyPrinter(indent=4) >>> pp.pprint(preparer.prepare(xfiles_game)) { 'description': 'As an extension of one of the most long-running...', 'id': 1, 'title': 'The X-Files Game'} >>> pp.pprint(preparer_with_cover.prepare(xfiles_game)) { 'cover': { 'image': 'http://www.mobygames.com/images/covers/l/3-the-x-files-game...', 'thumbnail': 'http://www.mobygames.com/images/covers/s/3-the-x-files...'}, 'description': 'As an extension of one of the most long-running...', 'id': 1, 'title': 'The X-Files Game'} >>> pp.pprint(preparer_with_cover_and_screenshots.prepare(xfiles_game)) { 'cover': { 'image': 'http://www.mobygames.com/images/covers/l/3-the-x-files-game...', 'thumbnail': 'http://www.mobygames.com/images/covers/s/3-the-x-files...'}, 'description': 'As an extension of one of the most long-running...', 'id': 1, 'screenshots': [ { 'caption': 'Mulder and Special Agent Willmore', 'image': 'http://www.mobygames.com/images/shots/l/86087-the-x-files...', 'thumbnail': 'http://www.mobygames.com/images/shots/s/86087-the...'}, { 'caption': 'Title screen (from intro)', 'image': 'http://www.mobygames.com/images/shots/l/313897-the-x-files-game...', 'thumbnail': 'http://www.mobygames.com/images/shots/s/313897-the-x...'}, { 'caption': 'Gillian Anderson (from intro)', 'image': 'http://www.mobygames.com/images/shots/l/313919-the-x-files-game...', 'thumbnail': 'http://www.mobygames.com/images/shots/s/313919-the-x...'}, { 'caption': 'David Duchovny (from intro)', 'image': 'http://www.mobygames.com/images/shots/l/313908-the-x-files-game-windows...', 'thumbnail': 'http://www.mobygames.com/images/shots/s/313908-the-x-files...'}], 'title': 'The X-Files Game'} Check `https://github.com/allisson/python-preparer/tree/master/examples `_ for more code examples. Credits ------- This is a fork of excellent https://github.com/toastdriven/restless/blob/master/restless/preparers.py .. |TravisCI Build Status| image:: https://travis-ci.org/allisson/python-preparer.svg?branch=master :target: https://travis-ci.org/allisson/python-preparer .. |Coverage Status| image:: https://codecov.io/gh/allisson/python-preparer/branch/master/graph/badge.svg :target: https://codecov.io/gh/allisson/python-preparer .. |Requirements Status| image:: https://requires.io/github/allisson/python-preparer/requirements.svg?branch=master :target: https://requires.io/github/allisson/python-preparer/requirements/?branch=master python-preparer-0.1.0/examples/000077500000000000000000000000001322020432600164575ustar00rootroot00000000000000python-preparer-0.1.0/examples/quickstart.py000066400000000000000000000102711322020432600212240ustar00rootroot00000000000000import pprint from preparer import FieldsPreparer, SubPreparer, CollectionSubPreparer pp = pprint.PrettyPrinter(indent=4) xfiles_game = { 'description': 'As an extension of one of the most long-running...', 'game_id': 1, 'genres': [ { 'genre_category': 'Basic Genres', 'genre_category_id': 1, 'genre_id': 2, 'genre_name': 'Adventure' }, { 'genre_category': 'Perspective', 'genre_category_id': 2, 'genre_id': 7, 'genre_name': '1st-person' }, { 'genre_category': 'Narrative Theme/Topic', 'genre_category_id': 8, 'genre_id': 55, 'genre_name': 'Detective / Mystery' }, { 'genre_category': 'Setting', 'genre_category_id': 10, 'genre_id': 8, 'genre_name': 'Sci-Fi / Futuristic' }, { 'genre_category': 'Other Attributes', 'genre_category_id': 6, 'genre_id': 82, 'genre_name': 'Licensed Title' } ], 'moby_score': 3.8, 'moby_url': 'http://www.mobygames.com/game/x-files-game', 'num_votes': 53, 'official_url': None, 'platforms': [ { 'first_release_date': '1998', 'platform_id': 3, 'platform_name': 'Windows' }, { 'first_release_date': '1998-06', 'platform_id': 74, 'platform_name': 'Macintosh' }, { 'first_release_date': '1999', 'platform_id': 6, 'platform_name': 'PlayStation' } ], 'sample_cover': { 'height': 927, 'image': 'http://www.mobygames.com/images/covers/l/3-the-x-files-game...', 'platforms': [ 'Windows' ], 'thumbnail_image': 'http://www.mobygames.com/images/covers/s/3-the-x-files...', 'width': 800 }, 'sample_screenshots': [ { 'caption': 'Mulder and Special Agent Willmore', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/86087-the-x-files...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/86087-the...', 'width': 640 }, { 'caption': 'Title screen (from intro)', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/313897-the-x-files-game...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/313897-the-x...', 'width': 640 }, { 'caption': 'Gillian Anderson (from intro)', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/313919-the-x-files-game...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/313919-the-x...', 'width': 640 }, { 'caption': 'David Duchovny (from intro)', 'height': 480, 'image': 'http://www.mobygames.com/images/shots/l/313908-the-x-files-game-windows...', 'thumbnail_image': 'http://www.mobygames.com/images/shots/s/313908-the-x-files...', 'width': 640 } ], 'title': 'The X-Files Game' } preparer = FieldsPreparer(fields={ 'id': 'game_id', 'title': 'title', 'description': 'description' }) cover_preparer = FieldsPreparer(fields={ 'image': 'image', 'thumbnail': 'thumbnail_image' }) preparer_with_cover = FieldsPreparer(fields={ 'id': 'game_id', 'title': 'title', 'description': 'description', 'cover': SubPreparer('sample_cover', cover_preparer) }) screenshot_preparer = FieldsPreparer(fields={ 'caption': 'caption', 'image': 'image', 'thumbnail': 'thumbnail_image' }) preparer_with_cover_and_screenshot = FieldsPreparer(fields={ 'id': 'game_id', 'title': 'title', 'description': 'description', 'cover': SubPreparer('sample_cover', cover_preparer), 'screenshots': CollectionSubPreparer('sample_screenshots', screenshot_preparer) }) pp.pprint(preparer.prepare(xfiles_game)) pp.pprint(preparer_with_cover.prepare(xfiles_game)) pp.pprint(preparer_with_cover_and_screenshot.prepare(xfiles_game)) python-preparer-0.1.0/examples/simple.py000066400000000000000000000014161322020432600203240ustar00rootroot00000000000000import pprint from preparer import FieldsPreparer pp = pprint.PrettyPrinter(indent=4) payload = { 'type': 'articles', 'id': '1', 'attributes': { 'title': 'JSON API paints my bikeshed!', 'body': 'The shortest article. Ever.', 'created': '2015-05-22T14:56:29.000Z', 'updated': '2015-05-22T14:56:28.000Z' }, 'relationships': { 'author': { 'data': {'id': '42', 'type': 'people'} } }, 'tags': [ {'name': 'tag-1', 'count': 1}, {'name': 'tag-2', 'count': 2}, {'name': 'tag-3', 'count': 3}, ], } preparer = FieldsPreparer(fields={ 'id': 'id', 'type': 'type', 'title': 'attributes.title', 'body': 'attributes.body' }) pp.pprint(preparer.prepare(payload)) python-preparer-0.1.0/preparer/000077500000000000000000000000001322020432600164615ustar00rootroot00000000000000python-preparer-0.1.0/preparer/__init__.py000066400000000000000000000001221322020432600205650ustar00rootroot00000000000000from .preparers import FieldsPreparer, SubPreparer, CollectionSubPreparer # noqa python-preparer-0.1.0/preparer/preparers.py000066400000000000000000000147351322020432600210500ustar00rootroot00000000000000import abc class Preparer: """ A plain preparation object which just passes through data. It also is relevant as the protocol subclasses should implement to work with Restless. """ @abc.abstractmethod def prepare(self, data): """ Handles actually transforming the data. """ class FieldsPreparer(Preparer): """ A more complex preparation object, this will return a given set of fields. This takes a ``fields`` parameter, which should be a dictionary of keys (fieldnames to expose to the user) & values (a dotted lookup path to the desired attribute/key on the object). Example:: preparer = FieldsPreparer(fields={ # ``user`` is the key the client will see. # ``author.pk`` is the dotted path lookup ``FieldsPreparer`` # will traverse on the data to return a value. 'user': 'author.pk', }) """ def __init__(self, fields=None): self.fields = fields or {} def prepare(self, data): """ Handles transforming the provided data into the fielded data that should be exposed to the end user. Uses the ``lookup_data`` method to traverse dotted paths. Returns a dictionary of data as the response. """ result = {} if not self.fields: # No fields specified. Serialize everything. return data for fieldname, lookup in self.fields.items(): if isinstance(lookup, SubPreparer): result[fieldname] = lookup.prepare(data) else: result[fieldname] = self.lookup_data(lookup, data) return result def lookup_data(self, lookup, data): """ Given a lookup string, attempts to descend through nested data looking for the value. Can work with either dictionary-alikes or objects (or any combination of those). Lookups should be a string. If it is a dotted path, it will be split on ``.`` & it will traverse through to find the final value. If not, it will simply attempt to find either a key or attribute of that name & return it. Example:: >>> data = { ... 'type': 'message', ... 'greeting': { ... 'en': 'hello', ... 'fr': 'bonjour', ... 'es': 'hola', ... }, ... 'person': Person( ... name='daniel' ... ) ... } >>> lookup_data('type', data) 'message' >>> lookup_data('greeting.en', data) 'hello' >>> lookup_data('person.name', data) 'daniel' """ value = data parts = lookup.split('.') if not parts or not parts[0]: return value part = parts[0] remaining_lookup = '.'.join(parts[1:]) if callable(getattr(data, 'keys', None)) and hasattr(data, '__getitem__'): # Dictionary enough for us. value = data[part] elif data is not None: # Assume it's an object. value = getattr(data, part) # Call if it's callable except if it's a Django DB manager instance # We check if is a manager by checking the db_manager (duck typing) if callable(value) and not hasattr(value, 'db_manager'): value = value() if not remaining_lookup: return value # There's more to lookup, so dive in recursively. return self.lookup_data(remaining_lookup, value) class SubPreparer(FieldsPreparer): """ A preparation class designed to be used within other preparers. This is primary to enable deeply-nested structures, allowing you to compose/share definitions as well. Typical usage consists of creating a configured instance of a FieldsPreparer, then use a `SubPreparer` to pull it in. Example:: # First, define the nested fields you'd like to expose. author_preparer = FieldsPreparer(fields={ 'id': 'pk', 'username': 'username', 'name': 'get_full_name', }) # Then, in the main preparer, pull them in using `SubPreparer`. preparer = FieldsPreparer(fields={ 'author': SubPreparer('user', author_preparer), # Other fields can come before/follow as normal. 'content': 'post', 'created': 'created_at', }) """ def __init__(self, lookup, preparer): self.lookup = lookup self.preparer = preparer def get_inner_data(self, data): """ Used internally so that the correct data is extracted out of the broader dataset, allowing the preparer being called to deal with just the expected subset. """ return self.lookup_data(self.lookup, data) def prepare(self, data): """ Handles passing the data to the configured preparer. Uses the ``get_inner_data`` method to provide the correct subset of the data. Returns a dictionary of data as the response. """ return self.preparer.prepare(self.get_inner_data(data)) class CollectionSubPreparer(SubPreparer): """ A preparation class designed to handle collections of data. This is useful in the case where you have a 1-to-many or many-to-many relationship of data to expose as part of the parent data. Example:: # First, set up a preparer that handles the data for each thing in # the broader collection. comment_preparer = FieldsPreparer(fields={ 'comment': 'comment_text', 'created': 'created', }) # Then use it with the ``CollectionSubPreparer`` to create a list # of prepared sub items. preparer = FieldsPreparer(fields={ # A normal blog post field. 'post': 'post_text', # All the comments on the post. 'comments': CollectionSubPreparer('comments.all', comment_preparer), }) """ def prepare(self, data): """ Handles passing each item in the collection data to the configured subpreparer. Uses a loop and the ``get_inner_data`` method to provide the correct item of the data. Returns a list of data as the response. """ result = [] for item in self.get_inner_data(data): result.append(self.preparer.prepare(item)) return result python-preparer-0.1.0/pytest.ini000066400000000000000000000001001322020432600166610ustar00rootroot00000000000000[pytest] addopts = -vvv --cov=preparer --cov-report=term-missingpython-preparer-0.1.0/requirements-dev.txt000066400000000000000000000001261322020432600207000ustar00rootroot00000000000000-r requirements.txt codecov flake8 pysimplemodel pytest pytest-cov Sphinx twine wheel python-preparer-0.1.0/requirements.txt000066400000000000000000000000001322020432600201130ustar00rootroot00000000000000python-preparer-0.1.0/setup.py000066400000000000000000000034521322020432600163570ustar00rootroot00000000000000import codecs import os import re from setuptools import setup, find_packages, Command here = os.path.abspath(os.path.dirname(__file__)) version = '0.0.0' changes = os.path.join(here, 'CHANGES.rst') match = r'^#*\s*(?P[0-9]+\.[0-9]+(\.[0-9]+)?)$' with codecs.open(changes, encoding='utf-8') as changes: for line in changes: res = re.match(match, line) if res: version = res.group('version') break # Get the long description with codecs.open(os.path.join(here, 'README.rst'), encoding='utf-8') as f: long_description = f.read() # Get version with codecs.open(os.path.join(here, 'CHANGES.rst'), encoding='utf-8') as f: changelog = f.read() install_requirements = [] tests_requirements = [ 'pysimplemodel', 'pytest', 'pytest-cov', ] class VersionCommand(Command): description = 'print library version' user_options = [] def initialize_options(self): pass def finalize_options(self): pass def run(self): print(version) setup( name='preparer', version=version, description='Simple way to build a new dict based on fields declaration', long_description=long_description, url='https://github.com/allisson/python-preparer', author='Allisson Azevedo', author_email='allisson@gmail.com', classifiers=[ 'Development Status :: 3 - Alpha', 'Intended Audience :: Developers', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Topic :: Software Development :: Libraries', ], packages=find_packages(exclude=['docs', 'tests*']), setup_requires=['pytest-runner'], install_requires=install_requirements, tests_require=tests_requirements, cmdclass={ 'version': VersionCommand, }, ) python-preparer-0.1.0/tests/000077500000000000000000000000001322020432600160035ustar00rootroot00000000000000python-preparer-0.1.0/tests/__init__.py000066400000000000000000000000001322020432600201020ustar00rootroot00000000000000python-preparer-0.1.0/tests/conftest.py000066400000000000000000000032331322020432600202030ustar00rootroot00000000000000import pytest from preparer import CollectionSubPreparer, FieldsPreparer, SubPreparer @pytest.fixture def payload(): return { 'type': 'articles', 'id': '1', 'attributes': { 'title': 'JSON API paints my bikeshed!', 'body': 'The shortest article. Ever.', 'created': '2015-05-22T14:56:29.000Z', 'updated': '2015-05-22T14:56:28.000Z' }, 'relationships': { 'author': { 'data': {'id': '42', 'type': 'people'} } }, 'tags': [ {'name': 'tag-1', 'count': 1}, {'name': 'tag-2', 'count': 2}, {'name': 'tag-3', 'count': 3}, ], } @pytest.fixture def simple_preparer_without_fields(): return FieldsPreparer() @pytest.fixture def simple_preparer(): fields = { 'type': 'type', 'id': 'id', 'title': 'attributes.title', 'body': 'attributes.body', 'relationship_id': 'relationships.author.data.id' } return FieldsPreparer(fields=fields) @pytest.fixture def preparer_with_subpreparer(): attributes_preparer = FieldsPreparer( fields={'title': 'title', 'body': 'body'} ) fields = { 'type': 'type', 'id': 'id', 'attrs': SubPreparer('attributes', attributes_preparer) } return FieldsPreparer(fields=fields) @pytest.fixture def preparer_with_collectionsubpreparer(): tags_preparer = FieldsPreparer(fields={'tag_name': 'name'}) fields = { 'type': 'type', 'id': 'id', 'tag_list': CollectionSubPreparer('tags', tags_preparer) } return FieldsPreparer(fields=fields) python-preparer-0.1.0/tests/test_preparers.py000066400000000000000000000046421322020432600214250ustar00rootroot00000000000000from simple_model.builder import model_builder def test_simple_preparer_lookup_data_with_dict(simple_preparer, payload): assert simple_preparer.lookup_data('', payload) == payload assert simple_preparer.lookup_data('type', payload) == payload['type'] assert simple_preparer.lookup_data('attributes.title', payload) == payload['attributes']['title'] assert simple_preparer.lookup_data('relationships.author.data.id', payload) == payload['relationships']['author']['data']['id'] def test_simple_preparer_lookup_data_with_object(simple_preparer, payload): obj = model_builder(payload) assert simple_preparer.lookup_data('', obj) == obj assert simple_preparer.lookup_data('type', obj) == obj.type assert simple_preparer.lookup_data('attributes.title', obj) == obj.attributes.title assert simple_preparer.lookup_data('relationships.author.data.id', obj) == obj.relationships.author.data.id def test_simple_preparer_prepare(simple_preparer, payload): expected = { 'type': 'articles', 'id': '1', 'title': 'JSON API paints my bikeshed!', 'body': 'The shortest article. Ever.', 'relationship_id': '42' } assert simple_preparer.prepare(payload) == expected assert simple_preparer.prepare(model_builder(payload)) == expected def test_simple_preparer_without_fields_prepare(simple_preparer_without_fields, payload): assert simple_preparer_without_fields.prepare(payload) == payload assert simple_preparer_without_fields.prepare(model_builder(payload)) == payload def test_preparer_with_subpreparer_prepare(preparer_with_subpreparer, payload): expected = { 'type': 'articles', 'id': '1', 'attrs': { 'title': 'JSON API paints my bikeshed!', 'body': 'The shortest article. Ever.' } } assert preparer_with_subpreparer.prepare(payload) == expected assert preparer_with_subpreparer.prepare(model_builder(payload)) == expected def test_preparer_with_collectionsubpreparer_prepare(preparer_with_collectionsubpreparer, payload): expected = { 'type': 'articles', 'id': '1', 'tag_list': [ {'tag_name': 'tag-1'}, {'tag_name': 'tag-2'}, {'tag_name': 'tag-3'}, ] } assert preparer_with_collectionsubpreparer.prepare(payload) == expected assert preparer_with_collectionsubpreparer.prepare(model_builder(payload)) == expected