Handle additional cases in GraduationJob

app/actors/hyrax/actors/pregrad_embargo.rb

@@ -40,7 +40,7 @@ def handle_malformed_data(env)
                "is being interpreted as a request for no embargo on " \
                "#{env.attributes[:title]}."
 
-          env.attributes.delete(:embargo_length)
+          # env.attributes.delete(:embargo_length)
 
           {}
         end

app/jobs/graduation_job.rb

@@ -21,7 +21,7 @@ def perform(work_id, graduation_date = Time.zone.today.to_s)
     publish_object
     ProquestJob.perform_later(@work.id)
     send_notifications
-    @work.save
+    @work.save!
   end
 
   # @param [Date] graduation_date
@@ -60,6 +60,19 @@ def update_embargo_release_date
       fs.embargo.embargo_release_date = embargo_release_date
       fs.embargo.save
     end
+
+    if embargo_release_date <= Time.zone.today
+      @work.visibility = @work.visibility_after_embargo if @work.visibility_after_embargo
+      @work.deactivate_embargo!
+      @work.embargo.save
+      @work.save
+      @work.file_sets.each do |fs|
+        fs.visibility = @work.visibility
+        fs.deactivate_embargo!
+        fs.save
+      end
+    end
+
     Rails.logger.warn "Graduation Job: ETD #{@work.id} embargo release date set to #{@work.embargo.embargo_release_date}"
   rescue => e
     Rails.logger.error "Error updating embargo release date for work #{@work}: #{e}"

spec/actors/hyrax/actors/pregrad_embargo_spec.rb

@@ -35,10 +35,10 @@
           'embargo_length' => InProgressEtd::NO_EMBARGO }
       end
 
-      it "removes the embargo_length attribute" do
+      it "does not remove the embargo_length attribute" do
         expect(env.attributes["embargo_length"]).to eq InProgressEtd::NO_EMBARGO
         middleware.create(env)
-        expect(env.attributes["embargo_length"]).to eq nil
+        expect(env.attributes["embargo_length"]).to eq InProgressEtd::NO_EMBARGO
       end
     end
 

spec/jobs/graduation_job_with_embargo_spec.rb

@@ -1,48 +1,67 @@
 require 'rails_helper'
-# For a work with an embargo, the GraduationJob should:
+# For the supplied ETD and graduation date, the GraduationJob should:
 # * set the degree_awarded date
 # * publish the work (workflow transition)
 # * update the relevant User object to have the post-graduation email address
-# * update the embargo release date to the user's graduation date plus
-#   their requested embargo length
+# * update the embargo release date to the user's graduation date plus their requested embargo length
+# * expire the embargo if it has already passed (sometimes happens when graduation is delayed)
 # * send notifications
-describe GraduationJob, integration: true do
-  context "a student with a requested embargo", :perform_jobs do
-    let(:workflow)    { WorkflowSetup.new("#{fixture_path}/config/emory/superusers.yml", "#{fixture_path}/config/emory/candler_admin_sets.yml", "/dev/null") }
+describe GraduationJob, :perform_jobs, integration: true do
+  context "standard cases" do
     let(:user)        { FactoryBot.create(:user) }
     let(:ability)     { ::Ability.new(user) }
