Direct deposit swagger docs (#12345)

* Add swagger docs and specs and update routes

* Fix failing specs for lighthouse direct deposit error_spec

* Fixed request body for updates

app/controllers/v0/profile/direct_deposits/disability_compensations_controller.rb

@@ -23,8 +23,9 @@ def show
         end
 
         def update
-          response = client.update payment_account_params
+          response = client.update_payment_information(payment_account_params)
           if response.ok?
+            send_confirmation_email
             render status: response.status,
                    json: response.body,
                    serializer: DisabilityCompensationsSerializer
@@ -57,6 +58,10 @@ def validate_payment_account
             raise Common::Exceptions::ValidationErrors, payment_account
           end
         end
+
+        def send_confirmation_email
+          VANotifyDdEmailJob.send_to_emails(current_user.all_emails, :comp_and_pen)
+        end
       end
     end
   end

app/swagger/swagger/requests/profile.rb

@@ -244,7 +244,7 @@ class Profile
             end
           end
 
-          response 201 do
+          response 200 do
             key :description, 'Direct deposit information for a users compensation and pension benefits.'
             schema do
               key :type, :object

lib/lighthouse/direct_deposit/client.rb

@@ -23,13 +23,35 @@ def get_payment_information
       parse_response(response)
     end
 
-    def update(body)
+    def update_payment_information(params)
+      body = request_body(params)
+      save_sanitized_body(body)
+
       response = config.put("?icn=#{@icn}", body)
       parse_response(response)
     end
 
     private
 
+    def request_body(params)
+      params.delete('financial_institution_name') if params['financial_institution_name'].blank?
+      {
+        'paymentAccount' =>
+        {
+          'accountNumber' => params[:account_number],
+          'accountType' => params[:account_type],
+          'financialInstitutionRoutingNumber' => params[:routing_number]
+        }
+      }.to_json
+    end
+
+    def save_sanitized_body(body)
+      json = JSON.parse(body)
+      json['paymentAccount']['accountNumber'] = '****'
+
+      @sanitized_req_body = json
+    end
+
     def valid_response?(response)
       ok?(response) || control_info?(response)
     end

spec/controllers/v0/profile/direct_deposits/disability_compensations_controller_spec.rb

@@ -161,18 +161,18 @@
 
   describe '#update' do
     context 'when successful' do
-      it 'returns a status of 201' do
+      it 'returns a status of 200' do
         params = {
           account_number: '1234567890',
           account_type: 'CHECKING',
           routing_number: '031000503'
         }
 
-        VCR.use_cassette('lighthouse/direct_deposit/update/201_response') do
+        VCR.use_cassette('lighthouse/direct_deposit/update/200_response') do
           put(:update, params:)
         end
 
-        expect(response).to have_http_status(:created)
+        expect(response).to have_http_status(:ok)
       end
     end
 

spec/requests/swagger_spec.rb

@@ -2264,13 +2264,13 @@
       end
 
       context 'PUT' do
-        it 'returns a 201' do
+        it 'returns a 200' do
           headers = { '_headers' => { 'Cookie' => sign_in(user, nil, true) } }
           params = { account_number: '1234567890', account_type: 'CHECKING', routing_number: '031000503' }
-          VCR.use_cassette('lighthouse/direct_deposit/update/201_response') do
+          VCR.use_cassette('lighthouse/direct_deposit/update/200_response') do
             expect(subject).to validate(:put,
                                         '/v0/profile/direct_deposits/disability_compensations',
-                                        201,
+                                        200,
                                         headers.merge('_data' => params))
           end
         end