bulkrax 1.0.0

data/app/views/bulkrax/exporters/show.html.erb

@@ -0,0 +1,124 @@
+<p id='notice'><%= notice %></p>
+
+<div class='col-xs-12 main-header'>
+  <h1><span class='fa fa-cloud-download' aria-hidden='true'></span> Exporter: <%= @exporter.name %></h1>
+</div>
+
+<div class='panel panel-default'>
+  <div class='panel-body'>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.name') %>:</strong>
+      <%= @exporter.name %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.user') %>:</strong>
+      <%= @exporter.user %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.export_type') %>:</strong>
+      <%= @exporter.export_type %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.export_from') %>:</strong>
+      <%= @exporter.export_from %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.export_source') %>:</strong>
+      <% case @exporter.export_from %>
+      <% when 'collection' %>
+        <% collection = Collection.find(@exporter.export_source) %>
+        <%= link_to collection&.title&.first, hyrax.dashboard_collection_path(collection.id) %>
+      <% when 'importer' %>
+        <% importer = Bulkrax::Importer.find(@exporter.export_source) %>
+        <%= link_to importer.name, bulkrax.importer_path(importer.id) %>
+      <% when 'worktype' %>
+        <%= @exporter.export_source %>
+      <% end %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.parser_klass') %>:</strong>
+      <%= @exporter.parser_klass %>
+    </p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.limit') %>:</strong>
+      <%= @exporter.limit %>
+    </p>
+
+  <%= render partial: 'bulkrax/shared/bulkrax_field_mapping', locals: {item: @exporter} %>
+
+    <%# Currently, no parser-specific fields exist on Exporter,
+        thus there's no real reason to always show this field %>
+    <% if @exporter.parser_fields.present? %>
+      <p class='bulkrax-p-align'>
+        <strong><%= t('bulkrax.exporter.labels.parser_fields') %>:</strong><br>
+        <% @exporter.parser_fields.each do |k, v| %>
+          <%= k %>: <%= v %><br>
+        <% end %>
+      </p>
+    <% end %>
+
+    <p class='bulkrax-p-align'><strong><%= t('bulkrax.exporter.labels.field_mapping') %>:</strong></p>
+
+    <p class='bulkrax-p-align'>
+      <strong><%= t('bulkrax.exporter.labels.total_work_entries') %>:</strong>
+      <%= @exporter.exporter_runs.last&.total_work_entries %>
+    </p>
+    <br>
+    <div class="bulkrax-nav-tab-table-left-align">
+      <h2>Entries</h2>
+      <table class='table table-striped'>
+        <thead>
+          <tr>
+            <th>Identifier</th>
+            <th>Collection</th>
+            <th>Entry ID</th>
+            <th>Status</th>
+            <th>Errors</th>
+            <th>Status Set At</th>
+            <th>Actions</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @work_entries.each do |e| %>
+            <tr>
+              <td><%= link_to e.identifier, bulkrax.exporter_entry_path(@exporter.id, e.id) %></td>
+              <% if e.parsed_metadata.present? && e.parsed_metadata.dig('collections').present? %>
+                <td><%= e.parsed_metadata.dig('collections').map {|c| c['id'] }.join('; ') %></td>
+              <% elsif e.raw_metadata.present? %>
+                <td><%= Array.wrap(e.raw_metadata.dig('collection')).join(';') %></td>
+              <% else %>
+              <td></td>
+              <% end %>
+              <td><%= e.id %></td>
+              <% if e.status == 'Complete' %>
+                <td><span class='glyphicon glyphicon-ok' style='color: green;'></span> <%= e.status %></td>
+                <% else %>
+                <td><span class='glyphicon glyphicon-remove' style='color: red;'></span> <%= e.status %></td>
+              <% end %>
+              <% if e.last_error.present? %>
+                <td><%= link_to e.last_error.dig('error_class'), bulkrax.exporter_entry_path(@exporter.id, e.id) %></td>
+              <% else %>
+                <td></td>
+              <% end %>
+              <td><%= e.status_at %></td>
+              <td><%= link_to raw("<span class='glyphicon glyphicon-info-sign'></span>"), bulkrax.exporter_entry_path(@exporter.id, e.id) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+      <%= page_entries_info(@work_entries) %><br>
+      <%= paginate(@work_entries, param_name: :work_entries_page) %>
+      <br>
+      <%= link_to 'Edit', edit_exporter_path(@exporter) %>
+      |
+      <%= link_to 'Back', exporters_path %>
+    </div>
+  </div>
+</div>

