datacite 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c402c810fe15ec361ab43cc1d16eb828cf20996453c0c1ef6ebe9c37a843eb3
-  data.tar.gz: 77b49fcbb192cf95d5ede1eb4718fa1fa200c57b4a40f2780e19052bbdd96e09
+  metadata.gz: 14e944d80dc95aa79554d485193762732d942e6b17cc039cbd88bd2a390b9289
+  data.tar.gz: 7358ac61628a052e33c3bd82da253451135e87a9e584695b28022d33801ae0df
 SHA512:
-  metadata.gz: f6cbae355c732c44531a9b5b8378ede3daf2616b86b473a3355d548b572306f7860a4c697ab6dcf74b380aaf677e06dc2748c16a98bd0bebf840e2ca9bb254de
-  data.tar.gz: 955cbd7fdcf0ff420c255070a7586c333b14e1960defd74140f2650228d7f6654a542e21d87629be3dc8a8f8966904e39622498052e9d725c05d1e97b5012b65
+  metadata.gz: 6fd39012378ac1312ae25e38ac72797f58daec08db118b94548f898be989d5ef2a2dcf6e55d1a513333bc73ca21beeea32cf92387c312c6f1eb29cc906afb942
+  data.tar.gz: 3efbef3e7d82b69ba1b2c5df6c2b9423b0a618c10e41dba770e5102581fa5f4b75fa12b552b280de011d126211bab4cc89e343c6ce7c32f4a2704b2ed43c019d

data/.circleci/config.yml

@@ -0,0 +1,11 @@
+version: 2.1
+orbs:
+  ruby-rails: sul-dlss/ruby-rails@4.6.0
+workflows:
+  build:
+    jobs:
+      - ruby-rails/lint:
+          name: lint
+      - ruby-rails/test-gem:
+          name: test
+          context: dlss

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 
@@ -227,40 +227,6 @@ Style/SwapValues: # new in 1.1
   Enabled: true
 Style/YAMLFileRead: # new in 1.53
   Enabled: true
-Capybara/ClickLinkOrButtonStyle: # new in 2.19
-  Enabled: true
-Capybara/MatchStyle: # new in 2.17
-  Enabled: true
-Capybara/NegationMatcher: # new in 2.14
-  Enabled: true
-Capybara/RedundantWithinFind: # new in 2.20
-  Enabled: true
-Capybara/SpecificActions: # new in 2.14
-  Enabled: true
-Capybara/SpecificFinders: # new in 2.13
-  Enabled: true
-Capybara/SpecificMatcher: # new in 2.12
-  Enabled: true
-Capybara/RSpec/HaveSelector: # new in 2.19
-  Enabled: true
-Capybara/RSpec/PredicateMatcher: # new in 2.19
-  Enabled: true
-FactoryBot/AssociationStyle: # new in 2.23
-  Enabled: true
-FactoryBot/ConsistentParenthesesStyle: # new in 2.14
-  Enabled: true
-FactoryBot/ExcessiveCreateList: # new in 2.25
-  Enabled: true
-FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
-  Enabled: true
-FactoryBot/FactoryNameStyle: # new in 2.16
-  Enabled: true
-FactoryBot/IdSequence: # new in 2.24
-  Enabled: true
-FactoryBot/RedundantFactoryOption: # new in 2.23
-  Enabled: true
-FactoryBot/SyntaxMethods: # new in 2.7
-  Enabled: true
 RSpec/BeEmpty: # new in 2.20
   Enabled: true
 RSpec/BeEq: # new in 2.9.0
@@ -311,15 +277,61 @@ RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
 RSpec/VerifiedDoubleReference: # new in 2.10.0
   Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
+Gemspec/AddRuntimeDependency: # new in 1.65
+  Enabled: true
+Lint/ArrayLiteralInRegexp: # new in 1.71
+  Enabled: true
+Lint/ConstantReassignment: # new in 1.70
+  Enabled: true
+Lint/CopDirectiveSyntax: # new in 1.72
+  Enabled: true
+Lint/DuplicateSetElement: # new in 1.67
+  Enabled: true
+Lint/HashNewWithKeywordArgumentsAsDefault: # new in 1.69
+  Enabled: true
+Lint/NumericOperationWithConstantResult: # new in 1.69
+  Enabled: true
+Lint/RedundantTypeConversion: # new in 1.72
+  Enabled: true
+Lint/SharedMutableDefault: # new in 1.70
+  Enabled: true
+Lint/SuppressedExceptionInNumberConversion: # new in 1.72
+  Enabled: true
+Lint/UnescapedBracketInRegexp: # new in 1.68
+  Enabled: true
+Lint/UselessConstantScoping: # new in 1.72
+  Enabled: true
+Lint/UselessDefined: # new in 1.69
+  Enabled: true
+Lint/UselessNumericOperation: # new in 1.66
+  Enabled: true
+Style/AmbiguousEndlessMethodDefinition: # new in 1.68
+  Enabled: true
+Style/BitwisePredicate: # new in 1.68
+  Enabled: true
+Style/CombinableDefined: # new in 1.68
+  Enabled: true
+Style/DigChain: # new in 1.69
+  Enabled: true
+Style/FileNull: # new in 1.69
+  Enabled: true
+Style/FileTouch: # new in 1.69
+  Enabled: true
+Style/HashSlice: # new in 1.71
+  Enabled: true
+Style/ItAssignment: # new in 1.70
+  Enabled: true
+Style/KeywordArgumentsMerging: # new in 1.68
+  Enabled: true
+Style/MapIntoArray: # new in 1.63
   Enabled: true
