Merge pull request #1174 from transitland/query-params-apikey

Query params: apikey
transitland · Aug 22, 2017 · 257fc19 · 257fc19
2 parents 7ac2ea1 + c5481c2
commit 257fc19
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 27 deletions.
diff --git a/app/controllers/api/v1/activity_updates_controller.rb b/app/controllers/api/v1/activity_updates_controller.rb
@@ -28,7 +28,7 @@ def index
   private
 
   def query_params
-    {
+    super.merge({
       feed: {
         desc: "Filter by Feed",
         type: "onestop_id",
@@ -39,7 +39,7 @@ def query_params
         type: "integer",
         array: true
       }
-    }
+    })
   end
 
 end
diff --git a/app/controllers/api/v1/base_api_controller.rb b/app/controllers/api/v1/base_api_controller.rb
@@ -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]}")
@@ -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

diff --git a/app/controllers/api/v1/change_payloads_controller.rb b/app/controllers/api/v1/change_payloads_controller.rb
@@ -39,7 +39,7 @@ def destroy
   private
 
   def query_params
-    {
+    super.merge({
       ids: {
         desc: "Change Payload ID",
         type: "integer",
@@ -50,7 +50,7 @@ def query_params
         type: "integer",
         show: false
       }
-    }
+    })
   end
 
   def change_payload_params

diff --git a/app/controllers/api/v1/changesets_controller.rb b/app/controllers/api/v1/changesets_controller.rb
@@ -110,7 +110,7 @@ def revert
   private
 
   def query_params
-    {
+    super.merge({
       ids: {
         desc: "Filter by Changeset ID",
         type: "integer",
@@ -120,7 +120,7 @@ def query_params
         desc: "Applied Changesets",
         type: "boolean"
       }
-    }
+    })
   end
 
   def set_changeset

diff --git a/app/controllers/api/v1/current_entity_controller.rb b/app/controllers/api/v1/current_entity_controller.rb
@@ -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",
@@ -188,6 +188,6 @@ def query_params
         type: "boolean",
         show: false
       }
-    }
+    })
   end
 end
diff --git a/app/controllers/api/v1/feed_version_imports_controller.rb b/app/controllers/api/v1/feed_version_imports_controller.rb
@@ -32,7 +32,7 @@ def show
   private
 
   def query_params
-    {
+    super.merge({
       ids: {
         desc: "FeedVersionImport IDs",
         type: "integer",
@@ -48,7 +48,7 @@ def query_params
         type: "sha1",
         array: true
       }
-    }
+    })
   end
 
   def set_feed_version_import

diff --git a/app/controllers/api/v1/feed_version_infos_controller.rb b/app/controllers/api/v1/feed_version_infos_controller.rb
@@ -55,7 +55,7 @@ def paginated_json_collection(collection)
   private
 
   def query_params
-    {
+    super.merge({
       feed_onestop_id: {
         desc: "Feed",
         type: "onestop_id",
@@ -77,7 +77,7 @@ def query_params
         type: "integer",
         array: true
       }
-    }
+    })
   end
 
   def set_feed_version_info

diff --git a/app/controllers/api/v1/feed_versions_controller.rb b/app/controllers/api/v1/feed_versions_controller.rb
@@ -115,7 +115,7 @@ def update
   private
 
   def query_params
-    {
+    super.merge({
       feed_onestop_id: {
         desc: "Feed",
         type: "onestop_id",
@@ -146,7 +146,7 @@ def query_params
         type: "sha1",
         array: true
       }
-    }
+    })
   end
 
   def set_feed_version

diff --git a/app/controllers/api/v1/issues_controller.rb b/app/controllers/api/v1/issues_controller.rb
@@ -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

diff --git a/app/controllers/api/v1/onestop_id_controller.rb b/app/controllers/api/v1/onestop_id_controller.rb
@@ -5,11 +5,11 @@ def show
   end
 
   def query_params
-    {
+    super.merge({
       onestop_id: {
         desc: "Onestop ID",
         type: "onestop_id"
       }
-    }
+    })
   end
 end
diff --git a/app/controllers/api/v1/schedule_stop_pairs_controller.rb b/app/controllers/api/v1/schedule_stop_pairs_controller.rb
@@ -175,7 +175,7 @@ def set_schedule_stop_pairs
 
 
   def query_params
-    {
+    super.merge({
       active: {
         desc: "Imported from active Feed Version",
         type: "boolean"
@@ -262,7 +262,7 @@ def query_params
         type: "sha1",
         array: true
       }
-    }
+    })
   end
 
   def tz_now

diff --git a/app/controllers/api/v1/users_controller.rb b/app/controllers/api/v1/users_controller.rb
@@ -39,13 +39,13 @@ def show
   private
 
   def query_params
-    {
+    super.merge({
       ids: {
         desc: "Users",
         type: "integer",
         array: true
-      },
-    }
+      }
+    })
   end
 
   def set_user

diff --git a/app/controllers/concerns/json_collection_pagination.rb b/app/controllers/concerns/json_collection_pagination.rb
@@ -73,10 +73,6 @@ def paginated_geojson_collection(collection)
 
   private
 
-  def query_params
-    {}
-  end
-
   def sort_key
     (params[:sort_key].presence || :id).to_sym
   end

diff --git a/spec/controllers/json_collection_pagination_spec.rb b/spec/controllers/json_collection_pagination_spec.rb
@@ -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|