Fix #113 Transparent support for jsonapi-rb and other response renderer that use custom format

Author: Paulo Mateus Moura da Silva

README.md

@@ -42,6 +42,9 @@ ApiPagination.configure do |config|
   # Optional: set this to add a header with the current page number.
   config.page_header = 'X-Page'
 
+  # Optional: set this to add other response format. Useful with tools that define :jsonapi format
+  config.response_formats = [:json, :xml, :jsonapi]
+
   # Optional: what parameter should be used to set the page option
   config.page_param = :page
   # or

lib/api-pagination/configuration.rb

@@ -10,6 +10,8 @@ class Configuration
 
     attr_accessor :base_url
 
+    attr_accessor :response_formats
+
     def configure(&block)
       yield self
     end
@@ -20,6 +22,7 @@ def initialize
       @page_header     = nil
       @include_total   = true
       @base_url   = nil
+      @response_formats = [:json, :xml]
     end
 
     ['page', 'per_page'].each do |param_name|

lib/rails/pagination.rb

@@ -8,11 +8,12 @@ def paginate(*options_or_collection)
 
       return _paginate_collection(collection, options) if collection
 
-      collection = options[:json] || options[:xml]
+      response_format = _discover_format(options)
+
+      collection = options[response_format]
       collection = _paginate_collection(collection, options)
 
-      options[:json] = collection if options[:json]
-      options[:xml]  = collection if options[:xml]
+      options[response_format] = collection if options[response_format]
 
       render options
     end
@@ -23,6 +24,12 @@ def paginate_with(collection)
 
     private
 
+    def _discover_format(options)
+      for response_format in ApiPagination.config.response_formats
+        return response_format if options.key?(response_format)
+      end
+    end
+
     def _paginate_collection(collection, options={})
       options[:page] = ApiPagination.config.page_param(params)
       options[:per_page] ||= ApiPagination.config.per_page_param(params)