[ARP - lower camel responses - 3] handle camel params in ARP IPF controller (#20623)

* [ARP] handle camel params in ARP IPF controller

* [ARP - lower camel responses - 4] camel response in ARP users controller (#20624)

* [ARP] camel response in ARP users controller

* [ARP - lower camel responses - 5] bypass olive branch (#20625)

* [ARP] bypass olive branch

* lint fixes

Author: nihil2501

modules/accredited_representative_portal/app/controllers/accredited_representative_portal/v0/in_progress_forms_controller.rb

@@ -8,7 +8,7 @@ class InProgressFormsController < ApplicationController
       def update
         form = find_form || build_form
         form.update!(
-          form_data: params[:form_data],
+          form_data: params[:formData],
           metadata: params[:metadata]
         )
 

modules/accredited_representative_portal/app/controllers/accredited_representative_portal/v0/representative_users_controller.rb

@@ -11,18 +11,18 @@ def show
         # serialization layer.
         render json: {
           account: {
-            account_uuid: @current_user.user_account_uuid
+            accountUuid: @current_user.user_account_uuid
           },
           profile: {
-            first_name: @current_user.first_name,
-            last_name: @current_user.last_name,
+            firstName: @current_user.first_name,
+            lastName: @current_user.last_name,
             verified: @current_user.user_account.verified?,
-            sign_in: {
-              service_name: @current_user.sign_in[:service_name]
+            signIn: {
+              serviceName: @current_user.sign_in[:service_name]
             }
           },
-          prefills_available: [],
-          in_progress_forms:
+          prefillsAvailable: [],
+          inProgressForms: in_progress_forms
         }
       end
 

modules/accredited_representative_portal/config/initializers/bypass_olive_branch.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AccreditedRepresentativePortal
+  ##
+  # `olive_branch` transforms (a) request and (b) response payloads.
+  #
+  # (a) It deeply transforms request and query param keys.
+  # At times it is convenient for params to act as snake-cased setters at a Ruby
+  # interface, but not always. Form resources are a possible example where not.
+  #
+  # For now, let's wait to encounter the cases where we really want this
+  # convenience. If we do encounter some, we may discover that we want a more
+  # explicit and collocated way to opt in.
+  #
+  # (b) It reloads the response from JSON, deeply transforms keys, and dumps
+  # back to JSON.
+  # This is superfluous because our serialization layer `jsonapi-serializer`
+  # already has a configuration option for key casing. This realizes our desired
+  # casing the one and only time it is visiting an object during serialization.
+  #
+  module BypassOliveBranch
+    def call(env)
+      exclude_arp_route?(env) ? @app.call(env) : super
+    end
+
+    private
+
+    ARP_PATH_INFO_PREFIX = '/accredited_representative_portal'
+
+    def exclude_arp_route?(env)
+      env['PATH_INFO'].to_s.start_with?(ARP_PATH_INFO_PREFIX)
+    end
+  end
+end
+
+module OliveBranch
+  class Middleware
+    prepend AccreditedRepresentativePortal::BypassOliveBranch
+  end
+end

modules/accredited_representative_portal/spec/factories/representative_user.rb

@@ -39,7 +39,11 @@
           {
             form_id: evaluator.in_progress_form_id,
             user_account: user.user_account,
-            user_uuid: user.uuid
+            user_uuid: user.uuid,
+            metadata: {
+              version: 1,
+              returnUrl: 'foo.com'
+            }
           }
         )
       end

modules/accredited_representative_portal/spec/requests/accredited_representative_portal/bypass_olive_branch_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+class BypassOliveBranchTestController < ActionController::API
+  def arp = render json: {}
+  def normal = render json: {}
+end
+
+RSpec.describe AccreditedRepresentativePortal::BypassOliveBranch, type: :request do
+  subject do
+    get "#{path_prefix}/bypass_olive_branch_test", headers: {
+      'X-Key-Inflection' => 'camel',
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  before(:all) do
+    Rails.application.routes.draw do
+      get '/accredited_representative_portal/bypass_olive_branch_test', to: 'bypass_olive_branch_test#arp'
+      get '/bypass_olive_branch_test', to: 'bypass_olive_branch_test#normal'
+    end
+  end
+
+  after(:all) do
+    Rails.application.reload_routes!
+  end
+
+  context 'when the request is for an accredited representative portal route' do
+    let(:path_prefix) { '/accredited_representative_portal' }
+
+    it 'bypasses OliveBranch processing' do
+      expect(OliveBranch::Transformations).not_to receive(:underscore_params)
+      expect(OliveBranch::Transformations).not_to receive(:transform)
+      subject
+    end
+  end
+
+  context 'when the request is for a normal route' do
+    let(:path_prefix) { '' }
+
+    it 'applies OliveBranch processing' do
+      expect(OliveBranch::Transformations).to receive(:underscore_params)
+      expect(OliveBranch::Transformations).to receive(:transform)
+      subject
+    end
+  end
+end

modules/accredited_representative_portal/spec/requests/accredited_representative_portal/v0/in_progress_forms_spec.rb

@@ -22,7 +22,11 @@
           :in_progress_form,
           user_uuid: representative_user.uuid,
           form_data: { field: 'value' },
-          form_id:
+          form_id:,
+          metadata: {
+            version: 1,
+            returnUrl: 'foo.com'
+          }
         )
 
         get("/accredited_representative_portal/v0/in_progress_forms/#{form_id}")
@@ -33,14 +37,7 @@
             },
             'metadata' => {
               'version' => 1,
-              'return_url' => 'foo.com',
-              'submission' => {
-                'status' => false,
-                'error_message' => false,
-                'id' => false,
-                'timestamp' => false,
-                'has_attempted_submit' => false
-              },
+              'returnUrl' => 'foo.com',
               'createdAt' => 1_646_370_367,
               'expiresAt' => 1_651_554_367,
               'lastUpdated' => 1_646_370_367,
@@ -57,7 +54,7 @@
 
         put(
           "/accredited_representative_portal/v0/in_progress_forms/#{form_id}",
-          params: { 'form_data' => { another_field: 'foo' } }.to_json,
+          params: { 'formData' => { anotherField: 'foo' } }.to_json,
           headers:
         )
 
@@ -85,7 +82,7 @@
         expect(parsed_response).to eq(
           {
             'formData' => {
-              'another_field' => 'foo'
+              'anotherField' => 'foo'
             },
             'metadata' => {
               'createdAt' => 1_646_456_767,
@@ -101,7 +98,7 @@
 
         put(
           "/accredited_representative_portal/v0/in_progress_forms/#{form_id}",
-          params: { 'form_data' => { another_field: 'foo', sample_field: 'sample' } }.to_json,
+          params: { 'formData' => { anotherField: 'foo', sampleField: 'sample' } }.to_json,
           headers:
         )
 
@@ -129,8 +126,8 @@
         expect(parsed_response).to eq(
           {
             'formData' => {
-              'another_field' => 'foo',
-              'sample_field' => 'sample'
+              'anotherField' => 'foo',
+              'sampleField' => 'sample'
             },
             'metadata' => {
               'createdAt' => 1_646_456_767,

modules/accredited_representative_portal/spec/requests/accredited_representative_portal/v0/user_spec.rb

@@ -46,30 +46,23 @@
           expect(parsed_response).to eq(
             {
               'account' => {
-                'account_uuid' => user.user_account.id
+                'accountUuid' => user.user_account.id
               },
               'profile' => {
-                'first_name' => first_name,
-                'last_name' => last_name,
+                'firstName' => first_name,
+                'lastName' => last_name,
                 'verified' => true,
-                'sign_in' => {
-                  'service_name' => sign_in_service_name
+                'signIn' => {
+                  'serviceName' => sign_in_service_name
                 }
               },
-              'prefills_available' => [],
-              'in_progress_forms' => [
+              'prefillsAvailable' => [],
+              'inProgressForms' => [
                 {
                   'form' => in_progress_form_id,
                   'metadata' => {
                     'version' => 1,
-                    'return_url' => 'foo.com',
-                    'submission' => {
-                      'status' => false,
-                      'error_message' => false,
-                      'id' => false,
-                      'timestamp' => false,
-                      'has_attempted_submit' => false
-                    },
+                    'returnUrl' => 'foo.com',
                     'createdAt' => Time.current.to_i,
                     'expiresAt' => 60.days.from_now.to_i,
                     'lastUpdated' => Time.current.to_i,