-    let(:for_embargo) { Hyrax::Actors::Environment.new(Etd.new, ability, attributes) }
-    let(:attributes)  {
+    let(:for_embargo) { Hyrax::Actors::Environment.new(Etd.new, ability, attributes.merge(embargo)) }
+    let(:no_embargo)  { Hyrax::Actors::Environment.new(Etd.new, ability, attributes.merge(open_access)) }
+    let(:open)        { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC }
+    let(:restricted)  { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE }
+    let(:attributes) {
       Hash[
         title: ['The Adventures of Cottontail Rabbit'],
         depositor: user.user_key,
         post_graduation_email: ['me@after.graduation.com'],
         creator: ['Quest, June'],
         school: ["Candler School of Theology"],
         department: ["Divinity"],
+        uploaded_files: [FactoryBot.create(:primary_uploaded_file, user_id: user.id).id]
+      ]
+    }
+    let(:embargo) {
+      Hash[
         files_embargoed: true,
         abstract_embargoed: true,
         toc_embargoed: true,
-        embargo_length: '6 months',
-        uploaded_files: [file.id]
+        embargo_length: '6 months'
       ]
     }
-    let(:six_years_from_today) { Time.zone.today + 6.years }
-    let(:file)        { FactoryBot.create :primary_uploaded_file, user_id: user.id }
-    let(:open)        { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC }
-    let(:restricted)  { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE }
+    let(:open_access) {
+      Hash[
+        files_embargoed: false,
+        abstract_embargoed: false,
+        toc_embargoed: false,
+        embargo_length: InProgressEtd::NO_EMBARGO
+      ]
+    }
+
+    before :all do
+      WorkflowSetup.new("#{fixture_path}/config/emory/superusers.yml", "#{fixture_path}/config/emory/candler_admin_sets.yml", "/dev/null").setup
+    end
 
     before do
-      workflow.setup
       allow(Hyrax::Workflow::DegreeAwardedNotification).to receive(:send_notification)
       ActiveJob::Base.queue_adapter.filter = [AttachFilesToWorkJob]
-      Hyrax::CurationConcern.actor.create(for_embargo)
-      @etd_with_embargo_requested = for_embargo.curation_concern.id
     end
 
-    it "performs the graduation process" do
+    let(:eight_months_ago)     { 8.months.ago.beginning_of_day }
+    let(:two_months_ago)       { eight_months_ago + 6.months }
+    let(:one_month_ago)        { 1.month.ago.beginning_of_day }
+    let(:five_months_from_now) { one_month_ago + 6.months }
+    let(:six_years_from_today) { 6.years.from_now.beginning_of_day }
+
+    it "handles ETDs with embargos expiring in the future", :aggregate_failures do
       # Before the GraduationJob is run
-      etd = Etd.find(@etd_with_embargo_requested)
+      Hyrax::CurationConcern.actor.create(for_embargo)
+      id = for_embargo.curation_concern.id
+      etd = Etd.find(id)
       expect(etd.degree_awarded).to eq nil
       expect(etd.embargo.embargo_release_date).to eq six_years_from_today
       expect(etd.embargo_length).to eq "6 months"
@@ -53,12 +72,14 @@
       expect(etd.file_sets.first)
         .to have_attributes visibility: restricted
       graduation_job = described_class.new
-      graduation_job.perform(etd.id, Time.zone.tomorrow)
+      graduation_job.perform(etd.id, one_month_ago)
       etd.reload
 
       # After the GraduationJob is run
       # The ETD should now have a degree_awarded date
-      expect(etd.degree_awarded).to eq Time.zone.tomorrow
+      # The degree awarded date will always be in the past
+      # because of how the Registrar data is produced
+      expect(etd.degree_awarded).to eq one_month_ago
 
       # An object must be "published" and "active" to be publicly visible
       expect(etd.to_sipity_entity.workflow_state_name).to eq "published"
@@ -70,8 +91,9 @@
 
       # The embargo_release_date of the ETD and any attached files should now
       # equal the user's graduation date plus the requested embargo length
-      expect(etd.embargo.embargo_release_date).to eq Time.zone.tomorrow + 6.months
-      expect(etd.file_sets.first.embargo.embargo_release_date).to eq Time.zone.tomorrow + 6.months
+      # i.e. one month ago + 6 months = 5 months from now
+      expect(etd.embargo.embargo_release_date).to eq five_months_from_now
+      expect(etd.file_sets.first.embargo.embargo_release_date).to eq five_months_from_now
 
       # Attached files should be restricted during the embargo period
       expect(etd.file_sets.first).to have_attributes visibility: restricted
@@ -83,5 +105,44 @@
       # Notifications have been sent that the degree was awarded and the ETD was published
       expect(Hyrax::Workflow::DegreeAwardedNotification).to have_received(:send_notification)
     end
+
+    it "handles ETDs with embargos ending before the job run", :aggregate_failures do
+      Hyrax::CurationConcern.actor.create(for_embargo)
+      etd_id = for_embargo.curation_concern.id
+      graduation_job = described_class.new
+      graduation_job.perform(etd_id, eight_months_ago)
+
+      etd = Etd.find(etd_id)
+      expect(etd.degree_awarded).to eq eight_months_ago
+      expect(etd.embargo_length).to eq "6 months"
+      expect(etd.to_sipity_entity.workflow_state_name).to eq "published"
+      expect(etd.state).to eq Vocab::FedoraResourceStatus.active
+
+      # The embargo should be deactivated (embargo_release_date = nil) and
+      # The embargo history should list the embargo_release_date of the expired embargo
+      # i.e. 8 months ago + 6 months = 2 months ago
+      expect(etd.embargo.embargo_history.last).to include two_months_ago.strftime('%Y-%m-%d')
+
+      # Embargo should be expired and attached files should be visible
+      expect(etd.file_sets.first.embargo.embargo_history.last).to include two_months_ago.strftime('%Y-%m-%d')
+      expect(etd.file_sets.first).to have_attributes visibility: open
+    end
+
+    it "handles ETDs without embargos", :aggregate_failures do
+      Hyrax::CurationConcern.actor.create(no_embargo)
+      etd_id = no_embargo.curation_concern.id
+      graduation_job = described_class.new
+      graduation_job.perform(etd_id, one_month_ago)
+
+      etd = Etd.find(etd_id)
+      expect(etd.degree_awarded).to eq one_month_ago
+      expect(etd.to_sipity_entity.workflow_state_name).to eq "published"
+      expect(etd.state).to eq Vocab::FedoraResourceStatus.active
+      expect(etd.file_sets.first).to have_attributes visibility: open
+      expect(etd.embargo_length).to eq "None - open access immediately" # i.e. InProgressEtd::NO_EMBARGO
+
+      # The etd should not have an embargo
+      expect(etd.embargo).to be_nil
+    end
   end
 end