Spawn a background export job when a new export is created

.rubocop.yml

@@ -26,6 +26,10 @@ RSpec/MessageChain:
 RSpec/MultipleExpectations:
   Enabled: false
 
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/services/grocer/export_object_spec.rb'
+
 Style/Documentation:
   Enabled: false
 

README.md

@@ -1,2 +1,81 @@
 # grocer
 Backup manager for Fedora's produce.
+
+## Installation
+
+* Add Grocer to your Gemfile
+
+   ```
+   gem 'grocer', github: 'pulibrary/grocer'
+   ```
+
+* Then run the Grocer installation
+
+   ```
+   bundle install
+   rails g grocer:install
+   rake db:migrate
+   ```
+
+* If your application is based on CurationConcerns 2.0 or Hyrax, you can trigger a Grocer export on
+  workflow changes by adding this service call to an action:
+
+   ```
+   "methods": ["Grocer::ExportObject"]
+   ```
+
+and then reloading your workflow:
+
+   ```
+   rake curation_concerns:workflow:load
+   ```
+
+
+## Configuration
+
+To configure Grocer's behavior, you can add an initializer:
+
+```
+Grocer.configure do |conf|
+  conf.export_dir = ENV['GROCER_EXPORT_DIR'] || Rails.root.join('tmp', 'export')
+end
+```
+
+The available configuration options are:
+
+* `baseurl`: Fedora base URL, defaults to using ActiveFedora settings
+
+* `export_dir`: Base directory to export resources to, defaults to `/pub/export`
+
+* `metadata_template`: YAML file defining Bag metadata, defaults to `[export_dir]/metadata.yml`
+
+* `jar`: Import/Export Java JAR file, defaults to `[export_dir]/export.jar`
+
+* `predicates`: Comma-separated list of membership predicates to follow when retrieving a resources,
+   defaults to `pcdm:hasMember,ldp:contains`
+
+See the [Fedora Import/Export README](https://github.com/fcrepo4-labs/fcrepo-import-export) for more 
+information about BagIt metadata, membership predicates, and the Import/Export tool in general.
+
+## Required files
+
+You must create two files required by the import/export tool:
+
+* The Import/Export JAR file, which can be downloaded from the [Import/Export releases]
+(https://github.com/fcrepo4-labs/fcrepo-import-export/releases).
+
+* A Bag metadata config file, such as:
+
+   ```
+   bag-info.txt:
+     Source-Organization: York University Libraries
+     Organization-Address: 4700 Keele Street Toronto, Ontario M3J 1P3 Canada
+     Contact-Name: Nick Ruest
+     Contact-Phone: +14167362100
+     Contact-Email: ruestn@yorku.ca
+     External-Description: Sample bag exported from fcrepo
+     External-Identifier: SAMPLE_001
+     Bag-Group-Identifier: SAMPLE
+     Internal-Sender-Identifier: SAMPLE_001
+     Internal-Sender-Description: Sample bag exported from fcrepo
+   ```

app/controllers/grocer/exports_controller.rb

@@ -21,6 +21,7 @@ def create
       @export = Export.new(export_params)
 
       if @export.save
+        Grocer::ExportJob.perform_later(@export.pid, @export.ark)
         redirect_to @export, notice: 'Export was successfully created.'
       else
         render :new
@@ -37,7 +38,7 @@ def set_export
     # Only allow a trusted parameter "white list" through.
     def export_params
       params.require(:export).permit(:pid, :job, :status, :last_error, :last_success, :logfile,
-                                     :page)
+                                     :page, :ark)
     end
 
     def page

app/jobs/grocer/export_job.rb

@@ -33,7 +33,7 @@ def export(pid, url, dir, ark = nil)
         log ? export.error!(log.path) : export.success!
       end
     ensure
-      File.delete(meta.path)
+      File.delete(meta.path) if meta
     end
 
     def monitor_process(out, wait_thread)

app/services/grocer/export_object.rb

@@ -0,0 +1,8 @@
+module Grocer
+  class ExportObject
+    def self.call(target:, user: nil, comment: nil)
+      Rails.logger.info "Exporting #{target.id}, user: #{user}, comment: #{comment}"
+      Grocer::ExportJob.perform_later(target.id, target.identifier)
+    end
+  end
+end

config/routes.rb

@@ -1,4 +1,3 @@
 Grocer::Engine.routes.draw do
   resources :exports, only: [:create, :index, :new, :show]
-  root to: 'exports#index'
 end

db/migrate/20170124154627_add_ark_to_grocer_exports.rb

@@ -0,0 +1,5 @@
+class AddArkToGrocerExports < ActiveRecord::Migration[5.0]
+  def change
+    add_column :grocer_exports, :ark, :string
+  end
+end

spec/controllers/grocer/exports_controller_spec.rb

@@ -34,18 +34,21 @@
   describe 'POST #create' do
     context 'with valid params' do
       it 'creates a new Grocer::Export' do
+        allow(Grocer::ExportJob).to receive(:perform_later).with('pid4', 'ark4')
         expect do
-          post :create, params: { export: { pid: 'pid4' } }, session: valid_session
+          post :create, params: { export: { pid: 'pid4', ark: 'ark4' } }, session: valid_session
         end.to change(Grocer::Export, :count).by(1)
       end
 
       it 'assigns a newly created export as @export' do
+        allow(Grocer::ExportJob).to receive(:perform_later)
         post :create, params: { export: { pid: 'pid5' } }, session: valid_session
         expect(assigns(:export)).to be_a(Grocer::Export)
         expect(assigns(:export)).to be_persisted
       end
 
       it 'redirects to the created export' do
+        allow(Grocer::ExportJob).to receive(:perform_later)
         post :create, params: { export: { pid: 'pid6' } }, session: valid_session
         expect(response).to redirect_to(Grocer::Export.last)
       end

spec/services/grocer/export_object_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe Grocer::ExportObject do
+  let(:obj) { double('object', id: 'obj1', identifier: 'ark:/12345/x12345678x') }
+  let(:job) { class_double(Grocer::ExportJob).as_stubbed_const }
+
+  before do
+    allow(job).to receive(:perform_later)
+  end
+
+  it 'triggers an export job' do
+    described_class.call(target: obj)
+    expect(job).to have_received(:perform_later).with('obj1', 'ark:/12345/x12345678x')
+  end
+end