hyrax-doi 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0263fd4d11d35e30f48410437354a6604f0726ddfeb13791062faf174c85d81
-  data.tar.gz: 7db8943b4fa0b9960572ad3dba14f4f6bb069af024338033b5260ba74aac4450
+  metadata.gz: 9e91c07abad2fa33a98363ee05c8b3e2bf8c217161226d338e233772fb0941b8
+  data.tar.gz: bbf399c0250b3e073b2c11563d5f21ecf370d80a24eb88df1e1ade1186670946
 SHA512:
-  metadata.gz: 69950241eb6d5511544d937cd87cdb94351ec171ebc94e7ad6f4dc91a16cd95be5263dea80d366ff431c6e79ba47bc28fd0b89e435078d8d199fc5caa8f7d2eb
-  data.tar.gz: 789ac23699e1a9476c215350d1abef88dcf0fd5c596e2c7e76974d442fc4065d44ea9f0d8e26a895401635d93a5eb06f5bdc5b084189dfdd14702dff247b1266
+  metadata.gz: 3e32e969a6e8275ef71adf8a5012231f288b6126cb1ae3f765764fa2ad20217825aed3e8785b885aa9398dd03647f2ddef52f94c304d46b21f6dcf79a37d2410
+  data.tar.gz: 8a96dbf165655b4ceaf0cc79bc085ef1bc63bfaa272b09f21f95ee5f77c219cc66e8032cc9a5756012d714763ade05a53117f3541b443ab072d2d57ad0ed9663

data/README.md

@@ -1,6 +1,6 @@
 # Hyrax::DOI
