et_fake_ccd 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 715abb41a7a8c8b03d511144100c3c850bdf0c28ac692ff4035fe4f1e98fbd20
-  data.tar.gz: 610bfb8032916563890b8078e433ad7db24b7d42ba623d2e01579432f9fe489d
+  metadata.gz: e5968450f9fb5c522a5ef2843d74bd516795565a7e0ea2db74b99f535b3b218b
+  data.tar.gz: 7ef2bf4693eda7b6c427a5ddb4597de610c0d5b30eda626af7e94e735e50b242
 SHA512:
-  metadata.gz: 5b0c423548802001cad2d385821ad76aae05a760e00152fac1fb7fc5864246401ac98bd70267c93cf9e744831ca6abf96dcb3056f99cf0e157ae3504908732fb
-  data.tar.gz: 29bdc2795a91160e1bdd654d5b10a83074f568a10d0a63e69e8509c318fd1fe4d527607b806918b68019c6ec7a407b49a07b2eac3c66deaa1c0b60cf6af2a41e
+  metadata.gz: ec1cd2619dab545b1c59a681c4396da960296eaf31c1a56b5c4c8b085f0c87d9151e75bd181a2a1a5df90697f7b54c8a5696ec944b106133a352e04baefcf574
+  data.tar.gz: 23102b8a755b256725c001afd3ea9b7fc87afe645dec8e6dc61278c89cf44ab239a912118153e8da46fa094627f8edd417c7c4063e2d15eba131c63369b53501

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    et_fake_ccd (1.1.3)
+    et_fake_ccd (1.1.4)
       activemodel (>= 5.2.3)
       iodine (~> 0.7)
       json-schema (~> 2.5)
@@ -13,9 +13,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activesupport (6.1.1)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,18 +23,18 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    iodine (0.7.43)
+    iodine (0.7.44)
     json-schema (2.8.1)
       addressable (>= 2.4)
-    minitest (5.14.3)
+    minitest (5.14.4)
     public_suffix (4.0.6)
     rack (2.2.3)
     rake (13.0.1)
-    roda (3.40.0)
+    roda (3.43.1)
       rack
     rotp (6.2.0)
     rspec (3.9.0)
@@ -50,7 +50,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    thor (1.0.1)
+    thor (1.1.0)
     tilt (2.0.10)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -97,7 +97,74 @@ So, here is a list of deliberate errors that Im sure will increase in size :-
 * Use the lead claimant title of "Mr" to only force the error on the first occurence
 * Use the lead claimant title of "Mrs" to force the error on every occurence
 
+### Improved Deliberate Error Control
 
+The above deliberate error mechanism worked, it does not give quite enough control.
+
+A new system has therefore been developed that you can use instead of it.
+
+This uses special configuration settings in the 'External System' in the admin.
+
+There are 2 key entries
+
+1. 'extra_headers'
+2. 'send_request_id'
+
+#### extra_headers
+
+'extra_headers' should contain a JSON encoded value of a hash.  Each entry in the hash is a header
+to add to every request to this fake ccd server.
+
+##### force_failures header
+
+The force_failures header should contain a hash which looks like this
+
+```json
+    {
+      "idam_stage": { ..spec.. },
+      "token_stage": { ..spec.. },
+      "data_stage": { ..spec.. }
+    } 
+
+```
+
+The 4 different stages give control of when the error will happen
+
+The 'idam_stage' is the stage of the transaction when an IDAM token is requested.
+However, this does not happen all of the time because IDAM tokens are cached, so
+you will not necessarily see one request per transaction.
+
+The 'token_stage' is used in most transactions such as case creation
+where a 'token' is the starting stage - which then allows the case
+to be created against this token.
+
+The 'documents' stage is used in transactions that require documents uploading before the
+case is created.
+
+The 'data_stage' is used in most transactions and means the actual data
+creation.
+
+The '..spec..' is the same irrespective of which stage and is described below:
+
+```json
+    [a, b, c]
+```
+
+a, b, c (you can specify as many as you want here, not just 3)
+are http response codes for the 'nth' request.  i.e. the first argument
+is for the first request, the 2nd for the 2nd etc..
+The special value of 0 means allow the normal response and do not force an
+error - allowing for patterns such as error on the 1st, 2nd and 5th.
+
+Any non zero value is the http status code to respond with.
+
+#### send_request_id
+
+'send_request_id' should be set to 'true' to enable a request identifier to be sent with every
+request to this fake ccd server.  This identifier is unique to a particular export from the main system,
+so it will persist even across retries of the same export.
+
+This is then used to assist in special rules where errors are forced on the 'nth' request for example.
 
 
 ## Development

