Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

oai-pmh identifiers use colon to separate namespace and id, not slash #73

Merged
merged 1 commit into from
Aug 22, 2019

Conversation

jrochkind
Copy link
Collaborator

@jrochkind jrochkind commented Aug 22, 2019

This is in conformance with oai-pmh non-mandatory guidelines

It also matches how sample identifier in 'Identify' was being generated before.

r.sampleIdentifier "#{provider.prefix}:#{provider.identifier}"

It was a bug that sample identifier didn't match actual identifiers. Hypothetically, it would have been
less backwards-incompat to make sample identifier use slash, as the Guidelines saying to use colon are not mandatory, it is legal.

But let's use the 1.0 release to make this conform to oai-pmh guidance.

Especially becuase the majority of current users of this gem are probably using it via blacklight_oai_provider, and it was already providing runtime patches to the oai gem to get colon behavior, and had a commit message suggesting it believed it was patching an "identifier bug in oai gem." So let's fix the thing our main user thinks was a bug, for the 1.0 release!

Closes #38
Ref #61

@jrochkind jrochkind changed the title oai-pmh identifieres use colon to separate namespace and id, not slash oai-pmh identifiers use colon to separate namespace and id, not slash Aug 22, 2019
This is in conformance with oai-pmh non-mandatory guidelines: http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm

It also matches how sample identifier in 'Identify' was being generated before.
https://github.com/code4lib/ruby-oai/blob/23e3ac83c43231fbf55f8dfb70175dbe0975b914/lib/oai/provider/response/identify.rb#L24

It was a bug that sample identifier didn't match actual identifiers. Hypothetically, it would have been
less backwards-incompat to make sample identifier use slash. But let's use 1.0 to make this conform to oai-pmh guidance.

Especially becuase the majority of current users of this gem are probably using it via blacklight_oai_provider, and it was already providing runtime patches to the oai gem to get colon behavior, and had a commit message suggesting it believed it was patching an "identifier bug in oai gem." So let's fix the thing our main user thinks was a bug!
https://github.com/projectblacklight/blacklight_oai_provider/blob/f4b25ee43846cb9efc9d5124a8639a496153aa18/config/initializers/oai_patches.rb

Closes #38
Ref #61
@jrochkind jrochkind merged commit c0caea3 into master Aug 22, 2019
@jrochkind jrochkind deleted the proper_identifiers branch August 22, 2019 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discrepancy between sample identifier format and real identifier
1 participant