refactor api error

dephy-io · Jan 31, 2025 · e698496 · e698496
1 parent eb069ab
commit e698496
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 53 deletions.
diff --git a/app/controllers/api/application_controller.rb b/app/controllers/api/application_controller.rb
@@ -3,5 +3,21 @@
 module Api
   class ApplicationController < ActionController::API
     include Pagy::Backends::UuidCursor
+
+    module ErrorConstants
+      OK = "ok"
+      INVALID_JSON = "invalid_json"
+      EVENT_NOT_FOUND = "event_not_found"
+      RECIPIENT_NOT_FOUND = "recipient_not_found"
+      TOPIC_NOT_FOUND = "topic_not_found"
+      BAD_EVENT = "bad_event"
+      POST_TOO_FAST = "post_too_fast"
+    end
+
+    rescue_from JSON::ParserError do
+      render json: {
+        status: ErrorConstants::INVALID_JSON
+      }, status: :bad_request
+    end
   end
 end
diff --git a/app/controllers/api/events_controller.rb b/app/controllers/api/events_controller.rb
@@ -6,9 +6,9 @@ def show
       @event = Event.find_by!(eid: params[:id])
 
       render json: {
-        status: "ok",
+        status: ErrorConstants::OK,
         event: @event.nip1_hash,
-        extra: {
+        metadata: {
           topic: @event.topic,
           session: @event.session,
           latest: {
@@ -21,36 +21,28 @@ def show
       }
     rescue ActiveRecord::RecordNotFound => _ex
       render json: {
-        status: "error",
-        error: {
-          message: "Event not found"
-        }
+        status: ErrorConstants::EVENT_NOT_FOUND
       }, status: :not_found
     end
 
     def create
       @event = Event.from_raw params.require(:event)
       if @event.save
         render json: {
-          status: "ok",
+          status: ErrorConstants::OK,
           event: @event.nip1_hash
         }
       else
         render json: {
-          status: "error",
+          status: ErrorConstants::BAD_EVENT,
           error: {
-            message: "Event not saved",
             data: @event.errors.full_messages
           }
         }, status: :unprocessable_content
       end
     rescue ActiveRecord::StaleObjectError
       render json: {
-        status: "error",
-        error: {
-          message: "Event not saved",
-          data: "Too fast requests."
-        }
+        status: ErrorConstants::POST_TOO_FAST
       }, status: :unprocessable_content
     end
 
@@ -73,8 +65,8 @@ def batch_create
       end
 
       render json: {
-        status: "ok",
-        returns: returns.map(&:nip1_hash),
+        status: ErrorConstants::OK,
+        saved: returns.map(&:nip1_hash),
         errored: errored
       }
     end

diff --git a/app/controllers/api/home_controller.rb b/app/controllers/api/home_controller.rb
@@ -4,7 +4,7 @@ module Api
   class HomeController < Api::ApplicationController
     def index
       render json: {
-        status: "ok"
+        status: ErrorConstants::OK
       }
     end
   end

diff --git a/app/controllers/api/recipients/application_controller.rb b/app/controllers/api/recipients/application_controller.rb
@@ -10,8 +10,7 @@ class ApplicationController < ::Api::ApplicationController
       def set_recipient
         if params[:recipient_id].blank?
           render json: {
-            status: "error",
-            error: "Recipient not found"
+            status: ErrorConstants::RECIPIENT_NOT_FOUND
           }, status: :not_found
         end
 

diff --git a/app/controllers/api/recipients/events_controller.rb b/app/controllers/api/recipients/events_controller.rb
@@ -9,7 +9,7 @@ def index
       )
 
       render json: {
-        status: "ok",
+        status: ErrorConstants::OK,
         events: @records.map(&:nip1_hash),
         pagination: {
           has_more: @pagy.has_more?
@@ -21,7 +21,7 @@ def latest
       @event = Event.of_recipient(@recipient).order(id: :desc).first
 
       render json: {
-        status: "ok",
+        status: ErrorConstants::OK,
         event: @event&.nip1_hash
       }
     end

diff --git a/app/controllers/api/topics/application_controller.rb b/app/controllers/api/topics/application_controller.rb
@@ -10,8 +10,7 @@ class ApplicationController < ::Api::ApplicationController
       def set_topic
         if params[:topic_id].blank?
           render json: {
-            status: "error",
-            error: "Topic not found"
+            status: ErrorConstants::TOPIC_NOT_FOUND
           }, status: :not_found
         end
 

diff --git a/app/controllers/api/topics/events_controller.rb b/app/controllers/api/topics/events_controller.rb
@@ -9,7 +9,7 @@ def index
       )
 
       render json: {
-        status: "ok",
+        status: ErrorConstants::OK,
         events: @records.map(&:nip1_hash),
         pagination: {
           has_more: @pagy.has_more?
@@ -21,7 +21,7 @@ def latest
       @event = Event.of_topic(@topic).order(id: :desc).first
 
       render json: {
-        status: "ok",
+        status: ErrorConstants::OK,
         event: @event&.nip1_hash
       }
     end