Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions app/controllers/api/v1/airlines_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
module Api
module V1
class AirlinesController < ApplicationController
include Pagination

skip_before_action :verify_authenticity_token, only: %i[create update destroy]
before_action :set_airline, only: %i[show update destroy]

Expand Down Expand Up @@ -77,10 +79,9 @@ def destroy
# GET /api/v1/airlines/list
def index
country = params[:country]
limit = params[:limit] || 10
offset = params[:offset] || 0

begin
limit, offset = pagination_params
airlines = Airline.list_by_country_or_all(key: [country, limit, offset])

airlines = airlines.pluck(:callsign, :country, :iata, :icao, :name)
Expand All @@ -107,8 +108,7 @@ def to_airport
raise ArgumentError, 'Destination airport is missing' unless params[:destinationAirportCode].present?

destination_airport = params[:destinationAirportCode]
limit = params[:limit] || 10
offset = params[:offset] || 0
limit, offset = pagination_params

airlines = Airline.to_airport(key: [destination_airport, limit, offset])
.pluck(:callsign, :country, :iata, :icao, :name)
Expand Down
5 changes: 3 additions & 2 deletions app/controllers/api/v1/airports_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
module Api
module V1
class AirportsController < ApplicationController
include Pagination

skip_before_action :verify_authenticity_token, only: %i[create update destroy]
before_action :set_airport, only: %i[show update destroy]

Expand Down Expand Up @@ -113,8 +115,7 @@ def direct_connections
raise ArgumentError, 'Destination airport is missing' unless params[:destinationAirportCode].present?

destination_airport = params[:destinationAirportCode]
limit = params[:limit] || 10
offset = params[:offset] || 0
limit, offset = pagination_params

destination_airports = Route.direct_connections(key: [destination_airport, limit, offset])
.pluck(:destinationairport)
Expand Down
31 changes: 31 additions & 0 deletions app/controllers/concerns/pagination.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# frozen_string_literal: true

# Parses the `limit` and `offset` query parameters for list endpoints.
#
# The models' N1QL `query_fn`s interpolate these values directly into
# `LIMIT ... OFFSET ...`, so they must reach the model as non-negative
# Integers. Invalid values raise ArgumentError, which the actions already
# render as 400 Bad Request.
module Pagination
extend ActiveSupport::Concern

DEFAULT_LIMIT = 10
DEFAULT_OFFSET = 0

private

# Returns [limit, offset] as non-negative Integers.
def pagination_params
[pagination_integer(:limit, DEFAULT_LIMIT), pagination_integer(:offset, DEFAULT_OFFSET)]
end

def pagination_integer(name, default)
raw = params[name]
return default if raw.blank?

value = Integer(raw.to_s, 10, exception: false)
raise ArgumentError, "#{name} must be a non-negative integer" if value.nil? || value.negative?

value
end
end
28 changes: 28 additions & 0 deletions spec/requests/api/v1/airlines_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,14 @@
expect(response.content_type).to eq('application/json; charset=utf-8')
expect(JSON.parse(response.body)).to eq(expected_airlines)
end

it 'rejects a non-integer limit before querying Couchbase' do
get '/api/v1/airlines/list', params: { country:, limit: 'abc', offset: }

expect(response).to have_http_status(:bad_request)
expect(JSON.parse(response.body)).to eq({ 'error' => 'Invalid request',
'message' => 'limit must be a non-negative integer' })
end
end

describe 'GET /api/v1/airlines/to-airport' do
Expand Down Expand Up @@ -229,6 +237,26 @@
end
end

context 'when limit and offset are omitted' do
it 'defaults to the first 10 airlines' do
get '/api/v1/airlines/to-airport', params: { destinationAirportCode: destination_airport_code }

expect(response).to have_http_status(:ok)
expect(JSON.parse(response.body)).to eq(expected_airlines)
end
end

context 'when offset is negative' do
it 'returns a bad request error' do
get '/api/v1/airlines/to-airport',
params: { destinationAirportCode: destination_airport_code, limit:, offset: '-1' }

expect(response).to have_http_status(:bad_request)
expect(JSON.parse(response.body)).to eq({ 'error' => 'Invalid request',
'message' => 'offset must be a non-negative integer' })
end
end

context 'when destinationAirportCode is not provided' do
it 'returns a bad request error' do
get '/api/v1/airlines/to-airport', params: { limit:, offset: }
Expand Down
11 changes: 11 additions & 0 deletions spec/requests/api/v1/airports_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,17 @@
end
end

context 'when limit is not an integer' do
it 'returns a bad request error' do
get '/api/v1/airports/direct-connections',
params: { destinationAirportCode: destination_airport_code, limit: '10 OFFSET 0', offset: }

expect(response).to have_http_status(:bad_request)
expect(JSON.parse(response.body)).to eq({ 'error' => 'Invalid request',
'message' => 'limit must be a non-negative integer' })
end
end

context 'when the destination airport code is not provided' do
it 'returns a bad request error' do
get '/api/v1/airports/direct-connections'
Expand Down
Loading