Committee API endpoint

.gitignore

@@ -55,3 +55,4 @@ config/settings/*.local.yml
 config/environments/*.local.yml
 
 /config/master.key
+docs/development/

.rubocop.yml

@@ -322,3 +322,16 @@ Naming/MemoizedInstanceVariableName:
 
 Style/MultipleComparison:
   Enabled: false
+
+
+# Rubocop doesn't seem to understand the rswag DSL.
+# Exclude the rswag spec file spec/requests/api/v1/api_docs/committee_records_spec.rb
+# from RSpec/EmptyExampleGroup.  Without this, autocorrect will delete 
+# the code in that file.
+RSpec/EmptyExampleGroup:
+  Exclude:
+    - 'spec/requests/api/v1/api_docs/committee_records_spec.rb'
+
+RSpec/VariableName:
+  Exclude:
+    - 'spec/requests/api/v1/api_docs/committee_records_spec.rb'

Gemfile

@@ -85,7 +85,8 @@ gem 'config', '~> 5.5.2'
 gem 'discard'
 # Temporary file downloads over HTTP
 gem 'down'
-
+# API documentation
+gem 'rswag' 
 
 group :development, :test do
   # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
@@ -95,6 +96,8 @@ group :development, :test do
   # Coverage report
   gem 'simplecov', '~> 0.17.0'
   gem 'mutex_m'
+  # API documentation
+  gem 'rswag' 
 end
 
 group :development do

Gemfile.lock

@@ -214,6 +214,9 @@ GEM
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
     json (2.16.0)
+    json-schema (6.1.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
     jwt (2.10.1)
       base64
     language_server-protocol (3.17.0.5)
@@ -402,6 +405,21 @@ GEM
     rspec-retry (0.6.2)
       rspec-core (> 3.3)
     rspec-support (3.13.2)
+    rswag (2.17.0)
+      rswag-api (= 2.17.0)
+      rswag-specs (= 2.17.0)
+      rswag-ui (= 2.17.0)
+    rswag-api (2.17.0)
+      activesupport (>= 5.2, < 8.2)
+      railties (>= 5.2, < 8.2)
+    rswag-specs (2.17.0)
+      activesupport (>= 5.2, < 8.2)
+      json-schema (>= 2.2, < 7.0)
+      railties (>= 5.2, < 8.2)
+      rspec-core (>= 2.14)
+    rswag-ui (2.17.0)
+      actionpack (>= 5.2, < 8.2)
+      railties (>= 5.2, < 8.2)
     rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -599,6 +617,7 @@ DEPENDENCIES
   rsolr (~> 2.5.0)
   rspec-rails (~> 7.0.0)
   rspec-retry (~> 0.6.0)
+  rswag
   sassc-rails (~> 2.1.2)
   seedbank (~> 0.5.0)
   selenium-webdriver (~> 4.26)

app/controllers/api/v1/committee_records_controller.rb

@@ -0,0 +1,80 @@
+module Api
+  module V1
+    class CommitteeRecordsController < ApplicationController
+      skip_before_action :verify_authenticity_token
+
+      before_action :authenticate_api_key
+
+      def faculty_committees
+        access_id = params[:access_id]
+        if access_id.blank?
+          render json: { error: 'access_id is required' }, status: :bad_request
+          return
+        end
+
+        committee_memberships = CommitteeMember
+                                .joins(:submission).where('submissions.status LIKE "released for publication%" OR submissions.status = "waiting for publication release"')
+                                .includes(:committee_role, submission: [:author, :degree, :program])
+                                .where(access_id: access_id)
+
+        render json: {
+          faculty_access_id: access_id,
+          committees: format_committees(committee_memberships)
+        }, status: :ok
+      rescue StandardError => e
+        render json: { error: e.message }, status: :internal_server_error
+      end
+
+      private
+
+        def authenticate_api_key
+          token = request.headers['HTTP_X_API_KEY']
+
+          @api_token = ApiToken.includes(:external_app).find_by(token: token)
+          return unauthorized! unless @api_token
+
+          @external_app = @api_token.external_app
+          @api_token.update_column(:last_used_at, Time.current)
+
+          true
+        end
+
+        def unauthorized!
+          render json: { error: "Unauthorized" }, status: :unauthorized
+        end
+
+        def format_committees(committee_memberships)
+          committee_memberships.map { |membership| committee_payload(membership) }
+        end
+
+        def committee_payload(membership)
+          submission = membership.submission
+          author = submission&.author
+
+          {
+            committee_member_id: membership.id,
+
+            role: membership.committee_role&.name,
+            role_code: membership.committee_role&.code,
+
+            student_fname: author&.first_name,
+            student_lname: author&.last_name,
+            student_access_id: author&.access_id,
+
+            submission_id: submission.id,
+            title: submission.title,
+            degree_name: submission.degree&.name,
+            program_name: submission.program&.name,
+            semester: submission.semester,
+            year: submission.year,
+
+            approval_started_at: membership.approval_started_at,
+            final_submission_approved_at: submission.final_submission_approved_at,
+
+            submission_status: submission.status,
+            committee_member_status: membership.status
+          }
+        end
+    end
+  end
+end

app/models/external_app.rb

@@ -29,10 +29,24 @@ def self.build
     end
   end
 
+  class FamsTools
+    NAME = "FAMS Tools"
+
+    def self.build
+      ExternalApp.find_or_create_by(name: NAME) do |app|
+        app.api_tokens.build
+      end
+    end
+  end
+
   def self.etda_explore
     EtdaExplore.build
   end
 
+  def self.fams_tools
+    FamsTools.build
+  end
+
   def token
     api_tokens.first.token
   end

config/initializers/rswag_api.rb

@@ -0,0 +1,14 @@
+Rswag::Api.configure do |c|
+
+  # Specify a root folder where Swagger JSON files are located
+  # This is used by the Swagger middleware to serve requests for API descriptions
+  # NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
+  # that it's configured to generate files in the same folder
+  c.openapi_root = Rails.root.to_s + '/swagger'
+
+  # Inject a lambda function to alter the returned Swagger prior to serialization
+  # The function will have access to the rack env for the current request
+  # For example, you could leverage this to dynamically assign the "host" property
+  #
+  c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+end

config/initializers/rswag_ui.rb

@@ -0,0 +1,16 @@
+Rswag::Ui.configure do |c|
+
+  # List the Swagger endpoints that you want to be documented through the
+  # swagger-ui. The first parameter is the path (absolute or relative to the UI
+  # host) to the corresponding endpoint and the second is a title that will be
+  # displayed in the document selector.
+  # NOTE: If you're using rspec-api to expose Swagger files
+  # (under openapi_root) as JSON or YAML endpoints, then the list below should
+  # correspond to the relative paths for those endpoints.
+
+  c.swagger_endpoint '/admin/api-docs/v1/swagger.yaml', 'API V1 Docs'
+
+  # Add Basic Auth in case your API is private
+  # c.basic_auth_enabled = true
+  # c.basic_auth_credentials 'username', 'password'
+end

config/routes.rb

@@ -2,7 +2,6 @@
 require 'sidekiq/web'
 
 Rails.application.routes.draw do
-
   devise_for :approvers, path: 'approver'
   devise_for :authors, path: 'author'
   devise_for :admins, path: 'admin'
@@ -20,6 +19,12 @@
 
   mount OkComputer::Engine, at: "/healthcheck"
 
+  namespace :api do
+    namespace :v1 do
+        post "committee_records/faculty_committees"
+    end
+  end
+
   ## works: get '/committee_members/autocomplete', to: 'ldap_lookup#autocomplete', as: :committee_members_autocomplete
   get '/committee_members/autocomplete', to: 'application#autocomplete', as: :committee_members_autocomplete
 
@@ -43,6 +48,8 @@
 
     authenticate :admin do
       mount Sidekiq::Web => '/sidekiq'
+      mount Rswag::Api::Engine => '/api-docs'
+      mount Rswag::Ui::Engine => '/api-docs'
     end
 
     get '/custom_report', to: 'reports#custom_report_index', as: :custom_report_index

db/schema.rb

@@ -195,7 +195,7 @@
     t.index ["name"], name: "index_degrees_on_name", unique: true
   end
 
-  create_table "external_apps", charset: "utf8mb4", collation: "utf8mb4_unicode_ci", force: :cascade do |t|
+  create_table "external_apps", charset: "utf8mb4", force: :cascade do |t|
     t.string "name"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
@@ -277,7 +277,7 @@
     t.index ["name", "code"], name: "index_programs_on_name_and_code", unique: true
   end
 
-  create_table "remediated_final_submission_files", charset: "utf8mb4", collation: "utf8mb4_unicode_ci", force: :cascade do |t|
+  create_table "remediated_final_submission_files", charset: "utf8mb4", force: :cascade do |t|
     t.bigint "submission_id", null: false
     t.bigint "final_submission_file_id", null: false
     t.text "asset"
@@ -342,9 +342,9 @@
     t.string "lionpath_semester"
     t.string "academic_program"
     t.string "degree_checkout_status"
-    t.datetime "author_release_warning_sent_at", precision: nil
-    t.datetime "acknowledgment_page_submitted_at", precision: nil
     t.string "candidate_number"
+    t.datetime "acknowledgment_page_submitted_at", precision: nil
+    t.datetime "author_release_warning_sent_at", precision: nil
     t.string "extension_token"
     t.datetime "last_lionpath_export_at", precision: nil
     t.index ["author_id"], name: "submissions_author_id_fk"