Merge branch 'AP-345-expirations' into 'master'

Allow users without eligible jobs to update and setup expiry date to current date

See merge request lap/alma-user-load!49

Author: steve-sullivan

README.md

@@ -136,8 +136,8 @@ Note - to run the test suite you need to change the LDAP setting in your `.env`
 ## Future Improvements:
 - Replace fixtures w/some sort of factory (VCR)
 - DRY things up (UCPath vs. SIS --> phone, email, address, names, etc...)
-- SIS - add run by user id (similar to how I setup ucpath)
+- SIS - add run by user id (similar to how I setup ucpath)...if possible
 - Move 'create_user_record' from user.rb to a separate class
 - Add a check to make sure all necessary config settings are set!
-- Fix LDAP tests to override the 
 - Setup a rake command to run the test suite
+- Reduce some of the complexity in the complexity so I can remove some of the rubocop disables

config/settings.yml

@@ -5,6 +5,8 @@ Settings:
   ucpath_upload_path: "/alma/patron_employees/"
   upload_host: "upload.lib.berkeley.edu"
   upload_user: "ssullivan"
+  last_alma_purge: "2023-06-30"
+  application_version: "1.5.6"
 
 # TODO - flesh this out
 # http://docopt.org/

config/ucpath_fields.yml

@@ -206,6 +206,11 @@ Job:
       dbdef: "VARCHAR(16)"
       status: OPTIONAL
 
+    - name: termination_date
+      jpath: "$.actions.terminationDate"
+      dbdef: "VARCHAR(16)"
+      status: OPTIONAL
+
 EmployeeIDs:
   employee_rootnode: "//ar:response/emp:employees/emp:employee"
   total_records_xpath: "//ar:offset/ar:total"

lib/alma/xml_writer.rb

@@ -3,10 +3,11 @@
 
 module Alma
   class XMLWriter
-    attr_reader :out
+    attr_reader :out, :change_log_count
 
-    def initialize(outfile)
+    def initialize(outfile, change_log_count = nil)
       @out = ensure_io(outfile)
+      @change_log_count = change_log_count
     end
 
     def write(record)
@@ -43,7 +44,8 @@ def prolog_and_opening_tag
       tag = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
       tag += "<!-- GIT_COMMIT:#{ENV['GIT_COMMIT']} -->\n"
       tag += "<!-- DOCKER_TAG:#{ENV['DOCKER_TAG']} -->\n"
-      tag += "<!-- VERSION: 1.5.4 -->\n"
+      tag += "<!-- VERSION: #{ENV['VERSION']} -->\n"
+      tag += "<!-- CHANGE_LOG_COUNT: #{change_log_count} -->\n"
       tag += "<users>\n"
       tag
     end

lib/helpers/setup.rb

@@ -5,6 +5,9 @@
 
 module Helpers
   class Setup
+    # Set the version of the application
+    ENV['VERSION'] = Config.setting('application_version')
+
     # Command Line Args:
     attr_reader :type, :users, :start_date, :end_date, :num_days, :term_id, :outdir
 

lib/ucpath.rb

@@ -15,7 +15,7 @@ def run_ucpath(setup)
     process_list = setup.users || UCPath::API.change_log(setup.start_date, setup.end_date)
 
     if process_list
-      writer = Alma::XMLWriter.new(setup.xml_path)
+      writer = Alma::XMLWriter.new(setup.xml_path, process_list.count)
 
       process_list.each_with_index do |id, idx|
         logger.info "#{idx} - #{id}"

lib/ucpath/jobs.rb

@@ -7,7 +7,22 @@
 
 module UCPath
   class Jobs
-    attr_accessor :job
+    attr_accessor :job, :first_job
+
+    class << self
+      # We're no longer skipping users who do not have an eligible job.
+      # But we still need a "job record" quick and dirty to create a dummy job
+      # and set the expiration date (expected_end_date) to today.
+      def dummy_job
+        OpenStruct.new(
+          hr_status_code: 'I',
+          expected_end_date: Date.today.to_s,
+          org_relationship_code: nil,
+          dept_desc: 'NO_JOB_FOUND',
+          job_code: nil
+        )
+      end
+    end
 
     def initialize(id)
       # Fetch the raw job data
@@ -16,10 +31,10 @@ def initialize(id)
       return if job_data.nil?
 
       # Break the jobs data into an array using jsonpath
