hydra-remote_identifier 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dd65def0770c56f479dbc71aaa0dc462603f1ad
-  data.tar.gz: d79fbb1d6ce12a804369a4ef441598c1effa2fbb
+  metadata.gz: b96ecf3dd7c10241d67f8e45794d8d392f2dc5a8
+  data.tar.gz: d50f078a9a4dbabfd9ab4e70fbe12f7535da198a
 SHA512:
-  metadata.gz: 29daa6481feda3dd6225bc112b38d6117c717ca50eac693bbe7a5f665c5958a8659fa400cb49f0e2e1bc0fff3da210d05b2358715bd932af99584e031142af7b
-  data.tar.gz: 72ccf7cd67fa4cca2dc617858a760530f2c06537a0e79efc9d2ef9ce62f798d91e84b5a2b378730c05ce4af1fcb0b547ecdb544f90824023aa846151992a14ae
+  metadata.gz: 4427c065e94c4386c1f5b63a8f216c5d3b6a35107f9ae8eb59eedf56dbb284fad6587577956eeaf1aa407673581bbdc4ca4dbafe8fa5f35513058f5c0e429984
+  data.tar.gz: 4c5081a38b8ccecee029f6b5bfb1239b2292b5d1b0fe298770527c939d1ef959d38c35f0f4131f1639ebba60c66dfd4a67d5b8d43def8b1e8d3a700a58abd7df

data/lib/generators/hydra/remote_identifier/doi_generator.rb

