datacite 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdf38cc62fc479c6a1c83719e27652830c893850b54faa42bd745c45336fbe38
-  data.tar.gz: ca019efa9f9130d58061c9150fad4abdbeb2a2bbfb373d68a1bf0cfb8c639068
+  metadata.gz: 70e80d4615ecf31ae69938f5008ee396db504bd2e4ce7637816bb5df5c4038cd
+  data.tar.gz: ef72c4e1491a8567f087e1fa889e68c5cfba68a96070f324cbe4f670dda70967
 SHA512:
-  metadata.gz: 2a211b25333cf2dc5bc57db4744f3253d8954e35b74bb8af4c77252f1063ea85a1077717a8330f60bd2c58577a4f1dd03777c11a12fa607074502ebca4b7db9c
-  data.tar.gz: 5d7715a9e6c66cde554740b4ded731c7c90344969b77a2295d5567014fd2a79db25ca87b99a13750959e3e1cf81c15cba69d1a575c90618fede91f74a63bfe19
+  metadata.gz: 447c41b1b2d1cc567fb9f9aa854e249b56d31f9f8646f8e859af461dad8931e381b611eb5f346b129868677d1773b3d84f356fa5ed3b1cc1895df88021c8e1f7
+  data.tar.gz: '085d1ddcb4ed62ab36480fb1875e73f71b29245e16fd8e8d7746df321d6a89df6a01156902ed639962f79e9a8bec0ce2b10a51e3137001404118d7633eade4fc'

data/.rubocop.yml

@@ -3,7 +3,7 @@ plugins:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.4
 
 Metrics/BlockLength:
   Exclude:
@@ -16,17 +16,12 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
 Layout/LineLength:
   Max: 120
 
+RSpec/ExampleLength:
+  Enabled: false
+
 Gemspec/DeprecatedAttributeAssignment: # new in 1.30
   Enabled: true
 Gemspec/DevelopmentDependencies: # new in 1.44
@@ -335,3 +330,30 @@ Style/SendWithLiteralMethodName: # new in 1.64
   Enabled: true
 Style/SuperArguments: # new in 1.64
   Enabled: true
+
+Gemspec/AttributeAssignment: # new in 1.77
+  Enabled: true
+Layout/EmptyLinesAfterModuleInclusion: # new in 1.79
+  Enabled: true
+Lint/UselessDefaultValueArgument: # new in 1.76
+  Enabled: true
+Lint/UselessOr: # new in 1.76
+  Enabled: true
+Naming/PredicateMethod: # new in 1.76
+  Enabled: true
+Style/ArrayIntersectWithSingleElement: # new in 1.81
+  Enabled: true
+Style/CollectionQuerying: # new in 1.77
+  Enabled: true
+Style/ComparableBetween: # new in 1.74
+  Enabled: true
+Style/EmptyStringInsideInterpolation: # new in 1.76
+  Enabled: true
+Style/HashFetchChain: # new in 1.75
+  Enabled: true
+Style/ItBlockParameter: # new in 1.75
+  Enabled: true
+Style/RedundantArrayFlatten: # new in 1.76
+  Enabled: true
+RSpec/IncludeExamples: # new in 3.6
+  Enabled: true

data/Gemfile

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in datacite.gemspec
 gemspec
 
 # Specify development dependencies here
-gem "base64"
-gem "byebug"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rake"
-gem "rubocop-rspec"
-gem "simplecov"
-gem "webmock", "~> 3.13"
+gem 'base64'
+gem 'byebug'
+gem 'cocina-models' # only used in tests
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'simplecov'
+gem 'webmock', '~> 3.13'

data/Gemfile.lock

@@ -1,72 +1,161 @@
 PATH
   remote: .
   specs:
-    datacite (0.6.0)
+    datacite (0.8.0)
+      activesupport
       dry-monads (~> 1.3)
       faraday (~> 2.0)
+      json_schemer
       zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
+    attr_extras (7.1.0)
     base64 (0.3.0)
-    bigdecimal (3.2.1)
+    bigdecimal (3.3.1)
     byebug (12.0.0)
+    cocina-models (0.108.2)
+      activesupport
+      deprecation
+      dry-struct (~> 1.0)
+      dry-types (~> 1.1)
+      edtf
+      equivalent-xml
+      i18n
+      jsonpath
+      nokogiri
+      openapi_parser (~> 1.0)
+      super_diff
+      thor
+      zeitwerk (~> 2.1)
     concurrent-ruby (1.3.5)
