datacite_doi_ify 0.0.1

data/spec/cassettes/upload_metadata/creates_new_version_of_metadata.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://test:test@mds.datacite.org/metadata
+    body:
+      encoding: UTF-8
+      string: |
+        <resource xmlns="http://datacite.org/schema/kernel-3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd">
+        <identifier identifierType="DOI">10.5072/my_test</identifier>
+        <creators>
+        <creator>
+        <creatorName>First, Last</creatorName>
+        </creator>
+        </creators>
+        <titles>
+        <title>For testing</title>
+        </titles>
+        <publisher>ABC</publisher>
+        <publicationYear>2013</publicationYear>
+        <subjects>
+        <subject>Assessment</subject>
+        <subject>Information Literacy</subject>
+        <subject>Engineering</subject>
+        </subjects>
+        <language>eng</language>
+        <resourceType resourceTypeGeneral="Dataset">Dataset</resourceType>
+        <version>1</version>
+        <descriptions>
+        <description descriptionType="Abstract">
+        A test
+        </description>
+        </descriptions>
+        </resource>
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/xml;charset=UTF-8
+      Content-Length:
+      - '821'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Tue, 04 Nov 2014 13:50:10 GMT
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Location:
+      - https://mds.datacite.org/metadata/10.5072/my_test
+      Content-Type:
+      - application/xml;charset=UTF-8
+      Content-Length:
+      - '20'
+    body:
+      encoding: UTF-8
+      string: OK (10.5072/my_test)
+    http_version:
+  recorded_at: Tue, 04 Nov 2014 13:50:13 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/upload_metadata/returns_400_for_an_invalid_xml.yml

@@ -0,0 +1,76 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://test:test@mds.datacite.org/metadata
+    body:
+      encoding: UTF-8
+      string: |-
+        <resource xmlns="http://datacite.org/schema/kernel-3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd">
+          <creators>
+            <creator>
+              <creatorName>First, Last</creatorName>
+            </creator>
+          </creators>
+          <titles>
+            <title>For testing</title>
+          </titles>
+          <publisher>ABC</publisher>
+          <publicationYear>2013</publicationYear>
+          <subjects>
+            <subject>Assessment</subject>
+            <subject>Information Literacy</subject>
+            <subject>Engineering</subject>
+          </subjects>
+          <language>eng</language>
+          <resourceType resourceTypeGeneral="Dataset">Dataset</resourceType>
+          <version>1</version>
+          <descriptions>
+            <description descriptionType="Abstract">
+              A test
+            </description>
+          </descriptions>
+        </resource>
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/xml;charset=UTF-8
+      Content-Length:
+      - '828'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Tue, 04 Nov 2014 15:23:14 GMT
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Length:
+      - '573'
+      Connection:
+      - close
+      Content-Type:
+      - text/plain
+    body:
+      encoding: UTF-8
+      string: '[xml] xml error: cvc-complex-type.2.4.b: The content of element ''resource''
+        is not complete. One of ''{"http://datacite.org/schema/kernel-3":identifier,
+        "http://datacite.org/schema/kernel-3":contributors, "http://datacite.org/schema/kernel-3":dates,
+        "http://datacite.org/schema/kernel-3":alternateIdentifiers, "http://datacite.org/schema/kernel-3":relatedIdentifiers,
+        "http://datacite.org/schema/kernel-3":sizes, "http://datacite.org/schema/kernel-3":formats,
+        "http://datacite.org/schema/kernel-3":rightsList, "http://datacite.org/schema/kernel-3":geoLocations}''
+        is expected.'
+    http_version:
+  recorded_at: Tue, 04 Nov 2014 15:23:16 GMT
+recorded_with: VCR 2.9.3