data/app/views/bulkrax/importers/_bagit_fields.html.erb

@@ -0,0 +1,54 @@
+<div class='bagit_fields'>
+
+  <%#= fi.input :metadata_type, 
+    collection:  importer.import_metadata_type, 
+    selected: importer.parser_fields['metadata_type'],
+    include_blank: true,
+    input_html: { class: 'form-control' }
+    %>
+  <%= fi.input :metadata_file_name, as: :string, input_html: { value: importer.parser_fields['metadata_file_name'] } %>
+
+  <%= fi.input :metadata_format, 
+    collection:  importer.import_metadata_format, 
+    selected: importer.parser_fields['metadata_format'],
+    include_blank: true,
+    input_html: { class: 'form-control' }
+    %>
+
+  <%= fi.input :visibility,
+    collection: [
+      ['Public', 'open'],
+      ['Private', 'restricted']
+    ],
+    selected: importer.parser_fields['visibility'] || 'open',
+    input_html: { class: 'form-control' }
+  %>
+
+  <% rights_statements = Hyrax.config.rights_statement_service_class.new %>
+  <%= fi.input :rights_statement,
+        collection: rights_statements.select_active_options,
+        selected: importer.parser_fields['rights_statement'],
+        include_blank: true,
+        item_helper: rights_statements.method(:include_current_value),
+        input_html: { class: 'form-control' } ,
+        required: false
+        %>
+  <%= fi.input :override_rights_statement, as: :boolean, hint: 'If checked, always use the selected rights statment. If unchecked, use rights or rights_statement from the record and only use the provided value if dc:rights is blank.', input_html: { checked: (importer.parser_fields['override_rights_statement'] == "1") } %>
+
+  <h4>Bag or Bags to Import:</h4>
+  <p>File upload and Cloud File upload must be a Zip file containing a single BagIt Bag, or a folder containing multiple BagIt Bags.</p>
+  <p>The Server Path can point to a BagIt Bag, a folder containing BagIt Bags, or a zip file containing either.</p>
+
+  <%= fi.input :file_style, collection: ['Upload a File', 'Specify a Path on the Server', 'Add Cloud File'], as: :radio_buttons, label: false %>
+  <div id='file_upload'>
+    <%= fi.input 'file', as: :file, input_html: {accept: 'application/zip'} %><br />
+  </div>
+  <div id='file_path'>
+    <%= fi.input :import_file_path, as: :string, input_html: { value: importer.parser_fields['import_file_path'] } %>
+  </div>
+  <div id='cloud'>
+    <% if Hyrax.config.browse_everything? %>
+      <%= render 'browse_everything', form: form %>
+    <% end %>
+  </div>
+</div>

data/app/views/bulkrax/importers/_browse_everything.html.erb

@@ -0,0 +1,12 @@
+
+<%
+	f = "#{form.lookup_action}_importer"
+	f = "#{f}_#{@importer.id}" unless @importer.new_record?
+%>
+<div id='cloud-files'> 
+	<button type="button" data-toggle="browse-everything" data-route="<%=browse_everything_engine.root_path%>"
+		data-target="#<%= f %>" class="btn btn-primary" id="browse">
+		<span class="glyphicon glyphicon-plus"></span>
+		Add Cloud Files
+	</button>
+</div>

data/app/views/bulkrax/importers/_csv_fields.html.erb