-    crack (1.0.0)
+    connection_pool (2.5.4)
+    crack (1.0.1)
       bigdecimal
       rexml
+    deprecation (1.1.0)
+      activesupport
     diff-lcs (1.6.2)
     docile (1.4.1)
+    drb (2.2.3)
     dry-core (1.1.0)
       concurrent-ruby (~> 1.0)
       logger
       zeitwerk (~> 2.6)
-    dry-monads (1.8.3)
+    dry-inflector (1.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    faraday (2.13.1)
+    dry-monads (1.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-types (1.8.3)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    edtf (3.2.0)
+      activesupport (>= 3.0, < 9.0)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    faraday (2.14.0)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.4.0)
+    faraday-net_http (3.4.1)
       net-http (>= 0.5.0)
-    hashdiff (1.2.0)
-    json (2.12.2)
+    hana (1.3.7)
+    hashdiff (1.2.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json (2.15.2)
+    json_schemer (2.4.0)
+      bigdecimal
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      simpleidn (~> 0.2)
+    jsonpath (1.1.5)
+      multi_json
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    net-http (0.6.0)
+    minitest (5.26.0)
+    multi_json (1.17.0)
+    net-http (0.7.0)
       uri
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
+    openapi_parser (1.0.0)
+    optimist (3.2.1)
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
+    prism (1.6.0)
     public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
-    regexp_parser (2.10.0)
-    rexml (3.4.1)
-    rspec (3.13.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.4)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
-    rubocop (1.75.8)
+    rspec-support (3.13.6)
+    rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -74,46 +163,58 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.6.0)
+    rubocop-rspec (3.7.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
-    webmock (3.25.1)
+    simpleidn (0.2.3)
+    super_diff (0.17.0)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
+    thor (1.4.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.1)
+    webmock (3.26.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     zeitwerk (2.7.3)
 
 PLATFORMS
-  arm64-darwin-23
-  arm64-darwin-24
-  x86_64-darwin-19
-  x86_64-darwin-21
-  x86_64-darwin-22
-  x86_64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
   base64
   byebug
+  cocina-models
   datacite!
   rake (~> 13.0)
   rspec (~> 3.0)
@@ -124,4 +225,4 @@ DEPENDENCIES
   webmock (~> 3.13)
 
 BUNDLED WITH
-   2.6.9
+   2.7.2

data/README.md

@@ -97,6 +97,26 @@ result.either(
 )
 ```
 
+## Working with Cocina
+
+### Validating
+
+This gem provides a method for mapping and validating a `Cocina::Models::DRO` object to a DataCite request based on the DataCite JSON Schema (v4.6), without sending any data to the DataCite API:
+
+```ruby
+cocina_object = Cocina::Models::DRO.new(...)
+validator = Datacite::Validators::CocinaValidator.new(cocina_object:)
+puts validator.errors.join(', ') unless validator.valid?
+```
+
+NOTE: A Datacite request payload can be validated without first translating from Cocina if you build the request manually or use your own metadata mapping library, e.g.:
+
+```ruby
+datacite_attributes = { ... }
+validator = Datacite::Validators::AttributesValidator.new(attributes: datacite_attributes)
+puts validator.errors.join(', ') unless validator.valid?
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "datacite"
+require 'bundler/setup'
+require 'datacite'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require "datacite"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/datacite.gemspec

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "lib/datacite/version"
+require_relative 'lib/datacite/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "datacite"
+  spec.name          = 'datacite'
   spec.version       = Datacite::VERSION
-  spec.authors       = ["Justin Coyne"]
-  spec.email         = ["jcoyne@justincoyne.com"]
+  spec.authors       = ['Justin Coyne']
+  spec.email         = ['jcoyne@justincoyne.com']
 
-  spec.summary       = "A Ruby client library for the DataCite REST API "
-  spec.description   = "See https://support.datacite.org/docs/api"
-  spec.homepage      = "https://github.com/sul-dlss/datacite-ruby"
-  spec.required_ruby_version = ">= 3.0"
+  spec.summary       = 'A Ruby client library for the DataCite REST API '
+  spec.description   = 'See https://support.datacite.org/docs/api'
+  spec.homepage      = 'https://github.com/sul-dlss/datacite-ruby'
+  spec.required_ruby_version = '>= 3.4'
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
@@ -24,12 +24,14 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "dry-monads", "~> 1.3"
-  spec.add_dependency "faraday", "~> 2.0"
-  spec.add_dependency "zeitwerk", "~> 2.4"
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'dry-monads', '~> 1.3'
+  spec.add_dependency 'faraday', '~> 2.0'
+  spec.add_dependency 'json_schemer'
+  spec.add_dependency 'zeitwerk', '~> 2.4'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/datacite/autogenerate_doi_request_body.rb

@@ -12,7 +12,7 @@ module Datacite
     def to_json(*_args)
       {
         data: {
-          type: "dois",
+          type: 'dois',
           attributes: {
             prefix: prefix
           }

data/lib/datacite/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "faraday"
-require "dry/monads"
+require 'faraday'
+require 'dry/monads'
 
 module Datacite
   # The connection to DataCite API
@@ -11,7 +11,7 @@ module Datacite
     # @param [String] username
     # @param [String] password
     # @param [String] host
-    def initialize(username: nil, password: nil, host: "api.test.datacite.org")
+    def initialize(username: nil, password: nil, host: 'api.test.datacite.org')
       @conn = Faraday.new(
         url: "https://#{host}",
         headers: headers
@@ -85,14 +85,14 @@ module Datacite
 
     # @returns [Dry::Monads::Result]
     def register(request_body)
-      response = conn.post("/dois", request_body)
+      response = conn.post('/dois', request_body)
       response.success? ? Success(Response.new(response)) : Failure(response)
     end
 
     def headers
       {
-        "Content-Type" => "application/vnd.api+json",
-        "User-Agent" => "Datacite Ruby client version #{Datacite::VERSION}"
+        'Content-Type' => 'application/vnd.api+json',
+        'User-Agent' => "Datacite Ruby client version #{Datacite::VERSION}"
       }
     end
 

data/lib/datacite/mapping/from_cocina/alternate_identifiers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Datacite
+  module Mapping
+    module FromCocina
+      # Maps alternative identifiers from cocina description to DataCite JSON
+      class AlternateIdentifiers
+        # @param [Cocina::Models::Description] description
+        def self.build(...)
+          new(...).call
+        end
+
+        def initialize(description:)
+          @description = description
+        end
+
+        attr_reader :description
+
+        delegate :purl, to: :description
+
+        def call
+          [{
+            alternateIdentifier: purl,
+            alternateIdentifierType: 'PURL'
+          }]
+        end
+      end
+    end
+  end
+end

data/lib/datacite/mapping/from_cocina/attributes.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'cocina/models'
+
+module Datacite
+  module Mapping
+    module FromCocina
+      # Transform the Cocina::Models::DRO to a DataCite request attributes payload
+      class Attributes
+        # @param [Cocina::Models::DRO] cocina_object
+        # @return [Hash] Hash of DataCite attributes, conforming to the DataCite API Schema
+        def self.build(...)
+          new(...).call
+        end
+
+        def initialize(cocina_object:)
+          @cocina_object = cocina_object
+
+          # Set the time zone
+          Time.zone = 'Pacific Time (US & Canada)'
+        end
+
+        attr_reader :cocina_object
+
+        delegate :access, :description, :identification, to: :cocina_object
+
+        def call # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          {
+            event: 'publish',
+            url: description.purl,
+            identifiers: Identifiers.build(identification:),
+            titles: Titles.build(description:),
+            publisher: { name: 'Stanford Digital Repository' }, # per DataCite schema
+            publicationYear: publication_year,
+            subjects: Subject.build(description:),
+            dates: Date.build(cocina_object:),
+            language: 'en',
+            types: Types.build(description:),
+            alternateIdentifiers: AlternateIdentifiers.build(description:),
+            relatedIdentifiers: related_identifiers,
+            rightsList: RightsList.build(access:),
+            descriptions: Descriptions.build(description:),
+            relatedItems: related_items,
+            schemaVersion: 'http://datacite.org/schema/kernel-4'
+          }.merge(ContributorAttributes.build(description:)).compact
+        end
+
+        private
+
+        def publication_year
+          date = if access.embargo
+                   access.embargo.releaseDate.to_datetime
+                 else
+                   Time.zone.today
+                 end
+          date.year.to_s
+        end
+
+        def related_identifiers
+          Array(description&.relatedResource).filter_map do |related_resource|
+            RelatedResource.related_identifier_attributes(related_resource:)
+          end
+        end
+
+        def related_items
+          Array(description&.relatedResource).filter_map do |related_resource|
+            RelatedResource.related_item_attributes(related_resource:)
+          end
+        end
+      end
+    end
+  end
+end