-      raw_jobs = JsonPath.on(job_data, '$..response[*].jobs')
-      return unless raw_jobs.count.positive?
+      job_list = JsonPath.on(job_data, '$..response[*].jobs')
+      return unless job_list.count.positive?
 
-      @job = find_eligible_job(raw_jobs)
+      @job = find_eligible_job(job_list)
     end
 
     def eligible_job?
@@ -30,23 +45,20 @@ def eligible_job?
     private
 
     # Extract the data from the raw jobs into the fields we need
+    # config/ucpath_fields.yml contains the fields/jpath we want to extract
     def find_eligible_job(raw_jobs)
       raw_jobs.first.each do |job_hash|
-        j = job_hash.to_json
-
-        job = OpenStruct.new
-
-        # config/ucpath_fields.yml contains the fields/jpath we need
-        Config.ucpath_job_fields.each do |field|
-          value = JsonPath.on(j, field['jpath']).first || ''
-          job[field['name']] = value if value
-        end
-
-        # Return this job struct if it's eligible
+        job = OpenStruct.new(
+          Config.ucpath_job_fields.to_h do |field|
+            [field['name'], JsonPath.on(job_hash, field['jpath']).first || '']
+          end
+        )
+
+        # First one - save it incase we don't find any eligible jobs!
+        @first_job ||= job
         return job if check_if_eligible(job)
       end
 
-      # No eligible jobs found, return nil
       nil
     end
 

lib/ucpath/user.rb

@@ -19,7 +19,7 @@ class User
     Email = Struct.new(:preferred, :email_address, :email_types)
     Phone = Struct.new(:preferred, :preferred_sms, :phone_number, :phone_types)
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def initialize(id)
       @id = id
       logger.info "#{id} - Processing record..."
@@ -51,13 +51,33 @@ def initialize(id)
       @jobs = Jobs.new(id)
 
       #----------------------------------------------------------------#
-      # NO ELIGIBLE JOB - NO REASON TO PROCEED!
+      # NO ELIGIBLE JOB
+      # AP-345: Changed this logic
+      # If we could not find an "eligible" job we'd just skip this user
+      # and move on. Now what we need to do is update the user's expiration
+      # date to the current date so that they will get purged from Alma.
+      # We'll either use the first job found (which is the users most recent job)
+      # or we'll create a dummy job with the expected_end_date set to today.
       unless @jobs.eligible_job?
-        @user = nil
-        @jobs = nil
-        @rec = nil
-        @ucpath_rec = nil
-        logger.info "#{id} - No eligible job, skipping LDAP search"
+        if @jobs.first_job
+          logger.info "#{id} - No eligible job found, using first job"
+          @jobs.job = @jobs.first_job
+
+          @jobs.job.expected_end_date = Date.today.to_s
+        else
+          logger.info "#{id} - No job found, using a dummy job"
+          @jobs.job = Jobs.dummy_job
+        end
+      end
+
+      #----------------------------------------------------------------#
+      # If we have a termination date that is before the last Alma
+      # purge date, then we can skip this user
+      term_date = @jobs.job.termination_date
+
+      if term_date && term_date != '' && Date.iso8601(term_date) < Date.parse(Config.setting('last_alma_purge'))
+        logger.info "#{id} - Ineligible: Termination date before #{Config.setting('last_alma_purge')}"
+        @eligible = false
         return
       end
 
@@ -91,7 +111,7 @@ def initialize(id)
 
       logger.info "#{id} - Eligible: #{eligible?}"
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def eligible?
       eligible
@@ -107,7 +127,7 @@ def create_user_record
       if ldap&.berkeleyeduaffiliations
         ldap.berkeleyeduaffiliations.each do |affiliation|
           if Config.student_affiated? affiliation
-            logger.info "#{id} - Ineligible - ldap student affiliation: #{affiliation}"
+            logger.info "#{id} - Ineligible: ldap student affiliation: #{affiliation}"
             return nil
           end
         end

spec/data/sis/expected_xml_3.xml

@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- GIT_COMMIT:LOCAL_TESTING -->
 <!-- DOCKER_TAG:DEV -->
-<!-- VERSION: 1.5.4 -->
+<!-- VERSION: VERSIONNUMBER -->
+<!-- CHANGE_LOG_COUNT:  -->
 <users>
 <user>
   <record_type>PUBLIC</record_type>