data/lib/et_fake_ccd/forced_error_handling.rb

@@ -0,0 +1,20 @@
+require 'et_fake_ccd/request_store_service'
+module EtFakeCcd
+  module ForcedErrorHandling
+    extend ActiveSupport::Concern
+
+    def with_forced_error_handling(r, stage:)
+      request_id = r.headers['request_id']
+      RequestStoreService.store "#{stage}-#{request_id}" unless request_id.nil?
+      count = request_id.nil? ? 1 : RequestStoreService.count("#{stage}-#{request_id}")
+      specs = JSON.parse(r.headers['force_failures'] || '{}')
+      spec = specs.fetch("#{stage}_stage", [])
+      response_code = spec[count - 1].to_i
+      if response_code.zero?
+        yield
+      else
+        r.halt response_code
+      end
+    end
+  end
+end

data/lib/et_fake_ccd/service/auth_app.rb

@@ -9,12 +9,14 @@ module EtFakeCcd
       plugin :halt
       route do |r|
         r.is "lease" do
-          r.post do
-            command = ::EtFakeCcd::Command::LeaseCommand.from_json JSON.parse(r.body.read)
-            if command.valid?
-              ::EtFakeCcd::AuthService.generate_service_token
-            else
-              r.halt 403, render_error_for(command)
+          with_forced_error_handling(r, stage: :token) do
+            r.post do
+              command = ::EtFakeCcd::Command::LeaseCommand.from_json JSON.parse(r.body.read)
+              if command.valid?
+                ::EtFakeCcd::AuthService.generate_service_token
+              else
+                r.halt 403, render_error_for(command)
+              end
             end
           end
         end

data/lib/et_fake_ccd/service/authentication_web_app.rb

@@ -11,15 +11,19 @@ module EtFakeCcd
       route do |r|
         r.is "login" do
           r.get do
-            file = File.absolute_path(File.join('..', 'views', 'login.html.erb'), __dir__)
-            render(path: file, locals: { oauth2_redirect_url: config.oauth2_redirect_url, oauth2_client_id: config.oauth2_client_id })
+            with_forced_error_handling(r, stage: :token) do
+              file = File.absolute_path(File.join('..', 'views', 'login.html.erb'), __dir__)
+              render(path: file, locals: { oauth2_redirect_url: config.oauth2_redirect_url, oauth2_client_id: config.oauth2_client_id })
+            end
           end
           r.post do
-            command = ::EtFakeCcd::Command::LoginUserCommand.from_json(r.params)
-            if command.valid?
-              r.redirect "/case-management-web/oauth2redirect?code=pfSHb6v4dEDEfqqP"
-            else
-              r.halt 401, "Access Denied"
+            with_forced_error_handling(r, stage: :token) do
+              command = ::EtFakeCcd::Command::LoginUserCommand.from_json(r.params)
+              if command.valid?
+                r.redirect "/case-management-web/oauth2redirect?code=pfSHb6v4dEDEfqqP"
+              else
+                r.halt 401, "Access Denied"
+              end
             end
           end
         end

data/lib/et_fake_ccd/service/data_store_app.rb

@@ -1,96 +1,109 @@
 require 'roda'
 require 'json'
 require 'et_fake_ccd/commands'
+require 'et_fake_ccd/forced_error_handling'
 require 'et_fake_ccd/auth_service'
 require 'et_fake_ccd/data_store_service'
 require 'et_fake_ccd/request_store_service'
 module EtFakeCcd
   module Service
     class DataStoreApp < Roda
+      include ForcedErrorHandling
       plugin :request_headers
       plugin :halt
       route do |r|
         r.is "caseworkers", String, "jurisdictions", String, "case-types", String, "event-triggers", "initiateCase", "token" do |uid, jid, ctid|
           r.get do
-            if EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              initiate_case(uid, jid, ctid)
-            else
-              r.halt 403, forbidden_error_for(r)
+            with_forced_error_handling(r, stage: :token) do
+              if EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                initiate_case(uid, jid, ctid)
+              else
+                r.halt 403, forbidden_error_for(r)
+              end
             end
           end
         end
         r.is "caseworkers", String, "jurisdictions", String, "case-types", String, "event-triggers", "createMultiple", "token" do |uid, jid, ctid|
           r.get do
-            if EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              initiate_bulk_case(uid, jid, ctid)
-            else
-              r.halt 403, forbidden_error_for(r)
+            with_forced_error_handling(r, stage: :token) do
+              if EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                initiate_bulk_case(uid, jid, ctid)
+              else
+                r.halt 403, forbidden_error_for(r)
+              end
             end
           end
         end
         r.is "caseworkers", String, "jurisdictions", String, "case-types", String, "cases", String, "event-triggers", "uploadDocument", "token" do |uid, jid, ctid, cid|
           r.get do
