cirneco 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a761311be0485a9712ca2f2dc30c3dec2c44ca0
-  data.tar.gz: ba477ef68eeffa7bf27e014131407714de8f3c1c
+  metadata.gz: eaeaad21cf2a466a9c9cd5f263c3023ffbb06d88
+  data.tar.gz: e8a4c0677b9c1b295b08df6cfba35059c245836f
 SHA512:
-  metadata.gz: c19efc867ab3112914ea0af11c2d5fc693d25b4e630c1300318df8988b260451185a65ecf23161b2cfc39f4b9d3111e926af89e2b80f9ffd3a9704037db060c2
-  data.tar.gz: 3d7d4d63127f7600c5fa50244235be60ce4a0b311913ce985de141a7a932b06e7bc461e32df814ff1ebf15a00bbc281a30f44da4bd0fab82ff1cf7edfff7d5dd
+  metadata.gz: c77a6e9d70d11a4452b7ae5d8167fba20aaeaedfbced8b79008f2b0c4fbe8d1e77095b20198b51b25c756a0a01478cd90a5a607b147415ba8876d48940f42fdd
+  data.tar.gz: 8e995c12b58effd10dea51965c8d2874f1bf925cb4ccf95d033f646b424ccc99ebdb6001522847ce991c70316a6d2d18604ecec4849b7d74b7983340678db5fb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cirneco (0.6.1)
+    cirneco (0.6.2)
       activesupport (~> 4.2, >= 4.2.5)
       base32-crockford-checksum (~> 0.2.2)
       bergamasco (~> 0.2)
@@ -22,7 +22,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.3.8)
     base32-crockford-checksum (0.2.3)
-    bergamasco (0.2.11)
+    bergamasco (0.2.12)
       activesupport (~> 4.2, >= 4.2.5)
       addressable (~> 2.3.8)
       builder (~> 3.2, >= 3.2.2)
@@ -127,4 +127,4 @@ DEPENDENCIES
   webmock (~> 1.22, >= 1.22.3)
 
 BUNDLED WITH
-   1.13.6
+   1.12.5

data/lib/cirneco/doi.rb

@@ -48,32 +48,32 @@ module Cirneco
       end
     end
 
-    desc "register DOCUMENTS", "register documents"
+    desc "mint DOCUMENTS", "mint documents"
     method_option :username, :default => ENV['MDS_USERNAME']
     method_option :password, :default => ENV['MDS_PASSWORD']
     method_option :prefix, :default => ENV['PREFIX']
     method_option :sandbox, :default => ENV['SANDBOX']
-    def register(filepath)
+    def mint(filepath)
 
       if File.directory?(filepath)
-        response = register_all_files(filepath, options)
+        response = mint_dois_for_all_files(filepath, options)
       else
-        response = register_file(filepath, options)
+        response = mint_doi_for_file(filepath, options)
       end
 
       puts response
     end
 
-    desc "unregister DOCUMENTS", "unregister documents"
+    desc "hide DOCUMENTS", "hide documents"
     method_option :username, :default => ENV['MDS_USERNAME']
     method_option :password, :default => ENV['MDS_PASSWORD']
     method_option :sandbox, :default => ENV['SANDBOX']
-    def unregister(filepath)
+    def hide(filepath)
 
       if File.directory?(filepath)
-        response = unregister_all_files(filepath, options)
+        response = hide_dois_for_all_files(filepath, options)
       else
-        response = unregister_file(filepath, options)
+        response = hide_doi_for_file(filepath, options)
       end
 
       puts response

data/lib/cirneco/utils.rb

@@ -28,12 +28,12 @@ module Cirneco
     end
 
     # currently only supports markdown files with YAML header
-    def register_file(filepath, options={})
+    def mint_doi_for_file(filepath, options={})
       filename = File.basename(filepath)
       return "File #{filename} ignored: not a markdown file" unless File.extname(filepath) == ".md"
 
       old_metadata = Bergamasco::Markdown.read_yaml_for_doi_metadata(filepath)
-      return nil if old_metadata["doi"]
+      return nil if old_metadata["doi"] && old_metadata["published"]
 
       metadata = generate_metadata_for_work(filepath, options)
       work = register_work_for_metadata(metadata)
@@ -44,17 +44,18 @@ module Cirneco
       # new_data = [{ "filename" => filename, "doi" => doi, "date" => Time.now.utc.iso8601 }]
       # Bergamasco::Markdown.write_yaml(datapath, data + new_data)
 
-      new_metadata = Bergamasco::Markdown.update_file(filepath, { "doi" => metadata["doi"] })
-      "DOI #{new_metadata["doi"]} added for #{filename}"
+      new_metadata = Bergamasco::Markdown.update_file(filepath, "doi" => metadata["doi"], "published" => true)
+      "DOI #{new_metadata["doi"]} minted for #{filename}"
     end
 
     # currently only supports markdown files with YAML header
-    def unregister_file(filepath, options={})
+    # DOIs are never deleted, but we can remove the metadata from the DataCite index
+    def hide_doi_for_file(filepath, options={})
       filename = File.basename(filepath)
       return "File #{filename} ignored: not a markdown file" unless File.extname(filepath) == ".md"
 
       old_metadata = Bergamasco::Markdown.read_yaml_for_doi_metadata(filepath)
-      return nil unless old_metadata["doi"]
+      return nil unless old_metadata["doi"] && old_metadata["published"]
 
       metadata = generate_metadata_for_work(filepath, options)
       work = unregister_work_for_metadata(metadata)
@@ -65,19 +66,19 @@ module Cirneco
       # new_data = [{ "filename" => filename, "doi" => doi, "date" => Time.now.utc.iso8601 }]
       # Bergamasco::Markdown.write_yaml(datapath, data + new_data)
 
-      new_metadata = Bergamasco::Markdown.update_file(filepath, { "doi" => nil })
-      "DOI #{old_metadata["doi"]} removed for #{filename}"
+      new_metadata = Bergamasco::Markdown.update_file(filepath, "published" => false)
+      "DOI #{old_metadata["doi"]} hidden for #{filename}"
     end
 
-    def register_all_files(folderpath, options={})
+    def mint_dois_for_all_files(folderpath, options={})
       Dir.glob("#{folderpath}/*.md").map do |filepath|
-        register_file(filepath, options)
+        mint_doi_for_file(filepath, options)
       end.compact.join("\n")
     end
 
-    def unregister_all_files(folderpath, options={})
+    def hide_dois_for_all_files(folderpath, options={})
       Dir.glob("#{folderpath}/*.md").map do |filepath|
-        unregister_file(filepath, options)
+        hide_doi_for_file(filepath, options)
       end.compact.join("\n")
     end
 
@@ -201,7 +202,7 @@ module Cirneco
       work = Cirneco::Work.new(metadata)
 
       filename  = metadata["doi"].split("/", 2).last + ".xml"
-      File.delete(filename)
+      File.delete(filename) if File.exist?(filename)
 
       work
     end

data/lib/cirneco/version.rb

@@ -1,3 +1,3 @@
 module Cirneco
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

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

@@ -7,6 +7,8 @@ tags:
 - doi
 - featured
 image: https://blog.datacite.org/images/2016/12/cool-dois.png
+doi: 10.23725/0000-03VC
+published: false
 ---
 In 1998 Tim Berners-Lee coined the term cool URIs [-@https://www.w3.org/Provider/Style/URI], that is URIs that don’t change. We know that URLs referenced in the scholarly literature are often not cool, leading to link rot [@https://doi.org/10.1371/journal.pone.0115253] and making it hard or impossible to find the referenced resource.READMORE
 

data/spec/utils_spec.rb

@@ -40,35 +40,41 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
     end
   end
 
-  describe "register" do
-    it 'should register_file' do
+  describe "mint and hide DOIs" do
+    it 'should mint for file' do
       filepath = fixture_path + 'cool-dois.html.md'
       number = 123
-      response = subject.register_file(filepath, number: number)
-      expect(response).to eq("DOI 10.23725/0000-03VC added for cool-dois.html.md")
+      response = subject.mint_doi_for_file(filepath, number: number)
+      expect(response).to eq("DOI 10.23725/0000-03VC minted for cool-dois.html.md")
     end
 
-    it 'should unregister_file' do
+    it 'should hide for file' do
       filepath = fixture_path + 'cool-dois.html.md'
-      response = subject.unregister_file(filepath)
-      expect(response).to eq("DOI 10.23725/0000-03VC removed for cool-dois.html.md")
+      response = subject.hide_doi_for_file(filepath)
+      expect(response).to eq("DOI 10.23725/0000-03VC hidden for cool-dois.html.md")
     end
 
-    it 'should register_all_files' do
+    it 'should mint for all files' do
       number = 123
-      response = subject.register_all_files(fixture_path, number: number)
-      expect(response).to eq("DOI 10.23725/0000-03VC added for cool-dois.html.md")
+      response = subject.mint_dois_for_all_files(fixture_path, number: number)
+      expect(response).to eq("DOI 10.23725/0000-03VC minted for cool-dois.html.md")
     end
 
-    it 'should unregister_all_files' do
+    it 'should hide for all files' do
       number = 123
-      response = subject.unregister_all_files(fixture_path)
-      expect(response).to eq("DOI 10.23725/0000-03VC removed for cool-dois.html.md")
+      response = subject.hide_dois_for_all_files(fixture_path)
+      expect(response).to eq("DOI 10.23725/0000-03VC hidden for cool-dois.html.md")
     end
 
-    it 'should ignore non-markdown file for register_file' do
+    it 'should ignore non-markdown file for mint file' do
       filepath = fixture_path + 'cool-dois.yml'
-      response = subject.register_file(filepath)
+      response = subject.mint_doi_for_file(filepath)
+      expect(response).to eq("File cool-dois.yml ignored: not a markdown file")
+    end
+
+    it 'should ignore non-markdown file for hide file' do
+      filepath = fixture_path + 'cool-dois.yml'
+      response = subject.hide_doi_for_file(filepath)
       expect(response).to eq("File cool-dois.yml ignored: not a markdown file")
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cirneco
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Martin Fenner