hyrax-doi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0263fd4d11d35e30f48410437354a6604f0726ddfeb13791062faf174c85d81
-  data.tar.gz: 7db8943b4fa0b9960572ad3dba14f4f6bb069af024338033b5260ba74aac4450
+  metadata.gz: 12db48742cfe4714f719f444954e9cfdf217a6ad9e66edc941a19043ebfc68c6
+  data.tar.gz: 1a3a56a08ec0c8f41217133e810bb307e690eb78cdc122a6871ca1d068bbc13e
 SHA512:
-  metadata.gz: 69950241eb6d5511544d937cd87cdb94351ec171ebc94e7ad6f4dc91a16cd95be5263dea80d366ff431c6e79ba47bc28fd0b89e435078d8d199fc5caa8f7d2eb
-  data.tar.gz: 789ac23699e1a9476c215350d1abef88dcf0fd5c596e2c7e76974d442fc4065d44ea9f0d8e26a895401635d93a5eb06f5bdc5b084189dfdd14702dff247b1266
+  metadata.gz: 40c3448c22706056a7d385fe078ce0f4257baed5eab6acb664b7b2ce7d10c3d05c45c9fe15925e8c675fdfe357fb5b318cd120b3621fb6759f9c4b994122f5ce
+  data.tar.gz: ee71b4f0ba50177bddf6c96698dad279b52fac0b71bb11d37c0f967157170ad09f36f681c3f4c494e93357f4cb99329b706988f6a336eebc5215824941b1b666

data/README.md

@@ -10,6 +10,27 @@ Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
 
 Hyrax-doi is a Hyrax plugin that provides tools for working with DOIs including model attributes, minting, and fetching descriptive metadata.
 
