using->location

tomchristie · tomchristie · commit ce403e01db5b · 2016-01-13T16:49:56.000Z
diff --git a/coreapi/codecs/corejson.py b/coreapi/codecs/corejson.py
@@ -90,8 +90,8 @@ def _document_to_primative(node, base_url=None):
         ret = OrderedDict({'name': node.name})
         if node.required:
             ret['required'] = True
-        if node.type:
-            ret['type'] = node.type
+        if node.location:
+            ret['location'] = node.location
         return ret
 
     elif isinstance(node, Object):
@@ -168,7 +168,7 @@ def _primative_to_document(data, base_url=None):
             # Transform the strings or dicts into strings or Field instances.
             fields = [
                 item if isinstance(item, string_types) else
-                Field(item['name'], required=bool(item.get('required', False)), type=str(item.get('type', '')))
+                Field(item['name'], required=bool(item.get('required', False)), location=str(item.get('type', '')))
                 for item in fields
             ]
 
diff --git a/coreapi/document.py b/coreapi/document.py
@@ -36,12 +36,12 @@ def _key_sorting(item):
 
 # The field class, as used by Link objects:
 
-Field = namedtuple('Field', ['name', 'required', 'type'])
+Field = namedtuple('Field', ['name', 'required', 'location'])
 Field.__new__.__defaults__ = (False, '')
 
 
 def required(name):
-    return Field(name, required=True, type='')
+    return Field(name, required=True, location='')
 
 
 # The Core API primatives:
@@ -195,7 +195,7 @@ def __init__(self, url=None, action=None, inplace=None, fields=None):
         self._action = '' if (action is None) else action
         self._inplace = inplace
         self._fields = () if (fields is None) else tuple([
-            item if isinstance(item, Field) else Field(item, required=False, type='')
+            item if isinstance(item, Field) else Field(item, required=False, location='')
             for item in fields
         ])
 
diff --git a/coreapi/transport.py b/coreapi/transport.py
@@ -61,15 +61,15 @@ def get_params(self, method, link, params=None):
         query_params = {}
         form_params = {}
         for key, value in params.items():
-            if key not in fields or not fields[key].type:
+            if key not in fields or not fields[key].location:
                 # Default is 'query' for 'GET'/'DELETE', and 'form' others.
-                param_type = 'query' if method in ('GET', 'DELETE') else 'form'
+                location = 'query' if method in ('GET', 'DELETE') else 'form'
             else:
-                param_type = fields[key].type
+                location = fields[key].location
 
-            if param_type == 'path':
+            if location == 'path':
                 path_params[key] = value
-            elif param_type == 'query':
+            elif location == 'query':
                 query_params[key] = value
             else:
                 form_params[key] = value
diff --git a/tests/test_codecs.py b/tests/test_codecs.py
@@ -152,7 +152,7 @@ def test_link_encodings(json_codec):
         'link': Link(
             action='post',
             inplace=True,
-            fields=['optional', Field('required', required=True, type='path')]
+            fields=['optional', Field('required', required=True, location='path')]
         )
     })
     bytes = json_codec.dump(doc, indent=True)
@@ -169,7 +169,7 @@ def test_link_encodings(json_codec):
             {
                 "name": "required",
                 "required": true,
-                "type": "path"
+                "location": "path"
             }
         ]
     }
diff --git a/tests/test_transport.py b/tests/test_transport.py
@@ -77,7 +77,7 @@ def mockreturn(method, url, **opts):
     link = Link(
         url='http://example.org/{user_id}/',
         action='get',
-        fields=[Field(name='user_id', type='path')]
+        fields=[Field(name='user_id', location='path')]
     )
     doc = http.transition(link, params={'user_id': 123})
     assert doc == {'example': 'http://example.org/123/'}

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ def test_link_encodings(json_codec):`
`152`	`152`	`'link': Link(`
`153`	`153`	`action='post',`
`154`	`154`	`inplace=True,`
`155`		`- fields=['optional', Field('required', required=True, type='path')]`
	`155`	`+ fields=['optional', Field('required', required=True, location='path')]`
`156`	`156`	`)`
`157`	`157`	`})`
`158`	`158`	`bytes = json_codec.dump(doc, indent=True)`
`@@ -169,7 +169,7 @@ def test_link_encodings(json_codec):`
`169`	`169`	`{`
`170`	`170`	`"name": "required",`
`171`	`171`	`"required": true,`
`172`		`- "type": "path"`
	`172`	`+ "location": "path"`
`173`	`173`	`}`
`174`	`174`	`]`
`175`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ def mockreturn(method, url, **opts):`
`77`	`77`	`link = Link(`
`78`	`78`	`url='http://example.org/{user_id}/',`
`79`	`79`	`action='get',`
`80`		`- fields=[Field(name='user_id', type='path')]`
	`80`	`+ fields=[Field(name='user_id', location='path')]`
`81`	`81`	`)`
`82`	`82`	`doc = http.transition(link, params={'user_id': 123})`
`83`	`83`	`assert doc == {'example': 'http://example.org/123/'}`