cirneco 0.7.4 → 0.8.1

data/lib/cirneco/work.rb

@@ -11,7 +11,7 @@ module Cirneco
     include Cirneco::Api
     include Cirneco::Utils
 
-    attr_accessor :doi, :url, :creators, :title, :publisher, :publication_year, :resource_type, :version, :related_identifiers, :rights_list, :descriptions, :contributors, :date_issued, :subjects, :media, :username, :password, :validation_errors
+    attr_accessor :doi, :url, :creators, :title, :publisher, :publication_year, :resource_type, :version, :alternate_identifier, :related_identifiers, :rights_list, :descriptions, :contributors, :date_issued, :date_created, :date_updated, :subjects, :media, :username, :password, :validation_errors
 
     def initialize(metadata, **options)
       @doi = metadata.fetch("doi", nil)
@@ -24,9 +24,12 @@ module Cirneco
       @version = metadata.fetch("version", nil)
       @rights_list = metadata.fetch("rights_list", nil)
       @date_issued = metadata.fetch("date_issued", nil)
+      @date_created = metadata.fetch("date_created", nil)
+      @date_updated = metadata.fetch("date_updated", nil)
       @subjects = metadata.fetch("subjects", nil)
       @descriptions = metadata.fetch("descriptions", nil)
       @contributors = metadata.fetch("contributors", nil)
+      @alternate_identifier = metadata.fetch("alternate_identifier", nil)
       @related_identifiers = metadata.fetch("related_identifiers", nil)
 
       @media = options.fetch(:media, nil)
@@ -52,6 +55,7 @@ module Cirneco
       insert_publisher(xml)
       insert_publication_year(xml)
       insert_resource_type(xml)
+      insert_alternate_identifiers(xml)
       insert_subjects(xml)
       insert_contributors(xml)
       insert_dates(xml)
@@ -119,16 +123,24 @@ module Cirneco
       xml.resourceType(resource_type[:value], 'resourceTypeGeneral' => resource_type[:resource_type_general])
     end
 
-    def insert_dates(xml)
-      return xml unless date_issued.present?
+    def insert_alternate_identifiers(xml)
+      return xml unless alternate_identifier.present?
 
+      xml.alternateIdentifiers do
+        xml.alternateIdentifier(alternate_identifier, 'alternateIdentifierType' => "Local accession number")
+      end
+    end
+
+    def insert_dates(xml)
       xml.dates do
-        insert_date(xml)
+        insert_date(xml, date_created, 'Created') if date_created.present?
+        insert_date(xml, date_issued, 'Issued') if date_issued.present?
+        insert_date(xml, date_updated, 'Updated') if date_updated.present?
       end
     end
 
-    def insert_date(xml)
-      xml.date(date_issued, 'dateType' => 'Issued')
+    def insert_date(xml, date, date_type)
+      xml.date(date, 'dateType' => date_type)
     end
 
     def insert_subjects(xml)
@@ -198,7 +210,7 @@ module Cirneco
     end
 
     def validation_errors
-      @validation_errors ||= schema.validate(Nokogiri::XML(data)).map { |error| error.to_s }
+      @validation_errors ||= OpenStruct.new(body: { "errors" => schema.validate(Nokogiri::XML(data)).map { |error| { "title" => error.to_s } } })
     end
   end
 end

data/spec/api_spec.rb

@@ -28,6 +28,15 @@ describe Cirneco::Work, vcr: true, :order => :defined do
                               password: password) }
 
   describe "Metadata API" do
+    context "post" do
+      it 'should post metadata' do
+        response = subject.post_metadata(subject.data, options)
+        expect(response.body["data"]).to eq("OK (10.5072/0000-03VC)")
+        expect(response.status).to eq(201)
+        expect(response.headers["Location"]).to eq("http://mds-sandbox.datacite.org/metadata/10.5072/0000-03VC")
+      end
+    end
+
     context "get" do
       it 'should get metadata' do
         response = subject.get_metadata(doi, options)
@@ -42,15 +51,6 @@ describe Cirneco::Work, vcr: true, :order => :defined do
         expect(response.status).to eq(200)
       end
     end
-
-    context "post" do
-      it 'should post metadata' do
-        response = subject.post_metadata(subject.data, options)
-        expect(response.body["data"]).to eq("OK (10.5072/0000-03VC)")
-        expect(response.status).to eq(201)
-        expect(response.headers["Location"]).to eq("https://mds.test.datacite.org/metadata/10.5072/0000-03VC")
-      end
-    end
   end
 
   describe "DOI API" do
@@ -66,7 +66,7 @@ describe Cirneco::Work, vcr: true, :order => :defined do
       it 'should get all dois' do
         response = subject.get_dois(options)
         dois = response.body["data"]
