105455 add gclaws client (#21463)

* gclaws client wip

* spelling

* add specs

Author: jvcAdHoc

app/models/accredited_individual.rb

@@ -3,7 +3,7 @@
 require 'accredited_representation/constants'
 
 class AccreditedIndividual < ApplicationRecord
-  # Represents an accredited individual (attorney, claims agent, representative) as defined by he OGC accreditation
+  # Represents an accredited individual (attorney, claims agent, representative) as defined by the OGC accreditation
   # APIs. Until a form of soft deletion is implemented, these records will only reflect individuals with active
   # accreditation.
   #

app/models/accredited_organization.rb

@@ -3,7 +3,7 @@
 require 'accredited_representation/constants'
 
 class AccreditedOrganization < ApplicationRecord
-  # Represents an accredited organization as defined by he OGC accreditation APIs. Until a form of soft deletion is
+  # Represents an accredited organization as defined by the OGC accreditation APIs. Until a form of soft deletion is
   # implemented, these records will only reflect organization with active accreditation.
   #
   # Key notes:

config/initializers/inflections.rb

@@ -12,6 +12,7 @@
   inflect.acronym 'DGI' # Digital GI
   inflect.acronym 'EVSS'
   inflect.acronym 'FHIR'
+  inflect.acronym 'GCLAWS' # General Counsel Automated Workload System
   inflect.acronym 'GIDS'
   inflect.acronym 'GI'
   inflect.acronym 'HCA'

modules/representation_management/app/services/representation_management/gclaws/client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This client is responsible for retrieving accreditation data from the GCLAWS API.
+
+module RepresentationManagement
+  module GCLAWS
+    class Client
+      ALLOWED_TYPES = %w[agents attorneys representatives veteran_service_organizations].freeze
+      DEFAULT_PAGE = 1
+      DEFAULT_PAGE_SIZE = 100
+
+      def self.get_accredited_entities(type:, page: DEFAULT_PAGE, page_size: DEFAULT_PAGE_SIZE)
+        return {} unless ALLOWED_TYPES.include?(type)
+
+        configuration = GCLAWS::Configuration.new(type:, page:, page_size:)
+
+        configuration.connection.get
+      rescue Faraday::ConnectionFailed
+        Rails.logger.error(
+          "GCLAWS Accreditation connection failed for #{type}"
+        )
+        Faraday::Response.new(status: :service_unavailable,
+                              body: { errors: 'GCLAWS Accreditation unavailable' }.to_json)
+      rescue Faraday::TimeoutError
+        Rails.logger.error("GCLAWS Accreditation request timed out for #{type}")
+        Faraday::Response.new(status: :request_timeout,
+                              body: { errors: 'GCLAWS Accreditation request timed out' }.to_json)
+      end
+    end
+  end
+end

modules/representation_management/app/services/representation_management/gclaws/configuration.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# HTTP client configuration for the RepresentationManagement::GCLAWS::Client
+#
+module RepresentationManagement
+  module GCLAWS
+    class Configuration
+      DEFAULT_SORT_PARAMS = {
+        'agents' => {
+          'sortColumn' => 'LastName',
+          'sortOrder' => 'ASC'
+        },
+        'attorneys' => {
+          'sortColumn' => 'LastName',
+          'sortOrder' => 'ASC'
+        },
+        'representatives' => {
+          'sortColumn' => 'LastName',
+          'sortOrder' => 'ASC'
+        },
+        'veteran_service_organizations' => {
+          'sortColumn' => 'Organization.OrganizationName',
+          'sortOrder' => 'ASC'
+        }
+      }.freeze
+
+      URL_MAPPING = {
+        'agents' => Settings.gclaws.accreditation.agents.url,
+        'attorneys' => Settings.gclaws.accreditation.attorneys.url,
+        'representatives' => Settings.gclaws.accreditation.representatives.url,
+        'veteran_service_organizations' => Settings.gclaws.accreditation.veteran_service_organizations.url
+      }.freeze
+
+      def initialize(type:, page:, page_size:)
+        @type = type
+        @page = page
+        @page_size = page_size
+      end
+
+      def connection
+        Faraday.new(url:, params:, headers:) do |conn|
+          conn.request :json
+          conn.response :json, content_type: /\bjson$/
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      private
+
+      def api_key
+        Settings.gclaws.accreditation.api_key
+      end
+
+      def headers
+        {
+          'x-api-key' => api_key
+        }
+      end
+
+      def params
+        DEFAULT_SORT_PARAMS[@type].merge({ 'page' => @page, 'pageSize' => @page_size })
+      end
+
+      def url
+        URL_MAPPING[@type]
+      end
+    end
+  end
+end

modules/representation_management/spec/models/representation_management/form_2122_digital_submission_spec.rb

@@ -197,7 +197,7 @@
         end
       end
 
-      context 'when the user has a participant id' do
+      context 'when the user has an ICN' do
         it 'does not add the blank ICN error to the form' do
           subject.valid?
 

modules/representation_management/spec/services/representation_management/gclaws/client_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'faraday'
+require 'json'
+
+RSpec.describe RepresentationManagement::GCLAWS::Client do
+  subject { described_class }
+
+  describe '.get_accredited_entities' do
+    context 'when the type is invalid' do
+      let(:type) { 'invalid' }
+
+      it 'returns an empty hash' do
+        response = subject.get_accredited_entities(type:)
+        expect(response).to eq({})
+      end
+    end
+
+    context 'when the type is valid' do
+      let(:type) { 'agents' }
+      let(:parsed_body) { { field: 'value' } }
+
+      context 'when the request is successful' do
+        it 'returns a successful response' do
+          stub_request(:get, Settings.gclaws.accreditation.agents.url)
+            .with(query: { 'page' => 1, 'pageSize' => 100, 'sortColumn' => 'LastName', 'sortOrder' => 'ASC' })
+            .to_return(status: 200, body: parsed_body.to_json, headers: { 'Content-Type' => 'application/json' })
+
+          response = subject.get_accredited_entities(type:)
+
+          expect(response.status).to eq(200)
+          expect(response.body).to eq(parsed_body.stringify_keys)
+        end
+      end
+
+      context 'when the connection fails' do
+        it 'logs the error and returns a service unavailable status' do
+          stub_request(:get, Settings.gclaws.accreditation.agents.url)
+            .with(query: { 'page' => 1, 'pageSize' => 100, 'sortColumn' => 'LastName', 'sortOrder' => 'ASC' })
+            .to_raise(Faraday::ConnectionFailed.new('GCLAWS Accreditation unavailable'))
+
+          expect(Rails.logger).to receive(:error).with("GCLAWS Accreditation connection failed for #{type}")
+
+          response = subject.get_accredited_entities(type:)
+
+          expect(response.status).to eq(:service_unavailable)
+          expect(JSON.parse(response.body)['errors']).to eq('GCLAWS Accreditation unavailable')
+        end
+      end
+
+      context 'when the request times out' do
+        it 'logs the error and returns a request timeout status' do
+          stub_request(:get, Settings.gclaws.accreditation.agents.url)
+            .with(query: { 'page' => 1, 'pageSize' => 100, 'sortColumn' => 'LastName', 'sortOrder' => 'ASC' })
+            .to_raise(Faraday::TimeoutError.new('GCLAWS Accreditation request timed out'))
+
+          expect(Rails.logger).to receive(:error).with(
+            "GCLAWS Accreditation request timed out for #{type}"
+          )
+
+          response = subject.get_accredited_entities(type:)
+
+          expect(response.status).to eq(:request_timeout)
+          expect(JSON.parse(response.body)['errors']).to eq('GCLAWS Accreditation request timed out')
+        end
+      end
+    end
+  end
+end

modules/representation_management/spec/services/representation_management/gclaws/configuration_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe RepresentationManagement::GCLAWS::Configuration do
+  subject { described_class.new(type:, page:, page_size:) }
+
+  let(:type) { 'agents' }
+  let(:page) { 1 }
+  let(:page_size) { 10 }
+
+  describe '#connection' do
+    it 'creates a Faraday connection' do
+      expect(subject.connection).to be_a(Faraday::Connection)
+    end
+
+    it 'sets the search params' do
+      expect(subject.connection.params).to eq({ 'sortColumn' => 'LastName', 'sortOrder' => 'ASC', 'page' => 1,
+                                                'pageSize' => 10 })
+    end
+
+    it 'sets the url' do
+      expect(subject.connection.url_prefix.to_s).to eq(Settings.gclaws.accreditation.agents.url)
+    end
+
+    it 'sets the api_key' do
+      expect(subject.connection.headers['x-api-key']).to eq(Settings.gclaws.accreditation.api_key)
+    end
+  end
+end