Skip to content

feat: support relationships that are named "type" #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: support relationships that are named "type" #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ The simplified version will be:

[
{
"type": "articles",
"$type": "articles",
"id": "1",
"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",
"author": {
"type": "people",
"$type": "people",
"id": "42",
"name": "John",
"age": 80,
Expand Down
8 changes: 5 additions & 3 deletions json_api_doc/deserialization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def _resolve(data, included, resolved):
for key, value in data.items():
if isinstance(value, tuple):
id = {
"type": value[0],
"$type": value[0],
"id": value[1]
}
resolved_item = included.get(value, id)
Expand All @@ -52,7 +52,7 @@ def _resolve(data, included, resolved):
for item in value:
if isinstance(item, tuple):
id = {
"type": item[0],
"$type": item[0],
"id": item[1]
}
resolved_item = included.get(item, id)
Expand All @@ -73,13 +73,15 @@ def _resolve(data, included, resolved):
def _parse_included(included):
result = {}
for include in included:
result[(include["type"], include["id"])] = _flat(include)
result[(include["$type"], include["id"])] = _flat(include)
return result


def _flat(obj):
obj['$type'] = obj.pop('type')
obj.pop("links", None)
obj.update(obj.pop("attributes", {}))

if "relationships" in obj:
for relationship, item in obj.pop("relationships").items():
data = item.get("data")
Expand Down
51 changes: 43 additions & 8 deletions tests/test_relationships.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def test_parse_included():
}]
assert json_api_doc._parse_included(data) == {
("people", "9"): {
"type": "people",
"$type": "people",
"id": "9",
"first-name": "Bob",
"last-name": "Doe",
Expand Down Expand Up @@ -101,7 +101,7 @@ def test_resolve_missing():
doc = json_api_doc._resolve(data, included, set())
assert doc == {
"title": "Article 1",
"author": {"type": "people", "id": "9"}
"author": {"$type": "people", "id": "9"}
}


Expand Down Expand Up @@ -145,8 +145,8 @@ def test_resolve_list_missing_items():
assert doc == {
"title": "Article 1",
"authors": [
{"id": "9", "type": "people"},
{"id": "10", "type": "people"}
{"id": "9", "$type": "people"},
{"id": "10", "$type": "people"}
]
}

Expand Down Expand Up @@ -204,7 +204,7 @@ def test_resolve_loop():
"name": "Jean",
"father": {
"name": "Luc",
"son": {"type": "people", "id": "1"}
"son": {"$type": "people", "id": "1"}
}
}
}
Expand Down Expand Up @@ -235,11 +235,11 @@ def test_simple_relationships():
}
doc = json_api_doc.parse(response)
assert doc == {
"type": "article",
"$type": "article",
"id": "1",
"title": "Article 1",
"author": {
"type": "people",
"$type": "people",
"id": "9",
"first-name": "Bob",
"last-name": "Doe"
Expand All @@ -266,7 +266,7 @@ def test_linked_relationship():
}
doc = json_api_doc.parse(response)
assert doc == {
"type": "article",
"$type": "article",
"id": "1",
"title": "Article 1",
"author": {
Expand All @@ -275,3 +275,38 @@ def test_linked_relationship():
}
}
}


def test_type_relationship():
response = {
"data": {
"type": "article",
"id": "1",
"attributes": {
"title": "Article 1"
},
"relationships": {
"type": {
"data": {"type": "article-type", "id": "9"}
}
}
},
"included": [{
"type": "article-type",
"id": "9",
"attributes": {
"field": "value"
}
}]
}
doc = json_api_doc.parse(response)
assert doc == {
"$type": "article",
"id": "1",
"title": "Article 1",
"type": {
"$type": "article-type",
"id": "9",
"field": "value"
}
}
8 changes: 4 additions & 4 deletions tests/test_simple.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def test_simple_object():
}
doc = json_api_doc.parse(response)
assert doc == {
"type": "article",
"$type": "article",
"id": "1",
"title": "Article 1"
}
Expand All @@ -44,7 +44,7 @@ def test_simple_object_without_attributes():
}
doc = json_api_doc.parse(response)
assert doc == {
"type": "article",
"$type": "article",
"id": "1"
}

Expand All @@ -71,12 +71,12 @@ def test_simple_list():
doc = json_api_doc.parse(response)
assert len(doc) == 2
assert doc[0] == {
"type": "article",
"$type": "article",
"id": "1",
"title": "Article 1"
}
assert doc[1] == {
"type": "article",
"$type": "article",
"id": "2",
"title": "Article 2"
}
Expand Down