A platform for community discussion. Free, open, simple.
DEV: Add the JSON:API cursor pagination profile (#42805)
Loïc Guitaut1293c7302a52
diff --git a/app/controllers/json_api_kit/base_controller.rb b/app/controllers/json_api_kit/base_controller.rbindex 3639ff8b3c1..ea43f5af1b5 100644--- a/app/controllers/json_api_kit/base_controller.rb+++ b/app/controllers/json_api_kit/base_controller.rb@@ -43,7 +43,9 @@ module JsonApiKitenddef render_document(document)- render json: document.to_h, status: document.status, content_type: MediaType::JSON_API+ render json: document.to_h,+ status: document.status,+ content_type: Pagination::Profile::MEDIA_TYPEenddef negotiatediff --git a/lib/json_api_kit/document.rb b/lib/json_api_kit/document.rbindex bf0dab2f2a3..c804bd57314 100644--- a/lib/json_api_kit/document.rb+++ b/lib/json_api_kit/document.rb@@ -35,7 +35,7 @@ module JsonApiKitdef contents = @contents ||= Contents.new(primary_records, query.included)- def links = { self: urls.current.to_s }+ def links = { self: { href: urls.current.to_s, type: Pagination::Profile::MEDIA_TYPE } }def included = contents.related.map { ResourceObject.new(it, urls:).to_h }enddiff --git a/lib/json_api_kit/pagination/profile.rb b/lib/json_api_kit/pagination/profile.rbnew file mode 100644index 00000000000..6801452bc73--- /dev/null+++ b/lib/json_api_kit/pagination/profile.rb@@ -0,0 +1,12 @@+# frozen_string_literal: true++module JsonApiKit+ module Pagination+ module Profile+ URL = "https://jsonapi.org/profiles/ethanresnick/cursor-pagination"+ MAX_SIZE = "#{URL}/max-size-exceeded"+ RANGE_UNSUPPORTED = "#{URL}/range-pagination-not-supported"+ MEDIA_TYPE = %(#{MediaType::JSON_API};profile="#{URL}")+ end+ end+enddiff --git a/lib/json_api_kit/request/contract/mapper.rb b/lib/json_api_kit/request/contract/mapper.rbindex bfa4e620cc1..7c1d803afcf 100644--- a/lib/json_api_kit/request/contract/mapper.rb+++ b/lib/json_api_kit/request/contract/mapper.rb@@ -4,9 +4,6 @@ module JsonApiKitclass Requestclass Contractclass Mapper- MAX_SIZE = "https://jsonapi.org/profiles/ethanresnick/cursor-pagination/max-size-exceeded"- RANGE_UNSUPPORTED =- "https://jsonapi.org/profiles/ethanresnick/cursor-pagination/range-pagination-not-supported"NOT_AN_INTEGER = {title: "Page size is not an integer",detail: ->(_) { "Page size must be an integer." },@@ -14,7 +11,7 @@ module JsonApiKitRANGE = {title: "Range pagination is not supported",detail: ->(_) { "Use page[after] or page[before], not both." },- type: RANGE_UNSUPPORTED,+ type: Pagination::Profile::RANGE_UNSUPPORTED,}.freezeINVALID_CURSOR = {title: "Invalid cursor",@@ -125,7 +122,7 @@ module JsonApiKitdetail: ->(error) do"Page size #{error.options[:value]} exceeds the maximum of #{error.options[:count]}."end,- type: MAX_SIZE,+ type: Pagination::Profile::MAX_SIZE,meta: ->(error) { { page: { maxSize: error.options[:count] } } },},[:"page.before_size", :not_an_integer] => SIDE_NOT_AN_INTEGER,@@ -146,7 +143,7 @@ module JsonApiKit"the maximum of #{error.options[:count]}."end,source: WINDOW_PARAMETER,- type: MAX_SIZE,+ type: Pagination::Profile::MAX_SIZE,meta: ->(error) { { page: { maxSize: error.options[:count] } } },},[:"page.after", :present] => RANGE,diff --git a/spec/integration/json_api_kit/endpoint_spec.rb b/spec/integration/json_api_kit/endpoint_spec.rbindex 88e68798ea9..ee88e67c4f7 100644--- a/spec/integration/json_api_kit/endpoint_spec.rb+++ b/spec/integration/json_api_kit/endpoint_spec.rb@@ -45,6 +45,7 @@ RSpec.describe "a JSON:API endpoint", type: :request dolet(:base) { "http://test.localhost/api" }let(:current) { "#{base}/topics" }let(:media_type) { "application/vnd.api+json" }+ let(:profile_media_type) { JsonApiKit::Pagination::Profile::MEDIA_TYPE }let(:profile) { "https://jsonapi.org/profiles/ethanresnick/cursor-pagination" }let(:path) { "/api/topics" }let(:headers) { {} }@@ -68,7 +69,7 @@ RSpec.describe "a JSON:API endpoint", type: :request dodescribe "the response" doit "sends the JSON:API media type" do- expect(response.media_type).to eq(media_type)+ expect(response.media_type).to eq(profile_media_type)endit "varies on the accept header" do@@ -79,7 +80,7 @@ RSpec.describe "a JSON:API endpoint", type: :request dolet(:path) { "/api/topics.json" }it "sends the JSON:API media type" do- expect(response.media_type).to eq(media_type)+ expect(response.media_type).to eq(profile_media_type)endit "varies on the accept header" do@@ -186,7 +187,7 @@ RSpec.describe "a JSON:API endpoint", type: :request doit { expect(response).to have_http_status(:internal_server_error) }it "sends the JSON:API media type" do- expect(response.media_type).to eq(media_type)+ expect(response.media_type).to eq(profile_media_type)endit "sends the reason" do@@ -214,7 +215,7 @@ RSpec.describe "a JSON:API endpoint", type: :request doit { expect(response).to have_http_status(:forbidden) }it "sends the JSON:API media type" do- expect(response.media_type).to eq(media_type)+ expect(response.media_type).to eq(profile_media_type)endit "sends the reason" dodiff --git a/spec/integration/json_api_kit/support.rb b/spec/integration/json_api_kit/support.rbindex f0593b94d4c..6b8944126a8 100644--- a/spec/integration/json_api_kit/support.rb+++ b/spec/integration/json_api_kit/support.rb@@ -184,7 +184,10 @@ RSpec.shared_context "with a listing of topics" dodef profile_link(name) = "https://jsonapi.org/profiles/ethanresnick/cursor-pagination/#{name}"- def self_link = query.blank? ? current : "#{current}?#{query.to_query}"+ def self_link+ href = query.blank? ? current : "#{current}?#{query.to_query}"+ { href:, type: JsonApiKit::Pagination::Profile::MEDIA_TYPE }+ enddef links_of(**pages) = { self: self_link, **{ prev: nil, next: nil }.merge(pages) }diff --git a/spec/lib/json_api_kit/document/collection_spec.rb b/spec/lib/json_api_kit/document/collection_spec.rbindex 047f50feccd..d9e1ca8e66e 100644--- a/spec/lib/json_api_kit/document/collection_spec.rb+++ b/spec/lib/json_api_kit/document/collection_spec.rb@@ -20,9 +20,9 @@ RSpec.describe JsonApiKit::Document::Collection doendendlet(:guardian) { Guardian.new }- let(:urls) do- JsonApiKit::Urls.new(base: "https://example.com/api", current: "https://example.com/api/topics")- end+ let(:urls) { JsonApiKit::Urls.new(base: "https://example.com/api", current:) }+ let(:current) { "https://example.com/api/topics" }+ let(:self_link) { { href: current, type: JsonApiKit::Pagination::Profile::MEDIA_TYPE } }let(:params) { {} }let(:listing) { resource.all(params, guardian:) }let(:primary_data) { document.to_h[:data] }@@ -88,7 +88,7 @@ RSpec.describe JsonApiKit::Document::Collection dodata: [],included: [],links: {- self: "https://example.com/api/topics",+ self: self_link,prev: nil,next: nil,},@@ -109,7 +109,7 @@ RSpec.describe JsonApiKit::Document::Collection doit "renders a link to the page at each end" doexpect(document.to_h[:links]).to eq(- self: "https://example.com/api/topics",+ self: self_link,prev: "https://example.com/api/topics?page%5Bbefore%5D=#{page_cursor}",next: "https://example.com/api/topics?page%5Bafter%5D=#{page_cursor}",)diff --git a/spec/lib/json_api_kit/document/individual_spec.rb b/spec/lib/json_api_kit/document/individual_spec.rbindex 7555aa0d72b..1ebf801b086 100644--- a/spec/lib/json_api_kit/document/individual_spec.rb+++ b/spec/lib/json_api_kit/document/individual_spec.rb@@ -13,12 +13,9 @@ RSpec.describe JsonApiKit::Document::Individual doendendlet(:guardian) { Guardian.new }- let(:urls) do- JsonApiKit::Urls.new(- base: "https://example.com/api",- current: "https://example.com/api/topics/1",- )- end+ let(:urls) { JsonApiKit::Urls.new(base: "https://example.com/api", current:) }+ let(:current) { "https://example.com/api/topics/1" }+ let(:self_link) { { href: current, type: JsonApiKit::Pagination::Profile::MEDIA_TYPE } }let(:reading) { resource.find(topic.id, guardian:) }describe "#to_h" do@@ -36,7 +33,7 @@ RSpec.describe JsonApiKit::Document::Individual do},included: [],links: {- self: "https://example.com/api/topics/1",+ self: self_link,},)end