Merge branch 'master' into pyup-scheduled-update-2020-12-21

Author: sliverc

.github/workflows/tests.yml

@@ -0,0 +1,55 @@
+name: Tests
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Run test
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.django-rest-framework == 'master' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
+        django: ["2.2", "3.0", "3.1"]
+        django-rest-framework: ["3.12", "master"]
+    env:
+      PYTHON: ${{ matrix.python-version }}
+      DJANGO: ${{ matrix.django }}
+      DJANGO_REST_FRAMEWORK: ${{ matrix.django-rest-framework }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v1
+        with:
+          env_vars: PYTHON,DJANGO,DJANGO_REST_FRAMEWORK
+  check:
+    name: Run check
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        tox-env: ["black", "lint", "docs"]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.6
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run lint
+        run: tox
+        env:
+          TOXENV: ${{ matrix.tox-env }}

.travis.yml

@@ -15,6 +15,7 @@ Jason Housley <[email protected]>
 Jerel Unruh <[email protected]>
 Jonathan Senecal <[email protected]>
 Joseba Mendivil <[email protected]>
+Kevin Partington <[email protected]>
 Kieran Evans <[email protected]>
 Léo S. <[email protected]>
 Luc Cary <[email protected]>

AUTHORS

@@ -13,6 +13,7 @@ any parts of the framework not mentioned in the documentation should generally b
 ### Added
 
 * Ability for the user to select `included_serializers` to apply when using `BrowsableAPI`, based on available `included_serializers` defined for the current endpoint.
+* Ability for the user to format serializer properties in URL segments using the `JSON_API_FORMAT_RELATED_LINKS` setting.
 
 ### Fixed
 

CHANGELOG.md

@@ -2,8 +2,9 @@
 JSON API and Django Rest Framework
 ==================================
 
-.. image:: https://travis-ci.com/django-json-api/django-rest-framework-json-api.svg?branch=master
-   :target: https://travis-ci.com/django-json-api/django-rest-framework-json-api
+.. image:: hhttps://github.com/django-json-api/django-rest-framework-json-api/workflows/Tests/badge.svg
+   :alt: Tests
+   :target: https://github.com/django-json-api/django-rest-framework-json-api/actions
 
 .. image:: https://readthedocs.org/projects/django-rest-framework-json-api/badge/?version=latest
    :alt: Read the docs

README.rst

@@ -477,6 +477,44 @@ When set to pluralize:
 }
 ```
 
+#### Related URL segments
+
+Serializer properties in relationship and related resource URLs may be infected using the `JSON_API_FORMAT_RELATED_LINKS` setting.
+
+``` python
+JSON_API_FORMAT_RELATED_LINKS = 'dasherize'
+```
+
+For example, with a serializer property `created_by` and with `'dasherize'` formatting:
+
+```json
+{
+  "data": {
+      "type": "comments",
+      "id": "1",
+      "attributes": {
+          "text": "Comments are fun!"
+      },
+      "links": {
+          "self": "/comments/1"
+      },
+      "relationships": {
+        "created_by": {
+          "links": {
+            "self": "/comments/1/relationships/created-by",
+            "related": "/comments/1/created-by"
+          }
+        }
+      }
+  },
+  "links": {
+      "self": "/comments/1"
+  }
+}
+```
+
+The relationship name is formatted by the `JSON_API_FORMAT_FIELD_NAMES` setting, but the URL segments are formatted by the `JSON_API_FORMAT_RELATED_LINKS` setting.
+
 ### Related fields
 
 #### ResourceRelatedField
@@ -703,6 +741,14 @@ class OrderSerializer(serializers.HyperlinkedModelSerializer):
     }
 ```
 
+<div class="warning">
+    <strong>Note:</strong>
+    Even though with related urls relations are served on different urls there are still served
+    by the same view. This means that the object permission check is performed on the parent object.
+    In other words when the parent object is accessible by the user the related object will be as well.
+</div>
+
+
 ### RelationshipView
 `rest_framework_json_api.views.RelationshipView` is used to build
 relationship views (see the

docs/usage.md

@@ -13,7 +13,7 @@
 JSON_API_FORMAT_TYPES = "camelize"
 JSON_API_PLURALIZE_TYPES = True
 
-REST_FRAMEWORK.update(
+REST_FRAMEWORK.update(  # noqa: F405
     {  # noqa
         "PAGE_SIZE": 1,
     }

example/settings/test.py

@@ -15,6 +15,7 @@
 from rest_framework_json_api.exceptions import Conflict
 from rest_framework_json_api.utils import (
     Hyperlink,
+    format_link_segment,
     get_included_serializers,
     get_resource_type_from_instance,
     get_resource_type_from_queryset,
@@ -112,14 +113,10 @@ def get_links(self, obj=None, lookup_field="pk"):
             else view.kwargs[lookup_field]
         }
 
+        field_name = self.field_name if self.field_name else self.parent.field_name
+
         self_kwargs = kwargs.copy()
-        self_kwargs.update(
-            {
-                "related_field": self.field_name
-                if self.field_name
-                else self.parent.field_name
-            }
-        )
+        self_kwargs.update({"related_field": format_link_segment(field_name)})
         self_link = self.get_url("self", self.self_link_view_name, self_kwargs, request)
 
         # Assuming RelatedField will be declared in two ways:

rest_framework_json_api/relations.py

@@ -1,9 +1,22 @@
+from collections import OrderedDict
+
 import inflection
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.models.query import QuerySet
 from django.utils.translation import gettext_lazy as _
 from rest_framework.exceptions import ParseError
-from rest_framework.serializers import *  # noqa: F403
+
+# star import defined so `rest_framework_json_api.serializers` can be
+# a simple drop in for `rest_framework.serializers`
+from rest_framework.serializers import *  # noqa: F401, F403
+from rest_framework.serializers import (
+    BaseSerializer,
+    HyperlinkedModelSerializer,
+    ModelSerializer,
+    Serializer,
+    SerializerMetaclass,
+)
+from rest_framework.settings import api_settings
 
 from rest_framework_json_api.exceptions import Conflict
 from rest_framework_json_api.relations import ResourceRelatedField

rest_framework_json_api/serializers.py

@@ -12,6 +12,7 @@
 DEFAULTS = {
     "FORMAT_FIELD_NAMES": False,
     "FORMAT_TYPES": False,
+    "FORMAT_RELATED_LINKS": False,
     "PLURALIZE_TYPES": False,
     "UNIFORM_EXCEPTIONS": False,
 }