@@ -0,0 +1,39 @@
+<div class='csv_fields'>
+
+  <%= fi.input :visibility,
+    collection: [
+      ['Public', 'open'],
+      ['Private', 'restricted']
+    ],
+    selected: importer.parser_fields['visibility'] || 'open',
+    input_html: { class: 'form-control' }
+  %>
+
+  <% rights_statements = Hyrax.config.rights_statement_service_class.new %>
+  <%= fi.input :rights_statement,
+        collection: rights_statements.select_active_options,
+        selected: importer.parser_fields['rights_statement'],
+        include_blank: true,
+        item_helper: rights_statements.method(:include_current_value),
+        input_html: { class: 'form-control' },
+        required: false
+        %>
+  <%= fi.input :override_rights_statement, as: :boolean, hint: 'If checked, always use the selected rights statment. If unchecked, use rights or rights_statement from the record and only use the provided value if dc:rights is blank.', input_html: { checked: (importer.parser_fields['override_rights_statement'] == "1") } %>
+
+  <h4>Add CSV File to Import:</h4>
+  <%# accept a single file upload; data files and bags will need to be added another way %>
+
+  <%= fi.input :file_style, collection: ['Upload a File', 'Specify a Path on the Server'], as: :radio_buttons, label: false %>
+  <div id='file_upload'>
+    <%= fi.input 'file', as: :file, input_html: { accept: 'text/csv,application/zip' } %><br />
+  </div>
+  <div id='file_path'>
+    <%= fi.input :import_file_path, as: :string, input_html: { value: importer.parser_fields['import_file_path'] } %>
+  </div>
+  <% if Hyrax.config.browse_everything? %>
+	  <h4>Add Files to Import:</h4>
+	  <p>Choose files to upload. The filenames must be unique, and the filenames must be referenced in a column called 'file' in the accompanying CSV file.</p>
+    <%= render 'browse_everything', form: form %>
+  <% end %>
+  <br />
+</div>

data/app/views/bulkrax/importers/_edit_form_buttons.html.erb

@@ -0,0 +1,16 @@
+
+<%# If we can know the parser, we can vary the buttons here %>
+
+<% if @importer.importer_runs.blank? %>
+	<%= form.button :submit, value: 'Update Importer', class: 'btn btn-primary' %>
+	| <%= form.button :submit, value: 'Update and Import (importer has not yet been run)', class: 'btn btn-primary' %>
+<% elsif @importer.parser_klass.include?('Oai') %> 
+	<%= form.button :submit, value: 'Update Importer', class: 'btn btn-primary' %>
+	| <%= form.button :submit, value: 'Update and Harvest Updated Items', class: 'btn btn-primary' %>
+	| <%= form.button :submit, value: 'Update and Re-Harvest All Items', class: 'btn btn-primary' %>
+<% else %>
+	<%= form.button :submit, value: 'Update Importer', class: 'btn btn-primary' %>
+	| <%= form.button :submit, value: 'Update and Re-Import (update metadata only)', class: 'btn btn-primary' %>
+  | <%= form.button :submit, value: 'Update All (update metadata and update files)', class: 'btn btn-primary' %>
+	| <%= form.button :submit, value: 'Update and Re-Import (update metadata and replace files)', class: 'btn btn-primary', data: {confirm: "Are you sure? This will remove all files before adding them from the import."} %>
+<% end %>

data/app/views/bulkrax/importers/_form.html.erb

@@ -0,0 +1,35 @@
+<div class="panel-body">
+  <% if importer.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(importer.errors.count, "error") %> prohibited this importer from being saved:</h2>
+
+      <ul>
+        <% importer.errors.full_messages.each do |message| %>
+          <li><%= message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <%= form.input :name %>
+
+  <%= form.input :admin_set_id, collection: available_admin_sets %>
+
+  <%= form.hidden_field :user_id, value: current_user.id %>
+
+  <%= form.input :frequency, collection: form.object.class.frequency_enums %>
+
+  <%= form.input :limit, as: :integer, hint: 'leave blank or 0 for all records' %>
+
+  <%= form.input :parser_klass, collection: Bulkrax.parsers.map {|p| [p[:name], p[:class_name], {'data-partial' => p[:partial]}]}, label: "Parser" %>
+
+  <%= form.fields_for :parser_fields do |fi| %>
+    <div class='parser_fields'>
+      <p>Specific fields for each parser are available only when a parser is selected</p>
+      <% Bulkrax.parsers.map {|p| p[:partial]}.uniq.each do |partial| %>
+        <%= render partial: partial, locals: {form: form, fi: fi, importer: importer} %>
+      <% end %>
+    </div>
+  <% end %>
+
+</div>

data/app/views/bulkrax/importers/_oai_fields.html.erb

