1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
|
require 'spec_helper'
require 'support/shared_examples/existing_headers'
require 'support/shared_examples/first_page'
require 'support/shared_examples/middle_page'
require 'support/shared_examples/last_page'
describe NumbersController, :type => :controller do
before { request.host = 'example.org' }
describe 'GET #index' do
let(:link) { response.headers['Link'] }
let(:links) { link.split(', ') }
let(:total) { response.headers['Total'].to_i }
let(:per_page) { response.headers['Per-Page'].to_i }
context 'without enough items to give more than one page' do
before { get :index, params: {count: 10} }
it 'should not paginate' do
expect(response.headers.keys).not_to include('Link')
end
it 'should give a Total header' do
expect(total).to eq(10)
end
it 'should give a Per-Page header' do
expect(per_page).to eq(10)
end
it 'should list all numbers in the response body' do
body = '[1,2,3,4,5,6,7,8,9,10]'
expect(response.body).to eq(body)
end
end
context 'with existing Link headers' do
before { get :index, params: {count: 30, with_headers: true} }
it_behaves_like 'an endpoint with existing Link headers'
end
context 'with enough items to paginate' do
context 'when on the first page' do
before { get :index, params: {count: 100} }
it_behaves_like 'an endpoint with a first page'
end
context 'when on the last page' do
before { get :index, params: {count: 100, page: 10} }
it_behaves_like 'an endpoint with a last page'
end
context 'when somewhere comfortably in the middle' do
before { get :index, params: {count: 100, page: 2} }
it_behaves_like 'an endpoint with a middle page'
end
end
context 'providing a block' do
it 'yields to the block instead of implicitly rendering' do
get :index_with_custom_render, params: {count: 100}
json = { numbers: (1..10).map { |n| { number: n } } }.to_json
expect(response.body).to eq(json)
end
end
context 'with custom response headers' do
before do
ApiPagination.config.total_header = 'X-Total-Count'
ApiPagination.config.per_page_header = 'X-Per-Page'
ApiPagination.config.page_header = 'X-Page'
ApiPagination.config.base_url = 'http://guybrush:3000'
get :index, params: params
end
after do
ApiPagination.config.total_header = 'Total'
ApiPagination.config.per_page_header = 'Per-Page'
ApiPagination.config.page_header = nil
ApiPagination.config.base_url = nil
end
let(:params) { { count: 10 } }
let(:total) { response.header['X-Total-Count'].to_i }
let(:per_page) { response.header['X-Per-Page'].to_i }
let(:page) { response.header['X-Page'].to_i }
let(:link) { response.header['Link'] }
it 'should give a X-Total-Count header' do
headers_keys = response.headers.keys
expect(headers_keys).not_to include('Total')
expect(headers_keys).to include('X-Total-Count')
expect(total).to eq(10)
end
it 'should give a X-Per-Page header' do
headers_keys = response.headers.keys
expect(headers_keys).not_to include('Per-Page')
expect(headers_keys).to include('X-Per-Page')
expect(per_page).to eq(10)
end
it 'should give a X-Page header' do
headers_keys = response.headers.keys
expect(headers_keys).to include('X-Page')
expect(page).to eq(1)
end
context 'with paginated result' do
let(:params) { { count: 20 } }
it 'should use custom base_url in the Link header' do
expect(response.headers['Link']).to eq(
'<http://guybrush:3000/numbers?count=20&page=2>; rel="last", <http://guybrush:3000/numbers?count=20&page=2>; rel="next"')
end
end
end
context 'configured not to include the total' do
before { ApiPagination.config.include_total = false }
it 'should not include a Total header' do
get :index, params: {count: 10}
expect(response.header['Total']).to be_nil
end
it 'should not include a link with rel "last"' do
get :index, params: { count: 100 }
expect(link).to_not include('rel="last"')
end
after { ApiPagination.config.include_total = true }
end
context 'custom page param' do
context 'page_param as a symbol' do
before do
ApiPagination.config.page_param = :foo
ApiPagination.config.page_header = 'Page'
end
after do
ApiPagination.config.page_param = :page
ApiPagination.config.page_header = nil
end
it 'should work' do
get :index, params: {foo: 2, count: 100}
expect(response.header['Page']).to eq('2')
end
end
context 'page_param as a block' do
before do
ApiPagination.config.page_param do |params|
params[:foo][:bar]
end
ApiPagination.config.page_header = 'Page'
end
after do
ApiPagination.config.page_param = :page
ApiPagination.config.page_header = nil
end
it 'should work' do
get :index, params: {foo: {bar: 2}, count: 100}
expect(response.header['Page']).to eq('2')
end
end
end
context 'custom per_page param' do
context 'per_page_param as a symbol' do
before do
ApiPagination.config.per_page_param = :foo
end
after do
ApiPagination.config.per_page_param = :per_page
end
it 'should work' do
get :index_with_no_per_page, params: {foo: 2, count: 100}
expect(response.header['Per-Page']).to eq('2')
end
end
context 'page_param as a block' do
before do
ApiPagination.config.per_page_param do |params|
params[:foo][:bar]
end
end
after do
ApiPagination.config.per_page_param = :per_page
end
it 'should work' do
get :index_with_no_per_page, params: {foo: {bar: 2}, count: 100}
expect(response.header['Per-Page']).to eq('2')
end
end
end
if ApiPagination.config.paginator.to_sym == :kaminari
context 'paginate array options' do
let(:paginate_array_total_count) { 300 }
let(:total_header) { 300 }
let(:count) { 50 }
let(:params) do
{
paginate_array_total_count: paginate_array_total_count,
count: count,
}
end
it 'has a properly set Total header' do
get :index_with_paginate_array_options, params: params
expect(response.header['Total']).to be_kind_of(String)
expect(response.header['Total'].to_i).to eq total_header
end
end
end
if [:will_paginate, :kaminari].include?(ApiPagination.config.paginator.to_sym)
context 'default per page in model' do
before do
class Fixnum
@default_per_page = 6
@per_page = 6
class << self
attr_accessor :default_per_page, :per_page
end
end
end
after do
class Fixnum
@default_per_page = 25
@per_page = 25
end
end
after :all do
class Fixnum
class << self
undef_method :default_per_page, :per_page
end
end
end
it 'should use default per page from model' do
get :index_with_no_per_page, params: {count: 100}
expect(response.header['Per-Page']).to eq('6')
end
it 'should not fail if the model yields nil for per page' do
class Fixnum
@default_per_page = nil
@per_page = nil
end
get :index_with_no_per_page, params: {count: 100}
expect(response.header['Per-Page']).to eq(
case ApiPagination.config.paginator
when :pagy then Pagy::DEFAULT[:items].to_s
when :kaminari then Kaminari.config.default_per_page.to_s
when :will_paginate then WillPaginate.per_page.to_s
end
)
end
end
end
context 'default per page in objects without paginator defaults' do
it 'should not fail if model does not respond to per page' do
get :index_with_no_per_page, params: {count: 100}
expect(response.header['Per-Page']).to eq(
case ApiPagination.config.paginator
when :pagy then Pagy::DEFAULT[:items].to_s
when :kaminari then Kaminari.config.default_per_page.to_s
when :will_paginate then WillPaginate.per_page.to_s
end
)
end
end
end
end
|