data/spec/datacite_doi_ify_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe DataciteDoiIfy do
+
+  let(:endpoint)    { Datacite.new('test', 'test') }
+  let(:doi)    { '10.5072/MY_TEST' }
+  let(:url)    { 'https://seek.sysmo-db.org' }
+
+  describe 'resolve a DOI', :vcr => {:cassette_name => "resolve_a_DOI/returns_a_url_associated_with_a_given_DOI"} do
+    it 'returns a url associated with a given DOI' do
+      expect(endpoint.resolve(doi)).to eq(url)
+    end
+
+    it 'returns a 401 for un-authorized account', :vcr => {:cassette_name => "resolve_a_DOI/returns_a_401_for_un-authorized_account"} do
+      invalid_user = 'invalid'
+      invalid_password = 'invalid'
+      endpoint = Datacite.new(invalid_user, invalid_password)
+      expect(endpoint.resolve(doi)).to eq('401')
+    end
+
+    it 'returns a 404 for not-found DOI', :vcr => {:cassette_name => "resolve_a_DOI/returns_a_404_for_not-found_DOI"} do
+      doi = 'non-existing'
+      expect(endpoint.resolve(doi)).to eq('404')
+    end
+  end
+
+  describe 'mint a DOI' do
+    context 'DOI does not exist' do
+      it 'mints a new DOI', :vcr => {:cassette_name => "mint_a_DOI/mints_a_new_DOI"} do
+        metadata = open('my_test.xml').read
+        expect(endpoint.upload_metadata(metadata)).to eq('OK (10.5072/my_test)')
+        expect(endpoint.mint(doi, url)).to eq('OK')
+        expect(endpoint.resolve(doi)).to eq(url)
+      end
+
+      it 'returns 412 if metadata has not been uploaded', :vcr => {:cassette_name => "mint_a_DOI/returns_412_if_metadata_has_not_been_uploaded"} do
+        new_doi = "10.5072/new_doi"
+        #412 Precondition failed
+        expect(endpoint.mint(new_doi, url)).to eq('412')
+      end
+    end
+
+    context 'DOI exists' do
+      it 'updates the URL if different', :vcr => {:cassette_name => "mint_a_DOI/updates_the_URL_if_different"} do
+        #use test_doi.xml so that it does not update the url of my_test.xml
+        metadata = open('test_doi.xml').read
+        doi = '10.5072/test_doi'
+        expect(endpoint.upload_metadata(metadata)).to eq('OK (10.5072/test_doi)')
+        expect(endpoint.mint(doi, url)).to eq('OK')
+        expect(endpoint.resolve(doi)).to eq(url)
+
+        new_url = 'https://seek.sysmo-db.org/data_files'
+        expect(endpoint.mint(doi, new_url)).to eq('OK')
+        expect(endpoint.resolve(doi)).to eq(new_url)
+      end
+    end
+  end
+
+  describe 'retrieve metadata' do
+    it 'returns metadata associated with a given DOI', :vcr => {:cassette_name => "retrieve_metadata/returns_metadata_associated_with_a_given_DOI"} do
+      metadata = open('my_test.xml').read
+      expect(endpoint.metadata(doi)).to eq(metadata)
+    end
+
+    it 'returns 404 for not found DOI', :vcr => {:cassette_name => "retrieve_metadata/returns_404_for_not_found_DOI"} do
+      doi = 'non-existing'
+      expect(endpoint.metadata(doi)).to eq('404')
+    end
+  end
+
+  describe 'upload metadata' do
+    it 'creates new version of metadata', :vcr => {:cassette_name => "upload_metadata/creates_new_version_of_metadata"} do
+      metadata = open('my_test.xml').read
+      expect(endpoint.upload_metadata(metadata)).to eq('OK (10.5072/my_test)')
+    end
+
+    it 'returns 400 for an invalid xml', :vcr => {:cassette_name => "upload_metadata/returns_400_for_an_invalid_xml"} do
+      # metadata without a DOI => Bad request
+      metadata = open('invalid_doi.xml').read
+      expect(endpoint.upload_metadata(metadata)).to eq('400')
+    end
+  end
+
+  describe 'inactivate a DOI' do
+    it 'marks a dataset as inactive'
+  end
+
+  describe 'activate a DOI' do
+    context 'after a DOI being inactivated' do
+      it 'post new metadata for a given DOI'
+    end
+  end
+
+  #TODO: Media API
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'vcr'
+require 'pry'
+require 'datacite_doi_ify'
+require 'webmock/rspec'
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :none }
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |c|
+
+end