@@ -0,0 +1,42 @@
+<div class='oai_fields'>
+  <%= fi.input :base_url, as: :string, input_html: { value: importer.parser_fields['base_url'] } %>
+  
+  <%= fi.input :metadata_prefix, as: :string, hint: 'Such as oai_dc, dcterms or oai_qdc', input_html: { value: importer.parser_fields['metadata_prefix'] } %>
+  
+  <%= fi.input :set, collection: [importer.parser_fields['set']], label: 'Set (source)', selected: importer.parser_fields['set'] %>
+  <button type="button" class="btn btn-default refresh-set-source">Refresh Sets</button>
+
+  <%= fi.input :visibility,
+    collection: [
+      ['Public', 'open'],
+      ['Private', 'restricted']
+    ],
+    selected: importer.parser_fields['visibility'] || 'open',
+    input_html: { class: 'form-control' }
+  %>
+
+  <% rights_statements = Hyrax.config.rights_statement_service_class.new %>
+  <%= fi.input :rights_statement,
+        collection: rights_statements.select_active_options,
+        selected: importer.parser_fields['rights_statement'],
+        include_blank: true,
+        item_helper: rights_statements.method(:include_current_value),
+        input_html: { class: 'form-control' },
+        required: false
+        %>
+  <%= fi.input :override_rights_statement, as: :boolean, hint: 'If checked, always use the selected rights statment. If unchecked, use dc:rights from the record and only use the provided value if dc:rights is blank.', input_html: { checked: (importer.parser_fields['override_rights_statement'] == "1") } %>
+  <%= fi.input :thumbnail_url, required: false, as: :string, input_html: { value: importer.parser_fields['thumbnail_url'] } %>
+  <div class="help-block well well-sm">
+    <p>
+      The Thumbnail URL allows for basic templating and substitution on any identified information in to the url. For example:
+    </p>
+
+    <p>
+      http://commons.ptsem.edu/?cover=<&#37= identifier.split(':').last &#37>&size=L
+    </p>
+
+    <p>
+      http://commons.ptsem.edu/?cover=<&#37= record.header.identifier.split(':').last &#37>&size=L
+    </p>
+  </div>
+</div>

data/app/views/bulkrax/importers/_xml_fields.html.erb

@@ -0,0 +1,60 @@
+<div class='xml_fields'>
+
+  <%# @todo improve on this implementation. 
+    As it stands, it's a hostage to namespaces, 
+    eg. dc:title 
+    if namespaces aren't in the xml, we would have to specify dc:title
+    but if the namespaces ARE present, we remove them so we would need title
+  %>
+  <%= fi.input :record_element, 
+    hint: 'Provide the xml element name to use to identify the record, or records, eg. ROW - each record in the attached XML is wrapped in a <ROW> tag.', 
+    input_html: { value: importer.parser_fields['record_element'] }
+    %>
+
+  <%= fi.input :import_type, 
+		collection: [
+      ['Single Work per Metadata File', 'single'],
+			['Multiple Works per Metadata File', 'multiple'] 
+		], 
+    selected: importer.parser_fields['import_type'],
+    input_html: { class: 'form-control' }
+    %>
+  
+  <h4>Visiblity</h4>
+
+  <%= fi.input :visibility,
+    collection: [
+      ['Public', 'open'],
+      ['Private', 'restricted']
+    ],
+    selected: importer.parser_fields['visibility'] || 'open',
+    input_html: { class: 'form-control' }
+  %>
+
+  <% rights_statements = Hyrax.config.rights_statement_service_class.new %>
+  <%= fi.input :rights_statement,
+        collection: rights_statements.select_active_options,
+        selected: importer.parser_fields['rights_statement'],
+        include_blank: true,
+        item_helper: rights_statements.method(:include_current_value),
+        input_html: { class: 'form-control' },
+        required: false %>
+  <%= fi.input :override_rights_statement, as: :boolean, hint: 'If checked, always use the selected rights statment. If unchecked, use rights or rights_statement from the record and only use the provided value if dc:rights is blank.', input_html: { checked: (importer.parser_fields['override_rights_statement'] == "1") } %>
+
+  <h4>XML and files to Import:</h4>
+  <p>File upload and Cloud File upload MUST be a either a single XML file (for metadata only import) OR a Zip file containing the XML files and data files, each in a separate folder.</p>
+  <p>The Server Path can point to a folder containing XML files and data files to import, or direct to the XML file itself.</p>
+
+  <%= fi.input :file_style, collection: ['Upload a File', 'Specify a Path on the Server', 'Add Cloud File'], as: :radio_buttons, label: false %>
+  <div id='file_upload'>
+    <%= fi.input 'file', as: :file, input_html: {accept: ['application/zip', 'application/xml']} %><br />
+  </div>
+  <div id='file_path'>
+    <%= fi.input :import_file_path, as: :string, input_html: { value: importer.parser_fields['import_file_path'] } %>
+  </div>
+  <div id='cloud'>
+    <% if Hyrax.config.browse_everything? %>
+      <%= render 'browse_everything', form: form %>
+    <% end %>
+  </div>
+</div>

