Check the answers you gave for <%= subsection.humanize(capitalize: false) %>
- <%= display_answered_questions_summary(subsection, case_log, form) %>
+ <%= display_answered_questions_summary(subsection, @case_log, form) %>
<% form.pages_for_subsection(subsection).each do |page, page_info| %>
<% page_info["questions"].each do |question_title, question_info| %>
- <% if total_questions(subsection, case_log, form).include?(question_title) %>
- <%= render partial: 'form/check_answers_table', locals: { question_title: question_title, question_info: question_info, case_log: case_log, page: page } %>
+ <% if total_questions(subsection, @case_log, form).include?(question_title) %>
+ <%= render partial: 'form/check_answers_table', locals: { question_title: question_title, question_info: question_info, case_log: @case_log, page: page } %>
<%end %>
<%end %>
<% end %>
diff --git a/db/migrate/20211014154616_add_discarded_at_to_case_logs.rb b/db/migrate/20211014154616_add_discarded_at_to_case_logs.rb
new file mode 100644
index 000000000..429640759
--- /dev/null
+++ b/db/migrate/20211014154616_add_discarded_at_to_case_logs.rb
@@ -0,0 +1,6 @@
+class AddDiscardedAtToCaseLogs < ActiveRecord::Migration[6.1]
+ def change
+ add_column :case_logs, :discarded_at, :datetime
+ add_index :case_logs, :discarded_at
+ end
+end
diff --git a/db/schema.rb b/db/schema.rb
index 3e73a03e0..fbfb2467e 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -10,7 +10,7 @@
#
# It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema.define(version: 2021_10_13_113607) do
+ActiveRecord::Schema.define(version: 2021_10_14_154616) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"
@@ -131,6 +131,8 @@ ActiveRecord::Schema.define(version: 2021_10_13_113607) do
t.boolean "reasonable_preference_reason_medical_grounds"
t.boolean "reasonable_preference_reason_avoid_hardship"
t.boolean "reasonable_preference_reason_do_not_know"
+ t.datetime "discarded_at"
+ t.index ["discarded_at"], name: "index_case_logs_on_discarded_at"
end
end
diff --git a/spec/factories/case_log.rb b/spec/factories/case_log.rb
index a9aa4ab56..044a4cbac 100644
--- a/spec/factories/case_log.rb
+++ b/spec/factories/case_log.rb
@@ -2,14 +2,14 @@ FactoryBot.define do
factory :case_log do
sequence(:id) { |i| i }
trait :in_progress do
- status { 0 }
+ status { 1 }
tenant_code { "TH356" }
property_postcode { "SW2 6HI" }
previous_postcode { "P0 5ST" }
tenant_age { "12" }
end
- trait :submitted do
- status { 1 }
+ trait :completed do
+ status { 2 }
tenant_code { "BZ737" }
property_postcode { "NW1 7TY" }
end
diff --git a/spec/helpers/tasklist_helper_spec.rb b/spec/helpers/tasklist_helper_spec.rb
index 28860962f..e2ced980f 100644
--- a/spec/helpers/tasklist_helper_spec.rb
+++ b/spec/helpers/tasklist_helper_spec.rb
@@ -1,8 +1,9 @@
require "rails_helper"
RSpec.describe TasklistHelper do
- let!(:empty_case_log) { FactoryBot.create(:case_log) }
- let!(:case_log) { FactoryBot.create(:case_log, :in_progress) }
+ let(:empty_case_log) { FactoryBot.build(:case_log) }
+ let(:case_log) { FactoryBot.build(:case_log, :in_progress) }
+ let(:completed_case_log) { FactoryBot.build(:case_log, :completed) }
form_handler = FormHandler.instance
let(:form) { form_handler.get_form("test_form") }
@@ -35,7 +36,6 @@ RSpec.describe TasklistHelper do
end
it "returns not started if the subsection is declaration and all the questions are completed" do
- completed_case_log = CaseLog.new(case_log.attributes.map { |key, value| Hash[key, value || "value"] }.reduce(:merge))
status = get_subsection_status("declaration", completed_case_log, declaration_questions)
expect(status).to eq(:not_started)
end
diff --git a/spec/requests/case_log_controller_spec.rb b/spec/requests/case_log_controller_spec.rb
index cf874bb86..0cdf5d791 100644
--- a/spec/requests/case_log_controller_spec.rb
+++ b/spec/requests/case_log_controller_spec.rb
@@ -1,26 +1,33 @@
require "rails_helper"
RSpec.describe CaseLogsController, type: :request do
+ let(:api_username) { "test_user" }
+ let(:api_password) { "test_password" }
+ let(:basic_credentials) do
+ ActionController::HttpAuthentication::Basic
+ .encode_credentials(api_username, api_password)
+ end
+
+ let(:headers) do
+ {
+ "Content-Type" => "application/json",
+ "Accept" => "application/json",
+ "Authorization" => basic_credentials,
+ }
+ end
+
+ before do
+ allow(ENV).to receive(:[])
+ allow(ENV).to receive(:[]).with("API_USER").and_return(api_username)
+ allow(ENV).to receive(:[]).with("API_KEY").and_return(api_password)
+ end
+
describe "POST #create" do
let(:tenant_code) { "T365" }
let(:tenant_age) { 35 }
let(:property_postcode) { "SE11 6TY" }
- let(:api_username) { "test_user" }
- let(:api_password) { "test_password" }
- let(:basic_credentials) do
- ActionController::HttpAuthentication::Basic
- .encode_credentials(api_username, api_password)
- end
- let(:in_progress) { "in progress" }
- let(:submitted) { "submitted" }
-
- let(:headers) do
- {
- "Content-Type" => "application/json",
- "Accept" => "application/json",
- "Authorization" => basic_credentials,
- }
- end
+ let(:in_progress) { "in_progress" }
+ let(:completed) { "completed" }
let(:params) do
{
@@ -31,9 +38,6 @@ RSpec.describe CaseLogsController, type: :request do
end
before do
- allow(ENV).to receive(:[])
- allow(ENV).to receive(:[]).with("API_USER").and_return(api_username)
- allow(ENV).to receive(:[]).with("API_KEY").and_return(api_password)
post "/case_logs", headers: headers, params: params.to_json
end
@@ -75,9 +79,134 @@ RSpec.describe CaseLogsController, type: :request do
JSON.parse(File.open("spec/fixtures/complete_case_log.json").read)
end
- it "marks the record as submitted" do
+ it "marks the record as completed" do
json_response = JSON.parse(response.body)
- expect(json_response["status"]).to eq(submitted)
+ expect(json_response["status"]).to eq(completed)
+ end
+ end
+
+ context "request with invalid credentials" do
+ let(:basic_credentials) do
+ ActionController::HttpAuthentication::Basic.encode_credentials(api_username, "Oops")
+ end
+
+ it "returns 401" do
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+ end
+
+ describe "PATCH" do
+ let(:case_log) do
+ FactoryBot.create(:case_log, :in_progress, tenant_code: "Old Value", property_postcode: "Old Value")
+ end
+ let(:params) do
+ { tenant_code: "New Value" }
+ end
+ let(:id) { case_log.id }
+
+ before do
+ patch "/case_logs/#{id}", headers: headers, params: params.to_json
+ end
+
+ it "returns http success" do
+ expect(response).to have_http_status(:success)
+ end
+
+ it "updates the case log with the given fields and keeps original values where none are passed" do
+ case_log.reload
+ expect(case_log.tenant_code).to eq("New Value")
+ expect(case_log.property_postcode).to eq("Old Value")
+ end
+
+ context "invalid case log id" do
+ let(:id) { (CaseLog.order(:id).last&.id || 0) + 1 }
+
+ it "returns 404" do
+ expect(response).to have_http_status(:not_found)
+ end
+ end
+
+ context "request with invalid credentials" do
+ let(:basic_credentials) do
+ ActionController::HttpAuthentication::Basic.encode_credentials(api_username, "Oops")
+ end
+
+ it "returns 401" do
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+ end
+
+ # We don't really have any meaningful distinction between PUT and PATCH here since you can update some or all
+ # fields in both cases, and both route to #Update. Rails generally recommends PATCH as it more closely matches
+ # what actually happens to an ActiveRecord object and what we're doing here, but either is allowed.
+ describe "PUT" do
+ let(:case_log) do
+ FactoryBot.create(:case_log, :in_progress, tenant_code: "Old Value", property_postcode: "Old Value")
+ end
+ let(:params) do
+ { tenant_code: "New Value" }
+ end
+ let(:id) { case_log.id }
+
+ before do
+ put "/case_logs/#{id}", headers: headers, params: params.to_json
+ end
+
+ it "returns http success" do
+ expect(response).to have_http_status(:success)
+ end
+
+ it "updates the case log with the given fields and keeps original values where none are passed" do
+ case_log.reload
+ expect(case_log.tenant_code).to eq("New Value")
+ expect(case_log.property_postcode).to eq("Old Value")
+ end
+
+ context "invalid case log id" do
+ let(:id) { (CaseLog.order(:id).last&.id || 0) + 1 }
+
+ it "returns 404" do
+ expect(response).to have_http_status(:not_found)
+ end
+ end
+
+ context "request with invalid credentials" do
+ let(:basic_credentials) do
+ ActionController::HttpAuthentication::Basic.encode_credentials(api_username, "Oops")
+ end
+
+ it "returns 401" do
+ expect(response).to have_http_status(:unauthorized)
+ end
+ end
+ end
+
+ describe "DELETE" do
+ let!(:case_log) do
+ FactoryBot.create(:case_log, :in_progress)
+ end
+ let(:id) { case_log.id }
+
+ before do
+ delete "/case_logs/#{id}", headers: headers
+ end
+
+ it "returns http success" do
+ expect(response).to have_http_status(:success)
+ end
+
+ it "soft deletes the case log" do
+ expect { CaseLog.find(id) }.to raise_error(ActiveRecord::RecordNotFound)
+ expect(CaseLog.with_discarded.find(id)).to be_a(CaseLog)
+ end
+
+ context "invalid case log id" do
+ let(:id) { (CaseLog.order(:id).last&.id || 0) + 1 }
+
+ it "returns 404" do
+ expect(response).to have_http_status(:not_found)
end
end
diff --git a/spec/views/case_log_index_view_spec.rb b/spec/views/case_log_index_view_spec.rb
index b97347cb6..cc826e3c8 100644
--- a/spec/views/case_log_index_view_spec.rb
+++ b/spec/views/case_log_index_view_spec.rb
@@ -1,12 +1,12 @@
require "rails_helper"
RSpec.describe "case_logs/index" do
let(:in_progress_log) { FactoryBot.build(:case_log, :in_progress) }
- let(:submitted_log) { FactoryBot.build(:case_log, :submitted) }
+ let(:completed_log) { FactoryBot.build(:case_log, :completed) }
context "given an in progress log list" do
it "renders a table for in progress logs only" do
assign(:in_progress_case_logs, [in_progress_log])
- assign(:submitted_case_logs, [])
+ assign(:completed_case_logs, [])
render
expect(rendered).to match(/
/)
expect(rendered).to match(/Logs you need to complete/)
@@ -16,23 +16,23 @@ RSpec.describe "case_logs/index" do
end
end
- context "given a submitted log list" do
+ context "given a completed log list" do
it "renders a table for in progress logs only" do
assign(:in_progress_case_logs, [])
- assign(:submitted_case_logs, [submitted_log])
+ assign(:completed_case_logs, [completed_log])
render
expect(rendered).to match(//)
expect(rendered).to match(/Logs you've submitted/)
expect(rendered).not_to match(/Logs you need to complete/)
- expect(rendered).to match(submitted_log.tenant_code)
- expect(rendered).to match(submitted_log.property_postcode)
+ expect(rendered).to match(completed_log.tenant_code)
+ expect(rendered).to match(completed_log.property_postcode)
end
end
- context "given a submitted log list and an in_progress log list" do
+ context "given a completed log list and an in_progress log list" do
it "renders two tables, one for each status" do
assign(:in_progress_case_logs, [in_progress_log])
- assign(:submitted_case_logs, [submitted_log])
+ assign(:completed_case_logs, [completed_log])
render
expect(rendered).to match(//)
expect(rendered).to match(/Logs you've submitted/)
From 882a1de227a04607043d42d6dbb6b121355c09e6 Mon Sep 17 00:00:00 2001
From: baarkerlounger
Date: Fri, 15 Oct 2021 11:52:50 +0100
Subject: [PATCH 2/2] Test case log state machine
---
app/models/case_log.rb | 4 ++--
spec/models/case_log_spec.rb | 17 +++++++++++++++++
spec/requests/case_log_controller_spec.rb | 13 +++++++++++++
3 files changed, 32 insertions(+), 2 deletions(-)
diff --git a/app/models/case_log.rb b/app/models/case_log.rb
index efcf09f92..30a2b3980 100644
--- a/app/models/case_log.rb
+++ b/app/models/case_log.rb
@@ -51,11 +51,11 @@ class CaseLog < ApplicationRecord
end
def not_started?
- status == "not started"
+ status == "not_started"
end
def in_progress?
- status == "in progress"
+ status == "in_progress"
end
private
diff --git a/spec/models/case_log_spec.rb b/spec/models/case_log_spec.rb
index 86f4e9d9b..b456e6988 100644
--- a/spec/models/case_log_spec.rb
+++ b/spec/models/case_log_spec.rb
@@ -14,4 +14,21 @@ RSpec.describe Form, type: :model do
expect { CaseLog.create!(tenant_age: 0) }.to raise_error(ActiveRecord::RecordInvalid)
end
end
+
+ describe "status" do
+ let!(:empty_case_log) { FactoryBot.create(:case_log) }
+ let!(:in_progress_case_log) { FactoryBot.create(:case_log, :in_progress) }
+
+ it "is set to not started for an empty case log" do
+ expect(empty_case_log.not_started?).to be(true)
+ expect(empty_case_log.in_progress?).to be(false)
+ expect(empty_case_log.completed?).to be(false)
+ end
+
+ it "is set to not started for an empty case log" do
+ expect(in_progress_case_log.in_progress?).to be(true)
+ expect(in_progress_case_log.not_started?).to be(false)
+ expect(in_progress_case_log.completed?).to be(false)
+ end
+ end
end
diff --git a/spec/requests/case_log_controller_spec.rb b/spec/requests/case_log_controller_spec.rb
index 0cdf5d791..a1c552a52 100644
--- a/spec/requests/case_log_controller_spec.rb
+++ b/spec/requests/case_log_controller_spec.rb
@@ -127,6 +127,19 @@ RSpec.describe CaseLogsController, type: :request do
end
end
+ context "invalid case log params" do
+ let(:params) { {tenant_age: 200} }
+
+ it "returns 422" do
+ expect(response).to have_http_status(:unprocessable_entity)
+ end
+
+ it "returns an error message" do
+ json_response = JSON.parse(response.body)
+ expect(json_response["errors"]).to eq(["Tenant age must be between 0 and 120"])
+ end
+ end
+
context "request with invalid credentials" do
let(:basic_credentials) do
ActionController::HttpAuthentication::Basic.encode_credentials(api_username, "Oops")