@@ -0,0 +1,59 @@
+require 'rails/generators'
+
+class Hydra::RemoteIdentifier::DoiGenerator < Rails::Generators::Base
+  DEFAULT_CREDENTIALS_PATH = 'config/doi.yml'
+
+  desc 'Register the target class names as acceptable for DOI'
+  class_option :credentials_path, type: :string, default: DEFAULT_CREDENTIALS_PATH, desc: 'Where can we find your DOI credentials'
+  class_option :target, type: :string, default: ":permanent_uri", desc: "What is the object's permanent_uri"
+  class_option :creator, type: :string, default: ":creator", desc: "Name of the object's creator"
+  class_option :title, type: :string, default: ":title", desc: "Title of the created object"
+  class_option :publisher, type: :string, default: ":publisher", desc: "Publisher of the created object"
+  class_option :publication_year, type: :string, default: ":publication_year", desc: "Year the created object was published"
+  class_option :set_identifier, type: :string, default: ":set_doi_identifier", desc: "Method on object to call when DOI is set"
+  argument :targets, :type => :array, :default => [], :banner => "class_name class_name"
+
+  def insert_doi
+    inject_into_file(
+      "config/initializers/hydra-remote_identifier_config.rb",
+      after: /Hydra::RemoteIdentifier.*/
+    ) do
+
+      data = []
+      data << ""
+      data << %(  doi_credentials = Psych.load_file("#{credentials_path}"))
+      data << %(  config.remote_service(:doi, doi_credentials) do |doi|)
+      data << %(    doi.register(#{normalized_targets}) do |map|)
+      data << %(      map.target #{options.fetch('target')})
+      data << %(      map.creator #{options.fetch('creator')})
+      data << %(      map.title #{options.fetch('title')})
+      data << %(      map.publisher #{options.fetch('publisher')})
+      data << %(      map.publicationyear #{options.fetch('publication_year')})
+      data << %(      map.set_identifier #{options.fetch('set_identifier')})
+      data << %(    end)
+      data << %(  end)
+      data << ""
+      data.join("\n")
+
+    end
+  end
+
+  def optionally_create_credentials_path
+    if credentials_path == DEFAULT_CREDENTIALS_PATH
+      require 'hydra/remote_identifier/remote_services/doi'
+      create_file(
+        credentials_path,
+        Hydra::RemoteIdentifier::RemoteServices::Doi::TEST_CONFIGURATION.to_yaml
+      )
+    end
+  end
+
+  private
+  def credentials_path
+    options.fetch('credentials_path')
+  end
+
+  def normalized_targets
+    targets.collect(&:classify).join(", ")
+  end
+end

data/lib/generators/hydra/remote_identifier/install_generator.rb

@@ -7,20 +7,19 @@ class Hydra::RemoteIdentifier::InstallGenerator < Rails::Generators::Base
 
       data << '# Register and configure remote identifiers for persisted objects'
       data << 'Hydra::RemoteIdentifier.configure do |config|'
-      data << ''
-      data << '#   doi_credentials = Psych.load("/path/to/doi_credentials.yml")'
-      data << '#   config.remote_service(:doi, doi_credentials) do |doi|'
-      data << '#     doi.register(PersistedObject) do |map|'
-      data << '#       map.target :url'
-      data << '#       map.creator {|obj| obj.person_name }'
-      data << '#       map.title :title'
-      data << '#       map.publisher :publisher'
-      data << '#       map.publicationyear :publicationyear'
-      data << '#       map.set_identifier :set_doi_identifier='
-      data << '#     end'
-      data << '#   end'
-      data << ''
+      data << '  # doi_credentials = Psych.load("/path/to/doi_credentials.yml")'
+      data << '  # config.remote_service(:doi, doi_credentials) do |doi|'
+      data << '  #   doi.register(PersistedObject) do |map|'
+      data << '  #     map.target :url'
+      data << '  #     map.creator {|obj| obj.person_name }'
+      data << '  #     map.title :title'
+      data << '  #     map.publisher :publisher'
+      data << '  #     map.publicationyear :publicationyear'
+      data << '  #     map.set_identifier :set_doi_identifier='
+      data << '  #   end'
+      data << '  # end'
       data << 'end'
+      data << ''
 
       data.join("\n")
     end

data/lib/hydra/remote_identifier.rb

@@ -26,11 +26,17 @@ module Hydra::RemoteIdentifier
     #     end
     #
     # @yieldparam config [Configuration]
+    def configure(&block)
+      @configuration_block = block
+      configure! unless defined?(Rails)
+    end
     attr_accessor :configuration
-    def configure
+
+    def configure!
       self.configuration ||= Configuration.new
-      yield(configuration)
+      @configuration_block.call(configuration)
     end
+    private :configure!
 
     # Yields the specified RemoteService if it _could_ be requested for the
     # Target.

data/lib/hydra/remote_identifier/railtie.rb

@@ -2,6 +2,11 @@ module Hydra::RemoteIdentifier
   class Railtie < Rails::Railtie
     generators do
       require 'generators/hydra/remote_identifier/install_generator'
+      require 'generators/hydra/remote_identifier/doi_generator'
+    end
+
+    config.to_prepare do
+      Hydra::RemoteIdentifier.send(:configure!)
     end
   end
 end

data/lib/hydra/remote_identifier/remote_services/doi.rb

@@ -6,6 +6,13 @@ require 'active_support/core_ext/hash/indifferent_access'
 module Hydra::RemoteIdentifier
   module RemoteServices
     class Doi < Hydra::RemoteIdentifier::RemoteService
+      TEST_CONFIGURATION =
+      {
+        username: 'apitest',
+        password: 'apitest',
+        shoulder: 'doi:10.5072/FK2',
+        url: "https://n2t.net/ezid/"
+      }
 
       attr_reader :uri
       def initialize(configuration = {})
@@ -38,13 +45,13 @@ module Hydra::RemoteIdentifier
       end
 
       def data_for_create(payload)
-        [
-          "_target: #{payload.fetch(:target)}",
-          "datacite.creator: #{payload.fetch(:creator)}",
-          "datacite.title: #{payload.fetch(:title)}",
-          "datacite.publisher: #{payload.fetch(:publisher)}",
-          "datacite.publicationyear: #{payload.fetch(:publicationyear)}"
-        ].join("\n")
+        data = []
+        data << "_target: #{payload.fetch(:target)}"
+        data << "datacite.creator: #{payload.fetch(:creator)}"
+        data << "datacite.title: #{payload.fetch(:title)}"
+        data << "datacite.publisher: #{payload.fetch(:publisher)}"
+        data << "datacite.publicationyear: #{payload.fetch(:publicationyear)}"
+        data.join("\n")
       end
     end
   end

data/lib/hydra/remote_identifier/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module RemoteIdentifier
-    VERSION = "0.4.2"
+    VERSION = "0.4.3"
   end
 end

data/spec/lib/hydra/remote_identifier/remote_services/doi_spec.rb

@@ -5,14 +5,7 @@ module Hydra::RemoteIdentifier
   module RemoteServices
 
     describe Doi do
-      let(:configuration) {
-        {
-          username: 'apitest',
-          password: 'apitest',
-          shoulder: 'doi:10.5072/FK2',
-          url: "https://n2t.net/ezid/"
-        }
-      }
+      let(:configuration) { RemoteServices::Doi::TEST_CONFIGURATION }
       let(:payload) {
         {
           target: 'http://google.com',
@@ -29,7 +22,7 @@ module Hydra::RemoteIdentifier
       subject { RemoteServices::Doi.new(configuration) }
 
       context '.call' do
-        it 'should post to remote service', VCR::SpecSupport.merge(cassette_name: 'doi-create') do
+        it 'should post to remote service', VCR::SpecSupport(cassette_name: 'doi-create') do
           expect(subject.call(payload)).to eq(expected_doi)
         end
       end

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -70,7 +70,7 @@ module Hydra::RemoteIdentifier
 
     describe '.mint' do
 
-      it 'works!', VCR::SpecSupport.merge(record: :new_episodes, cassette_name: 'doi-integration') do
+      it 'works!', VCR::SpecSupport(record: :new_episodes, cassette_name: 'doi-integration') do
         expect {
           Hydra::RemoteIdentifier.mint(:doi, target)
         }.to change(target, :set_identifier).from(nil).to(expected_doi)

data/spec/spec_helper.rb

@@ -3,11 +3,8 @@ $:.unshift File.join(GEM_ROOT, "lib")
 
 require 'vcr'
 
-module VCR::SpecSupport
-  module_function
-  def merge(options = {})
-    {vcr: {record: :new_episodes}.merge(options)}
-  end
+def VCR::SpecSupport(options={})
+  {vcr: {record: :new_episodes}.merge(options)}
 end
 
 VCR.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -103,6 +103,7 @@ files:
 - README.md
 - Rakefile
 - hydra-remote_identifier.gemspec
+- lib/generators/hydra/remote_identifier/doi_generator.rb
 - lib/generators/hydra/remote_identifier/install_generator.rb
 - lib/hydra/remote_identifier.rb
 - lib/hydra/remote_identifier/configuration.rb