+## Features
+### DOI Creation and Updating
+DOIs are created and updated when a work of a DOI-enabled work type is saved.  This happens in a background job using the [external identifier interface](https://github.com/samvera/hyrax/pull/4458) provided by Hyrax.
+
+>Note: At this point only functionality for registering DOIs wtih DataCite is implemented but other registrars should be also be possible.
+
+#### Draft DOI Creation (DataCite)
+The deposit form has a button for creating a draft DOI without requiring submitting the form.  This is useful if you need to know the DOI and embed it in the uploaded file(s).
+
+#### DOI Status Support (DataCite)
+The uploader is allowed to choose the DOI status (draft, registered, findable) they want for the work when it becomes public.  If findable is chosen the DOI will remain as registered until the work become public.
+
+#### Form Validation (DataCite)
+Hyrax-doi will provide defaults or placeholders for fields which Hyrax doesn't require but which are mandatory for DataCite.  In this case the uploader will be notified of the missing fields and given the opportunity of filling them in before submittign or of continuing with the defaults. 
+
+### Form autofilling
+When submitting a work with an existing DOI (like a scholarly article), the uploader can fill in the DOI and click a button to autofill the deposit form with metadata from the DOI.  This is not limited to DataCite and works with DOIs from a variety of registrars (DataCite, CrossRef, JaLC, ISTIC, , etc.)
+
+### Metadata Crosswalking
+DOI submission and form autofilling happens by crosswalking the work's metadata with DataCite's schema through the [bolognese gem](https://github.com/datacite/bolognese) which enables crosswalking with a number of metadata formats besides those required by DOI registars including RIS, BibTeX, Crosscite, and Schema.org.
+
 ## Compatibilty
 Hyrax-doi is compatible with Hyrax 2.9+ and tested with a [Hyrax 2.9.0 test application](https://github.com/ubiquitypress/hyrax_test_app) that mirrors the generated app used by Hyrax internally for testing.
 
@@ -25,21 +46,49 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install hyrax-doi
+Then run the install generator
+```
+rails g hyrax:doi:install
+```
+Use the `--datacite` flag if working with DataCite DOIs:
+```
+rails g hyrax:doi:install --datacite
 ```
 
 ## Usage
 
-### Setup work type for hyrax-doi
+### Enable DOI functionality for a work type
 Run the generator to add DOI support to a given work type:
 ```
 rails g hyrax:doi:add_to_work_type MyWorkType
 ```
+Add the `--datacite` flag if creating DataCite DOIs:
+```
+rails g hyrax:doi:add_to_work_type MyWorkType --datacite
+```
+
+### Configuration
+After the install generator is run, Hyrax-doi can be configured in the `config/initializers/hyrax-doi.rb` initializer.
+
+If your application does not already set `host` in `default_url_options`, you will need to configure it for creating full urls to work show pages to be registered with DOIs.
+
+DataCite credentials can either be set in environment variables (DATACITE_PREFIX, DATACITE_USERNAME, and DATACITE_PASSWORD) or set in the initializer.  Hyrax-doi defaults to using DataCite's test environment but can be switched to the production environment by setting the mode:
+```
+Hyrax::DOI::DataCiteRegistrar.mode = :production
+```
+
+### Using with Hyku
+Hyrax-doi is currently implemented for a single-tenant Hyrax application with configuration shared application wide.  Work to support per tenant configuration is under way and will live in its own engine or be contributed directly to Hyku.
 
 ## Development
 
+### Setting up Development Environment
+After checking out the code, initialize the internal hyrax test application:
+```
+git submodule init
+git submodule update
+```
+
 ### Running Rake Tasks and Generators
 When working on this engine rake tasks from Hyku can be run by prepending the `app` namespace (e.g. `rake app:db:migrate`). Generators provided by rails or other gems/engines can be run like normal from this engine's root (e.g. `rails g job UbiquityExporter`).
 

data/app/services/bolognese/readers/hyrax_work_reader.rb

@@ -74,11 +74,10 @@ module Bolognese
       end
 
       def read_hyrax_work_publication_year(meta)
-        # FIXME: better parsing of free text dates...maybe using EDTF?
         date = meta.fetch("date_created", nil)&.first
         date ||= meta.fetch("date_uploaded", nil)
-        Date.parse(date.to_s).year
-      rescue Date::Error
+        Date.edtf(date.to_s).year
+      rescue StandardError
         Time.zone.today.year
       end
 
@@ -92,6 +91,7 @@ module Bolognese
 
       def read_hyrax_work_publisher(meta)
         # Fallback to ':unav' since this is a required field for datacite
+        # TODO: Should this default to application_name?
         parse_attributes(meta.fetch("publisher")).to_s.strip.presence || ":unav"
       end
     end

data/app/services/bolognese/writers/hyrax_work_writer.rb

@@ -18,7 +18,7 @@ module Bolognese
           'contributor' => contributors&.pluck("name"),
           'publisher' => Array(publisher),
           'date_created' => Array(publication_year),
-          'description' => descriptions&.pluck("description"),
+          'description' => build_hyrax_work_description,
           'keyword' => subjects&.pluck("subject")
         }
         hyrax_work_class = determine_hyrax_work_class
@@ -45,6 +45,11 @@ module Bolognese
       def build_hyrax_work_doi
         Array(doi&.sub('https://doi.org/', ''))
       end
+
+      def build_hyrax_work_description
+        return nil if descriptions.blank?
+        descriptions.pluck("description").map { |d| Array(d).join("\n") }
+      end
     end
   end
 end

data/app/views/hyrax/base/_form_doi.html.erb

@@ -1,20 +1,31 @@
+<%# TODO: determine these from actual DataCite data instead of the intention field stored in fedora %>
+<% disable_do_not_mint = @curation_concern.doi_status_when_public != nil %>
+<% disable_draft = @curation_concern.doi_status_when_public.in?(['registered','findable']) %>
+
 <div>
-  <%# TODO: Make this appear as singular %>
-  <%= render_edit_field_partial('doi', f: f) %>
+  <%# Render DOI input as a single field even though it is stored as multivalued %>
+  <%= f.input :doi, input_html: { value: @curation_concern.doi.first,
+                                  name: "#{f.object.model_name.param_key}[doi][]",
+                                  style: "max-width: 40em" } %>
 
-  <%= link_to "Create draft DOI",
-              Hyrax::DOI::Engine.routes.url_helpers.create_draft_doi_path,
-              remote: true,
-              method: :get,
-              data: {
-                disable_with: "Creating draft DOI...",
-                params: {
-                  curation_concern: curation_concern.class.name.underscore,
-                  attribute: 'doi'
-                }
-              },
-              class: 'btn btn-default',
-              id: 'doi-create-draft-btn' %>
+  <%# Only show an actionable button if the work doesn't have a DOI already %>
+  <% if @curation_concern.doi.blank? %>
+    <%= link_to "Create draft DOI",
+                Hyrax::DOI::Engine.routes.url_helpers.create_draft_doi_path,
+                remote: true,
+                method: :get,
+                data: {
+                  disable_with: "Creating draft DOI...",
+                  params: {
+                    curation_concern: @curation_concern.class.name.underscore,
+                    attribute: 'doi'
+                  }
+                },
+                class: 'btn btn-default',
+                id: 'doi-create-draft-btn' %>
+  <% else %>
+    <div id='doi-create-draft-btn' class='btn btn-default' disabled>Create draft DOI</div>
+  <% end %>
 
   <%= link_to "Autofill form",
               Hyrax::DOI::Engine.routes.url_helpers.autofill_path,
@@ -35,11 +46,11 @@
 
     <div class="form-group" style="margin-left: 20px">
       <label class="radio" style="font-weight: normal">
-        <%= f.radio_button :doi_status_when_public, '', style: 'margin-top: 0px;' %>
+        <%= f.radio_button :doi_status_when_public, '', disabled: disable_do_not_mint, style: 'margin-top: 0px;' %>
         Do not mint
       </label>
       <label class="radio" style="font-weight: normal">
-        <%= f.radio_button :doi_status_when_public, 'draft', style: 'margin-top: 0px;' %>
+        <%= f.radio_button :doi_status_when_public, 'draft', disabled: disable_draft, style: 'margin-top: 0px;' %>
         Draft
       </label>
       <label class="radio" style="font-weight: normal">
@@ -70,4 +81,29 @@
   $("#doi-autofill-btn").on("ajax:error", function(e, xhr, status, error) {
     alert(xhr.responseText);
   });
+
+  // Force the user to confirm using fallback defaults when DataCite mandatory fields
+  // not filled in on the deposit form.  This only applies when the DOI is set to become
+  // registered or findable.  Let drafts be drafts.
+  document.getElementById('with_files_submit').addEventListener("click", function(event){
+    if (["findable", "registered"].indexOf(document.querySelector('input[name="generic_work[doi_status_when_public]"]:checked').value) < 0)
+      return;
+
+    const empty_fields = [];
+    if (document.querySelector('.generic_work_title .form-control').value == "")
+      empty_fields.push("Title")
+    if (document.querySelector('.generic_work_creator .form-control').value == "")
+      empty_fields.push("Creator")
+    if (document.querySelector('.generic_work_publisher .form-control').value == "")
+      empty_fields.push("Publisher")
+    if (document.querySelector('.generic_work_date_created .form-control').value == "")
+      empty_fields.push("Date Created")
+    if (empty_fields.length == 0)
+      return;
+
+    if(!window.confirm("DataCite DOI mandatory fields ("+ empty_fields.join(', ') +") are missing.  Placeholder values will be submitted to DataCite instead.  Do you want to proceed?")){
+      event.preventDefault();
+      event.stopImmediatePropagation();
+    }
+  }, false);
 </script>

data/lib/hyrax/doi/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
   module DOI
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyrax-doi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Colvard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails