LSS 109833 Claims Evidence API Module (#22244)

wayne-weibel · web-flow · commit be8b27ad4267 · 2025-05-16T16:15:04.000-04:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1043,6 +1043,7 @@ modules/banners @department-of-veterans-affairs/vfs-facilities-frontend @departm
 modules/burials @department-of-veterans-affairs/pension-and-burials @department-of-veterans-affairs/backend-review-group
 modules/check_in @department-of-veterans-affairs/va-api-engineers @department-of-veterans-affairs/vsa-healthcare-health-quest-1-backend @department-of-veterans-affairs/patient-check-in @department-of-veterans-affairs/backend-review-group
 modules/claims_api @department-of-veterans-affairs/lighthouse-dash
+modules/claims_evidence_api @department-of-veterans-affairs/benefits-lifestage @department-of-veterans-affairs/backend-review-group
 modules/decision_reviews @department-of-veterans-affairs/benefits-decision-reviews-be @department-of-veterans-affairs/backend-review-group @department-of-veterans-affairs/benefits-admin
 modules/debts_api @department-of-veterans-affairs/vsa-debt-resolution @department-of-veterans-affairs/backend-review-group
 modules/dhp_connected_devices @department-of-veterans-affairs/digital-health-platform
diff --git a/.github/workflows/yardoc.yml b/.github/workflows/yardoc.yml
@@ -6,6 +6,7 @@ on: # `on` parses to `true` in ruby
     paths:
       # https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#patterns-to-match-file-paths
       - modules/burials/**/*.rb
+      - modules/claims_evidence_api/**/*.rb
       - modules/pensions/**/*.rb
       - modules/income_and_assets/**/*.rb
       
diff --git a/Gemfile b/Gemfile
@@ -15,6 +15,7 @@ path 'modules' do
   gem 'burials'
   gem 'check_in'
   gem 'claims_api'
+  gem 'claims_evidence_api'
   gem 'debts_api'
   gem 'decision_reviews'
   gem 'dhp_connected_devices'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -99,6 +99,7 @@ PATH
     check_in (0.1.0)
     claims_api (0.0.1)
       dry-schema
+    claims_evidence_api (0.1.0)
     debts_api (0.1.0)
     decision_reviews (0.1.0)
       rails (>= 7.1.4.1)
@@ -1234,6 +1235,7 @@ DEPENDENCIES
   carrierwave-aws
   check_in!
   claims_api!
+  claims_evidence_api!
   clamav-client
   combine_pdf
   committee-rails
diff --git a/config/routes.rb b/config/routes.rb
@@ -400,6 +400,7 @@
   mount Avs::Engine, at: '/avs'
   mount Burials::Engine, at: '/burials'
   mount CheckIn::Engine, at: '/check_in'
+  mount ClaimsEvidenceApi::Engine, at: '/claims_evidence_api'
   mount DebtsApi::Engine, at: '/debts_api'
   mount DhpConnectedDevices::Engine, at: '/dhp_connected_devices'
   mount FacilitiesApi::Engine, at: '/facilities_api'
diff --git a/lib/generators/module/templates/README.rdoc.erb b/lib/generators/module/templates/README.rdoc.erb
@@ -4,7 +4,7 @@ TODO: Short description and motivation.
 == Installation
 Ensure the following line is in the root project's Gemfile:
 
-  gem '<%= class_name.downcase %>', path: 'modules/<%= class_name.downcase %>'
+  gem '<%= class_name.underscore %>', path: 'modules/<%= class_name.underscore %>'
 
 == License
 This module is open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
diff --git a/lib/generators/module/templates/lib/namespace.rb.erb b/lib/generators/module/templates/lib/namespace.rb.erb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require '<%= class_name.downcase %>/engine'
+require '<%= class_name.underscore %>/engine'
 
 module <%= class_name %>
   # Your code goes here...
diff --git a/lib/generators/module/templates/lib/namespace/engine.rb.erb b/lib/generators/module/templates/lib/namespace/engine.rb.erb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module <%= class_name %>
+  # @see https://api.rubyonrails.org/classes/Rails/Engine.html
   class Engine < ::Rails::Engine
     isolate_namespace <%= class_name %>
     config.generators.api_only = true
diff --git a/lib/generators/module/templates/lib/namespace/version.rb.erb b/lib/generators/module/templates/lib/namespace/version.rb.erb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module <%= class_name %>
+  # version
   VERSION = '0.1.0'
 end
diff --git a/modules/claims_evidence_api/.adr-dir b/modules/claims_evidence_api/.adr-dir
@@ -0,0 +1 @@
+documentation/adr
diff --git a/modules/claims_evidence_api/.gitignore b/modules/claims_evidence_api/.gitignore
@@ -0,0 +1,22 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+.bundle
+.envrc
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp/*
+!/tmp/.keep
+
+# Ignore generated directories
+/coverage
+/reports
+
+# ignore yardoc generation
+.yardoc/
diff --git a/modules/claims_evidence_api/.irbrc b/modules/claims_evidence_api/.irbrc
@@ -0,0 +1,5 @@
+# Disable autocomplete in deployed environments
+# to help prevent running unintended commands
+if ENV['RAILS_ENV'] == 'production'
+  IRB.conf[:USE_AUTOCOMPLETE] = false
+end
diff --git a/modules/claims_evidence_api/.rspec b/modules/claims_evidence_api/.rspec
@@ -0,0 +1,7 @@
+--color
+--require spec_helper
+--format progress
+<% if ENV['CI'] %>
+--format RspecJunitFormatter
+--out log/rspec.xml
+<% end %>
diff --git a/modules/claims_evidence_api/Gemfile b/modules/claims_evidence_api/Gemfile
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in claimsevidenceapi.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
diff --git a/modules/claims_evidence_api/README.rdoc b/modules/claims_evidence_api/README.rdoc
@@ -0,0 +1,10 @@
+= ClaimsEvidenceApi
+TODO: Short description and motivation.
+
+== Installation
+Ensure the following line is in the root project's Gemfile:
+
+  gem 'claims_evidence_api', path: 'modules/claims_evidence_api'
+
+== License
+This module is open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
diff --git a/modules/claims_evidence_api/Rakefile b/modules/claims_evidence_api/Rakefile
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ClaimsEvidenceApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
diff --git a/modules/claims_evidence_api/app/controllers/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/app/controllers/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/app/models/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/app/models/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/app/serializers/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/app/serializers/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/app/services/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/app/services/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/bin/rails b/modules/claims_evidence_api/bin/rails
@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENGINE_ROOT = File.expand_path('../..', __dir__)
+ENGINE_PATH = File.expand_path('../../lib/claimsevidenceapi/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'
diff --git a/modules/claims_evidence_api/claims_evidence_api.gemspec b/modules/claims_evidence_api/claims_evidence_api.gemspec
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+# Maintain your gem's version:
+require 'claims_evidence_api/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = 'claims_evidence_api'
+  spec.version     = ClaimsEvidenceApi::VERSION
+  spec.authors     = ['Wayne Weibel']
+  spec.email       = ['wayne.weibel@adhocteam.us']
+  spec.homepage    = 'https://api.va.gov'
+  spec.summary     = 'An api.va.gov module'
+  spec.description = 'This module was auto-generated please update this description'
+  spec.license     = 'CC0-1.0'
+
+  spec.files = Dir['{app,config,db,lib}/**/*', 'Rakefile', 'README.md']
+end
diff --git a/modules/claims_evidence_api/config/routes.rb b/modules/claims_evidence_api/config/routes.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ClaimsEvidenceApi::Engine.routes.draw do
+end
diff --git a/modules/claims_evidence_api/documentation/adr/0001-record-architecture-decisions.md b/modules/claims_evidence_api/documentation/adr/0001-record-architecture-decisions.md
@@ -0,0 +1,41 @@
+# 1. Record architecture decisions
+
+Date: 2024-06-14
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision Documentation
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+### Using adr-tools
+
+This repository makes use of [adr-tools](https://github.com/npryce/adr-tools/tree/master) to record architectural decisions as part of the code base.
+
+There are two uses for this, recording a new decision and superseding an existing decision.
+
+#### Recording a new decision
+
+To create a new decision use the adr new command:
+
+```bash
+ adr new <decision-title>
+```
+
+#### Superseding an existing decision
+
+To overwrite an existing decision you can add the -s flag followed by which is getting overwritten. In this example we are overwriting decision 9 with an updated decision:
+
+```bash
+adr new -s 9 <decision-title>
+```
+
+## Consequences
+
+See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
diff --git a/modules/claims_evidence_api/documentation/adr/0002-use-modules-folder-for-claims-evidence-api-code.md b/modules/claims_evidence_api/documentation/adr/0002-use-modules-folder-for-claims-evidence-api-code.md
@@ -0,0 +1,19 @@
+# 2. Use modules folder for claims evidence api code
+
+Date: 2025-05-16
+
+## Status
+
+Accepted
+
+## Context
+
+The development cycle in vets-api is strained, with delays during review and an undesireable release cycle.  It was argued to contain the code for the Claims Evidence API in a separate repo and import to vets-api as another gem.  It was assumed that there would be more control and freedom over the development of the library, compared to if it were contained in the `modules` directory directly as part of vets-api.  There would have been an increased initial implmentation and integration cost, but later development would proceed much smoother.  This assumption was not correct.  There is still the same oversight for other repositories.  While the current CI process is not ideal it is predefined, and having the code within vets-api does allow reuse of existing libraries.
+
+## Decision
+
+The code for Claims Evidence API library will be placed in `modules`, which does contain a gemspec, so moving to a separate reporsitory later could be possible.
+
+## Consequences
+
+The development sprint cycle will be strained with the current process and delays may occur.
diff --git a/modules/claims_evidence_api/documentation/readme.md b/modules/claims_evidence_api/documentation/readme.md
@@ -0,0 +1,46 @@
+# Claims Evidence API Module Documentation
+
+## ADR
+
+The Benefits Lifestage team uses [ADR Tools](https://github.com/npryce/adr-tools/tree/master) to document important engineering related decisions for the vets-api repo. The goal is to capture the technical decisions our group makes so that anyone new to our team or following behind will be able to understand the reasons for the decisions.
+
+Additional architectural decisions made by other teams can be found here:
+https://github.com/department-of-veterans-affairs/va.gov-team-sensitive/tree/master/teams/benefits/architectural-decision-records
+
+| Decision                                                                                                    |
+| ----------------------------------------------------------------------------------------------------------- |
+| [Use ADR to document important engineering decisions](./adr/0001-record-architecture-decisions.md)          |
+|                                                                                                             |
+
+## Folder structure
+
+For more information on the Ruby on Rails directory structure, please refer to https://github.com/jwipeout/rails-directory-structure-guide
+
+The current folder structure generally follows the default directory structure that **Ruby on Rails** comes with.
+
+##### App Folder
+
+- At a high level, within the app folder, there are [controllers](https://guides.rubyonrails.org/action_controller_overview.html) and [models](https://guides.rubyonrails.org/active_record_basics.html). Ruby on Rails uses a MVC (model, view, controller) architecture pattern. There is little historical context or documentation on the choice of V0 or V1 for the controllers.
+- There are also a [sidekiq](https://github.com/sidekiq/sidekiq) and [swagger](https://swagger.io/) folders.
+
+##### Lib Folder
+
+- The lib folder is intended for common code or code that can be reused by other teams. It is also where the code for interfacing with external APIs lives.
+
+##### Config Folder
+
+- The config folder is where most of the configuration files for the main rails app, plugins, etc. are housed
+
+##### Spec Folder
+
+- Contains the tests for the module
+
+## Team
+
+| Name            | Email Address                |
+| ------------    | -------------------------    |
+| Wayne Weibel    | wayne.weibel@adhocteam.us    |
+
+## Troubleshooting
+
+##
diff --git a/modules/claims_evidence_api/lib/claims_evidence_api.rb b/modules/claims_evidence_api/lib/claims_evidence_api.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'claims_evidence_api/engine'
+
+# Claims Evidence API
+# https://claimevidence-api-test.dev.bip.va.gov/api/v1/rest/swagger-ui.html
+module ClaimsEvidenceApi
+  # The module path
+  MODULE_PATH = 'modules/burials'
+end
diff --git a/modules/claims_evidence_api/lib/claims_evidence_api/engine.rb b/modules/claims_evidence_api/lib/claims_evidence_api/engine.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ClaimsEvidenceApi
+  # @see https://api.rubyonrails.org/classes/Rails/Engine.html
+  class Engine < ::Rails::Engine
+    isolate_namespace ClaimsEvidenceApi
+    config.generators.api_only = true
+
+    initializer 'model_core.factories', after: 'factory_bot.set_factory_paths' do
+      FactoryBot.definition_file_paths << File.expand_path('../../spec/factories', __dir__) if defined?(FactoryBot)
+    end
+  end
+end
diff --git a/modules/claims_evidence_api/lib/claims_evidence_api/version.rb b/modules/claims_evidence_api/lib/claims_evidence_api/version.rb
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ClaimsEvidenceApi
+  # version
+  VERSION = '0.1.0'
+end
diff --git a/modules/claims_evidence_api/spec/controllers/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/controllers/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/spec/factories/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/factories/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/spec/lib/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/lib/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/spec/models/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/models/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/spec/serializers/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/serializers/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/spec/services/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/services/claims_evidence_api/.gitkeep
diff --git a/modules/claims_evidence_api/spec/spec_helper.rb b/modules/claims_evidence_api/spec/spec_helper.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Configure Rails Envinronment
+ENV['RAILS_ENV'] = 'test'
+
+require 'rspec/rails'
+
+RSpec.configure { |config| config.use_transactional_fixtures = true }
diff --git a/modules/claims_evidence_api/spec/support/claims_evidence_api/.gitkeep b/modules/claims_evidence_api/spec/support/claims_evidence_api/.gitkeep
diff --git a/spec/simplecov_helper.rb b/spec/simplecov_helper.rb
@@ -64,6 +64,7 @@ def self.add_modules
     add_group 'Banners', 'modules/banners/'
     add_group 'CheckIn', 'modules/check_in/'
     add_group 'ClaimsApi', 'modules/claims_api/'
+    add_group 'ClaimsEvidenceApi', 'modules/claims_evidence_api/'
     add_group 'DebtsApi', 'modules/debts_api/'
     add_group 'DhpConnectedDevices', 'modules/dhp_connected_devices/'
     add_group 'FacilitiesApi', 'modules/facilities_api/'
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -61,6 +61,7 @@
     add_group 'Burials', 'modules/burials/'
     add_group 'CheckIn', 'modules/check_in/'
     add_group 'ClaimsApi', 'modules/claims_api/'
+    add_group 'ClaimsEvidenceApi', 'modules/claims_evidence_api/'
     add_group 'CovidResearch', 'modules/covid_research/'
     add_group 'DebtsApi', 'modules/debts_api/'
     add_group 'DhpConnectedDevices', 'modules/dhp_connected_devices/'
