Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-05-01T00:52:33Z

Vchheda:

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*shiw_all: This is a GET endpoint that takes questionnaire_id as the path parameter and shows all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully displayed.
<pre>
def show_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questions = @questionnaire.questions
render json: @questions, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end

</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire (using put request) with correct parameters.
|-
| 7 || Test to update a Questionnaire (using put request) with incorrect parameters.
|-
| 8 || Test to update a Questionnaire (using put request) with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|-
|15 || Test to update the Questionnaire (using patch request) with correct parameters.
|-
|16 || Test to update the Questionnaire (using patch request) with incorrect parameters.
|-
|17 || Test to update the Questionnaire (using patch request) with non-existing id in the database.
|}

[[File:Questionnaire_spec_new.png|border|800px|]] 
[[File:Questionnaire_swagger_new.png|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question (using put request)with correct parameters.
|-
| 6 || Test to update the Question (using put request) with incorrect parameters.
|-
| 7 || Test to update the Question (using put request)with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|-
|15 || Test to update the Question (using patch request) with correct parameters.
|-
|16 || Test to update the Question (using patch request) with incorrect parameters.
|-
|17 || Test to update the Question (using patch request) with non-existing id in the database.
|-
|18 || Test to show all Questions of a Questionnaire with a valid Questionnaire id.
|-
|19 || Test to show all Questions of a Questionnaire with an invalid Questionnaire id.
|}

[[File:Question_spec_new.png|border|800px|]] 
[[File:Question_swagger_new.png|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

File:Question swagger new.png

2023-05-01T00:51:34Z

Vchheda:

File:Questionnaire swagger new.png

2023-05-01T00:51:15Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-05-01T00:47:24Z

Vchheda: /* Testing Methodology */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*shiw_all: This is a GET endpoint that takes questionnaire_id as the path parameter and shows all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully displayed.
<pre>
def show_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questions = @questionnaire.questions
render json: @questions, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end

</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire (using put request) with correct parameters.
|-
| 7 || Test to update a Questionnaire (using put request) with incorrect parameters.
|-
| 8 || Test to update a Questionnaire (using put request) with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|-
|15 || Test to update the Questionnaire (using patch request) with correct parameters.
|-
|16 || Test to update the Questionnaire (using patch request) with incorrect parameters.
|-
|17 || Test to update the Questionnaire (using patch request) with non-existing id in the database.
|}

[[File:Questionnaire_spec_new.png|border|800px|]] 
[[File:Questionnaire_swagger.jpeg|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question (using put request)with correct parameters.
|-
| 6 || Test to update the Question (using put request) with incorrect parameters.
|-
| 7 || Test to update the Question (using put request)with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|-
|15 || Test to update the Question (using patch request) with correct parameters.
|-
|16 || Test to update the Question (using patch request) with incorrect parameters.
|-
|17 || Test to update the Question (using patch request) with non-existing id in the database.
|-
|18 || Test to show all Questions of a Questionnaire with a valid Questionnaire id.
|-
|19 || Test to show all Questions of a Questionnaire with an invalid Questionnaire id.
|}

[[File:Question_spec_new.png|border|800px|]] 
[[File:Question_Swagger.jpeg|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-05-01T00:44:45Z

Vchheda: /* Testing Methodology */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*shiw_all: This is a GET endpoint that takes questionnaire_id as the path parameter and shows all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully displayed.
<pre>
def show_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questions = @questionnaire.questions
render json: @questions, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end

</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire (using put request) with correct parameters.
|-
| 7 || Test to update a Questionnaire (using put request) with incorrect parameters.
|-
| 8 || Test to update a Questionnaire (using put request) with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|-
|15 || Test to update the Questionnaire (using patch request) with correct parameters.
|-
|16 || Test to update the Questionnaire (using patch request) with incorrect parameters.
|-
|17 || Test to update the Questionnaire (using patch request) with non-existing id in the database.
|}

[[File:Questionnaire_spec_new.png|border|800px|]] 
[[File:Questionnaire_swagger.jpeg|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question (using put request)with correct parameters.
|-
| 6 || Test to update the Question (using put request) with incorrect parameters.
|-
| 7 || Test to update the Question (using put request)with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|-
|15 || Test to update the Question (using patch request) with correct parameters.
|-
|16 || Test to update the Question (using patch request) with incorrect parameters.
|-
|17 || Test to update the Question (using patch request) with non-existing id in the database.
|}

[[File:Question_spec_new.png|border|800px|]] 
[[File:Question_Swagger.jpeg|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-05-01T00:36:56Z

Vchheda:

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*shiw_all: This is a GET endpoint that takes questionnaire_id as the path parameter and shows all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully displayed.
<pre>
def show_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questions = @questionnaire.questions
render json: @questions, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end

</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|}

[[File:Questionnaire_spec_new.png|border|800px|]] 
[[File:Questionnaire_swagger.jpeg|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question with correct parameters.
|-
| 6 || Test to update the Question with incorrect parameters.
|-
| 7 || Test to update the Question with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|}

[[File:Question_spec_new.png|border|800px|]] 
[[File:Question_Swagger.jpeg|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-05-01T00:36:16Z

Vchheda:

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*shiw_all: This is a GET endpoint that takes questionnaire_id as the path parameter and shows all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully displayed.
<pre>
def show_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questions = @questionnaire.questions
render json: @questions, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end

</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|}

[[File:Questionnaire_spec_new.jpeg|border|800px|]] 
[[File:Questionnaire_swagger.jpeg|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question with correct parameters.
|-
| 6 || Test to update the Question with incorrect parameters.
|-
| 7 || Test to update the Question with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|}

[[File:Question_spec_new.jpeg|border|800px|]] 
[[File:Question_Swagger.jpeg|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

File:Question spec new.png

2023-05-01T00:35:11Z

Vchheda:

File:Questionnaire spec new.png

2023-05-01T00:34:57Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-05-01T00:33:45Z

Vchheda: /* Implementation */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*shiw_all: This is a GET endpoint that takes questionnaire_id as the path parameter and shows all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully displayed.
<pre>
def show_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questions = @questionnaire.questions
render json: @questions, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end

</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|}

[[File:Questionnaires_controller_test.jpeg|border|800px|]] 
[[File:Questionnaire_swagger.jpeg|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question with correct parameters.
|-
| 6 || Test to update the Question with incorrect parameters.
|-
| 7 || Test to update the Question with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|}

[[File:Questions_controller_test.jpeg|border|800px|]] 
[[File:Question_Swagger.jpeg|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-25T03:42:58Z

Vchheda:

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
The current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321]. 
To get the QuestionnairesController and QuestionsController endpoints running in the reimplementation-back-end repository, we need to reimplement the respective model files and add other dependent files. 

The following UML diagram shows the association between models we will be working on -

[[File:oodd_uml.png|border|800px|]]

Below is the implementation plan that we have followed for E2345:
<ol>
<li>
'''Implement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the instructor_id with the instructor details within the questionnaire object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
<pre>
def index
@questionnaires = Questionnaire.order(:id)
render json: @questionnaires, status: :ok and return
end
</pre>
:*show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@questionnaire = Questionnaire.find(params[:id])
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
end
end
</pre>
:*create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire. Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire if it exists, otherwise provides with appropriate error. It should delete the questionnaire only if there are no questions associated to it.
<pre>
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.delete
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
# Save questionnaire information
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.update(questionnaire_params)
@questionnaire.save!
render json: @questionnaire, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire if it exists, otherwise provides with appropriate error.
<pre>
def copy
begin
@questionnaire = Questionnaire.copy_questionnaire_details(params)
render json: "Copy of the questionnaire has been created successfully.", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*toggle_access: This is a GET endpoint that changes the access from public to private and vice versa if it exists, otherwise provides with appropriate error.
<pre>
def toggle_access
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.private = !@questionnaire.private
@questionnaire.save!
@access = @questionnaire.private == true ? 'private' : 'public'
render json: "The questionnaire \"#{@questionnaire.name}\" has been successfully made #{@access}. ", status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>
<li>
'''Reimplement ''questions_controller.rb'' to incorporate the feedback received in E2321.''' 
:*index: This is a GET endpoint that responds with a list of all questions with their attributes.
<pre>
def index
@questions = Question.order(:id)
render json: @questions, status: :ok
end
</pre>
:*show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists, otherwise provides with appropriate error.
<pre>
def show
begin
@question = Question.find(params[:id])
render json: @question, status: :ok
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found
end
end
</pre>
:*create: This is a POST endpoint that accepts the question parameters and creates a new question. Refactor the Create endpoint in questions_controller.rb such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*destroy: This is a DELETE endpoint that accepts a question ID and deletes that question if it exists, otherwise provides with appropriate error.
<pre>
def destroy
begin
@question = Question.find(params[:id])
@question.destroy
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*delete_all: This is a DELETE endpoint that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters if it exists, otherwise provides with appropriate error.
<pre>
def update
begin
@question = Question.find(params[:id])
@question.update(question_params)
@question.save!
render json: @question, status: :ok and return
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*types: This is a GET endpoint that responds with the list of question types.
<pre>
def types
types = Question.distinct.pluck(:question_type)
render json: types.to_a, status: :ok
end
</pre>
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

Rspec test skeleton for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could only do manual testing of our controller endpoints using Postman. In this project, we focus to create the models required to implement CRUD operations in the reimplementation-back-end repository and test the endpoints using Swagger API.

====Controller Tests====

To run the controller tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/requests/api/v1/questionnaires_controller_spec.rb
#rspec spec/requests/api/v1/questions_controller_spec.rb
#RAILS_ENV=test rails rswag

'''Tests for QuestionnairesController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|}

[[File:Questionnaires_controller_test.jpeg|border|800px|]] 
[[File:Questionnaire_swagger.jpeg|border|800px|]]

'''Tests for QuestionsController:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question with correct parameters.
|-
| 6 || Test to update the Question with incorrect parameters.
|-
| 7 || Test to update the Question with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|}

[[File:Questions_controller_test.jpeg|border|800px|]] 
[[File:Question_Swagger.jpeg|border|800px|]]

====Model Tests====

To run the model tests:

#git clone
#cd reimplementation-back-end/
#bundle install
#rspec spec/models/questionnaire_spec.rb
#rspec spec/models/question_spec.rb

'''Tests for Questionnaire model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

[[File:Questionnaire_model_test.jpeg|border|800px|]]

'''Tests for Question model:''' [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

[[File:Question_model_test.jpeg|border|800px|]]

== Future Work ==
*The questions and questionnaires model in the reimplementation-back-end repo has been updated to have question_type and questionnaire_type attribute instead of type attribute. Ruby has implicit inheritance when the type attribute is used. However, our repo does not have the dependent models for each type of Question and Questionnaire. For future implementation, those model classes could be added and this attribute can be refactored in the model and controller files.
*Implement other associations (for example: assignments) within each models.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:''' https://youtu.be/zkId16tklXI

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

File:Question Swagger.jpeg

2023-04-24T03:42:24Z

Vchheda:

File:Questionnaire swagger.jpeg

2023-04-24T03:42:10Z

Vchheda:

File:Questionnaires controller test.jpeg

2023-04-24T03:36:42Z

Vchheda:

File:Questions controller test.jpeg

2023-04-24T03:18:51Z

Vchheda:

File:Question model test.jpeg

2023-04-24T03:10:21Z

Vchheda:

File:Questionnaire model test.jpeg

2023-04-24T03:10:09Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T02:33:05Z

Vchheda: /* Controller Tests */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
<ol>
<li>
'''Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Refactor the Create endpoint in ''questions_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
# question = Object.const_get(params[:question][:type])
.create(txt: '', questionnaire_id: questionnaire_id, seq: num_of_existed_questions + 1, question_type:params[:question][:type], break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Create delete_all endpoint in QuestionsController that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
</pre>
:*Refactor questionnaire_params and create sanitize_display_type to make the create and update endpoints more modular.
<pre>
def questionnaire_params
params.require(:questionnaire).permit(:name, :questionnaire_type, :private, :min_question_score, :max_question_score, :instructor_id)
end
</pre>
<pre>
def sanitize_display_type(type)
display_type = type.split('Questionnaire')[0]
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split(/(?=[A-Z])/)).join('%')
end
display_type
end
</pre>
:*Refactor ''questionnaires_controller.rb'' and ''questions_controller.rb'' to handle ActiveRecord Errors and provide respective response codes. Handle response codes 200 (201 for create, 204 for delete) for successful execution, response code 404 for object not found, and 422 for unprocessable entity.
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec:''' Kindly refer to the Testing Methodology section for detailed description.
:*Unit tests for Question model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/question_spec.rb question_spec.rb]
:*Unit tests for Questionnaire model: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/models/questionnaire_spec.rb questionnaire_spec.rb]
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.''' Kindly refer to the Testing Methodology section for detailed description.
:*Swagger tests for QuestionsController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb questions_spec.rb]
:*Swagger tests for QuestionnairesController: [https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb questionnaires_spec.rb]
</li>
</ol>

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to create a new Question with non-existing Questionnaire id in the database
|-
| 4 || Test to list the Questions in the database.
|-
| 5 || Test to update the Question with correct parameters.
|-
| 6 || Test to update the Question with incorrect parameters.
|-
| 7 || Test to update the Question with non-existing id in the database.
|-
| 8 || Test to delete Question with existing id in the database.
|-
| 9 || Test to delete Question with the non-existing id in the database.
|-
| 10 || Test to show a Question with existing id in the database.
|-
| 11 || Test to show a Question with non-existing id in the database.
|-
| 12|| Test to get a types of Questions present in the database.
|-
| 13 || Test to delete all Questions of a Questionnaire with a valid Questionnaire id.
|-
| 14 || Test to delete all Questions of a Questionnaire with an invalid Questionnaire id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T02:24:26Z

Vchheda: /* Controller Tests */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
<ol>
<li>
'''Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Refactor the Create endpoint in ''questions_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
# question = Object.const_get(params[:question][:type])
.create(txt: '', questionnaire_id: questionnaire_id, seq: num_of_existed_questions + 1, question_type:params[:question][:type], break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Create delete_all endpoint in QuestionsController that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
</pre>
:*Refactor questionnaire_params and create sanitize_display_type to make the create and update endpoints more modular.
<pre>
def questionnaire_params
params.require(:questionnaire).permit(:name, :questionnaire_type, :private, :min_question_score, :max_question_score, :instructor_id)
end
</pre>
<pre>
def sanitize_display_type(type)
display_type = type.split('Questionnaire')[0]
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split(/(?=[A-Z])/)).join('%')
end
display_type
end
</pre>
:*Refactor ''questionnaires_controller.rb'' and ''questions_controller.rb'' to handle ActiveRecord Errors and provide respective response codes. Handle response codes 200 (201 for create, 204 for delete) for successful execution, response code 404 for object not found, and 422 for unprocessable entity.
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec.'''
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.'''
</li>
</ol>

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with non-existing id in database.
|-
| 9 || Test to delete Questionnaire with existing id in database.
|-
| 10 || Test to delete Questionnaire with the non-existing id in database.
|-
| 11 || Test to show a Questionnaire with a existing id in database.
|-
| 12 || Test to show a Questionnaire with non-existing id in database.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a existing id in database.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with non-existing id in database.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T02:22:24Z

Vchheda: /* Testing Methodology */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
<ol>
<li>
'''Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations.''' 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
'''Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321.''' 
:*Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Refactor the Create endpoint in ''questions_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
# question = Object.const_get(params[:question][:type])
.create(txt: '', questionnaire_id: questionnaire_id, seq: num_of_existed_questions + 1, question_type:params[:question][:type], break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Create delete_all endpoint in QuestionsController that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
</pre>
:*Refactor questionnaire_params and create sanitize_display_type to make the create and update endpoints more modular.
<pre>
def questionnaire_params
params.require(:questionnaire).permit(:name, :questionnaire_type, :private, :min_question_score, :max_question_score, :instructor_id)
end
</pre>
<pre>
def sanitize_display_type(type)
display_type = type.split('Questionnaire')[0]
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split(/(?=[A-Z])/)).join('%')
end
display_type
end
</pre>
:*Refactor ''questionnaires_controller.rb'' and ''questions_controller.rb'' to handle ActiveRecord Errors and provide respective response codes. Handle response codes 200 (201 for create, 204 for delete) for successful execution, response code 404 for object not found, and 422 for unprocessable entity.
</li>
<li>
'''Write unit tests for Questions model and Questionnaires model using Rspec.'''
</li>
<li>
'''Write Rspec tests using Swagger API for each endpoint of QuestionsController and QuestionnairesController.'''
</li>
</ol>

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire with existing id in database.
|-
| 4 || Test to create a copy of Questionnaire with non-existing id in database.
|-
| 5 || Test to list the Questionnaires.
|-
| 6 || Test to update a Questionnaire with correct parameters.
|-
| 7 || Test to update a Questionnaire with incorrect parameters.
|-
| 8 || Test to update a Questionnaire with invalid id.
|-
| 9 || Test to delete Questionnaire with existing id.
|-
| 10 || Test to delete Questionnaire with the non-existing id.
|-
| 11 || Test to show a Questionnaire with a valid id.
|-
| 12 || Test to show a Questionnaire with an invalid id.
|-
| 13 || Test to toggle private boolean flag of a Questionnaire with a valid id.
|-
| 14 || Test to toggle private boolean flag of a Questionnaire with a invalid id.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T02:16:14Z

Vchheda:

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
<ol>
<li>
Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations. 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321. The feedback is as follows: 
:*Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Refactor the Create endpoint in ''questions_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
# question = Object.const_get(params[:question][:type])
.create(txt: '', questionnaire_id: questionnaire_id, seq: num_of_existed_questions + 1, question_type:params[:question][:type], break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Create delete_all endpoint in QuestionsController that takes questionnaire_id as the path parameter and deletes all questions associated to that questionnaire. It returns status 404 if the questionnaire does not exist, status 422 if no questions are associated to that questionnaire and status 200 if all the questions are successfully deleted.
<pre>
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.questions.size > 0
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
else
render json: "No questions associated to Questionnaire ID:" + params[:id].to_s, status: :unprocessable_entity and return
end
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
</pre>
:*Refactor questionnaire_params and create sanitize_display_type to make the create and update endpoints more modular.
<pre>
def questionnaire_params
params.require(:questionnaire).permit(:name, :questionnaire_type, :private, :min_question_score, :max_question_score, :instructor_id)
end
</pre>
<pre>
def sanitize_display_type(type)
display_type = type.split('Questionnaire')[0]
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split(/(?=[A-Z])/)).join('%')
end
display_type
end
</pre>
</li>
</ol>

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire.
|-
| 4 || Test to list the Questionnaires.
|-
| 5 || Test to update the Questionnaire with correct parameters.
|-
| 6 || Test to update the Questionnaire with incorrect parameters.
|-
| 7 || Test to delete Questionnaire with existing id.
|-
| 8 || Test to delete Questionnaire with the non-existing id.
|-
| 9 || Test to show a Questionnaire with a valid id.
|-
| 10 || Test to show a Questionnaire with an invalid id.
|-
| 11 || Test to toggle private boolean flag of a Questionnaire with a valid id.
|-
| 12 || Test to toggle private boolean flag of a Questionnaire with a invalid id.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|-
| 9 || Test ensures minimum score is smaller than maximum score.
|-
| 10 || Test ensures minimum score is an integer.
|-
| 11 || Test validates the association that a questionnaire comprises of several questions.
|-
| 12 || Test ensures that a questionnaire is not deleted when it has questions associated.
|-
| 13 || Test ensures calls from the method copy_questionnaire_details.
|-
| 14 || Test ensures creation of a copy of given questionnaire.
|-
| 15 || Test ensures creation of copy of all the present questionnaire in the database.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T02:04:50Z

Vchheda: /* Model Tests */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
<ol>
<li>
Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations. 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire:
{ only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321. The feedback is as follows: 
:*Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Refactor the Create endpoint in ''questions_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Question object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
# question = Object.const_get(params[:question][:type])
.create(txt: '', questionnaire_id: questionnaire_id, seq: num_of_existed_questions + 1, question_type:params[:question][:type], break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
</li>

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire.
|-
| 4 || Test to list the Questionnaires.
|-
| 5 || Test to update the Questionnaire with correct parameters.
|-
| 6 || Test to update the Questionnaire with incorrect parameters.
|-
| 7 || Test to delete Questionnaire with existing id.
|-
| 8 || Test to delete Questionnaire with the non-existing id.
|-
| 9 || Test to show a Questionnaire with a valid id.
|-
| 10 || Test to show a Questionnaire with an invalid id.
|-
| 11 || Test to toggle private boolean flag of a Questionnaire with a valid id.
|-
| 12 || Test to toggle private boolean flag of a Questionnaire with a invalid id.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field.
|-
|7|| Test ensures that a question does not exist without a questionnaire.
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test validates the name of the questionnaire.
|-
| 3 || Test validates the instructor id in the questionnaire .
|-
| 4 || Test validates the maximum score in the questionnaire.
|-
| 5 || Test ensures maximum score of the questionnaire is an integer.
|-
| 6 || Test ensures maximum score is positive.
|-
| 7 || Test ensures maximum score is greater than the minimum score.
|-
| 8 || Test validates minimum score of a questionnaire.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T02:00:49Z

Vchheda: /* Model Tests */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
<ol>
<li>
Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations. 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire: { only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
In the above code, the as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
In the above code,
::*The as_json method is used to decorate the JSON object that is returned as a part of the response body from the controller endpoint. It is used to replace the questionnaire_id with the questionnaire details within the question object in JSON format.
::*The check_for_question_associations method is used to raise an Error if a Questionnaire that has associated questions is tried to be deleted.
::*The copy_questionnaire_details method is used to create a new object with the same attributes of the questionnaire and save it to the database. It is called when the copy endpoint is requested.
</li>
<li>
Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321. The feedback is as follows: 
:*Refactor the Create endpoint in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
@questionnaire = Questionnaire.new(questionnaire_params)
@questionnaire.display_type = sanitize_display_type(@questionnaire.questionnaire_type)
@questionnaire.save!
render json: @questionnaire, status: :created and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Refactor the Create endpoint in ''questions_controller.rb'' such that individual fields does not need to be set and validated. The below code represents the revised implementation of the method. A Questionnaire object is created using the new method instead of manual assignment of attributes.
<pre>
def create
begin
questionnaire_id = params[:questionnaire_id] unless params[:questionnaire_id].nil?
num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
question = Question.create(
txt: params[:txt],
questionnaire_id: questionnaire_id,
seq: num_of_existed_questions + 1,
question_type: params[:question_type],
break_before: true)
# question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: num_of_existed_questions + 1, question_type: params[:question][:type], break_before: true)
case question.question_type
when 'Scale'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
when 'Cake', 'Criterion'
question.weight = params[:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
question.size = '50, 3'
when 'Dropdown'
question.alternatives = '0|1|2|3|4|5'
question.size = nil
when 'TextArea'
question.size = '60, 5'
when 'TextField'
question.size = '30'
end

question.save!
render json: question, status: :created
rescue ActiveRecord::RecordNotFound
render json: $ERROR_INFO.to_s, status: :not_found and return
rescue ActiveRecord::RecordInvalid
render json: $ERROR_INFO.to_s, status: :unprocessable_entity
end
end
</pre>
:*Implement an endpoint to delete all questions associated with a questionnaire.
# DELETE on /questions/delete_all/<questionnaire_id>
# Endpoint to delete all questions associated to a particular questionnaire.
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
rescue
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
:*Add a validation to allow deletion of questionnaire only if all questions that belongs to it are deleted first. 
# DELETE on /questionnaires/:id
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
rescue
render json: $ERROR_INFO, status: :not_found and return
end
begin
name = @questionnaire.name
questions = @questionnaire.questions
# questions.each do |question|
# question.delete
# end
unless questions.nil?
msg = "This questionnaire has questions associated with it. Use this endpoint to delete all questions for the questionnaire: "
link = "/questions/delete_all/" + @questionnaire.id.to_s
msg += link
render json: msg and return
else
@questionnaire.delete
render json: "The questionnaire \"#{name}\" has been successfully deleted.", status: :ok and return
end
rescue StandardError => e
render json: e.message, status: :unprocessable_entity and return
end
end
</li>

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire.
|-
| 4 || Test to list the Questionnaires.
|-
| 5 || Test to update the Questionnaire with correct parameters.
|-
| 6 || Test to update the Questionnaire with incorrect parameters.
|-
| 7 || Test to delete Questionnaire with existing id.
|-
| 8 || Test to delete Questionnaire with the non-existing id.
|-
| 9 || Test to show a Questionnaire with a valid id.
|-
| 10 || Test to show a Questionnaire with an invalid id.
|-
| 11 || Test to toggle private boolean flag of a Questionnaire with a valid id.
|-
| 12 || Test to toggle private boolean flag of a Questionnaire with a invalid id.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question has valid attributes defined.
|-
| 2 || Test ensures that a question is not valid without seq field.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test ensures that a question is not valid without txt field.
|-
| 5 || Test ensures that a question is not valid without question_type field.
|-
|6|| Test ensures that a question is not valid without break_before field
|-
|7|| Test ensures that a question does not exist without a questionnaire
|-
|8|| Test ensures that a question object is deleted properly taking all its association into consideration
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test that Questionnaire requires max_question_score and min_question_score to be numerical.
|-
| 3 || Test that Questionnaire can have questions associated with it.
|-
| 4 || Test that Questionnaire can have assignments associated with it through assignment_questionnaires.
|-
| 5 || Test that Questionnaire validates the questionnaire.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T01:56:16Z

Vchheda: /* Model Tests */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
1. Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations. 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire: { only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
2. Write comprehensive test cases for both models using RSpec. 
3. Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321. The feedback is as follows: 
:*Optimize the Create method in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated.
# POST on /questionnaires
def create
if params[:questionnaire][:name].blank?
render json: "Questionnaire name cannot be blank.", status: :unprocessable_entity
end
begin
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire.private = params[:questionnaire][:private] == 'true'
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = 6 # session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split(/(?=[A-Z])/)).join('%')
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
render json: @questionnaire, status: :created
rescue StandardError
msg = $ERROR_INFO
render json: msg, status: :unprocessable_entity
end
end
:*Implement an endpoint to delete all questions associated with a questionnaire.
# DELETE on /questions/delete_all/<questionnaire_id>
# Endpoint to delete all questions associated to a particular questionnaire.
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
rescue
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
:*Add a validation to allow deletion of questionnaire only if all questions that belongs to it are deleted first. 
# DELETE on /questionnaires/:id
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
rescue
render json: $ERROR_INFO, status: :not_found and return
end
begin
name = @questionnaire.name
questions = @questionnaire.questions
# questions.each do |question|
# question.delete
# end
unless questions.nil?
msg = "This questionnaire has questions associated with it. Use this endpoint to delete all questions for the questionnaire: "
link = "/questions/delete_all/" + @questionnaire.id.to_s
msg += link
render json: msg and return
else
@questionnaire.delete
render json: "The questionnaire \"#{name}\" has been successfully deleted.", status: :ok and return
end
rescue StandardError => e
render json: e.message, status: :unprocessable_entity and return
end
end
4. Write comprehensive test cases for both controllers using RSpec.

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire.
|-
| 4 || Test to list the Questionnaires.
|-
| 5 || Test to update the Questionnaire with correct parameters.
|-
| 6 || Test to update the Questionnaire with incorrect parameters.
|-
| 7 || Test to delete Questionnaire with existing id.
|-
| 8 || Test to delete Questionnaire with the non-existing id.
|-
| 9 || Test to show a Questionnaire with a valid id.
|-
| 10 || Test to show a Questionnaire with an invalid id.
|-
| 11 || Test to toggle private boolean flag of a Questionnaire with a valid id.
|-
| 12 || Test to toggle private boolean flag of a Questionnaire with a invalid id.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question belongs to a Questionnaire.
|-
| 2 || Test that Question requires a sequence number.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test that Question requires a question type.
|-
| 5 || Test that Question requires a break_before flag.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test that Questionnaire requires max_question_score and min_question_score to be numerical.
|-
| 3 || Test that Questionnaire can have questions associated with it.
|-
| 4 || Test that Questionnaire can have assignments associated with it through assignment_questionnaires.
|-
| 5 || Test that Questionnaire validates the questionnaire.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questionnaires
#show: GET method - http://152.7.178.189:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.178.189:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.178.189:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.178.189:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.178.189:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.178.189:8080/api/v1/questions/
#show: GET method - http://152.7.178.189:8080/api/v1/questions/1
#create: POST method - http://152.7.178.189:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.178.189:8080/api/v1/questions/2
#update: PUT method - http://152.7.178.189:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.178.189:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.178.189:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-24T01:54:11Z

Vchheda: /* Relevant Links */

==Introduction==
This page gives a description of the changes made for the ''questions_controller.rb, questionnaire_controller.rb, question.rb & questionnaire.rb'' of Expertiza based OSS project.

== Problem Statement ==
What is needed: This project builds on E2321, and the main goal is to get the endpoints of QuestionsController and QuestionnairesController running in reimplementation-backend repository. Detailed goals of the project are as follows:
#Improving the clarity and conciseness of code: The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed.
#Discarding unused functionality: Any unused functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.
#Reimplement Question and Questionnaire models: Reimplement the two models to facilitate the endpoints of the respective controllers.
#Writing tests for the two models: Tests should be written for both the Questionnaires and the Questions models.
#Writing tests for the two controllers: Tests should be written for both the QuestionnairesController and the QuestionsController. The tests should written in the RSwag test format.

==General Design Goals==
* Ensure all prior/expected functionality is working correctly, and if not, make any repairs or changes necessary.
* Ensure that the each of the models and controllers have loose coupling and tight cohesion.
* DRY out prior implementation's controller and model methods which have functionality that already exists within the expertiza system.
* Ensure all present test cases still work properly after making the above changes and create additional test cases.

==Current Implementation==
Plan for current implementation for the code can be found here [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321].

After seperation of the responsibilities of the QuestionnairesController and QuestionsController, fixing bugs, discarding unused functionality, we reimplemented the code to create basic CRUD operations. Then the methods were converted to basic CRUD operations which are described below. (Information related to separating responsibilities, bugs fixed, current testing and unused functionality can be found on the above link for plan of current implementation.)
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

The current implementation of the Controllers include only manual testing via Postman. In E2345, we plan to add automated RSpec tests using the Swagger API to test each endpoint.

==Implementation==
We did not have models for Questionnaires and Questions, along with other primary models on which the Questionnaire and Question model depend on in the reimplementation-back-end repository, so we ran it on expertiza repository. To get the questions and questionnaires module running in the reimplementation-back-end repository, we plan to follow these steps: 
1. Reimplement basic version of ''question.rb'' and ''questionnaire.rb'' such that it facilitates the controllers' CRUD operations. 
:*Add required associations for ''user.rb, role.rb, question.rb, and questionnaire.rb'' only.
:*The below code snippets represent current implementation of ''question.rb'':
<pre>
class Question < ApplicationRecord
belongs_to :questionnaire # each question belongs to a specific questionnaire

validates :seq, presence: true, numericality: true # sequence must be numeric
validates :txt, length: { minimum: 0, allow_nil: false, message: "can't be nil" } # user must define text content for a question
validates :question_type, presence: true # user must define type for a question
validates :break_before, presence: true

def as_json(options = {})
super(options.merge({
only: %i[questionnaire_id txt weight seq question_type size alternatives break_before min_label max_label created_at updated_at],
include: {
questionnaire: { only: %i[name private min_question_score max_question_score instructor_id created_at updated_at questionnaire_type] }
}
})).tap do |hash|
hash['questionnaire'] ||= { id: nil, name: nil }
end
end

end
</pre>
:*The below code snippets represent current implementation of ''questionnaire.rb'':
<pre>
class Questionnaire < ApplicationRecord
has_many :questions, dependent: :restrict_with_error
belongs_to :instructor

before_destroy :check_for_question_associations

validate :validate_questionnaire
validates :name, presence: true
validates :max_question_score, :min_question_score, numericality: true

# clones the contents of a questionnaire, including the questions and associated advice
def self.copy_questionnaire_details(params)
orig_questionnaire = Questionnaire.find(params[:id])
questions = Question.where(questionnaire_id: params[:id])
questionnaire = orig_questionnaire.dup
questionnaire.name = 'Copy of ' + orig_questionnaire.name
questionnaire.created_at = Time.zone.now
questionnaire.updated_at = Time.zone.now
questionnaire.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = questionnaire.id
new_question.save!
end
questionnaire
end

# validate the entries for this questionnaire
def validate_questionnaire
errors.add(:max_question_score, 'The maximum question score must be a positive integer.') if max_question_score < 1
errors.add(:min_question_score, 'The minimum question score must be a positive integer.') if min_question_score < 0
errors.add(:min_question_score, 'The minimum question score must be less than the maximum.') if min_question_score >= max_question_score
results = Questionnaire.where('id <> ? and name = ? and instructor_id = ?', id, name, instructor_id)
errors.add(:name, 'Questionnaire names must be unique.') if results.present?
end

# Check_for_question_associations checks if questionnaire has associated questions or not
def check_for_question_associations
if questions.any?
raise ActiveRecord::DeleteRestrictionError.new(:base, "Cannot delete record because dependent questions exist")
end
end

def as_json(options = {})
super(options.merge({
only: %i[id name private min_question_score max_question_score created_at updated_at questionnaire_type],
include: {
instructor: { only: %i[name email fullname password role] }
}
})).tap do |hash|
hash['instructor'] ||= { id: nil, name: nil }
end
end
end
</pre>
2. Write comprehensive test cases for both models using RSpec. 
3. Reimplement ''questions_controller.rb'' and ''questionnaires_controller.rb'' to incorporate the feedback received in E2321. The feedback is as follows: 
:*Optimize the Create method in ''questionnaires_controller.rb'' such that individual fields does not need to be set and validated.
# POST on /questionnaires
def create
if params[:questionnaire][:name].blank?
render json: "Questionnaire name cannot be blank.", status: :unprocessable_entity
end
begin
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire.private = params[:questionnaire][:private] == 'true'
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = 6 # session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split(/(?=[A-Z])/)).join('%')
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
render json: @questionnaire, status: :created
rescue StandardError
msg = $ERROR_INFO
render json: msg, status: :unprocessable_entity
end
end
:*Implement an endpoint to delete all questions associated with a questionnaire.
# DELETE on /questions/delete_all/<questionnaire_id>
# Endpoint to delete all questions associated to a particular questionnaire.
def delete_all
begin
@questionnaire = Questionnaire.find(params[:id])
@questionnaire.questions.destroy_all
msg = "All questions for Questionnaire ID:" + params[:id].to_s + " has been successfully deleted!"
render json: msg, status: :ok
rescue
render json: $ERROR_INFO, status: :unprocessable_entity
end
end
:*Add a validation to allow deletion of questionnaire only if all questions that belongs to it are deleted first. 
# DELETE on /questionnaires/:id
def destroy
begin
@questionnaire = Questionnaire.find(params[:id])
rescue
render json: $ERROR_INFO, status: :not_found and return
end
begin
name = @questionnaire.name
questions = @questionnaire.questions
# questions.each do |question|
# question.delete
# end
unless questions.nil?
msg = "This questionnaire has questions associated with it. Use this endpoint to delete all questions for the questionnaire: "
link = "/questions/delete_all/" + @questionnaire.id.to_s
msg += link
render json: msg and return
else
@questionnaire.delete
render json: "The questionnaire \"#{name}\" has been successfully deleted.", status: :ok and return
end
rescue StandardError => e
render json: e.message, status: :unprocessable_entity and return
end
end
4. Write comprehensive test cases for both controllers using RSpec.

==Testing Methodology==

* Rspec tests for QuestionnairesController and QuestionsController had been added in the previous project [https://expertiza.csc.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2321._Reimplement_QuestionnairesController_and_QuestionsController E2321] but had not been executed due to missing dependencies. This project focuses on implementing them and getting automated test cases running as expected.
In our previous project we implemented the CRUD endpoints but since all the models were not present in reimplementation backend repository, we could not test our controller tests. In this project, we focus to create the models required to implement CRUD operations in the reimplementation backend repository and then run and test the API tests for the CRUD operations.

====Controller Tests====

To run the controller tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/requests/api/v1/questionnaires_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Questionnaire with valid parameters.
|-
| 2 || Test to create a new Questionnaire with invalid parameters.
|-
| 3 || Test to create a copy of Questionnaire.
|-
| 4 || Test to list the Questionnaires.
|-
| 5 || Test to update the Questionnaire with correct parameters.
|-
| 6 || Test to update the Questionnaire with incorrect parameters.
|-
| 7 || Test to delete Questionnaire with existing id.
|-
| 8 || Test to delete Questionnaire with the non-existing id.
|-
| 9 || Test to show a Questionnaire with a valid id.
|-
| 10 || Test to show a Questionnaire with an invalid id.
|-
| 11 || Test to toggle private boolean flag of a Questionnaire with a valid id.
|-
| 12 || Test to toggle private boolean flag of a Questionnaire with a invalid id.
|}

bundle exec rspec spec/requests/api/v1/questions_controller_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test to create a new Question with valid parameters.
|-
| 2 || Test to create a new Question with invalid parameters.
|-
| 3 || Test to list the Questions.
|-
| 4 || Test to update the Question with correct parameters.
|-
| 5 || Test to update the Question with incorrect parameters.
|-
| 6 || Test to delete Question with existing id.
|-
| 7 || Test to delete Question with the non-existing id.
|-
| 8 || Test to show a Question with a valid id.
|-
| 9 || Test to show a Question with an invalid id.
|-
|10|| Test to get a type of a Question with valid id.
|-
|11|| Test to get a type of a Question with invalid id.
|-
|12|| Test to delete all Questions of a Questionnaire with a valid id.
|-
|13|| Test to delete all Questions of a Questionnaire with an invalid id.
|}

* Rspec unit and functional tests for Questionnaire and Question model will be created. (Since, we are implementing required models for reimplementation backend repository in this project, we plan to write unit and functional tests to test the methods written in the model.)

====Model Tests====

To run the model tests:

1. git clone

2. cd reimplementation-back-end/

3. bundle install

4. bundle exec rspec spec/models/question_spec.rb
{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Question belongs to a Questionnaire.
|-
| 2 || Test that Question requires a sequence number.
|-
| 3 || Test that Question sequence number must be numerical.
|-
| 4 || Test that Question requires a question type.
|-
| 5 || Test that Question requires a break_before flag.
|}

5. bundle exec rspec spec/models/questionnaire_spec.rb

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test that Questionnaire requires a name.
|-
| 2 || Test that Questionnaire requires max_question_score and min_question_score to be numerical.
|-
| 3 || Test that Questionnaire can have questions associated with it.
|-
| 4 || Test that Questionnaire can have assignments associated with it through assignment_questionnaires.
|-
| 5 || Test that Questionnaire validates the questionnaire.
|}

* Demonstrating working of API endpoints on Postman. Given below are the endpoints which we tested successfully on Postman.
'''Questionnaires Controller'''
#index: GET method - http://152.7.177.152:8080/api/v1/questionnaires
#show: GET method - http://152.7.177.152:8080/api/v1/questionnaires/1
#create: POST method - http://152.7.177.152:8080/api/v1/questionnaires/
#destroy: DELETE method - http://152.7.177.152:8080/api/v1/questionnaires/1
#update: .PUT method - http://152.7.177.152:8080/api/v1/questionnaires/1
#copy: POST method - http://152.7.177.152:8080/api/v1/questionnaires/copy/1
#toggle_access: GET method - http://152.7.177.152:8080/api/v1/questionnaires/toggle_access/1

'''Questions Controller'''
#index: GET method - http://152.7.177.152:8080/api/v1/questions/
#show: GET method - http://152.7.177.152:8080/api/v1/questions/1
#create: POST method - http://152.7.177.152:8080/api/v1/questions/
#destroy: DELETE method - http://152.7.177.152:8080/api/v1/questions/2
#update: PUT method - http://152.7.177.152:8080/api/v1/questions/2
#delete all: DELETE method - http://152.7.177.152:8080/api/v1/questions/delete_all/2
#types: GET method - http://152.7.177.152:8080/api/v1/questions/types

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.178.189:8080
* '''Test Video Link:'''

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

User:Vchheda

2023-04-24T01:25:53Z

Vchheda: Blanked the page

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T23:55:52Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T23:24:46Z

Vchheda: /* Relevant Links */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T23:24:19Z

Vchheda: /* Testing Methodology */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T23:22:00Z

Vchheda: /* Testing Methodology */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T23:01:29Z

Vchheda: /* Current Implementation */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:51:18Z

Vchheda: /* Implementation Plan */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:50:42Z

Vchheda: /* Implementation Plan */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:49:16Z

Vchheda: /* Implementation Plan */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:45:40Z

Vchheda: /* Current Implementation */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:44:43Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:44:01Z

Vchheda: /* Current Implementation */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:40:37Z

Vchheda: /* Current Implementation */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:38:41Z

Vchheda: /* Current Implementation */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T22:36:32Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-12T13:49:24Z

Vchheda: /* Testing Methodology */

CSC/ECE 517 Spring 2023

2023-04-08T19:31:54Z

Vchheda: /* OSS Projects */

== OSS Projects ==

[[CSC/ECE 517 Spring_2023 -E2306. Refactor user_controller.rb, user.rb and its child classes]]

[[CSC/ECE 517 Spring_2023 - E2320. Reimplement the Question hierarchy]]

[[CSC/ECE 517 Spring_2023 - E2312 + E2313. Reimplement response.rb and responses_controller.rb]]

[[CSC/ECE 517 Spring_2023 - NTNX-1. Support provisioning MongoDb via NDB Kubernetes Operator]]

[[CSC/ECE 517 Spring_2023 - E2316. Reimplement sign_up_sheet_controller.rb]]

[[CSC/ECE 517 Spring_2023 - E2315. Reimplement signed_up_team.rb, sign_up_topic.rb, sign_up_sheet.rb]]

[[CSC/ECE 517 Spring_2023 - E2340. Reimplement signed_up_team.rb, sign_up_topic.rb, sign_up_sheet.rb (Project 4)]]

[[CSC/ECE 517 Spring_2023 - E2323. Refactor DueDate functionality from assignment.rb]]

[[CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb]]

[[CSC/ECE 517 Spring 2023 - E2314. Reimplement the response map hierarchy]]

[[CSC/ECE 517 Spring 2023- NTNX-4. Extend NDB operator provision postregresql aws]]

[[CSC/ECE 517 Spring 2023 - E2321. Reimplement QuestionnairesController and QuestionsController]]

[[CSC/ECE 517 Spring 2023 - E2305. Grading audit trail]]

[[CSC/ECE 517 Spring 2023 - E2329. Grading audit trail(Project 4)]]

[[CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses]]

[[CSC/ECE 517 Spring 2023 - NTNX-2. Support provisioning mySQL databases via NDB Kubernetes Operator]]

[[CSC/ECE 517 Spring 2023 - E2300. Refactor E1858. Github metrics integration]]

[[CSC/ECE 517 Sping 2023 - E2322: Refactor Questionnaire View to display Bookmark Rating]]

[[CSC/ECE 517 Spring 2023 - NTNX-3. Refactor models to keep profiles (software, compute, network, etc) as optional and use default if not specified]]

[[CSC/ECE_517_Spring_2023_-_E2301._Refactor_review_maping_helper]]

[[CSC/ECE_517_Spring_2023_-_E2330._Reimplementation_Invitation_Controller]]

[[CSC/ECE_517_Spring_2023_-_E2337._Reimplement_node_hierarchy]]

[[CSC/ECE_517_Spring_2023_-E2339._Reimplement signed_up_teams_controller and sign_up_topics_controller.rb]]

[[CSC/ECE_517_Spring_2023_-_E2320._Reimplement the Question Hierarchy]]

[[CSC/ECE_517_Spring_2023 - E2341. UI for Participants.rb]]

[[CSC/ECE_517_Spring_2023_-_E2336._Reimplement_response.rb]]

[[CSC/ECE_517_Spring_2023_-_E2345._Reimplement_QuestionnairesController_and_QuestionsController]]

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-07T18:34:16Z

Vchheda: /* Testing Methodology */

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-07T03:06:06Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2345. Reimplement QuestionnairesController and QuestionsController

2023-04-05T02:48:34Z

Vchheda:

CSC/ECE 517 Spring 2023 - E2321. Reimplement QuestionnairesController and QuestionsController

2023-03-30T00:15:01Z

Vchheda:

'''E2321. Reimplement QuestionnairesController and QuestionsController'''

==Problem Statement==
The questionnaire is the superclass for all kinds of questionnaires and rubrics. Rubrics are used for evaluating submissions and teammate contributions, as well as taking quizzes and surveys, and all of these are subclasses of the Questionnaire class. In Expertiza, various types of questionnaires can be created, such as the Survey Questionnaire, Author Feedback Questionnaire, Bookmark Rating Questionnaire, Metareview Questionnaire, Quiz Questionnaire, Review Questionnaire, and Teammate Review Questionnaire. Each of these questionnaires can have zero or more questions, which are represented by the Question class. Typically, a questionnaire is associated with an assignment using the Assignment class.

The Questionnaire Controller is responsible for performing CRUD (Create, Read, Update, Delete) operations, such as copying and viewing questionnaires. On the other hand, the Questions Controller is responsible for creating, modifying, and deleting individual questions within a questionnaire. Questions can come in various types, such as checkboxes, multiple choice, text boxes, and more. However, each question object will always belong to a particular questionnaire. However, the current implementation suffers from several issues, such as mixing the responsibilities of the two controllers, using methods with identical names for different functionalities, and unclear or unused functionalities. Therefore, to improve the code quality and functionality, the two controllers should be implemented separately and adhere to the CRUD operations as much as possible. Additionally, the code needs to be refactored and optimized for better performance, and unused or unclear methods should be discarded. Finally, comprehensive tests should be written to ensure that the code is functioning correctly and free of code smells.

==Goals of this Project==
The goals of this Project are:

#Separating the responsibilities of the QuestionnairesController and QuestionsController
#Fix bugs in the existing functionality
#Implementing CRUD operations for each controller
#Discarding unused or unclear functionality
#Writing tests for the two controllers

By achieving these goals, both the controllers can have their basic CRUD functionalities as well as it will also ensure that the code readability and functionality of the code for the two controllers is increased. It will also help in resolving the existing bugs which will increase correctness of the code.

==Implementation==

A considerable amount of time and effort was necessary to review, understand, and re-implement the previous implementation of QuestionsController and QuestionnairesController. The team started with understanding how the Questionnaires and Questions module work by playing around with the Expertiza website. Once we had understanding of the flow, we started understanding the existing code written in the controllers. At first glance, it was visible that the QuestionnairesController was handling all the CRUD operations of Questions as well. We identified what functionalities did not belong in the QuestionnairesController and which redundant code had to be removed. The issues that we have addressed in our reimplementation project are listed as follows.

*'''Separating the responsibilities of the QuestionnairesController and QuestionsController:''' The code snippets below are part of the original implementation of the QuestionnairesController. However, according to design principles, the QuestionsController should be responsible to handle the CRUD operations for questions. We reimplemented the CRUD operations and separated the responsibilities of each controller.
<pre>
def add_new_questions
questionnaire_id = params[:id] unless params[:id].nil?
# If the questionnaire is being used in the active period of an assignment, delete existing responses before adding new questions
if AnswerHelper.check_and_delete_responses(questionnaire_id)
flash[:success] = 'You have successfully added a new question. Any existing reviews for the questionnaire have been deleted!'
else
flash[:success] = 'You have successfully added a new question.'
end

num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|
question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)
if question.is_a? ScoredQuestion
question.weight = params[:question][:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
end

question.size = '50, 3' if question.is_a? Criterion
question.size = '50, 3' if question.is_a? Cake
question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown
question.size = '60, 5' if question.is_a? TextArea
question.size = '30' if question.is_a? TextField

begin
question.save
rescue StandardError
flash[:error] = $ERROR_INFO
end
end
redirect_to edit_questionnaire_path(questionnaire_id.to_sym)
end
</pre>
-> add_new_questions method in the questionnaire controller was responsible for creating questionnaire however it is a basic functionality of questions controller, hence was remove from the questionnaire's controller.
<pre>
def update
# If 'Add' or 'Edit/View advice' is clicked, redirect appropriately
if params[:add_new_questions]
# redirect_to action: 'add_new_questions', id: params.permit(:id)[:id], question: params.permit(:new_question)[:new_question]
nested_keys = params[:new_question].keys
permitted_params = params.permit(:id, :new_question => nested_keys)
redirect_to action: 'add_new_questions', id: permitted_params[:id], question: permitted_params[:new_question]
elsif params[:view_advice]
redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]
else
@questionnaire = Questionnaire.find(params[:id])
begin
# Save questionnaire information
@questionnaire.update_attributes(questionnaire_params)

# Save all questions
unless params[:question].nil?
params[:question].each_pair do |k, v|
@question = Question.find(k)
# example of 'v' value
# {"seq"=>"1.0", "txt"=>"WOW", "weight"=>"1", "size"=>"50,3", "max_label"=>"Strong agree", "min_label"=>"Not agree"}
v.each_pair do |key, value|
@question.send(key + '=', value) unless @question.send(key) == value
end
@question.save
end
end
flash[:success] = 'The questionnaire has been successfully updated!'
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'edit', id: @questionnaire.id.to_s.to_sym
end
end
</pre>
-> update method in the questionnaire controller was updating both questionnaire and questions controller. As we want to separate the responsibility of both the controllers, there are two separate method in each controller updating the respective controllers.
*'''Discard unused functionality and redundant code:''' The following code snippets were unused in the original implementation so we discarded them.
'''QUESTIONNAIRES CONTROLLER'''
<pre>
def create_questionnaire
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)
# Create Quiz content has been moved to Quiz Questionnaire Controller
if @questionnaire.type != 'QuizQuestionnaire' # checking if it is a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == 'Teaching Assistant'
save

redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>
-> Questionnaire is being created with the help of create method, create_questionnaire is a redundant method.
<pre>
def save_all_questions
questionnaire_id = params[:id]
begin
if params[:save]
params[:question].each_pair do |k, v|
@question = Question.find(k)
# example of 'v' value
# {"seq"=>"1.0", "txt"=>"WOW", "weight"=>"1", "size"=>"50,3", "max_label"=>"Strong agree", "min_label"=>"Not agree"}
v.each_pair do |key, value|
@question.send(key + '=', value) unless @question.send(key) == value
end

@question.save
flash[:success] = 'All questions have been successfully saved!'
end
end
rescue StandardError
flash[:error] = $ERROR_INFO
end

if params[:view_advice]
redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]
elsif questionnaire_id
redirect_to edit_questionnaire_path(questionnaire_id.to_sym)
end
end
</pre>
-> save_all_questions method was used in place of update method in questionnaire controller, that is update in questionnaire was being performed with the help of this method. While implementing basic CRUD, it is no longer needed.

<pre>
def action_allowed?
case params[:action]
when 'edit'
@questionnaire = Questionnaire.find(params[:id])
current_user_has_admin_privileges? ||
(current_user_is_a?('Instructor') && current_user_id?(@questionnaire.try(:instructor_id))) ||
(current_user_is_a?('Teaching Assistant') && session[:user].instructor_id == @questionnaire.try(:instructor_id))
else
current_user_has_student_privileges?
end
end
</pre>
-> Authorisation has been removed in the new implementation, so it is no longer needed. action_allowed method used to allow certain actions based on the session created by the login credentials.

<pre>
def new
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
rescue StandardError
flash[:error] = $ERROR_INFO
end
</pre>

<pre>
def edit
@questionnaire = Questionnaire.find(params[:id])
redirect_to Questionnaire if @questionnaire.nil?
session[:return_to] = request.original_url
end
</pre>

<pre>
def add_new_questions
questionnaire_id = params[:id] unless params[:id].nil?
# If the questionnaire is being used in the active period of an assignment, delete existing responses before adding new questions
if AnswerHelper.check_and_delete_responses(questionnaire_id)
flash[:success] = 'You have successfully added a new question. Any existing reviews for the questionnaire have been deleted!'
else
flash[:success] = 'You have successfully added a new question.'
end

num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size
((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|
question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)
if question.is_a? ScoredQuestion
question.weight = params[:question][:weight]
question.max_label = 'Strongly agree'
question.min_label = 'Strongly disagree'
end

question.size = '50, 3' if question.is_a? Criterion
question.size = '50, 3' if question.is_a? Cake
question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown
question.size = '60, 5' if question.is_a? TextArea
question.size = '30' if question.is_a? TextField

begin
question.save
rescue StandardError
flash[:error] = $ERROR_INFO
end
end
redirect_to edit_questionnaire_path(questionnaire_id.to_sym)
end
</pre>
-> add_new_questions method is now part of responsibility of questions controller as create method.

<pre>
def save_all_questions
questionnaire_id = params[:id]
begin
if params[:save]
params[:question].each_pair do |k, v|
@question = Question.find(k)
# example of 'v' value
# {"seq"=>"1.0", "txt"=>"WOW", "weight"=>"1", "size"=>"50,3", "max_label"=>"Strong agree", "min_label"=>"Not agree"}
v.each_pair do |key, value|
@question.send(key + '=', value) unless @question.send(key) == value
end

@question.save
flash[:success] = 'All questions have been successfully saved!'
end
end
rescue StandardError
flash[:error] = $ERROR_INFO
end

if params[:view_advice]
redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]
elsif questionnaire_id
redirect_to edit_questionnaire_path(questionnaire_id.to_sym)
end
end
</pre>

<pre>
def save
@questionnaire.save!
save_questions @questionnaire.id unless @questionnaire.id.nil? || @questionnaire.id <= 0
undo_link("Questionnaire \"#{@questionnaire.name}\" has been updated successfully. ")
end

# save questions that have been added to a questionnaire
def save_new_questions(questionnaire_id)
if params[:new_question]
# The new_question array contains all the new questions
# that should be saved to the database
params[:new_question].keys.each_with_index do |question_key, index|
q = Question.new
q.txt = params[:new_question][question_key]
q.questionnaire_id = questionnaire_id
q.type = params[:question_type][question_key][:type]
q.seq = question_key.to_i
if @questionnaire.type == 'QuizQuestionnaire'
# using the weight user enters when creating quiz
weight_key = "question_#{index + 1}"
q.weight = params[:question_weights][weight_key.to_sym]
end
q.save unless q.txt.strip.empty?
end
end
end
</pre>

<pre>
def delete_questions(questionnaire_id)
# Deletes any questions that, as a result of the edit, are no longer in the questionnaire
questions = Question.where('questionnaire_id = ?', questionnaire_id)
@deleted_questions = []
questions.each do |question|
should_delete = true
unless question_params.nil?
params[:question].each_key do |question_key|
should_delete = false if question_key.to_s == question.id.to_s
end
end

next unless should_delete

question.question_advices.each(&:destroy)
# keep track of the deleted questions
@deleted_questions.push(question)
question.destroy
end
end
</pre>
-> destroy method in the questions controller was responsible for deleting the questions, so it was unused method.

<pre>
def save_questions(questionnaire_id)
delete_questions questionnaire_id
save_new_questions questionnaire_id

if params[:question]
params[:question].keys.each do |question_key|
if params[:question][question_key][:txt].strip.empty?
# question text is empty, delete the question
Question.delete(question_key)
else
# Update existing question.
question = Question.find(question_key)
Rails.logger.info(question.errors.messages.inspect) unless question.update_attributes(params[:question][question_key])
end
end
end
end
</pre>

'''QUESTIONS CONTROLLER'''
<pre>
def action_allowed?
current_user_has_ta_privileges?
end
</pre>
-> Authorisation is not required while creating CRUD end points.

<pre>
def new
@question = Question.new
end
</pre>

<pre>
def edit
@question = Question.find(params[:id])
end
</pre>

*'''Minor Bug fixes in the existing code:''' The following bugs in the existing code needed to be fixed.
#User was not able to delete Questionnaire: After careful debugging, we found that a path for delete questionnaire was not defined in the routes.rb file.
[[File:delete-1.png|center|border|800px|]]
[[File:delete-2.png|center|border|800px|]]
#Nil Class Error while saving empty questionnaire: We kept a check in the save_all_questions method to handle the error and allow the questionnaire to be saved empty.
[[File:Nilerror.png|center|border|800px|]]
*'''Fix the update method in QuestionnairesController:''' The original implementation of the method could not update the attributes of the questionnaire and it was used only to update the questions of that questionnaire. We reimplemented the method to update both the questionnaire attributes and each question if a change was made to them.

Initial code for the Questions and Questionnaires controller can be referred here -
*Questionnaries Controller - https://github.com/mundra-ankur/expertiza/blob/main/app/controllers/questionnaires_controller.rb
*Questions Controller - https://github.com/mundra-ankur/expertiza/blob/main/app/controllers/questions_controller.rb

Code was reimplemented to create basic CRUD operations after the methods of the controllers were fixed for the bugs. Then the methods were converted to basic CRUD operations which are described below.
*'''Reimplement CRUD functionality and create JSON endpoints in QuestionsController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questions_controller.rb questions_controller.rb].
#index: This is a GET endpoint that responds with a list of all questions with their attributes.
#show: This is a GET endpoint that accepts a question id and responds with the attributes of that question if it exists.
#create: This is a POST endpoint that accepts the question parameters and creates a new question.
#destroy: This is a DELETE endpoint that accepts a question ID and deletes that question.
#update: This is a PUT endpoint that accepts a question ID and parameters, and, updates that question with the given parameters.
#types: This is a GET endpoint that responds with the list of question types.

[[File:Q1.png|center|border|800px|]]
[[File:Q2.png|center|border|800px|]]
[[File:Q30.png|center|border|800px|]]
[[File:Q4.png|center|border|800px|]]

*'''Reimplement CRUD functionality and create JSON endpoints in QuestionnairesController:''' We reimplemented the following methods to create the required endpoints in [https://github.com/expertiza/reimplementation-back-end/blob/0b09c15466e5d9865663ed2253d9f37a2e1ca1d9/app/controllers/api/v1/questionnaires_controller.rb questionnaires_controller.rb].
#index: This is a GET endpoint that responds with a list of all questionnaires with their attributes.
#show: This is a GET endpoint that accepts a questionnaire id and responds with the attributes of that questionnaire if it exists.
#create: This is a POST endpoint that accepts the questionnaire parameters and creates a new questionnaire.
#destroy: This is a DELETE endpoint that accepts a questionnaire ID and deletes that questionnaire.
#update: This is a PUT endpoint that accepts a questionnaire ID and parameters, and, updates that questionnaire with the given parameters.
#copy: This is a POST endpoint that accepts a questionnaire ID and creates a new questionnaire (copy) with the same attributes of that questionnaire.
#toggle_access: This is a GET endpoint that changes the access from public to private and vice versa.

[[File:Q50.png|center|border|800px|]]
[[File:Q6.png|center|border|800px|]]
[[File:Q7.png|center|border|800px|]]

==Testing Methodology==
Our work was to reimplement the QuestionsController.rb and QuestionnairesController.rb and create JSON endpoints for each CRUD operation. Since all the operations had dependencies on other Models and Helper functions which are not included in the reimplementation-back-end, it is not possible for us to use RSpec as the testing tool. To test each endpoint, we have used Postman to send a request to each endpoint. '''The video with the testing plan is available at''' https://bit.ly/E2321

'''Using Postman to test endpoints:''' 
We tested each route of the QuestionsController and QuestionnairesController to test whether the expected response is obtained. We made valid requests by passing the right parameters to each endpoint to check whether each method behaves as expected. We then made requests with incorrect number of parameters, invalid parameter types and values to check whether the endpoint throws a status 422 Invalid Request as the response. This method of testing via postman helped us ensure that each API endpoint handles the valid and invalid requests and behaves as intended.

For automated testing, these Rspec files https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questionnaires_spec.rb and https://github.com/Vineet2311/reimplementation-back-end/blob/main/spec/requests/api/v1/questions_spec.rb can be used in the future implementations when all the models and helper classes needed have been added to the repository. These test cases ensures that the API returns the expected responses for valid and invalid requests.

== Relevant Links ==
* '''Github Repository:''' https://github.com/Vineet2311/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/20
* '''VCL Server:''' http://152.7.177.38:8080
* '''Test Video Link:''' https://bit.ly/E2321

==Contributors==
This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Jigarbhai Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)

File:Q50.png

2023-03-30T00:12:56Z

Vchheda:

File:Q30.png

2023-03-30T00:12:10Z

Vchheda:

File:Q7.png

2023-03-30T00:10:57Z

Vchheda:

File:Q6.png

2023-03-30T00:10:37Z

Vchheda: