hyrax-doi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0263fd4d11d35e30f48410437354a6604f0726ddfeb13791062faf174c85d81
+  data.tar.gz: 7db8943b4fa0b9960572ad3dba14f4f6bb069af024338033b5260ba74aac4450
+SHA512:
+  metadata.gz: 69950241eb6d5511544d937cd87cdb94351ec171ebc94e7ad6f4dc91a16cd95be5263dea80d366ff431c6e79ba47bc28fd0b89e435078d8d199fc5caa8f7d2eb
+  data.tar.gz: 789ac23699e1a9476c215350d1abef88dcf0fd5c596e2c7e76974d442fc4065d44ea9f0d8e26a895401635d93a5eb06f5bdc5b084189dfdd14702dff247b1266

data/README.md

@@ -0,0 +1,65 @@
+# 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)
+
+
+Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
+
+Hyrax-doi is a Hyrax plugin that provides tools for working with DOIs including model attributes, minting, and fetching descriptive metadata.
+
+## 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.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyrax-doi'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install hyrax-doi
+```
+
+## Usage
+
+### Setup work type for hyrax-doi
+Run the generator to add DOI support to a given work type:
+```
+rails g hyrax:doi:add_to_work_type MyWorkType
+```
+
+## Development
+
+### 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`).
+
+### 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:
+```
+solr_wrapper -v --config .solr_wrapper.yml
+fcrepo_wrapper -v --config .fcrepo_wrapper.yml
+bundle exec rails server -b 0.0.0.0
+```
+
+### Testing
+
+Tests are run automatically on CircleCI 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:
+```
+solr_wrapper -v --config .solr_wrapper_test.yml
+fcrepo_wrapper -v --config .fcrepo_wrapper_test.yml
+bundle exec rspec
+```
+You shouldn't need to run anything from inside `spec/internal_test_hyrax` unless explicitly told to do so.

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hyrax::DOI'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/internal_test_hyrax/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Hyrax
+  module Actors
+    ##
+    # An actor that registers a DOI using the configured registar
+    # This actor should come after the model actor which saves the work
+    #
+    # @example use in middleware
+    #   stack = ActionDispatch::MiddlewareStack.new.tap do |middleware|
+    #     # middleware.use OtherMiddleware
+    #     middleware.use Hyrax::Actors::DOIActor
+    #     # middleware.use MoreMiddleware
+    #   end
+    #
+    #   env = Hyrax::Actors::Environment.new(object, ability, attributes)
+    #   last_actor = Hyrax::Actors::Terminator.new
+    #   stack.build(last_actor).create(env)
+    class DOIActor < AbstractActor
+      ##
+      # @return [Boolean]
+      #
+      # @see Hyrax::Actors::AbstractActor
+      def create(env)
+        # Assume the model actor has already run and saved the work
+        create_or_update_doi(env.curation_concern) && next_actor.create(env)
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      # @see Hyrax::Actors::AbstractActor
+      def update(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)
+
+        Hyrax::DOI::RegisterDOIJob.perform_later(work, registrar: work.doi_registrar.presence, registrar_opts: work.doi_registrar_opts)
+      end
+
+      # Check if work is DOI enabled
+      def doi_enabled_work_type?(work)
+        work.class.ancestors.include? Hyrax::DOI::DOIBehavior
+      end
+    end
+  end
+end

data/app/assets/config/hyrax_doi_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/hyrax/doi .js
+//= link_directory ../stylesheets/hyrax/doi .css

