144 allow to filter position collection by kind (#158)

* Fix #144 - Allow to filter Position collection by kind.

* Fix #144 - Allow to filter Position collection by kind.

* Fix #144 - Allowed_params

* Fix #144 - Fixes:
   . Add Position.allowed_params.
   . Move get_where_clause() from PostCode to BaseCRUD.
   . Include get_where_clause() into BaseCRUD.on_get().
   . Add 4 tests in Test_Position.py.

* Fix #144 - Delete identifiers from ban/core/models.py

* Fix #144 - Fix on Position & PostCode tests.
   . Check 'kind' value on Position tests.
   . Check 'code' value on PostCode tests.

Author: flyusfly

ban/http/resources.py

@@ -81,11 +81,19 @@ def get_collection(self, req, resp, **params):
                     else [self.model.pk])
         return self.model.select().order_by(*order_by)
 
+    def get_where_clause(self, req, qs):
+        for param in self.allowed_params:
+            values = req.get_param_as_list(param)
+            if values:
+                qs = qs.where(getattr(self.model, param) << values)
+        return qs
+
     @auth.protect
     @app.endpoint()
     def on_get(self, req, resp, **params):
         """Get {resource} collection."""
         qs = self.get_collection(req, resp, **params)
+        qs = self.get_where_clause(req, qs)
         self.collection(req, resp, qs.as_resource())
 
     @auth.protect
@@ -241,6 +249,7 @@ def get_bbox(self, req):
 class Position(VersionnedResource, BboxResource):
     """Manipulate position resources."""
     model = models.Position
+    allowed_params = ['kind']
 
     def get_collection(self, req, resp, **kwargs):
         qs = super().get_collection(req, resp, **kwargs)
@@ -299,21 +308,6 @@ class Postcode(WithHousenumbers):
     order_by = [model.code, model.municipality]
     allowed_params = ['code']
 
-    def get_where_clause(self, req, qs):
-        for param in self.allowed_params:
-            values = req.get_param_as_list(param)
-            if values:
-                qs = qs.where(getattr(self.model, param) << values)
-        return qs
-
-    @auth.protect
-    @app.endpoint()
-    def on_get(self, req, resp, **params):
-        """Get {resource} collection."""
-        qs = self.get_collection(req, resp, **params)
-        qs = self.get_where_clause(req, qs)
-        self.collection(req, resp, qs.as_resource())
-
 
 class Municipality(VersionnedResource):
     model = models.Municipality

ban/tests/http/test_position.py

@@ -442,3 +442,50 @@ def test_get_position_collection_filtered_by_bbox_is_paginated(get, url):
     assert 'previous' in page2
     resp = get(page2['previous'])
     assert resp.json == page1
+
+
+@authorize
+def test_get_position_collection_filtered_by_1_kind_param(get, url):
+    PositionFactory(kind='entrance')
+    PositionFactory(kind='exit')
+    resp = get(url('position', query_string={'kind': 'entrance'}))
+    assert resp.status == falcon.HTTP_200
+    assert resp.json['total'] == 1
+    assert resp.json['collection'][0]['kind'] == 'entrance'
+
+
+@authorize
+def test_get_position_collection_filtered_by_2_equals_kind_params(get, url):
+    PositionFactory(kind='entrance')
+    PositionFactory(kind='exit')
+    # 'kind' given by the user is used twice but with the same value.
+    params = (('kind', 'entrance'), ('kind', 'entrance'))
+    resp = get(url('position', query_string=params))
+    assert resp.status == falcon.HTTP_200
+    assert resp.json['total'] == 1
+    assert resp.json['collection'][0]['kind'] == 'entrance'
+
+
+@authorize
+def test_get_position_collection_filtered_by_2_diff_kind_params(get, url):
+    PositionFactory(kind='entrance')
+    PositionFactory(kind='exit')
+    # 'kind' given by the user is used with 2 differents values.
+    params = (('kind', 'entrance'), ('kind', 'exit'))
+    resp = get(url('position', query_string=params))
+    assert resp.status == falcon.HTTP_200
+    assert resp.json['total'] == 2
+    assert resp.json['collection'][0]['kind'] == 'entrance'
+    assert resp.json['collection'][1]['kind'] == 'exit'
+
+
+@authorize
+def test_get_position_collection_can_be_filtered_by_1_kind_and_1_pk(get, url):
+    PositionFactory(kind='entrance')
+    PositionFactory(kind='exit')
+    # Only 'kind' param will be used to filter, not 'pk' one.
+    params = (('kind', 'entrance'), ('pk', '405'))
+    resp = get(url('position', query_string=params))
+    assert resp.status == falcon.HTTP_200
+    assert resp.json['total'] == 1
+    assert resp.json['collection'][0]['kind'] == 'entrance'

ban/tests/http/test_postcode.py

@@ -56,6 +56,7 @@ def test_get_postcode_collection_filtered_by_1_code_param(get, url):
     resp = get(url('postcode', query_string={'code': '90000'}))
     assert resp.status == falcon.HTTP_200
     assert resp.json['total'] == 1
+    assert resp.json['collection'][0]['code'] == '90000'
 
 
 @authorize
@@ -67,6 +68,7 @@ def test_get_postcode_collection_filtered_by_2_equals_codes_param(get, url):
     resp = get(url('postcode', query_string=params))
     assert resp.status == falcon.HTTP_200
     assert resp.json['total'] == 1
+    assert resp.json['collection'][0]['code'] == '90000'
 
 
 @authorize
@@ -78,6 +80,8 @@ def test_get_postcode_collection_filtered_by_2_diff_codes_param(get, url):
     resp = get(url('postcode', query_string=params))
     assert resp.status == falcon.HTTP_200
     assert resp.json['total'] == 2
+    assert resp.json['collection'][0]['code'] == '90000'
+    assert resp.json['collection'][1]['code'] == '91000'
 
 
 @authorize
@@ -89,3 +93,4 @@ def test_get_postcode_collection_can_be_filtered_by_1_code_and_1_pk(get, url):
     resp = get(url('postcode', query_string=params))
     assert resp.status == falcon.HTTP_200
     assert resp.json['total'] == 1
+    assert resp.json['collection'][0]['code'] == '90000'