data/test_doi.xml

@@ -0,0 +1,29 @@
+<resource xmlns="http://datacite.org/schema/kernel-3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-3 http://schema.datacite.org/meta/kernel-3/metadata.xsd">
+<identifier identifierType="DOI">10.5072/test_doi</identifier>
+<creators>
+<creator>
+<creatorName>First, Last</creatorName>
+</creator>
+<creator>
+  <creatorName>Test, Doi</creatorName>
+</creator>
+</creators>
+<titles>
+<title>For testing</title>
+</titles>
+<publisher>ABC</publisher>
+<publicationYear>2013</publicationYear>
+<subjects>
+<subject>Assessment</subject>
+<subject>Information Literacy</subject>
+<subject>Engineering</subject>
+</subjects>
+<language>eng</language>
+<resourceType resourceTypeGeneral="Dataset">Dataset</resourceType>
+<version>1</version>
+<descriptions>
+<description descriptionType="Abstract">
+A test
+</description>
+</descriptions>
+</resource>

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: datacite_doi_ify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- quyen nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mint DOI and resolve DOI using Datacite restful web service
+email:
+- thucquyendn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- datacite_doi_ify.gemspec
+- invalid_doi.xml
+- lib/datacite_doi_ify.rb
+- lib/datacite_doi_ify/datacite.rb
+- lib/datacite_doi_ify/version.rb
+- my_test.xml
+- spec/cassettes/mint_a_DOI/mints_a_new_DOI.yml
+- spec/cassettes/mint_a_DOI/returns_412_if_metadata_has_not_been_uploaded.yml
+- spec/cassettes/mint_a_DOI/updates_the_URL_if_different.yml
+- spec/cassettes/resolve_a_DOI/returns_a_401_for_un-authorized_account.yml
+- spec/cassettes/resolve_a_DOI/returns_a_404_for_not-found_DOI.yml
+- spec/cassettes/resolve_a_DOI/returns_a_url_associated_with_a_given_DOI.yml
+- spec/cassettes/retrieve_metadata/returns_404_for_not_found_DOI.yml
+- spec/cassettes/retrieve_metadata/returns_metadata_associated_with_a_given_DOI.yml
+- spec/cassettes/upload_metadata/creates_new_version_of_metadata.yml
+- spec/cassettes/upload_metadata/returns_400_for_an_invalid_xml.yml
+- spec/datacite_doi_ify_spec.rb
+- spec/spec_helper.rb
+- test_doi.xml
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: datacite_doi_ify
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby gem to working with datacite doi restful web service
+test_files:
+- spec/cassettes/mint_a_DOI/mints_a_new_DOI.yml
+- spec/cassettes/mint_a_DOI/returns_412_if_metadata_has_not_been_uploaded.yml
+- spec/cassettes/mint_a_DOI/updates_the_URL_if_different.yml
+- spec/cassettes/resolve_a_DOI/returns_a_401_for_un-authorized_account.yml
+- spec/cassettes/resolve_a_DOI/returns_a_404_for_not-found_DOI.yml
+- spec/cassettes/resolve_a_DOI/returns_a_url_associated_with_a_given_DOI.yml
+- spec/cassettes/retrieve_metadata/returns_404_for_not_found_DOI.yml
+- spec/cassettes/retrieve_metadata/returns_metadata_associated_with_a_given_DOI.yml
+- spec/cassettes/upload_metadata/creates_new_version_of_metadata.yml
+- spec/cassettes/upload_metadata/returns_400_for_an_invalid_xml.yml
+- spec/datacite_doi_ify_spec.rb
+- spec/spec_helper.rb