-        expect(dois.length).to eq(13)
+        expect(dois.length).to eq(504)
         expect(dois.first).to eq("10.23725/0000-03VC")
       end
 

data/spec/doi_spec.rb

@@ -10,13 +10,14 @@ describe Cirneco::Doi do
   let(:prefix) { ENV['PREFIX'] }
   let(:doi) { "10.5072/0000-03VC" }
   let(:url) { "http://www.datacite.org" }
-  let(:filename) { 'cool-dois.html.md' }
+  let(:filename) { 'cool-dois.html' }
   let(:filepath) { fixture_path + filename }
   let(:username) { ENV['MDS_USERNAME'] }
   let(:password) { ENV['MDS_PASSWORD'] }
   let(:csl) { "spec/fixtures/apa.csl" }
   let(:bibliography) { "spec/fixtures/bibliography.yaml" }
   let(:api_options) { { username: username, password: password, sandbox: true } }
+  let(:mint_options) { { username: username, password: password, sandbox: true, source_path: "/spec/fixtures/", csl: csl, bibliography: bibliography } }
 
   describe "MDS DOI API", vcr: true, :order => :defined do
     context "put" do
@@ -28,8 +29,8 @@ describe Cirneco::Doi do
 
     context "get" do
       it 'should get all dois' do
-        subject.options = api_options
-        expect { subject.get "all" }.to output("10.23725/0000-03VC\n10.23725/0000-0A53\n10.23725/GQZDGNZW\n10.23725/MDS-CLIENT-RUBY-TEST\n10.5072/0000-03VC\n10.5438/0001\n10.5438/0002\n10.5438/0003\n10.5438/0004\n10.5438/0005\n10.5438/0006\n10.5438/EXAMPLE-FULL\n10.5438/MDS-CLIENT-RUBY-TEST\n").to_stdout
+        subject.options = api_options.merge(limit: 3)
+        expect { subject.get "all" }.to output("10.23725/0000-03VC\n10.23725/0000-0A53\n10.23725/GQZDGNZW\n").to_stdout
       end
 
       it 'should get doi' do
@@ -44,6 +45,13 @@ describe Cirneco::Doi do
     end
   end
 
+  context "accession_number" do
+    it 'generates an accession_number' do
+      subject.options = { number: number }
+      expect { subject.accession_number }.to output("MS-123\n").to_stdout
+    end
+  end
+
   context "base32" do
     it 'generates a doi' do
       subject.options = { number: number, prefix: prefix }
@@ -69,45 +77,39 @@ describe Cirneco::Doi do
     end
   end
 
-  context "mint and hide DOIs", :order => :defined do
+  context "mint and hide DOIs", vcr: true, :order => :defined do
     it 'mints a doi' do
-      subject.options = { csl: csl, bibliography: bibliography }
+      subject.options = mint_options
       expect { subject.mint filepath }.to output("DOI 10.5072/0000-03VC minted for #{filename}\n").to_stdout
     end
 
     it 'hides a doi' do
-      subject.options = { csl: csl, bibliography: bibliography }
-      expect { subject.hide filepath }.to output("DOI 10.5072/0000-03VC hidden for #{filename}\n").to_stdout
+      filename = 'cool-dois-minted.html'
+      filepath = fixture_path + filename
+      subject.options = mint_options.merge(filepath: filepath)
+      expect { subject.hide filepath }.to output("DOI 10.5072/0000-03WD hidden for #{filename}\n").to_stdout
     end
 
     it 'mints and hides a doi' do
-      subject.options = { csl: csl, bibliography: bibliography }
+      subject.options = mint_options
       expect { subject.mint_and_hide filepath }.to output("DOI 10.5072/0000-03VC minted and hidden for #{filename}\n").to_stdout
     end
 
-    it 'mints dois for contents of a folder' do
-      subject.options = { csl: csl, bibliography: bibliography }
-      expect { subject.mint fixture_path }.to output("DOI 10.5072/0000-03VC minted for #{filename}\n").to_stdout
-    end
-
-    it 'hides dois for contents of a folder' do
-      subject.options = { csl: csl, bibliography: bibliography }
-      expect { subject.hide fixture_path }.to output("DOI 10.5072/0000-03VC hidden for #{filename}\n").to_stdout
-    end
-
-    it 'mints and hides dois for contents of a folder' do
-      subject.options = { csl: csl, bibliography: bibliography }
-      expect { subject.mint_and_hide fixture_path }.to output("DOI 10.5072/0000-03VC minted and hidden for #{filename}\n").to_stdout
+    it 'mints dois for list of urls' do
+      subject.options = mint_options
+      expect { subject.mint [filepath] }.to output("DOI 10.5072/0000-03VC minted for #{filename}\n").to_stdout
     end
 