-Code: [![CircleCI](https://circleci.com/gh/ubiquitypress/hyrax-doi.svg?style=svg)](https://circleci.com/gh/ubiquitypress/hyrax-doi)
-[![Code Climate](https://codeclimate.com/github/ubiquitypress/hyrax-doi/badges/gpa.svg)](https://codeclimate.com/github/ubiquitypress/hyrax-doi)
+Code: [![CircleCI](https://circleci.com/gh/samvera-labs/hyrax-doi.svg?style=svg)](https://circleci.com/gh/samvera-labs/hyrax-doi)
+[![Code Climate](https://codeclimate.com/github/samvera-labs/hyrax-doi/badges/gpa.svg)](https://codeclimate.com/github/samvera-labs/hyrax-doi)
 
 
 Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.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,41 +46,87 @@ 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`).
+When working on this engine rake tasks from Hyrax 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 CheckDOIResolution`).
 
 ### Development Server
 
-To run a development server locally outside of docker do the following with each line in its own shell from the root of the engine:
+To run a development server locally, start the required services using Docker Compose:
 ```
-solr_wrapper -v --config .solr_wrapper.yml
-fcrepo_wrapper -v --config .fcrepo_wrapper.yml
+docker compose up -d
 bundle exec rails server -b 0.0.0.0
 ```
 
+To stop the services:
+```
+docker compose down
+```
+
 ### Testing
 
-Tests are run automatically on CircleCI with rubocop and codeclimate.  These tests must pass before pull requests can be merged.
+Tests are run automatically in CI with rubocop and codeclimate. These tests must pass before pull requests can be merged.
 
-To run the tests locally outside of docker do the following with each line in its own shell from the root of the engine:
+To run the tests locally, start the test services using Docker Compose:
 ```
-solr_wrapper -v --config .solr_wrapper_test.yml
-fcrepo_wrapper -v --config .fcrepo_wrapper_test.yml
+docker compose up -d
+docker compose exec web bash
+cd /app/samvera/hyrax-doi
+bundle
 bundle exec rspec
 ```
-You shouldn't need to run anything from inside `spec/internal_test_hyrax` unless explicitly told to do so.
+
+### Linting
+
+To run the linter locally, start the test services using Docker Compose:
+```
+docker compose up -d
+docker compose exec web bash
+cd /app/samvera/hyrax-doi
+bundle
+bundle exec rubocop
+```
+
+You shouldn't need to run anything from inside `vendor/engines/hyrax` unless explicitly told to do so.

data/Rakefile

@@ -15,7 +15,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("spec/internal_test_hyrax/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path("vendor/engines/hyrax/.dassie/Rakefile", __dir__)
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'

data/app/actors/hyrax/actors/doi_actor.rb

@@ -15,7 +15,9 @@ module Hyrax
     #   env = Hyrax::Actors::Environment.new(object, ability, attributes)
     #   last_actor = Hyrax::Actors::Terminator.new
     #   stack.build(last_actor).create(env)
-    class DOIActor < AbstractActor
+    class DOIActor < BaseActor
+      delegate :destroy, to: :next_actor
+
       ##
       # @return [Boolean]
       #
@@ -30,13 +32,17 @@ module Hyrax
       #
       # @see Hyrax::Actors::AbstractActor
       def update(env)
+        # Ensure that the work has any changed attributes persisted before we create the job
+        apply_save_data_to_curation_concern(env)
+        save(env)
+
         create_or_update_doi(env.curation_concern) && next_actor.update(env)
       end
 
       private
 
       def create_or_update_doi(work)
-        return true unless doi_enabled_work_type?(work)
+        return true unless doi_enabled_work_type?(work) && Flipflop.enabled?(:doi_minting) && valid_public_status?(work)
 
         Hyrax::DOI::RegisterDOIJob.perform_later(work, registrar: work.doi_registrar.presence, registrar_opts: work.doi_registrar_opts)
       end
@@ -45,6 +51,12 @@ module Hyrax
       def doi_enabled_work_type?(work)
         work.class.ancestors.include? Hyrax::DOI::DOIBehavior
       end
+
+      # FIXME: Find a way to push this into the registrar since it is Datacite specific
+      # Check that requested doi_status_when_public is valid
+      def valid_public_status?(work)
+        !work.respond_to?(:doi_status_when_public) || work.doi_status_when_public.in?(Hyrax::DOI::DataCiteRegistrar::STATES)
+      end
     end
   end
 end

data/app/controllers/hyrax/doi/hyrax_doi_controller.rb

@@ -5,11 +5,18 @@ module Hyrax
       before_action :check_authorization
 
       def create_draft_doi
-        draft_doi = mint_draft_doi
+        if Flipflop.enabled?(:doi_minting)
+          draft_doi = mint_draft_doi
 
-        respond_to do |format|
-          format.js { render js: autofill_field(doi_attribute_name, draft_doi), status: :created }
-          format.json { render_json_response(response_type: :created, options: { data: draft_doi }) }
+          respond_to do |format|
+            format.js { render js: autofill_field(doi_attribute_name, draft_doi), status: :created }
+            format.json { render_json_response(response_type: :created, options: { data: draft_doi }) }
+          end
+        else
+          respond_to do |format|
+            format.js { render plain: I18n.t("errors.doi_minting.disabled"), status: :internal_error }
+            format.json { render_json_response(response_type: :internal_error, message: I18n.t("errors.doi_minting.disabled")) }
+          end
         end
       rescue Hyrax::DOI::DataCiteClient::Error => e
         respond_to do |format|
@@ -42,7 +49,11 @@ module Hyrax
 
       def doi_registrar
         # TODO: generalize this
-        Hyrax::Identifier::Registrar.for(:datacite, {})
+        Hyrax::Identifier::Registrar.for(:datacite)
+      end
+
+      def use_sandbox
+        !doi_registrar.mode.equal?(:production)
       end
 
       def field_selector(attribute_name)
@@ -54,36 +65,41 @@ module Hyrax
       end
 
       def hyrax_work_from_doi(doi)
-        meta = Bolognese::Metadata.new(input: doi)
+        # TODO: generalize this
+        meta = Bolognese::Metadata.new(input: doi,
+                                       sandbox: use_sandbox)
         # Check that a record was actually loaded
         raise Hyrax::DOI::NotFoundError, "DOI (#{doi}) could not be found." if meta.blank? || meta.doi.blank?
+        meta.types["hyrax"] = (params['curation_concern'] || 'GenericWork').camelize
         meta.hyrax_work
       end
 
       # TODO: Move this out to a partial that gets rendered?
       def autofill_js(doi)
         # TODO: Need to wipe old data or is this just supplemental?
-        js = hyrax_work_from_doi(doi).attributes.collect { |k, v| autofill_field(k, v) }.reject(&:blank?).join("\n")
+        js = hyrax_work_from_doi(doi).attributes.collect { |k, v| autofill_field(k, v) }.compact_blank.join("\n")
         js << "document.location = '#metadata';"
       end
 
       # TODO: Move this out to a partial that gets rendered?
       def autofill_field(attribute_name, value)
         js = []
+        curation_concern = params[:curation_concern] || 'generic_work'
         # TODO: add error handling in the JS so an error doesn't leave the autofilling incomplete
         Array(value).each_with_index do |v, index|
           # Is this the right way to do this?
           # Need to be smarter to see if all repeated fields are filled before trying to create a new one by clicking?
           js << "document.querySelectorAll('#{field_selector(attribute_name)} button.add')[0].click();" unless index.zero?
-          js << "document.querySelectorAll('#{field_selector(attribute_name)} .form-control')[#{index}].value = '#{helpers.escape_javascript(v)}';"
+          # Use the field ID directly - this is more reliable than complex selectors
+          js << "var field = document.getElementById('#{curation_concern}_#{attribute_name}'); if (field) { field.value = '#{helpers.escape_javascript(v)}'; }"
         end
-        js.reject(&:blank?).join("\n")
+        js.compact_blank.join("\n")
       end
 
       # Override of Hyrax method (See https://github.com/samvera/hyrax/pull/4495)
       # render a json response for +response_type+
       def render_json_response(response_type: :success, message: nil, options: {})
-        json_body = Hyrax::API.generate_response_body(response_type: response_type, message: message, options: options)
+        json_body = Hyrax::API.generate_response_body(response_type:, message:, options:)
         render json: json_body, status: Hyrax::API.default_responses[response_type][:code]
       end
     end

data/app/helpers/hyrax/doi/work_form_helper.rb

@@ -4,7 +4,6 @@ module Hyrax
     module WorkFormHelper
       def form_tabs_for(form:)
         if form.model_class.ancestors.include? Hyrax::DOI::DOIBehavior
-          # TODO: Add check for feature flipper?
           super.prepend("doi")
         else
           super

data/app/models/concerns/hyrax/doi/doi_behavior.rb

@@ -4,7 +4,7 @@ module Hyrax
     module DOIBehavior
       extend ActiveSupport::Concern
 
-      DOI_REGEX = /\A10\.\d{4,}(\.\d+)*\/[-._;():\/A-Za-z\d]+\z/.freeze
+      DOI_REGEX = /\A10\.\d{4,}(\.\d+)*\/[-._;():\/A-Za-z\d]+\z/
 
       included do
         property :doi, predicate: ::RDF::Vocab::BIBO.doi, multiple: true do |index|

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

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'bolognese'
-
 module Bolognese
   module Readers
     # Use this with Bolognese like the following:
@@ -74,11 +72,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 +89,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

@@ -16,9 +16,9 @@ module Bolognese
           # FIXME: This may not roundtrip since datacite normalizes the creator name
           'creator' => creators&.pluck("name"),
           'contributor' => contributors&.pluck("name"),
-          'publisher' => Array(publisher),
+          'publisher' => build_hyrax_work_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
@@ -34,17 +34,47 @@ module Bolognese
       end
 
       def build_hyrax_work_class
-        Class.new(ActiveFedora::Base).tap do |c|
-          c.include ::Hyrax::WorkBehavior
-          c.include ::Hyrax::DOI::DOIBehavior
+        @hyrax_work_class ||= begin
+          klass = Class.new(ActiveFedora::Base) do
+            def self.name
+              "Bolognese::Writers::DynamicHyraxWork"
+            end
+
+            def self.to_s
+              name
+            end
+          end
+          klass.include ::Hyrax::WorkBehavior
+          klass.include ::Hyrax::DOI::DOIBehavior
           # Put BasicMetadata include last since it finalizes the metadata schema
-          c.include ::Hyrax::BasicMetadata
+          klass.include ::Hyrax::BasicMetadata
+          klass
         end
       end
 
       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
+
+      def build_hyrax_work_publisher
+        return [] if publisher.blank?
+        # For crossref data, publisher can be a hash like {"name" => "eLife Sciences Publications, Ltd"}
+        # For datacite data, publisher is usually a string
+        case publisher
+        when Hash
+          # Extract the actual publisher name
+          Array(publisher['name'])
+        when String
+          [publisher]
+        else
+          Array(publisher)
+        end
+      end
     end
   end
 end

data/app/services/hyrax/doi/datacite_client.rb

@@ -6,7 +6,7 @@ module Hyrax
 
       TEST_BASE_URL = "https://api.test.datacite.org/"
       TEST_MDS_BASE_URL = "https://mds.test.datacite.org/"
-      PRODUCTION_BASE_URL = "https://api.datacite.org"
+      PRODUCTION_BASE_URL = "https://api.datacite.org/"
       PRODUCTION_MDS_BASE_URL = "https://mds.datacite.org/"
 
       def initialize(username:, password:, prefix:, mode: :production)
@@ -20,7 +20,7 @@ module Hyrax
       # If you already have a DOI and want to register it as a draft then go through the normal process (put_metadata/register_url)
       def create_draft_doi
         # Use regular api instead of mds for metadata-less url-less draft doi creation
-        response = connection.post('dois', draft_doi_payload.to_json, "Content-Type" => "application/json")
+        response = connection.post('dois', draft_doi_payload.to_json, "Content-Type" => "application/vnd.api+json")
         raise Error.new('Failed creating draft DOI', response) unless response.status == 201
 
         JSON.parse(response.body)['data']['id']
@@ -103,14 +103,14 @@ module Hyrax
 
       def connection
         Faraday.new(url: base_url) do |c|
-          c.basic_auth(username, password)
+          c.try(:basic_auth) ? c.basic_auth(username, password) : c.request(:authorization, :basic, username, password)
           c.adapter(Faraday.default_adapter)
         end
       end
 
       def mds_connection
         Faraday.new(url: mds_base_url) do |c|
-          c.basic_auth(username, password)
+          c.try(:basic_auth) ? c.basic_auth(username, password) : c.request(:authorization, :basic, username, password)
           c.adapter(Faraday.default_adapter)
         end
       end
@@ -126,12 +126,13 @@ module Hyrax
         }
       end
 
+      # Ensre that `mode` is not a string
       def base_url
-        mode == :production ? PRODUCTION_BASE_URL : TEST_BASE_URL
+        mode&.to_sym == :production ? PRODUCTION_BASE_URL : TEST_BASE_URL
       end
 
       def mds_base_url
-        mode == :production ? PRODUCTION_MDS_BASE_URL : TEST_MDS_BASE_URL
+        mode&.to_sym == :production ? PRODUCTION_MDS_BASE_URL : TEST_MDS_BASE_URL
       end
     end
   end

data/app/services/hyrax/doi/datacite_registrar.rb

@@ -62,7 +62,7 @@ module Hyrax
       end
 
       def client
-        @client ||= Hyrax::DOI::DataCiteClient.new(username: self.username, password: self.password, prefix: self.prefix, mode: mode)
+        @client ||= Hyrax::DOI::DataCiteClient.new(username: self.username, password: self.password, prefix: self.prefix, mode:)
       end
 
       # Do the heavy lifting of submitting the metadata, registering the url, and ensuring the correct status

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

@@ -1,28 +1,39 @@
+<%# 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? && Flipflop.enabled?(:doi_minting) %>
+    <%= link_to "Create draft DOI",
+                Hyrax::DOI::Engine.routes.url_helpers.create_draft_doi_path,
+                remote: true,
+                method: :get,
+                data: {
+									disable_with: t("hyrax.works.form.mint.button.disable_with"),
+                  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="true">Create draft DOI</div>
+  <% end %>
 
   <%= link_to "Autofill form",
               Hyrax::DOI::Engine.routes.url_helpers.autofill_path,
               remote: true,
               method: :get,
               data: {
-                confirm: "This operation is destructive and will replace any information already filled in on this form.",
-                disable_with: "Autofilling form...",
+                confirm: t("hyrax.works.form.autofill.button.confirm"),
+                disable_with: t("hyrax.works.form.autofill.button.disable_with"),
                 params: { curation_concern: curation_concern.class.name.underscore }
               },
               class: 'btn btn-primary',
@@ -30,28 +41,30 @@
 
   <br/><br/><br/>
 
-  <fieldset class="set-doi-status-when-public">
-    <label class="control-label">DOI status when work is public</label>
+	<% if Flipflop.enabled?(:doi_minting) %>
+		<fieldset class="set-doi-status-when-public">
+			<label class="control-label">DOI status when work is public</label>
 
-    <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;' %>
-        Do not mint
-      </label>
-      <label class="radio" style="font-weight: normal">
-        <%= f.radio_button :doi_status_when_public, 'draft', style: 'margin-top: 0px;' %>
-        Draft
-      </label>
-      <label class="radio" style="font-weight: normal">
-        <%= f.radio_button :doi_status_when_public, 'registered', style: 'margin-top: 0px;' %>
-        Registered
-      </label>
-      <label class="radio" style="font-weight: normal">
-        <%= f.radio_button :doi_status_when_public, 'findable', style: 'margin-top: 0px;' %>
-        Findable
-      </label>
-    </div>
-  </fieldset>
+			<div class="form-group" style="margin-left: 20px">
+				<label class="radio" style="font-weight: normal">
+					<%= 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', disabled: disable_draft, style: 'margin-top: 0px;' %>
+					Draft
+				</label>
+				<label class="radio" style="font-weight: normal">
+					<%= f.radio_button :doi_status_when_public, 'registered', style: 'margin-top: 0px;' %>
+					Registered
+				</label>
+				<label class="radio" style="font-weight: normal">
+					<%= f.radio_button :doi_status_when_public, 'findable', style: 'margin-top: 0px;' %>
+					Findable
+				</label>
+			</div>
+		</fieldset>
+	<% end %>
 </div>
 
 <script type="text/javascript">
@@ -59,7 +72,7 @@
   // Note this uses jQuery since we're using jquery-ujs still
   // There is probably a better way to do this but this works for now
   $("#doi-autofill-btn").on("ajax:beforeSend", function(e, xhr, settings) {
-    doi = $('#generic_work_doi').val()
+    doi = $('<%= "##{curation_concern.class.name.underscore}_doi" %>').val()
     settings.url = settings.url + "&doi=" + encodeURIComponent(doi)
   });
 
@@ -67,7 +80,37 @@
     alert(xhr.responseText);
   });
 
+	// To override this action and add your own ajax error listener, you can use jQuery's `off` method,
+	// before registering your own listener. E.g. $("#doi-autofill-btn").off("ajax:error")
   $("#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).ready(function() {
+    curation_concern = '<%= curation_concern.class.name.underscore %>';
+    document.getElementById('with_files_submit').addEventListener("click", function(event){
+      if (["findable", "registered"].indexOf(document.querySelector('input[name="' + curation_concern + '[doi_status_when_public]"]:checked').value) < 0)
+        return;
+
+      const empty_fields = [];
+      if (document.querySelector('.' + curation_concern + '_title .form-control').value == "")
+        empty_fields.push("Title")
+      if (document.querySelector('.' + curation_concern + '_creator .form-control').value == "")
+        empty_fields.push("Creator")
+      if (document.querySelector('.' + curation_concern + '_publisher .form-control').value == "")
+        empty_fields.push("Publisher")
+      if (document.querySelector('.' + curation_concern + '_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/config/features.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Flipflop.configure do
+  feature :doi_minting,
+          default: true,
+          description: "Toggle the DOI minting for this tenant"
+end

data/config/locales/hyrax_doi.en.yml

@@ -3,5 +3,15 @@ en:
   hyrax:
     works:
       form:
+        mint:
+          button:
+            disable_with: Creating draft DOI...
+        autofill:
+          button:
+            disable_with: Autofilling form...
+            confirm: This operation is destructive and will replace any information already filled in on this form.
         tab:
-          doi: DOI
+          doi: DOI
+  errors:
+    doi_minting:
+      disabled: DOI minting is disabled by your administrator

data/lib/hyrax/doi/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Hyrax
   module DOI
     class Engine < ::Rails::Engine
@@ -13,6 +14,11 @@ module Hyrax
         end
       end
 
+      # Allow flipflop to load config/features.rb from the Hyrax gem:
+      initializer 'configure' do
+        Flipflop::FeatureLoader.current.append(self)
+      end
+
       config.after_initialize do
         Hyrax::CurationConcern.actor_factory.use Hyrax::Actors::DOIActor
 
@@ -20,8 +26,15 @@ module Hyrax
         Bolognese::Metadata.prepend Bolognese::Readers::HyraxWorkReader
         Bolognese::Metadata.prepend Bolognese::Writers::HyraxWorkWriter
 
-        # Prepend our views so they have precedence
-        ActionController::Base.prepend_view_path(paths['app/views'].existent)
+        # Prepend our views in front of Hyrax but after the main app, so they have precedence
+        # but can still be overridden
+        my_engine_root = Hyrax::DOI::Engine.root.to_s
+        hyrax_engine_root = Hyrax::Engine.root.to_s
+        paths = ActionController::Base.view_paths.collect(&:to_s)
+        hyrax_view_path = paths.detect { |path| path.match(%r{^#{hyrax_engine_root}}) }
+        paths.insert(paths.index(hyrax_view_path), File.join(my_engine_root, 'app', 'views')) if hyrax_view_path
+
+        ActionController::Base.view_paths = paths.uniq
       end
     end
   end

data/lib/hyrax/doi/spec/shared_specs/datacite_doi_presenter_behavior.rb

@@ -3,7 +3,11 @@ RSpec.shared_examples "a DataCite DOI-enabled presenter" do
   subject { presenter }
 
   let(:presenter) { presenter_class.new(solr_document, nil, nil) }
-  let(:solr_document) { instance_double(solr_document_class) }
+  let(:solr_document) do
+    solr_double = instance_double(solr_document_class)
+    allow(solr_double).to receive(:flexible?).and_return(false)
+    solr_double
+  end
 
   it { is_expected.to delegate_method(:doi_status_when_public).to(:solr_document) }
 

data/lib/hyrax/doi/spec/shared_specs/doi_presenter_behavior.rb

@@ -3,7 +3,11 @@ RSpec.shared_examples "a DOI-enabled presenter" do
   subject { presenter }
 
   let(:presenter) { presenter_class.new(solr_document, nil, nil) }
-  let(:solr_document) { instance_double(solr_document_class) }
+  let(:solr_document) do
+    solr_double = instance_double(solr_document_class)
+    allow(solr_double).to receive(:flexible?).and_return(false)
+    solr_double
+  end
 
   describe 'doi' do
     let(:doi) { '10.1234/abc' }

data/lib/hyrax/doi/version.rb

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

data/lib/hyrax/doi.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "hyrax/doi/engine"
 require "hyrax/doi/errors"
+require "flipflop"
 
 module Hyrax
   module DOI

metadata

@@ -1,69 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: hyrax-doi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Colvard
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.2.4
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.2.4
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: hyrax
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: bolognese
+  name: flipflop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bolognese
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
@@ -190,20 +223,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: webdrivers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -273,6 +292,7 @@ files:
 - app/services/hyrax/doi/datacite_registrar.rb
 - app/views/hyrax/base/_attribute_rows.html.erb
 - app/views/hyrax/base/_form_doi.html.erb
+- config/features.rb
 - config/locales/hyrax_doi.en.yml
 - config/routes.rb
 - lib/generators/hyrax/doi/add_to_work_type_generator.rb
@@ -297,7 +317,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -312,8 +331,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Hyrax plugin for working with DOIs.
 test_files: []