Merge pull request #175 from alphagov/2425-add-post-feedback-endpoint

Add Post answer feedback endpoint

Author: davidgisbey

app/blueprints/validation_error_blueprint.rb

@@ -0,0 +1,6 @@
+class ValidationErrorBlueprint < Blueprinter::Base
+  field :errors
+  field :message do
+    "Unprocessable entity"
+  end
+end

app/controllers/api/v0/conversations_controller.rb

@@ -1,6 +1,6 @@
 class Api::V0::ConversationsController < ApplicationController
   before_action { authorise_user!(SignonUser::Permissions::CONVERSATION_API) }
-  before_action :find_conversation, only: %i[show answer]
+  before_action :find_conversation, only: %i[show answer answer_feedback]
 
   def show
     answered_questions = @conversation.questions.joins(:answer)
@@ -23,11 +23,30 @@ def answer
     end
   end
 
+  def answer_feedback
+    answer = @conversation.answers.includes(:feedback).find(params[:answer_id])
+    feedback_form = Form::CreateAnswerFeedback.new(answer_feedback_params.merge(answer:))
+
+    if feedback_form.valid?
+      feedback_form.submit
+
+      render json: {}, status: :created
+    else
+      render json: ValidationErrorBlueprint.render(
+        errors: feedback_form.errors.messages,
+      ), status: :unprocessable_entity
+    end
+  end
+
 private
 
   def find_conversation
     @conversation = Conversation
                     .includes(questions: { answer: %i[sources feedback] })
                     .find(params[:conversation_id])
   end
+
+  def answer_feedback_params
+    params.permit(:useful)
+  end
 end

app/models/form/create_answer_feedback.rb

@@ -16,6 +16,6 @@ def submit
 private
 
   def no_feedback_present?
-    errors.add(:answer_feedback, "Feedback already provided") if answer.feedback.present?
+    errors.add(:base, "Feedback already provided for this answer") if answer.feedback.present?
   end
 end

config/initializers/committee.rb

@@ -1,4 +1,12 @@
 require "committee"
+require "api/request_validation_error"
+
+Rails.application.config.middleware.use Committee::Middleware::RequestValidation,
+                                        schema_path: "docs/api_openapi_specification.yml",
+                                        coerce_date_times: true,
+                                        prefix: "/api/v0",
+                                        strict_reference_validation: true,
+                                        error_class: Api::RequestValidationError
 
 Rails.application.config.middleware.use Committee::Middleware::ResponseValidation,
                                         schema_path: "docs/api_openapi_specification.yml",

config/routes.rb

@@ -147,6 +147,7 @@
     namespace :v0 do
       get "/conversation/:conversation_id", to: "conversations#show", as: :show_conversation
       get "/conversation/:conversation_id/questions/:question_id/answer", to: "conversations#answer", as: :answer_question
+      post "/conversation/:conversation_id/answers/:answer_id/feedback", to: "conversations#answer_feedback", as: :answer_feedback
     end
   end
 

docs/api_openapi_specification.yml

@@ -322,11 +322,11 @@ components:
       type: object
       required:
         - message
-        - fields
+        - errors
       properties:
         message:
           type: string
-        fields:
+        errors:
           description: |
             an object structure of field name to an array of errors
           type: object

lib/api/request_validation_error.rb

@@ -0,0 +1,7 @@
+module Api
+  class RequestValidationError < Committee::ValidationError
+    def error_body
+      GenericErrorBlueprint.render_as_hash(message:)
+    end
+  end
+end

spec/blueprints/validation_error_blueprint_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe ValidationErrorBlueprint do
+  describe ".render_as_json" do
+    it "renders the correct JSON based on the errors passed in" do
+      errors = {
+        user_question: ["Question must be 300 characters or less", "Personal data has been detected in your question. Please remove it and try asking again."],
+        base: ["Previous question pending. Please wait for a response"],
+      }
+
+      expect(described_class.render_as_json(errors:))
+        .to eq({ message: "Unprocessable entity", errors: }.as_json)
+    end
+  end
+end

spec/lib/api/request_validation_error_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Api::RequestValidationError do
+  describe "#render" do
+    it "returns an array which uses the GenericErrorBlueprint for the error body" do
+      request = double
+      error_message = "Bad request"
+      generic_error_blueprint = GenericErrorBlueprint.render(message: error_message)
+
+      error = described_class.new(400, :bad_request, error_message, request)
+      expect(error.render).to eq([400, { "Content-Type" => "application/json" }, [generic_error_blueprint]])
+    end
+  end
+end

spec/models/form/create_answer_feedback_spec.rb

@@ -17,7 +17,7 @@
       answer_with_feedback = build(:answer, :with_feedback)
       form = described_class.new(useful: true, answer: answer_with_feedback)
       expect(form).to be_invalid
-      expect(form.errors[:answer_feedback]).to eq(["Feedback already provided"])
+      expect(form.errors[:base]).to eq(["Feedback already provided for this answer"])
     end
   end