-    it 'should ignore non-markdown file for mint file' do
-      filename = 'cool-dois.yml'
-      expect { subject.mint fixture_path + filename }.to output("File #{filename} ignored: not a markdown file\n").to_stdout
+    it 'hides dois for list of urls' do
+      filename = 'cool-dois-minted.html'
+      filepath = fixture_path + filename
+      subject.options = mint_options.merge(filepath: filepath)
+      expect { subject.hide [filepath] }.to output("DOI 10.5072/0000-03WD hidden for #{filename}\n").to_stdout
     end
 
-    it 'should ignore non-markdown file for hide file' do
-      filename = 'cool-dois.yml'
-      expect { subject.hide fixture_path + filename }.to output("File #{filename} ignored: not a markdown file\n").to_stdout
+    it 'mints and hides dois for list of urls' do
+      subject.options = mint_options
+      expect { subject.mint_and_hide [filepath] }.to output("DOI 10.5072/0000-03VC minted and hidden for #{filename}\n").to_stdout
     end
   end
 end

data/spec/fixtures/cool-dois-minted.html

@@ -0,0 +1,404 @@
+<!DOCTYPE html>
+  <html>
+    <head>
+    <meta charset="utf-8">
+    <!-- (1) Optimize for mobile versions: http://goo.gl/EOpFl -->
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <!-- (1) force latest IE rendering engine: bit.ly/1c8EiC9 -->
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+
+    <title>Cool DOI's</title>
+    <meta name="description" content="In 1998 Tim Berners-Lee coined the term cool URIs (1998), that is URIs that don’t change. We know that URLs referenced in the scholarly literature are often not cool, leading to link rot (Klein et al., 2014) and making it hard or impossible to find..." />
+
+    <meta name="HandheldFriendly" content="True" />
+    <meta name="MobileOptimized" content="320" />
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+
+    <!-- DublinCore Metadata -->
+    <meta property="dc:title" content="Cool DOI's" />
+    <meta property="dc:format" content="text/html" />
+    <meta property="dc:language" content="en" />
+    <meta property="dc:rights" content="CC-BY" />
+    <meta property="dc:source" content="DataCite Blog" />
+    <meta property="dc:subject" content="Scholarly Communication" />
+    <meta property="dc:type" content="website" />
+
+    <meta name="twitter:card" content="summary" />
+    <meta name="twitter:site" content="datacite" />
+    <meta name="twitter:title" content="Cool DOI's" />
+    <meta name="twitter:image" content="https://blog.datacite.org/images/2016/12/cool-dois.png" />
+    <meta name="twitter:description" content="In 1998 Tim Berners-Lee coined the term cool URIs (1998), that is URIs that don’t change. We know that URLs referenced in the scholarly literature are often not cool, leading to link rot (Klein et al., 2014) and making it hard or impossible to find..." />
+
+    <meta property="og:site_name" content="Cool DOI's" />
+    <meta property="og:description" content="In 1998 Tim Berners-Lee coined the term cool URIs (1998), that is URIs that don’t change. We know that URLs referenced in the scholarly literature are often not cool, leading to link rot (Klein et al., 2014) and making it hard or impossible to find..." />
+    <meta property="og:image" content="https://blog.datacite.org/images/2016/12/cool-dois.png" />
+    <meta property="og:type" content="blog" />
+
+    <link href="//fonts.googleapis.com/css?family=Libre+Baskerville:400,400i,700" rel="stylesheet">
+    <link href='//fonts.googleapis.com/css?family=Raleway:400,600,400italic,600italic' rel='stylesheet' type='text/css'>
+    <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.6.1/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
+    <link href="//localhost:4568/stylesheets/datacite.css" rel='stylesheet' type='text/css'>
+
+    <link href="/images/favicon.ico" rel="icon" type="image/ico" />
+
+    <script type="application/ld+json">
+      {
+          "@context": "http://schema.org",
+          "@type": "BlogPosting",
+          "@id": "https://doi.org/10.5072/0000-03WD",
+          "name": "Cool DOI's",
+          "alternateName":"MS-124",
+          "url": "https://blog.datacite.org/cool-dois/",
+          "author": [
+              {
+                  "@type": "Person",
+                  "@id": "http://orcid.org/0000-0003-1419-2405",
+                  "givenName": "Martin",
+                  "familyName": "Fenner",
+                  "name": "Martin Fenner"
+              }
+          ],
+          "publisher": {
+              "@type": "Organization",
+              "name": "DataCite"
+          },
+          "dateCreated": "2016-12-15",
+          "datePublished": "2016-12-15",
+          "dateModified": "2016-12-15",
+          "keywords": "doi, featured",
+          "version": "1.0",
+          "description": "In 1998 Tim Berners-Lee coined the term cool URIs (1998), that is URIs that don’t change. We know that URLs referenced in the scholarly literature are often not cool, leading to link rot (Klein et al., 2014) and making it hard or impossible to find...",
+          "license": "https://creativecommons.org/licenses/by/4.0/",
+          "image": "https://blog.datacite.org/images/2016/12/cool-dois.png",
+          "encoding": {
+              "@type": "MediaObject",
+              "@id": "https://raw.githubusercontent.com/datacite/blog/master/source/posts/cool-dois.html.md",
+              "fileFormat": "text/markdown"
+          },
+          "isPartOf": {
+              "@type": "Blog",
+              "@id": "https://blog.datacite.org",
+              "name": "DataCite Blog"
+          },
+          "citation": [
+              {
+                  "@type": "CreativeWork",
+                  "@id": "https://www.w3.org/Provider/Style/URI"
+              },
+              {
+                  "@type": "CreativeWork",
+                  "@id": "https://doi.org/10.1371/journal.pone.0115253"
+              }
+          ]
+      }
+    </script>
+  </head>
+  <body>
+
+<!-- header start -->
+
+<div class="header" id="navtop">
+  <div class="navbar navbar-white navbar-static-top" role="navigation">
+    <div class="container-fluid">
+      <div class="navbar-header"
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+          <span class="sr-only">Toggle navigation</span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="/">DataCite Blog</a>
+      </div>
+      <div class="navbar-collapse collapse">
+        <ul class="nav navbar-nav navbar-right">
+          <li class="dropdown">
+            <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="support">Support <span class="caret"></a>
+            <ul class="dropdown-menu" role="menu">
+              <li><a href="mailto:support@datacite.org">Email</a></li>
+              <li><a href="https://github.com/datacite/blog">Source Code</a></li>
+            </ul>
+          </li>
+          <li class="dropdown">
+            <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="sites"><i class='fa fa-th'></i> <span class="caret"></span></a>
+            <ul class="dropdown-menu" role="menu">
+                  <li>
+                    <a href='https://api.datacite.org'>
+                      <i class='fa fa-cogs fa-fw'></i>
+                      API
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://blog.datacite.org'>
+                      <i class='fa fa-rss fa-fw'></i>
+                      Blog
+                    </a>
+                  </li>
+                  <li>
+                    <a href='http://citation.crosscite.org'>
+                      <i class='fa fa-file-text-o fa-fw'></i>
+                      Citation Formatter
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://data.datacite.org'>
+                      <i class='fa fa-repeat fa-fw'></i>
+                      Content Resolver
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://www.datacite.org'>
+                      <i class='fa fa-globe fa-fw'></i>
+                      Homepage
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://mds.datacite.org'>
+                      <i class='fa fa-database fa-fw'></i>
+                      MDS
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://oai.datacite.org'>
+                      <i class='fa fa-table fa-fw'></i>
+                      OAI-PMH
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://profiles.datacite.org'>
+                      <i class='fa fa-user fa-fw'></i>
+                      Profiles
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://schema.datacite.org'>
+                      <i class='fa fa-file-code-o fa-fw'></i>
+                      Schema
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://search.datacite.org'>
+                      <i class='fa fa-search fa-fw'></i>
+                      Search
+                    </a>
+                  </li>
+                  <li>
+                    <a href='https://stats.datacite.org'>
+                      <i class='fa fa-bar-chart fa-fw'></i>
+                      Statistics
+                    </a>
+                  </li>
+                  <li>
+                    <a href='http://status.datacite.org'>
+                      <i class='fa fa-calendar-check-o fa-fw'></i>
+                      Status
+                    </a>
+                  </li>
+            </ul>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</div>
+
+<!-- header end -->
+
+      <div class="wrapper">
+    <div class="section section-white">
+      <div class="container-fluid">
+        <div class="row row-section">
+          <div class="col-md-8 col-md-offset-2 post-content">
+            <a name="topofpage"></a>
+            <div class="post-meta">
+              <h1>Cool DOI's</h1>
+              December 15, 2016 by Martin Fenner
+              • <span class="post-reading-time"></span> read
+                <p class="doi"><a href="https://doi.org/10.5438/55E5-T5C0">https://doi.org/10.5438/55E5-T5C0</a></p>
+            </div>
+
+            <p>In 1998 Tim Berners-Lee coined the term cool URIs <span class="citation">(<a href="#ref-https://www.w3.org/Provider/Style/URI">1998</a>)</span>, that is URIs that don’t change. We know that URLs referenced in the scholarly literature are often not cool, leading to link rot <span class="citation">(Klein et al., <a href="#ref-https://doi.org/10.1371/journal.pone.0115253">2014</a>)</span> and making it hard or impossible to find the referenced resource.</p>
+<p>Cool URIs are, of course, a fundamental principle behind DOIs, with the two important concepts <a href="https://www.doi.org/doi_handbook/3_Resolution.html"><em>resolution</em></a> (it is very hard to maintain a URL directly pointing at a resource) and <a href="https://www.doi.org/doi_handbook/6_Policies.html"><em>policies</em></a> (that all DOI registration agencies and organizations minting DOIs agree to maintain the redirection). The third essential element for DOIs, their <a href="https://www.doi.org/doi_handbook/4_Data_Model.html"><em>data model</em></a>, is not directly about persistent linking, but about the discoverability of the linked resources via standard metadata in a central index.</p>
+<p>All DOIs, expressed as HTTP URI, are therefore cool URIs. So what is a cool DOI? And, furthermore, how to create and use them? To understand what a cool DOI is, we have to explain the three parts that make up a DOI:</p>
+<div class="figure">
+<img src="/images/2016/12/doi-parts.png" />
+
+</div>
+<h3 id="proxy">Proxy</h3>
+<p>The proxy is not part of the DOI specification, but almost all scholarly DOIs that users encounter today will be expressed as HTTP URLs. DataCite recommends that all DOIs are displayed as permanent URLs, consistent with the recommendations of other DOI registration agencies, e.g. the <a href="http://www.crossref.org/02publishers/doi_display_guidelines.html">Crossref DOI display guidelines</a>. When the DOI system was originally designed, it was thought that the DOI protocol would become widely used, but that clearly has not happened and displaying DOIs as <strong>doi:10.5281/ZENODO.31780</strong> is therefore not recommended.</p>
+<p>The DOI proxy enables the functionality of expressing DOIs as HTTP URIs. Users should also be aware of two these two recommendations:</p>
+<ul>
+<li>Use <a href="https://www.doi.org/doi_proxy/proxy_policies.html">doi.org</a> instead of dx.doi.org as DNS name</li>
+<li>Use the HTTPS protocol instead of HTTP protocol</li>
+</ul>
+<p>Ed Pentz from Crossref makes the case for HTTPS in a <a href="http://blog.crossref.org/2016/09/new-crossref-doi-display-guidelines.html">September blog post</a>. The web, and therefore also the scholarly web, is moving to HTTPS as the default. It is important that the DOI proxy redirects to HTTPS URLs, and it will take some time until all DataCite data centers use HTTPS for the landing pages their DOIs redirects to.</p>
+<p>What many users don’t know is that doi.org is not the only proxy server for DOIs. DOIs use the handle system and any handle server will resolve a DOI, just as doi.org will resolve any handle. This means that <a href="https://hdl.handle.net/10.5281/ZENODO.31780" class="uri">https://hdl.handle.net/10.5281/ZENODO.31780</a> will resolve to the landing page for that DOI and that <a href="http://doi.org/10273/BGRB5054RX05201" class="uri">http://doi.org/10273/BGRB5054RX05201</a> is a handle (for a <a href="http://www.igsn.org/">IGSN</a>) and not a DOI.</p>
+<h3 id="prefix">Prefix</h3>
+<p>The DOI prefix is used as a namespace so that DOIs are globally unique without requiring global coordination for every new identifier. Prefixes in the handle system and therefore for DOIs are numbers without any semantic meaning. One lesson learned with persistent identifiers is that adding meaning to the identifier (e.g. by using a prefix with the name of the data repository) is always dangerous, because – despite best intentions – all names can change over time.</p>
+<p>Since the DOI prefix is a namespace to keep DOIs globally unique, there is usually no need for multiple prefixes for one organization managing DOI assignment. The tricky part is that these responsibilities can change, e.g. when an organization manages multiple repositories and one of them is migrated to another organization. It therefore makes sense to assign one prefix per list of resources that always stays together, e.g. one repository. It is possible that one prefix is managed by multiple organizations (as long as they use the same DOI registration agency), but that makes DOI management more complex.</p>
+<h3 id="suffix">Suffix</h3>
+<p>The suffix for a DOI can be (almost) any string. Which is both a feature and a curse. It is a feature because it gives maximal flexibility, for example when migrating existing identifiers to the DOI system. And it is a curse because it not always works well in the web context, as the list of characters allowed in a URL is limited. A good example of this are SICIs (<a href="https://en.wikipedia.org/wiki/Serial_Item_and_Contribution_Identifier">Serial Item and Contribution Identifier</a>), they were defined in 1996 before the DOI system was implemented, and could then be migrated to DOIs. Unfortunately they can contain many characters that are problematic in a URL or make it difficult to validate the DOI, as in <a href="https://doi.org/10.1002/(sici)1099-1409(199908/10)3:6/7%3C672::aid-jpp192%3E3.0.co;2-8" class="uri">https://doi.org/10.1002/(sici)1099-1409(199908/10)3:6/7&lt;672::aid-jpp192&gt;3.0.co;2-8</a>. A Crossref <a href="http://blog.crossref.org/2015/08/doi-regular-expressions.html">blog post</a> by Andrew Gilmartin gives a good overview about the characters found in DOIs and suggests the following regular expression to check for valid DOIs:</p>
+<pre><code>/^10.\d{4,9}/[-._;()/:A-Z0-9]+$/i</code></pre>
+<p>SICIs demonstrate two other pitfalls:</p>
+<ul>
+<li>they contain semantic information (ISSN, volume, number, etc.) that may change over time, and</li>
+<li>they are long, difficult to transcribe, with characters not allowed in URLs, and not very human-readable.</li>
+</ul>
+<p>Semantic information might also lead users to expect certain functionalities. A common pattern that we see at DataCite is to include information about the version or parent in the suffix, e.g. <a href="https://doi.org/10.6084/M9.FIGSHARE.3501629.V1" class="uri">https://doi.org/10.6084/M9.FIGSHARE.3501629.V1</a> or <a href="https://doi.org/10.5061/DRYAD.0SN63/7" class="uri">https://doi.org/10.5061/DRYAD.0SN63/7</a>. While the decision on what to put into the suffix is up to each data center, we should make sure users don’t think that these are functionalities of the DOI system (e.g. that adding <strong>.V2</strong> to any DOI name will resolve to version 2 of that resource).</p>
+<p>Another issue to keep in mind when assigning suffixes is that DOIs – in contrast to HTTP URIs – are case-insensitive, <a href="https://doi.org/10.5281/ZENODO.31780" class="uri">https://doi.org/10.5281/ZENODO.31780</a> and <a href="https://doi.org/10.5281/zenodo.31780" class="uri">https://doi.org/10.5281/zenodo.31780</a> are the same DOI. All DOIs are <a href="https://www.doi.org/doi_handbook/2_Numbering.html#2.4">converted to upper case</a> upon registration and DOI resolution, but DOIs are not consistently displayed in such a way.</p>
+<h3 id="generating-cool-dois">Generating cool DOIs</h3>
+<p>With all that, what should the ideal DOI look like? Its suffix should be:</p>
+<ul>
+<li>opaque without semantic information</li>
+<li>work well in a web environment, avoiding characters problematic in URLs</li>
+<li>short and human-readable</li>
+<li>Resistant to transcription errors</li>
+<li>easy to generate</li>
+</ul>
+<p>On Tuesday DataCite released a tool that helps generating such a suffix, an open source command line tool called <a href="https://github.com/datacite/cirneco">cirneco</a> (a lot of our open source software uses Italian dog breed names). Cirneco is a Ruby gem that can be installed via</p>
+<pre><code>gem install cirneco</code></pre>
+<p>Cirneco uses base32 encoding, as <a href="http://www.crockford.com/wrmg/base32.html">described</a> by Douglas Crockford. The encoding starts with a randomly generated number to guarantee uniqueness of the identifier, and then encodes the number into a string that uses all numbers and uppercase letters. It avoids the letters I, O and L as they can be confused with the letter 1 and 0, using 32 characters (and 5 checksum characters) in total. The last character is a checksum. The resulting string from cirneco always has a length of 8 characters, in groups of 4 separated by a hyphen to help with readability. The advantage of base32 encoding over using only numbers (as for example ORCID is doing) is that the resulting string becomes much more compact, the available 7 characters (plus one for the checksum) can encode 34,359,738,367 strings, compared to 10 million when only using numbers. This number is large enough that the resulting suffix will not only be unique for a given prefix, but also unique for all DOIs (there is a very small chance to get the same random number twice, but this will be rejected when trying to register the DOI).</p>
+<p>Another common way to generate random strings would have been universally unique identifiers (<a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a>), but they are long and not very human-readable, e.g. <a href="https://doi.org/10.4233/UUID:6D192FE2-DE18-4556-873A-D3CD56AB96A6" class="uri">https://doi.org/10.4233/UUID:6D192FE2-DE18-4556-873A-D3CD56AB96A6</a>.</p>
+<p>An example DOI generated by cirneco would be</p>
+<pre><code>cirneco doi generate --prefix 10.5555
+10.5555/KVTD-VPWM</code></pre>
+<p>The generated DOI is short enough that it should work well in places where space is limited, providing an alternative to the <a href="http://shortdoi.org/">ShortDOI</a> service which shortens existing DOIs, but does this by adding another layer on top of the DOI proxy.</p>
+<p>Another cirneco command checks that this is a valid bas32 string using the checksum</p>
+<pre><code>cirneco doi check 10.5555/KVTD-VPWM
+Checksum for 10.5555/KVTD-VPWM is valid</code></pre>
+<p>This can be used to quickly verify a DOI, e.g. in a web form or API. The Ruby base32 encoding library used by cirneco is open source (<a href="https://github.com/datacite/base32" class="uri">https://github.com/datacite/base32</a>. I added the checksum to the existing library), and implementations of the Crockford base32 encoding pattern are available in many other languages, including <a href="https://github.com/jbittel/base32-crockford">Python</a>, <a href="https://github.com/dflydev/dflydev-base32-crockford">PHP</a>, <a href="https://www.npmjs.com/package/base32-crockford">Javascript</a>, <a href="http://stackoverflow.com/questions/22385467/crockford-base32-encoding-for-large-number-java-implementation">Java</a>, <a href="https://github.com/richardlehane/crock32">Go</a> and <a href="https://crockfordbase32.codeplex.com/">.NET</a>.</p>
+<p>To answer the question raised at the beginning: a cool DOI is a DOI expressed as HTTPS URI using the doi.org proxy and using a base32-encoded suffix, for example <strong>https://doi.org/10.5555/KVTD-VPWM</strong>. This DOI works well in a web environment, is human readable, easy to parse and detect (e.g. in text mining), and can be generated using an algorithm that is well understood and supported.</p>
+<div class="figure">
+<img src="/images/2016/12/cool-dois.svg" />
+
+</div>
+<h3 id="references" class="unnumbered">References</h3>
+<div id="refs" class="references">
+<div id="ref-https://www.w3.org/Provider/Style/URI">
+<p>Berners-Lee, T. (1998). Hypertext Style: Cool URIs don’t change. Retrieved from <a href="https://www.w3.org/Provider/Style/URI" class="uri">https://www.w3.org/Provider/Style/URI</a></p>
+</div>
+<div id="ref-https://doi.org/10.1371/journal.pone.0115253">
+<p>Klein, M., Sompel, H. V. de, Sanderson, R., Shankar, H., Balakireva, L., Zhou, K., &amp; Tobin, R. (2014). Scholarly Context Not Found: One in Five Articles Suffers from Reference Rot. <em>PLOS ONE</em>, <em>9</em>(12), e115253. <a href="http://doi.org/10.1371/journal.pone.0115253" class="uri">http://doi.org/10.1371/journal.pone.0115253</a></p>
+</div>
+</div>
+
+            <hr width="80%">
+          </div>
+        </div>
+        <div class="row">
+          <div class="col-md-5 col-md-offset-2 post-content">
+            <div class="bottom-teaser cf">
+  <div class="isLeft">
+    <section class="author">
+          <div class="author-image" style="background-image: url(https://www.gravatar.com/avatar/434592a097e91261792ebd6b492042bc?s=250&d=mm&r=x)">Blog Logo</div>
+        <h4>Martin Fenner</h4>
+        <p class="bio">DataCite Technical Director</p>
+        <p class="orcid"><a href="http://orcid.org/0000-0003-1419-2405">http://orcid.org/0000-0003-1419-2405</a></p>
+        <div class="clearfix"></div>
+      <h4>Cool DOI's</h4>
+        <p class="published"><a href="https://doi.org/10.5438/55E5-T5C0">https://doi.org/10.5438/55E5-T5C0</a>
+      <p class="published"><i class="fa fa-calendar"></i> <time datetime="2016-12-15 00:00">December 15, 2016</time></p>
+      <p class="published"><i class="fa fa-history"></i> <a href="https://github.com/datacite/blog/commits/master/source/posts/cool-dois.html.md">History</a></p>
+      <p class="published">© 2016 Martin Fenner. Distributed under the terms of the <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution license</a>.</p>
+      <p class="published">
+        <i class="fa fa-tags"></i>
+        <a href="/index.html?tag=doi">doi</a>, <a href="/index.html?tag=featured">featured</a>
+      </p>
+    </section>
+  </div>
+</div>
+
+          </div>
+          <div class="col-md-2 col-md-offset-1">
+             <div class="bottom-teaser cf">
+  <div class="isLeft">
+    <h5 class="index-headline featured"><span>Share on</span></h5>
+      <a class="icon-twitter" href="http://twitter.com/share?text=On the @datacite blog: Cool DOI's&amp;url=http://localhost:4567/cool-dois/"
+        onclick="window.open(this.href, 'twitter-share', 'width=550,height=255');return false;">
+        <i class="fa fa-twitter fa-2x"></i><span class="hidden">twitter</span>
+      </a>
+      <a class="icon-facebook" href="https://www.facebook.com/sharer.php?t=On the @datacite blog: Cool DOI's&amp;u=http://localhost:4567/cool-dois/"
+        onclick="window.open(this.href, 'facebook-share', 'width=550,height=255');return false;">
+        <i class="fa fa-facebook fa-2x"></i><span class="hidden">facebook</span>
+      </a>
+  </div>
+</div>
+
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+
+    <!-- footer start -->
+
+<footer class='row footer'>
+  <div class="container-fluid">
+    <div class='col-md-3 col-sm-4'>
+      <h4>About DataCite</h4>
+      <ul>
+        <li><a href="https://www.datacite.org/mission.html">What we do</a></a></li>
+        <li><a href="https://www.datacite.org/board.html">Board</a></a></li>
+        <li><a href="https://www.datacite.org/steering.html">Steering groups</a></a></li>
+        <li><a href="https://www.datacite.org/staff.html">Staff</a></a></li>
+        <li><a href="https://www.datacite.org/jobopportunities.html">Job opportunities</a></a></li>
+      </ul>
+    </div>
+    <div class='col-md-3 col-sm-4'>
+      <h4>Services</h4>
+      <ul>
+        <li><a href="https://www.datacite.org/dois.html">Assign DOIs</a></a></li>
+        <li><a href="https://www.datacite.org/search.html">Metadata search</a></a></li>
+        <li><a href="https://www.datacite.org/eventdata.html">Event data</a></a></li>
+        <li><a href="https://www.datacite.org/profiles.html">Profiles</a></a></li>
+        <li><a href="https://www.datacite.org/re3data.html">re3data</a></a></li>
+        <li><a href="https://www.datacite.org/citation.html">Citation formatter</a></a></li>
+        <li><a href="https://www.datacite.org/stats.html">Statistics</a></a></li>
+        <li><a href="https://www.datacite.org/service.html">Service status</a></a></li>
+        <li><a href="https://www.datacite.org/content.html">Content negotiation</a></a></li>
+        <li><a href="https://www.datacite.org/oaipmh.html">OAI-PMH</a></a></li>
+        <li><a href="https://www.datacite.org/test.html">Test environment</a></a></li>
+      </ul>
+    </div>
+    <div class='col-md-3 col-sm-4'>
+      <h4>Resources</h4>
+      <ul>
+        <li><a href="https://schema.datacite.org">Metadata schema</a></a></li>
+        <li><a href="https://www.datacite.org/technical.html">Technical documentation</a></a></li>
+        <li><a href="https://www.datacite.org/outreach.html">Outreach material</a></a></li>
+        <li><a href="https://www.datacite.org/events.html">Events</a></a></li>
+      </ul>
+      <h4>Community</h4>
+      <ul>
+        <li><a href="https://www.datacite.org/members.html">Members</a></a></li>
+        <li><a href="https://www.datacite.org/partners.html">Partners</a></a></li>
+        <li><a href="https://www.datacite.org/steering.html">Steering groups</a></a></li>
+        <li><a href="https://www.datacite.org/events.html">Events</a></a></li>
+      </ul>
+    </div>
+    <div class='col-md-3'>
+      <h4 class="share">Contact us</h4>
+      <a href='mailto:support@datacite.org' class="share">
+        <i class='fa fa-at'></i>
+      </a>
+      <a href='https://blog.datacite.org' class="share">
+        <i class='fa fa-rss'></i>
+      </a>
+      <a href='https://twitter.com/datacite' class="share">
+        <i class='fa fa-twitter'></i>
+      </a>
+      <a href='https://www.linkedin.com/company/datacite' class="share">
+        <i class='fa fa-linkedin'></i>
+      </a>
+      <ul class="share">
+        <li><a href="https://www.datacite.org/terms.html">Terms and conditions</a></a></li>
+        <li><a href="https://www.datacite.org/privacy.html">Privacy policy</a></a></li>
+        <li><a href="https://www.datacite.org/acknowledgments.html">Acknowledgements</a></a></li>
+      </ul>
+    </div>
+  </div>
+</div>
+
+  </body>
+</html>