Feature to format the relation names

docs/usage.md

@@ -55,7 +55,7 @@ If you set the `resource_name` property on the object to `False` the data
 will be returned without modification.
 
 
-### Inflecting object keys
+### Inflecting object and relation keys
 
 This package includes the ability (off by default) to automatically convert json
 requests and responses from the python/rest_framework's preferred underscore to
@@ -120,6 +120,60 @@ Example - With format conversion set to `dasherize`:
 }
 ```
 
+#### Relationship types
+
+A similar option to JSON\_API\_FORMAT\_KEYS can be set for the relationship names:
+
+``` python
+JSON_API_FORMAT_RELATION_KEYS = 'dasherize'
+```
+
+Example without format conversion:
+
+``` js
+{
+	"data": [{
+        "type": "identities",
+        "id": 3,
+        "attributes": {
+                ...
+        },
+        "relationships": {
+            "home_town": {
+                "data": [{
+                    "type": "home_town",
+                    "id": 3
+                }]
+            }
+        }
+    }]
+}
+```
+
+When set to dasherize:
+
+
+``` js
+{
+	"data": [{
+        "type": "identities",
+        "id": 3,
+        "attributes": {
+                ...
+        },
+        "relationships": {
+            "home_town": {
+                "data": [{
+                    "type": "home-town",
+                    "id": 3
+                }]
+            }
+        }
+    }]
+}
+```
+
+
 <!-- 
 ### Relationships
 ### Links

rest_framework_json_api/utils.py

@@ -128,6 +128,21 @@ def format_value(value, format_type=None):
     return value
 
 
+def format_relation_name(value, format_type=None):
+    format_type = getattr(settings, 'JSON_API_FORMAT_RELATION_KEYS', False)
+
+    value = inflection.underscore(value)
+
+    if format_type == 'dasherize':
+        value = inflection.dasherize(value)
+    elif format_type == 'camelize':
+        value = inflection.camelize(value)
+    elif format_type == 'underscore':
+        value = inflection.underscore(value)
+
+    return inflection.pluralize(value)
+
+
 def build_json_resource_obj(fields, resource, resource_instance, resource_name):
     resource_data = [
         ('type', resource_name),
@@ -168,7 +183,7 @@ def get_related_resource_type(relation):
             relation_model = parent_model_relation.field.related.model
         else:
             raise APIException('Unable to find related model for relation {relation}'.format(relation=relation))
-    return inflection.pluralize(relation_model.__name__).lower()
+    return format_relation_name(relation_model.__name__)
 
 
 def extract_id_from_url(url):
@@ -280,7 +295,7 @@ def extract_relationships(fields, resource, resource_instance):
 
             serializer = field.child
             relation_model = serializer.Meta.model
-            relation_type = inflection.pluralize(relation_model.__name__).lower()
+            relation_type = format_relation_name(relation_model.__name__)
 
             # Get the serializer fields
             serializer_fields = get_serializer_fields(serializer)
@@ -297,7 +312,7 @@ def extract_relationships(fields, resource, resource_instance):
 
         if isinstance(field, ModelSerializer):
             relation_model = field.Meta.model
-            relation_type = inflection.pluralize(relation_model.__name__).lower()
+            relation_type = format_relation_name(relation_model.__name__)
 
             # Get the serializer fields
             serializer_fields = get_serializer_fields(field)
@@ -331,7 +346,7 @@ def extract_included(fields, resource, resource_instance):
 
             serializer = field.child
             model = serializer.Meta.model
-            relation_type = inflection.pluralize(model.__name__).lower()
+            relation_type = format_relation_name(model.__name__)
 
             # Get the serializer fields
             serializer_fields = get_serializer_fields(serializer)
@@ -350,7 +365,7 @@ def extract_included(fields, resource, resource_instance):
         if isinstance(field, ModelSerializer):
 
             model = field.Meta.model
-            relation_type = inflection.pluralize(model.__name__).lower()
+            relation_type = format_relation_name(model.__name__)
 
             # Get the serializer fields
             serializer_fields = get_serializer_fields(field)