Added GeoJsonPagination

README.rst

@@ -25,6 +25,7 @@ Compatibility with DRF, Django and Python
 
 ===============  ============================ ==================== ==================================
 DRF-gis version  DRF version                  Django version       Python version
+**0.9.3**        **3.1.X**                    **1.5.x** to **1.8** **2.6** to **3.4**
 **0.9.2**        **3.1.X**                    **1.5.x** to **1.8** **2.6** to **3.4**
 **0.9.1**        **3.1.X**                    **1.5.x** to **1.8** **2.6** to **3.4**
 **0.9**          **3.1.X**                    **1.5.x** to **1.8** **2.6**, **2.7**, **3.3**, **3.4**
@@ -138,9 +139,6 @@ the above example, the ``GeoFeatureModelSerializer`` will output:
 If you are serializing an object list, ``GeoFeatureModelSerializer``
 will create a ``FeatureCollection``:
 
-(**NOTE:** This currenty does not work with the default pagination
-serializer)
-
 .. code-block:: javascript
 
     {
@@ -294,6 +292,54 @@ be saved as Polygons. Example:
             geo_field = 'geometry'
             bbox_geo_field = 'bbox_geometry'
 
+Pagination
+----------
+
+We provide a ``GeoJsonPagination`` class.
+
+GeoJsonPagination
+~~~~~~~~~~~~~~~~~
+
+Based on ``rest_framework.pagination.PageNumberPagination``.
+
+Code example:
+
+.. code-block:: python
+
+    from rest_framework_gis.pagination import GeoJsonPagination
+    # --- other omitted imports --- #
+
+    class GeojsonLocationList(generics.ListCreateAPIView):
+        # -- other omitted view attributes --- #
+        pagination_class = GeoJsonPagination
+
+Example result response (cut to one element only instead of 10):
+
+.. code-block:: javascript
+
+    {
+        "type": "FeatureCollection",
+        "count": 25,
+        "next": "http://localhost:8000/geojson/?page=2",
+        "previous": null,
+        "features": [
+            {
+                "type": "Feature",
+                "geometry": {
+                    "type": "Point",
+                    "coordinates": [
+                        42.0,
+                        50.0
+                    ]
+                },
+                "properties": {
+                    "name": "test"
+                }
+            }
+        ]
+    }
+
+
 Filters
 -------
 

rest_framework_gis/pagination.py

@@ -0,0 +1,22 @@
+try:
+    from collections import OrderedDict
+# python 2.6
+except ImportError:  # pragma: no cover
+    from ordereddict import OrderedDict
+
+from rest_framework import pagination
+from rest_framework.response import Response
+
+
+class GeoJsonPagination(pagination.PageNumberPagination):
+    """
+    A geoJSON implementation of a pagination serializer.
+    """
+    def get_paginated_response(self, data):
+        return Response(OrderedDict([
+            ('type', 'FeatureCollection'),
+            ('count', self.page.paginator.count),
+            ('next', self.get_next_link()),
+            ('previous', self.get_previous_link()),
+            ('features', data['features'])
+        ]))

tests/django_restframework_gis_tests/serializers.py

@@ -12,7 +12,6 @@
     'LocationGeoFeatureSerializer',
     'LocationGeoFeatureSlugSerializer',
     'LocationGeoFeatureFalseIDSerializer',
-    'PaginatedLocationGeoFeatureSerializer',
     'LocatedFileGeoFeatureSerializer',
     'BoxedLocationGeoFeatureSerializer',
     'LocationGeoFeatureBboxSerializer',
@@ -68,15 +67,6 @@ class Meta:
         id_field = False
 
 
-class PaginatedLocationGeoFeatureSerializer(pagination.PageNumberPagination):
-    page_size_query_param = 'limit'
-    page_size = 40
-    max_page_size = 10000
-
-    class Meta:
-        object_serializer_class = LocationGeoFeatureSerializer
-
-
 class LocatedFileGeoFeatureSerializer(gis_serializers.GeoFeatureModelSerializer):
     """ located file geo serializer  """
     details = serializers.HyperlinkedIdentityField(view_name='api_geojson_located_file_details')

tests/django_restframework_gis_tests/tests.py

@@ -524,3 +524,14 @@ class Meta:
                 exclude = ('geometry', )
         with self.assertRaises(ImproperlyConfigured):
             LocationGeoFeatureSerializer(instance=self.l1)
+
+    def test_geojson_pagination(self):
+        self._create_locations()
+        response = self.client.get(self.geojson_location_list_url)
+        self.assertEqual(response.data['type'], 'FeatureCollection')
+        self.assertEqual(len(response.data['features']), 2)
+        response = self.client.get('{0}?page_size=1'.format(self.geojson_location_list_url))
+        self.assertEqual(response.data['type'], 'FeatureCollection')
+        self.assertEqual(len(response.data['features']), 1)
+        self.assertIn('next', response.data)
+        self.assertIn('previous', response.data)

tests/django_restframework_gis_tests/views.py

@@ -1,6 +1,7 @@
 from rest_framework import generics
 from rest_framework.filters import DjangoFilterBackend
 from rest_framework_gis.filters import *
+from rest_framework_gis.pagination import GeoJsonPagination
 
 from .models import *
 from .serializers import *
@@ -28,7 +29,8 @@ class GeojsonLocationList(generics.ListCreateAPIView):
     model = Location
     serializer_class = LocationGeoFeatureSerializer
     queryset = Location.objects.all()
-    pagination_class = PaginatedLocationGeoFeatureSerializer
+    pagination_class = GeoJsonPagination
+    paginate_by_param = 'page_size'
 
 geojson_location_list = GeojsonLocationList.as_view()