Make Grape interface consistent with Rails'

Signed-off-by: David Celis <[email protected]>

Author: davidcelis

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright © 2013 David Celis
+Copyright © 2014 David Celis
 
 MIT License
 

README.md

@@ -39,8 +39,9 @@ class MoviesController < ApplicationController
   def cast
     actors = Movie.find(params[:id]).actors
 
-    # Override how many Actors get returned. The default is 10.
-    paginate json: actors, per_page: 25
+    # Override how many Actors get returned. If unspecified,
+    # params[:per_page] (which defaults to 25) will be used.
+    paginate json: actors, per_page: 10
   end
 end
 ```
@@ -63,13 +64,21 @@ class MoviesAPI < Grape::API
   format :json
 
   desc 'Return a paginated set of movies'
-  paginate per_page: 25
-  get :numbers do
-    movies = Movie.all # Movie.scoped if using ActiveRecord 3.x
-
+  paginate
+  get do
     # This method must take an ActiveRecord::Relation
     # or some equivalent pageable set.
-    paginate movies
+    paginate Movie.all
+  end
+
+  route_param :id do
+    desc "Return one movie's cast, paginated"
+    # Override how many Actors get returned. If unspecified,
+    # params[:per_page] (which defaults to 25) will be used.
+    paginate per_page: 10
+    get :cast do
+      paginate Movie.find(params[:id]).actors
+    end
   end
 end
 ```

lib/api-pagination.rb

@@ -7,7 +7,7 @@ class << self
 
     def paginate(collection, options = {})
       options[:page]     ||= 1
-      options[:per_page] ||= 10
+      options[:per_page] ||= 25
 
       case ApiPagination.paginator
       when :kaminari

lib/grape/pagination.rb

@@ -3,7 +3,11 @@ module Pagination
     def self.included(base)
       Grape::Endpoint.class_eval do
         def paginate(collection)
-          collection = ApiPagination.paginate(collection, params)
+          options = {
+            :page     => params[:page],
+            :per_page => (settings[:per_page] || params[:per_page])
+          }
+          collection = ApiPagination.paginate(collection, options)
 
           links = (header['Link'] || "").split(',').map(&:strip)
           url   = request.url.sub(/\?.*$/, '')
@@ -24,11 +28,11 @@ def paginate(collection)
 
       base.class_eval do
         def self.paginate(options = {})
-          options.reverse_merge!(:per_page => 10)
+          set :per_page, options[:per_page]
           params do
             optional :page,     :type => Integer, :default => 1,
                                 :desc => 'Page of results to fetch.'
-            optional :per_page, :type => Integer, :default => options[:per_page],
+            optional :per_page, :type => Integer,
                                 :desc => 'Number of results to return per page.'
           end
         end

lib/rails/pagination.rb

@@ -19,8 +19,11 @@ def paginate_with(collection)
     private
 
     def _paginate_collection(collection, options)
-      params[:per_page] = options.delete(:per_page) if options[:per_page]
-      collection = ApiPagination.paginate(collection, params)
+      options = {
+        :page     => params[:page],
+        :per_page => (options.delete(:per_page) || params[:per_page])
+      }
+      collection = ApiPagination.paginate(collection, options)
 
       links = (headers['Link'] || "").split(',').map(&:strip)
       url   = request.original_url.sub(/\?.*$/, '')

spec/support/numbers_controller.rb

@@ -55,6 +55,6 @@ def index
       headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without")
     end
 
-    paginate :json => (1..total).to_a
+    paginate :json => (1..total).to_a, :per_page => 10
   end
 end