From: Andy Allan <git@gravitystorm.co.uk>
Date: Wed, 11 Jan 2023 15:28:59 +0000 (+0000)
Subject: Move more api-related helper methods to ApiController
X-Git-Tag: live~1387^2
X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/4c564e5a322e04cd0a811c859ddb251cb80b45d4

Move more api-related helper methods to ApiController

This prevents them from being inadvertently used in non-API controllers
---

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index a8067a493..a2d016c8c 100644
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -143,4 +143,43 @@ class ApiController < ApplicationController
       end
     end
   end
+
+  def api_call_handle_error
+    yield
+  rescue ActionController::UnknownFormat
+    head :not_acceptable
+  rescue ActiveRecord::RecordNotFound => e
+    head :not_found
+  rescue LibXML::XML::Error, ArgumentError => e
+    report_error e.message, :bad_request
+  rescue ActiveRecord::RecordInvalid => e
+    message = "#{e.record.class} #{e.record.id}: "
+    e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
+    report_error message, :bad_request
+  rescue OSM::APIError => e
+    report_error e.message, e.status
+  rescue AbstractController::ActionNotFound => e
+    raise
+  rescue StandardError => e
+    logger.info("API threw unexpected #{e.class} exception: #{e.message}")
+    e.backtrace.each { |l| logger.info(l) }
+    report_error "#{e.class}: #{e.message}", :internal_server_error
+  end
+
+  ##
+  # asserts that the request method is the +method+ given as a parameter
+  # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
+  def assert_method(method)
+    ok = request.send(:"#{method.to_s.downcase}?")
+    raise OSM::APIBadMethodError, method unless ok
+  end
+
+  ##
+  # wrap an api call in a timeout
+  def api_call_timeout(&block)
+    Timeout.timeout(Settings.api_timeout, Timeout::Error, &block)
+  rescue Timeout::Error
+    ActiveRecord::Base.connection.raw_connection.cancel
+    raise OSM::APITimeoutError
+  end
 end
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 87be14e5b..d22a031d4 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -196,45 +196,6 @@ class ApplicationController < ActionController::Base
     response.headers["Content-Language"] = I18n.locale.to_s
   end
 
-  def api_call_handle_error
-    yield
-  rescue ActionController::UnknownFormat
-    head :not_acceptable
-  rescue ActiveRecord::RecordNotFound => e
-    head :not_found
-  rescue LibXML::XML::Error, ArgumentError => e
-    report_error e.message, :bad_request
-  rescue ActiveRecord::RecordInvalid => e
-    message = "#{e.record.class} #{e.record.id}: "
-    e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
-    report_error message, :bad_request
-  rescue OSM::APIError => e
-    report_error e.message, e.status
-  rescue AbstractController::ActionNotFound => e
-    raise
-  rescue StandardError => e
-    logger.info("API threw unexpected #{e.class} exception: #{e.message}")
-    e.backtrace.each { |l| logger.info(l) }
-    report_error "#{e.class}: #{e.message}", :internal_server_error
-  end
-
-  ##
-  # asserts that the request method is the +method+ given as a parameter
-  # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
-  def assert_method(method)
-    ok = request.send(:"#{method.to_s.downcase}?")
-    raise OSM::APIBadMethodError, method unless ok
-  end
-
-  ##
-  # wrap an api call in a timeout
-  def api_call_timeout(&block)
-    Timeout.timeout(Settings.api_timeout, Timeout::Error, &block)
-  rescue Timeout::Error
-    ActiveRecord::Base.connection.raw_connection.cancel
-    raise OSM::APITimeoutError
-  end
-
   ##
   # wrap a web page in a timeout
   def web_timeout(&block)