data/app/assets/javascripts/hyrax/doi/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/hyrax/doi/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+
+      def self.search_state_class=(*)
+        # no-op to make Hyrax::Controller happy
+      end
+
+      # Include after search_state_class is defined since Hyrax::Controller calls it
+      include Hyrax::Controller
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    class HyraxDOIController < ApplicationController
+      before_action :check_authorization
+
+      def create_draft_doi
+        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 }) }
+        end
+      rescue Hyrax::DOI::DataCiteClient::Error => e
+        respond_to do |format|
+          format.js { render plain: e.message, status: :internal_server_error }
+          format.json { render_json_response(response_type: :internal_error, message: e.full_message) }
+        end
+      end
+
+      def autofill
+        doi = params['doi']
+
+        respond_to do |format|
+          format.js { render js: autofill_js(doi), status: :ok }
+        end
+      rescue Hyrax::DOI::NotFoundError => e
+        respond_to do |format|
+          format.js { render plain: e.message, status: :internal_server_error }
+        end
+      end
+
+      private
+
+      def check_authorization
+        raise Hydra::AccessDenied unless current_ability.can_create_any_work?
+      end
+
+      def mint_draft_doi
+        doi_registrar.mint_draft_doi
+      end
+
+      def doi_registrar
+        # TODO: generalize this
+        Hyrax::Identifier::Registrar.for(:datacite, {})
+      end
+
+      def field_selector(attribute_name)
+        ".#{params[:curation_concern]}_#{attribute_name}"
+      end
+
+      def doi_attribute_name
+        params[:attribute] || "doi"
+      end
+
+      def hyrax_work_from_doi(doi)
+        meta = Bolognese::Metadata.new(input: doi)
+        # Check that a record was actually loaded
+        raise Hyrax::DOI::NotFoundError, "DOI (#{doi}) could not be found." if meta.blank? || meta.doi.blank?
+        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 << "document.location = '#metadata';"
+      end
+
+      # TODO: Move this out to a partial that gets rendered?
+      def autofill_field(attribute_name, value)
+        js = []
+        # 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)}';"
+        end
+        js.reject(&: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)
+        render json: json_body, status: Hyrax::API.default_responses[response_type][:code]
+      end
+    end
+  end
+end

data/app/forms/concerns/hyrax/doi/datacite_doi_form_behavior.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    module DataCiteDOIFormBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        self.terms += [:doi_status_when_public]
+
+        delegate :doi_status_when_public, to: :model
+      end
+
+      def secondary_terms
+        super - [:doi_status_when_public]
+      end
+    end
+  end
+end

data/app/forms/concerns/hyrax/doi/doi_form_behavior.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    module DOIFormBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        self.terms += [:doi]
+
+        delegate :doi, to: :model
+      end
+
+      def secondary_terms
+        super - [:doi]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    module HelperBehavior
+      include Hyrax::DOI::WorkFormHelper
+      include Hyrax::DOI::WorkShowHelper
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    module WorkShowHelper
+      def render_doi?(presenter)
+        return false unless presenter.class.ancestors.include? Hyrax::DOI::DOIPresenterBehavior
+        return presenter.doi_status_when_public.in? [nil, 'registered', 'findable'] if presenter.class.ancestors.include? Hyrax::DOI::DataCiteDOIPresenterBehavior
+        true
+      end
+    end
+  end
+end

data/app/jobs/hyrax/doi/application_job.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/jobs/hyrax/doi/register_doi_job.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    class RegisterDOIJob < ApplicationJob
+      queue_as Hyrax.config.ingest_queue_name
+
+      ##
+      # @param model [ActiveFedora::Base]
+      # @param registrar [String] Note this is a string and not a symbol because ActiveJob cannot serialize a symbol
+      # @param registrar_opts [Hash]
+      def perform(model, registrar: Hyrax.config.identifier_registrars.keys.first, registrar_opts: {})
+        Hyrax::Identifier::Dispatcher
+          .for(registrar.to_sym, **registrar_opts)
+          .assign_for!(object: model, attribute: :doi)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    module DataCiteDOIBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        property :doi_status_when_public, predicate: ::RDF::URI('http://samvera.org/ns/hyrax/doi#doi_status_when_public'), multiple: false do |index|
+          index.as :stored_sortable
+        end
+
+        validates :doi_status_when_public, inclusion: { in: Hyrax::DOI::DataCiteRegistrar::STATES }, allow_nil: true
+      end
+
+      # Override
+      def doi_registrar
+        'datacite'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Hyrax
+  module DOI
+    module DOIBehavior
+      extend ActiveSupport::Concern
+
+      DOI_REGEX = /\A10\.\d{4,}(\.\d+)*\/[-._;():\/A-Za-z\d]+\z/.freeze
+
+      included do
+        property :doi, predicate: ::RDF::Vocab::BIBO.doi, multiple: true do |index|
+          index.as :stored_sortable
+        end
+
+        validate :validate_doi
+      end
+
+      # Override this method
+      # Specify a registrar to use with this class
+      def doi_registrar
+        nil
+      end
+
+      # Override this method
+      # Specify options for the registrar to use with this class
+      def doi_registrar_opts
+        {}
+      end
+
+      private
+
+      def validate_doi
+        Array(doi).each do |doi|
+          errors.add(:doi, "DOI (#{doi}) is invalid.") unless doi.match? DOI_REGEX
+        end
+      end
+    end
+  end
+end