-            if EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              initiate_upload_document(uid, jid, ctid, cid)
-            else
-              r.halt 403, forbidden_error_for(r)
+            with_forced_error_handling(r, stage: :documents) do
+              if EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                initiate_upload_document(uid, jid, ctid, cid)
+              else
+                r.halt 403, forbidden_error_for(r)
+              end
             end
           end
         end
         r.is "caseworkers", String, "jurisdictions", String, "case-types", String, "cases", String, "events" do |uid, jid, ctid, cid|
           r.post do
-            if !EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) || !EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              r.halt 403, forbidden_error_for(r)
-              break
+            with_forced_error_handling(r, stage: :documents) do
+              if !EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) || !EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                r.halt 403, forbidden_error_for(r)
+                break
+              end
+              json = JSON.parse(r.body.read)
+              command = case json.dig('event', 'id')
+                        when 'uploadDocument' then ::EtFakeCcd::Command::UploadDocumentsToCaseCommand.from_json json
+                        else
+                          r.halt 400, unknown_event_error_for(r)
+                        end
+              if command.valid?
+                ::EtFakeCcd::DataStoreService.update_case_data(json, jid: jid, ctid: ctid, cid: cid)
+                case_updated_response(cid, uid, jid, ctid)
+              else
+                r.halt 422, render_error_for(command, r)
+              end
             end
-            json = JSON.parse(r.body.read)
-            command = case json.dig('event', 'id')
-                      when 'uploadDocument' then ::EtFakeCcd::Command::UploadDocumentsToCaseCommand.from_json json
-                      else
-                        r.halt 400, unknown_event_error_for(r)
-                      end
-            if command.valid?
-              ::EtFakeCcd::DataStoreService.update_case_data(json, jid: jid, ctid: ctid, cid: cid)
-              case_updated_response(cid, uid, jid, ctid)
-            else
-              r.halt 422, render_error_for(command, r)
-            end
-
           end
         end
         r.is "caseworkers", String, "jurisdictions", String, "case-types", String, "cases" do |uid, jid, ctid|
           r.post do
-            if !EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) || !EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              r.halt 403, forbidden_error_for(r)
-              break
-            end
-            json = JSON.parse(r.body.read)
-            next if force_deliberate_error(json, r)
+            with_forced_error_handling(r, stage: :data) do
+              if !EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) || !EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                r.halt 403, forbidden_error_for(r)
+                break
+              end
+              json = JSON.parse(r.body.read)
+              next if force_deliberate_error(json, r)
 
-            command = case json.dig('event', 'id')
-            when 'initiateCase' then ::EtFakeCcd::Command::CreateCaseCommand.from_json json
-                      when 'createMultiple' then ::EtFakeCcd::Command::CreateMultipleCaseCommand.from_json json
-                      else
-                        r.halt 400, unknown_event_error_for(r)
-                      end
-            if command.valid?
-              id = ::EtFakeCcd::DataStoreService.store_case_data(command.data, jid: jid, ctid: ctid)
-              case_created_response(id, uid, jid, ctid)
-            else
-              r.halt 422, render_error_for(command, r)
+              command = case json.dig('event', 'id')
+              when 'initiateCase' then ::EtFakeCcd::Command::CreateCaseCommand.from_json json
+                        when 'createMultiple' then ::EtFakeCcd::Command::CreateMultipleCaseCommand.from_json json
+                        else
+                          r.halt 400, unknown_event_error_for(r)
+                        end
+              if command.valid?
+                id = ::EtFakeCcd::DataStoreService.store_case_data(command.data, jid: jid, ctid: ctid)
+                case_created_response(id, uid, jid, ctid)
+              else
+                r.halt 422, render_error_for(command, r)
+              end
             end
           end
 
           r.get do
-            if !EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) || !EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              r.halt 403, forbidden_error_for(r)
-              break
+            with_forced_error_handling(r, stage: :data) do
+              if !EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) || !EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                r.halt 403, forbidden_error_for(r)
+                break
+              end
+              filters = r.params.dup
+              page = (filters.delete('page') || "1").to_i
+              sort_direction = filters.delete('sortDirection') || 'asc'
+              list = DataStoreService.list(jid: jid, ctid: ctid, filters: filters, page: page, sort_direction: sort_direction, page_size: 25)
+              cases_response(list, uid, jid, ctid)
             end
