return complete URIs on pagination links

Author: bacarini

docs/howto/add_pagination_links.md

@@ -30,10 +30,10 @@ ex:
     }
   ],
   "links": {
-    "first": "?page=1&per_page=1",
-    "prev": "?page=2&per_page=1",
-    "next": "?page=4&per_page=1",
-    "last": "?page=13&per_page=1"
+    "first": "http://example.com/articles?page=1&per_page=1",
+    "prev": "http://example.com/articles?page=2&per_page=1",
+    "next": "http://example.com/articles?page=4&per_page=1",
+    "last": "http://example.com/articles?page=13&per_page=1"
   }
 }
 ```

lib/action_controller/serialization.rb

@@ -25,6 +25,7 @@ def get_serializer(resource, options = {})
           "Please pass 'adapter: false' or see ActiveSupport::SerializableResource#serialize"
         options[:adapter] = false
       end
+      options[:original_url] = original_url
       ActiveModel::SerializableResource.serialize(resource, options) do |serializable_resource|
         if serializable_resource.serializer?
           serializable_resource.serialization_scope ||= serialization_scope
@@ -57,5 +58,9 @@ def serialization_scope(scope)
         self._serialization_scope = scope
       end
     end
+
+    def original_url
+      request.original_url.sub(/\?.*$/, "")
+    end
   end
 end

lib/active_model/serializer/adapter/json_api.rb

@@ -29,7 +29,7 @@ def serializable_hash(options = nil)
               end
             end
 
-            include_pagination_links if serializer.pagination
+            include_pagination_links if serializer.options[:pagination]
           else
             @hash[:data] = attributes_for_serializer(serializer, options)
             add_resource_relationships(@hash[:data], serializer)
@@ -168,7 +168,7 @@ def include_pagination_links
         end
 
         def page_links
-          @links ||= JsonApi::PaginationLinks.new(serializer.resource).page_links
+          @links ||= JsonApi::PaginationLinks.new(serializer.resource, serializer.options).page_links
         end
 
         def links?

lib/active_model/serializer/adapter/json_api/pagination_links.rb

@@ -5,11 +5,12 @@ class JsonApi < Adapter
         class PaginationLinks
           FIRST_PAGE = 1
 
-          attr_reader :collection
+          attr_reader :collection, :options
 
-          def initialize(collection)
+          def initialize(collection, options={})
             raise_unless_any_gem_installed
             @collection = collection
+            @options = options
           end
 
           def page_links
@@ -20,7 +21,7 @@ def page_links
 
           def build_links
             pages_from.each_with_object({}) do |(key, value), hash|
-              hash[key] = "?page=#{value}&per_page=#{collection.size}"
+              hash[key] = "#{url}?page=#{value}&per_page=#{collection.size}"
             end
           end
 
@@ -45,6 +46,15 @@ def raise_unless_any_gem_installed
             raise "AMS relies on either Kaminari or WillPaginate." +
               "Please install either dependency by adding one of those to your Gemfile"
           end
+
+          def url
+            return default_url unless options && options[:links] && options[:links][:self]
+            options[:links][:self]
+          end
+
+          def default_url
+            options[:original_url]
+          end
         end
       end
     end

lib/active_model/serializer/array_serializer.rb

@@ -5,7 +5,7 @@ class ArraySerializer
       include Enumerable
       delegate :each, to: :@objects
 
-      attr_reader :root, :meta, :meta_key, :pagination, :resource
+      attr_reader :root, :meta, :meta_key, :options, :resource
 
       def initialize(objects, options = {})
         @root = options[:root]
@@ -24,7 +24,7 @@ def initialize(objects, options = {})
         end
         @meta     = options[:meta]
         @meta_key = options[:meta_key]
-        @pagination = options[:pagination]
+        @options = options
       end
 
       def json_key

test/action_controller/json_api/pagination_test.rb

@@ -47,29 +47,37 @@ def render_array_omitting_pagination_options
         tests PaginationTestController
 
         def test_render_pagination_links_with_will_paginate
-          expected_links = {"first"=>"?page=1&per_page=1", "prev"=>"?page=1&per_page=1", "next"=>"?page=3&per_page=1", "last"=>"?page=3&per_page=1"}
+          expected_links = {"first"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate?page=1&per_page=1",
+            "prev"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate?page=1&per_page=1",
+            "next"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate?page=3&per_page=1",
+            "last"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate?page=3&per_page=1"}
 
           get :render_pagination_using_will_paginate, page: 2, per_page: 1
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
         def test_render_only_last_and_next_pagination_links
-          expected_links = {"next"=>"?page=2&per_page=2", "last"=>"?page=2&per_page=2"}
+          expected_links = {"next"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate?page=2&per_page=2",
+            "last"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate?page=2&per_page=2"}
           get :render_pagination_using_will_paginate, page: 1, per_page: 2
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
         def test_render_pagination_links_with_kaminari
-          expected_links = {"first"=>"?page=1&per_page=1", "prev"=>"?page=1&per_page=1", "next"=>"?page=3&per_page=1", "last"=>"?page=3&per_page=1"}
+          expected_links = {"first"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari?page=1&per_page=1",
+            "prev"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari?page=1&per_page=1",
+            "next"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari?page=3&per_page=1",
+            "last"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari?page=3&per_page=1"}
           get :render_pagination_using_kaminari, page: 2, per_page: 1
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
         def test_render_only_prev_and_first_pagination_links
-          expected_links = {"first"=>"?page=1&per_page=1", "prev"=>"?page=2&per_page=1"}
+          expected_links = {"first"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari?page=1&per_page=1",
+            "prev"=>"http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari?page=2&per_page=1"}
           get :render_pagination_using_kaminari, page: 3, per_page: 1
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']

test/action_controller/serialization_test.rb

@@ -404,6 +404,9 @@ def test_warn_overridding_use_adapter_as_falsy_on_controller_instance
           def use_adapter?
             false
           end
+          def original_url
+            "http://example.com/"
+          end
         }.new
         assert_match /adapter: false/, (capture(:stderr) {
           controller.get_serializer(Profile.new)
@@ -415,6 +418,9 @@ def test_dont_warn_overridding_use_adapter_as_truthy_on_controller_instance
           def use_adapter?
             true
           end
+          def original_url
+            "http://example.com/"
+          end
         }.new
         assert_equal "", (capture(:stderr) {
           controller.get_serializer(Profile.new)

test/array_serializer_test.rb

@@ -95,7 +95,7 @@ def test_json_key_with_root_and_no_serializers
 
       def test_pagination_attr_readers
         serializer = ArraySerializer.new(@resource, pagination: true)
-        assert_equal serializer.pagination, true
+        assert_equal serializer.options[:pagination], true
       end
 
       def test_resource