data/app/views/bulkrax/importers/edit.html.erb

@@ -0,0 +1,20 @@
+<% provide :page_header do %>
+  <h1><span class="fa fa-edit" aria-hidden="true"></span> Edit Importer</h1>
+<% end %>
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default tabs">
+      <%= simple_form_for @importer, html: { multipart: true } do |form| %>
+        <%= render 'form', importer: @importer, form: form %>
+        <div class="panel-footer">
+          <div class='pull-right'>
+            <%= render 'edit_form_buttons', form: form %>
+           <% cancel_path = form.object.persisted? ? importer_path(form.object) : importers_path %>
+            | <%= link_to t('.cancel'), cancel_path, class: 'btn btn-default ' %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/bulkrax/importers/index.html.erb

@@ -0,0 +1,77 @@
+<% provide :page_header do %>
+  <h1><span class="fa fa-cloud-upload" aria-hidden="true"></span> Importers</h1>
+  <div class="pull-right">
+    <%= link_to new_importer_path, class: 'btn btn-primary' do %>
+      <span class="fa fa-edit" aria-hidden="true"></span> <%= t(:'helpers.action.importer.new') %>
+    <% end %>
+  </div>
+<% end %>
+
+<div class="panel panel-default">
+  <div class="panel-body">
+    <% if @importers.present? %>
+      <div class="table-responsive">
+        <table class="table table-striped datatable">
+          <thead>
+            <tr>
+              <th scope="col">Name</th>
+              <th scope="col">Status</th>
+              <th scope="col">Last Run</th>
+              <th scope="col">Next Run</th>
+              <th scope="col">Entries Enqueued</th>
+              <th scope="col">Entries Processed</th>
+              <th scope="col">Entries Failed</th>
+              <th scope="col">Entries Deleted Upstream</th>
+              <th scope="col">Total Collection Entries</th>
+              <th scope="col">Total Work Entries</th>
+              <th scope="col"></th>
+              <th scope="col"></th>
+              <th scope="col"></th>
+            </tr>
+          </thead>
+          <tbody>
+            <% @importers.each do |importer| %>
+            <tr>
+              <th scope="row"><%= link_to importer.name, importer_path(importer) %></th>
+              <td>
+                <%= importer.status %>
+              </td>
+              <td><%= importer.last_imported_at.strftime("%b %d, %Y") if importer.last_imported_at %></td>
+              <td><%= importer.next_import_at.strftime("%b %d, %Y") if importer.next_import_at %></td>
+              <td><%= importer.importer_runs.last&.enqueued_records %></td>
+              <td><%= (importer.importer_runs.last&.processed_collections || 0) + (importer.importer_runs.last&.processed_records || 0)  %></td>
+              <td><%= (importer.importer_runs.last&.failed_collections || 0) + (importer.importer_runs.last&.failed_records || 0)  %></td>
+              <td><%= importer.importer_runs.last&.deleted_records %></td>
+              <td><%= importer.importer_runs.last&.total_collection_entries %></td>
+              <td><%= importer.importer_runs.last&.total_work_entries %></td>
+              <td><%= link_to raw('<span class="glyphicon glyphicon-info-sign"></span>'), importer_path(importer) %></td>
+              <td><%= link_to raw('<span class="glyphicon glyphicon-pencil"></span>'), edit_importer_path(importer) %></td>
+              <td><%= link_to raw('<span class="glyphicon glyphicon-remove"></span>'), importer, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+            </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+      <% else %>
+        <p>No importers have been created.</p>
+      <% end %>
+  </div>
+</div>
+
+<script>
+  $(function() {
+    $('#DataTables_Table_0').DataTable({
+      destroy: true, /* Reinitialize DataTable with config below */
+      'columnDefs': [
+          { 'orderable': true, 'targets': [...Array(10).keys()] },
+          { 'orderable': false, 'targets': [10, 11, 12] }
+      ],
+      'language': {
+        'info': 'Showing _START_ to _END_ of _TOTAL_ importers',
+        'infoEmpty': 'No importers to show',
+        'infoFiltered': '(filtered from _MAX_ total importers)',
+        'lengthMenu': 'Show _MENU_ importers'
+      }
+    })
+  })
+</script>