-            filters = r.params.dup
-            page = (filters.delete('page') || "1").to_i
-            sort_direction = filters.delete('sortDirection') || 'asc'
-            list = DataStoreService.list(jid: jid, ctid: ctid, filters: filters, page: page, sort_direction: sort_direction, page_size: 25)
-            cases_response(list, uid, jid, ctid)
           end
         end
       end

data/lib/et_fake_ccd/service/document_store_app.rb

@@ -13,27 +13,31 @@ module EtFakeCcd
       route do |r|
         r.is "documents" do
           r.post do
-            unless EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              r.halt 403, forbidden_error_for(r)
-              break
-            end
-            command = ::EtFakeCcd::Command::UploadDocumentCommand.from_json(r.params.deep_stringify_keys)
-            unless command.valid?
-              r.halt 422, render_error_for(command, r)
-              break
-            end
+            with_forced_error_handling(r, stage: :documents) do
+              unless EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                r.halt 403, forbidden_error_for(r)
+                break
+              end
+              command = ::EtFakeCcd::Command::UploadDocumentCommand.from_json(r.params.deep_stringify_keys)
+              unless command.valid?
+                r.halt 422, render_error_for(command, r)
+                break
+              end
 
-            upload_document(r)
+              upload_document(r)
+            end
           end
         end
         r.is "documents", String, "binary" do |uuid|
-          r.get do
-            file = ::EtFakeCcd::DocumentStoreService.find_file_by_id(uuid)
-            unless file
-              r.halt 404, not_found_error_for(r)
-              break
+          with_forced_error_handling(r, stage: :documents) do
+            r.get do
+              file = ::EtFakeCcd::DocumentStoreService.find_file_by_id(uuid)
+              unless file
+                r.halt 404, not_found_error_for(r)
+                break
+              end
+              send_file file.path
             end
-            send_file file.path
           end
         end
       end

data/lib/et_fake_ccd/service/ecm_app.rb

@@ -11,17 +11,19 @@ module EtFakeCcd
       route do |r|
         r.is "generateCaseRefNumbers" do
           r.post do
-            unless EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
-              r.halt 403, forbidden_error_for(r)
-              break
-            end
-            json = JSON.parse(r.body.read)
-            command = ::EtFakeCcd::Command::StartMultipleCommand.from_json json
-            if command.valid?
-              response = ::EtFakeCcd::EcmService.start_multiple(command)
-              start_multiple_response(response)
-            else
-              r.halt 422, render_error_for(command, r)
+            with_forced_error_handling(r, stage: :data) do
+              unless EtFakeCcd::AuthService.validate_service_token(r.headers['ServiceAuthorization'].gsub(/\ABearer /, '')) && EtFakeCcd::AuthService.validate_user_token(r.headers['Authorization'].gsub(/\ABearer /, ''))
+                r.halt 403, forbidden_error_for(r)
+                break
+              end
+              json = JSON.parse(r.body.read)
+              command = ::EtFakeCcd::Command::StartMultipleCommand.from_json json
+              if command.valid?
+                response = ::EtFakeCcd::EcmService.start_multiple(command)
+                start_multiple_response(response)
+              else
+                r.halt 422, render_error_for(command, r)
+              end
             end
           end
         end

data/lib/et_fake_ccd/service/sidam_app.rb

@@ -10,17 +10,21 @@ module EtFakeCcd
       route do |r|
         r.is "loginUser" do
           r.post do
-            command = ::EtFakeCcd::Command::LoginUserCommand.from_json(r.params)
-            if command.valid?
-              logged_in_result
-            else
-              r.halt 401, render_error_for(command)
+            with_forced_error_handling(r, stage: :token) do
+              command = ::EtFakeCcd::Command::LoginUserCommand.from_json(r.params)
+              if command.valid?
+                logged_in_result
+              else
+                r.halt 401, render_error_for(command)
+              end
             end
           end
         end
         r.is "details" do
           r.get do
-            details_result
+            with_forced_error_handling(r, stage: :token) do
+              details_result
+            end
           end
         end
       end

data/lib/et_fake_ccd/version.rb

@@ -1,3 +1,3 @@
 module EtFakeCcd
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: et_fake_ccd
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Gary Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -192,6 +192,7 @@ files:
 - lib/et_fake_ccd/data_store_service.rb
 - lib/et_fake_ccd/document_store_service.rb
 - lib/et_fake_ccd/ecm_service.rb
+- lib/et_fake_ccd/forced_error_handling.rb
 - lib/et_fake_ccd/iodine.rb
 - lib/et_fake_ccd/request_store_service.rb
 - lib/et_fake_ccd/root_app.rb
@@ -225,8 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fake CCD server for employment tribunals