Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Query params: apikey #1174

Merged
merged 5 commits into from
Aug 22, 2017
Merged

Query params: apikey #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d4b88ef
Move query_params super method to Base API Controller
irees Aug 22, 2017
a9f0f77
Base API subclasses query_params: call super
irees Aug 22, 2017
25682c4
Remove query_params method from json pagination
irees Aug 22, 2017
1deca57
Remove extra copy
irees Aug 22, 2017
c5481c2
Fix spec: dummy method
irees Aug 22, 2017
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
4 changes: 2 additions & 2 deletions app/controllers/api/v1/activity_updates_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def index
private

def query_params
{
super.merge({
feed: {
desc: "Filter by Feed",
type: "onestop_id",
Expand All @@ -39,7 +39,7 @@ def query_params
type: "integer",
array: true
}
}
})
end

end
10 changes: 10 additions & 0 deletions app/controllers/api/v1/base_api_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class Api::V1::BaseApiController < ApplicationController
render_error code: 400, message: exception.message
end


# following this pattern: https://gist.github.com/Sujimichi/2349565
def raise_not_found!
raise ActionController::RoutingError.new("No route matches #{request.env['REQUEST_METHOD']} /api/#{params[:unmatched_route]}")
Expand All @@ -52,6 +53,15 @@ def default_url_options

private

def query_params
return {
apikey: {
desc: "API Key",
type: "string"
}
}
end

def set_default_response_format
request.format = :json unless [:geojson, :csv, :rss].include?(request.format.to_sym)
end
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/change_payloads_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def destroy
private

def query_params
{
super.merge({
ids: {
desc: "Change Payload ID",
type: "integer",
Expand All @@ -50,7 +50,7 @@ def query_params
type: "integer",
show: false
}
}
})
end

def change_payload_params
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/changesets_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ def revert
private

def query_params
{
super.merge({
ids: {
desc: "Filter by Changeset ID",
type: "integer",
Expand All @@ -120,7 +120,7 @@ def query_params
desc: "Applied Changesets",
type: "boolean"
}
}
})
end

def set_changeset
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/current_entity_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def set_model

def query_params
# Allowed query parameters - and documentation
{
super.merge({
onestop_id: {
desc: "Onestop ID",
type: "onestop_id",
Expand Down Expand Up @@ -188,6 +188,6 @@ def query_params
type: "boolean",
show: false
}
}
})
end
end
4 changes: 2 additions & 2 deletions app/controllers/api/v1/feed_version_imports_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ def show
private

def query_params
{
super.merge({
ids: {
desc: "FeedVersionImport IDs",
type: "integer",
Expand All @@ -48,7 +48,7 @@ def query_params
type: "sha1",
array: true
}
}
})
end

def set_feed_version_import
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/feed_version_infos_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def paginated_json_collection(collection)
private

def query_params
{
super.merge({
feed_onestop_id: {
desc: "Feed",
type: "onestop_id",
Expand All @@ -77,7 +77,7 @@ def query_params
type: "integer",
array: true
}
}
})
end

def set_feed_version_info
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/feed_versions_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def update
private

def query_params
{
super.merge({
feed_onestop_id: {
desc: "Feed",
type: "onestop_id",
Expand Down Expand Up @@ -146,7 +146,7 @@ def query_params
type: "sha1",
array: true
}
}
})
end

def set_feed_version
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/issues_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@ def categories
private

def query_params
{
super.merge({
open: {},
issue_type: {},
category: {},
of_feed_entities: {},
of_entity: {},
imported_from_feed: {},
imported_from_feed_version: {}
}
})
end

def set_issue
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/api/v1/onestop_id_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ def show
end

def query_params
{
super.merge({
onestop_id: {
desc: "Onestop ID",
type: "onestop_id"
}
}
})
end
end
4 changes: 2 additions & 2 deletions app/controllers/api/v1/schedule_stop_pairs_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ def set_schedule_stop_pairs


def query_params
{
super.merge({
active: {
desc: "Imported from active Feed Version",
type: "boolean"
Expand Down Expand Up @@ -262,7 +262,7 @@ def query_params
type: "sha1",
array: true
}
}
})
end

def tz_now
Expand Down
6 changes: 3 additions & 3 deletions app/controllers/api/v1/users_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ def show
private

def query_params
{
super.merge({
ids: {
desc: "Users",
type: "integer",
array: true
},
}
}
})
end

def set_user
Expand Down
4 changes: 0 additions & 4 deletions app/controllers/concerns/json_collection_pagination.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ def paginated_geojson_collection(collection)

private

def query_params
{}
end

def sort_key
(params[:sort_key].presence || :id).to_sym
end
Expand Down
3 changes: 3 additions & 0 deletions spec/controllers/json_collection_pagination_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ def index
def url_for(params)
"http://blah/offset=#{params[:offset]}"
end
def query_params
{}
end
end

let(:pager) { Proc.new { |offset,per_page,total|
Expand Down