-RSpec/Rails/HaveHttpStatus: # new in 2.12
+Style/RedundantFormat: # new in 1.72
   Enabled: true
-RSpec/Rails/InferredSpecType: # new in 2.14
+Style/RedundantInterpolationUnfreeze: # new in 1.66
   Enabled: true
-RSpec/Rails/MinitestAssertions: # new in 2.17
+Style/SafeNavigationChainLength: # new in 1.68
   Enabled: true
-RSpec/Rails/NegationBeValid: # new in 2.23
+Style/SendWithLiteralMethodName: # new in 1.64
   Enabled: true
-RSpec/Rails/TravelAround: # new in 2.19
+Style/SuperArguments: # new in 1.64
   Enabled: true

data/Gemfile

@@ -11,6 +11,7 @@ gem "byebug"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.7"
-gem "rubocop-rake", "~> 0.6.0"
-gem "rubocop-rspec", "~> 2.4"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
 gem "webmock", "~> 3.13"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datacite (0.4.0)
+    datacite (0.5.0)
       dry-monads (~> 1.3)
       faraday (~> 2.0)
       json_schema (~> 0.21.0)
@@ -12,51 +12,54 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
+    ast (2.4.3)
     base64 (0.2.0)
     bigdecimal (3.1.9)
-    byebug (11.1.3)
-    concurrent-ruby (1.3.4)
+    byebug (12.0.0)
+    concurrent-ruby (1.3.5)
     crack (1.0.0)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.1)
+    docile (1.4.1)
     dry-core (1.1.0)
       concurrent-ruby (~> 1.0)
       logger
       zeitwerk (~> 2.6)
-    dry-monads (1.7.0)
+    dry-monads (1.8.3)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    faraday (2.12.2)
+    faraday (2.13.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
     hashdiff (1.1.2)
-    json (2.9.1)
+    json (2.11.3)
     json_schema (0.21.0)
-    language_server-protocol (3.17.0.3)
-    logger (1.6.5)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
     net-http (0.6.0)
       uri
-    parallel (1.26.3)
-    parser (3.3.6.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
+    prism (1.4.0)
     public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.10.0)
-    rexml (3.4.0)
+    rexml (3.4.1)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -65,41 +68,42 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.70.0)
+    rubocop (1.75.3)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.36.2, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.37.0)
-      parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.1)
-      rubocop (~> 1.61)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (2.31.0)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.29.1)
-      rubocop (~> 1.61)
+    rubocop-ast (1.44.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)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
-    unicode-display_width (3.1.3)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    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.2)
-    webmock (3.24.0)
+    uri (1.0.3)
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   arm64-darwin-23
@@ -116,9 +120,10 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
-  rubocop-rake (~> 0.6.0)
-  rubocop-rspec (~> 2.4)
+  rubocop-rake
+  rubocop-rspec
+  simplecov
   webmock (~> 3.13)
 
 BUNDLED WITH
-   2.4.13
+   2.6.8

data/README.md

@@ -1,6 +1,8 @@
-# Datacite Ruby Client
-
 [![Gem Version](https://badge.fury.io/rb/datacite.svg)](https://badge.fury.io/rb/datacite)
+[![CircleCI](https://circleci.com/gh/sul-dlss/datacite-ruby.svg?style=svg)](https://circleci.com/gh/sul-dlss/datacite-ruby)
+[![codecov](https://codecov.io/github/sul-dlss/datacite-ruby/graph/badge.svg?token=1FGARREHJN)](https://codecov.io/github/sul-dlss/datacite-ruby)
+
+# Datacite Ruby Client
 
 This is a Ruby client for interfacing with the DataCite REST API. https://support.datacite.org/docs/api
 
@@ -35,7 +37,7 @@ client = Datacite::Client.new(username: "foo",
 result = client.register_doi(prefix: '10.0001', suffix: 'bc123df4567')
 
 result.either(
-  -> response { response.doi },
+  -> response { response },
   -> response { raise("Something went wrong", response.status) }
 )
 ```
@@ -82,7 +84,18 @@ result.either(
   -> response { response },
   -> response { raise("Something went wrong", response.status) }
 )
+```
+
+### Get metadata for a DOI
 
+```ruby
+result = client.metadata(id: '10.0001/bc123df4567')
+
+result.either(
+  -> response { response },
+  -> response { raise("Something went wrong", response.status) }
+)
+```
 
 ### Validation
 This gem validates using a json schema from https://github.com/datacite/schema/blob/master/source/json/kernel-4.3/datacite_4.3_schema.json

data/lib/datacite/client.rb

@@ -71,6 +71,18 @@ module Datacite
       end
     end
 
+    # Fetches the metadata for a DOI
+    # @param [String] id
+    # @returns [Dry::Monads::Result(Hash)]
+    def metadata(id:)
+      response = conn.get("/dois/#{id}")
+      if response.success?
+        Success(response.body)
+      else
+        Failure(response)
+      end
+    end
+
     private
 
     # @returns [Dry::Monads::Result]

data/lib/datacite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Datacite
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacite
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".github/pull_request_template.md"
-- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"

data/.github/workflows/main.yml

@@ -1,16 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0
-        bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake