cirneco 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbfad88c2c54f5051b560e08c5e4b8bf712a0ddf
-  data.tar.gz: 6eb1e706e6fdb0315b2c1605d38da5239bcedfaf
+  metadata.gz: a82c5b7e10ab13eabc1913ab86f856bf1d28ee68
+  data.tar.gz: 38c61337cd19f6623ad835182baccaf2607f260f
 SHA512:
-  metadata.gz: 76547c8dfa55b15f623d9bd083a3f1dabb40f41262d41943e3766ff04e7d6e1d48409cc68bc2556e60b105a61437e061890da2b61bb59dad6bd2606a073824e5
-  data.tar.gz: 552148f8314551d7bae6bce5f35031b3708df2e3ad19c400d8ce4b8777d4e76a6c4e9ce5d94923efa212d78303922f37e6a7f1dd1a6a4c8fff4ecc9bffe008e5
+  metadata.gz: 2dbc92ffc86523a271cb1c69e2af2778f56bf2b0ca4c61714f3825fcbc84ee52ce7af2b42cd9edd1ead906e9a2620feda76de8dfec622698b74b2ab8a7910cf1
+  data.tar.gz: 00c3050b139c651521e9e1d0c0a454002f0fff2ff5f5b1a018a0e8aefcc4a258a009c2c7a03c332c1bb762dbc3176a941d8bdce961b7680a056f5c2d6b8967e1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cirneco (0.7.3)
+    cirneco (0.7.4)
       activesupport (~> 4.2, >= 4.2.5)
       base32-crockford-checksum (~> 0.2.2)
       bergamasco (~> 0.3)

data/README.md

@@ -87,9 +87,14 @@ Generate a random DOI in the format `xxxx-xxxy` where `y` is the checksum
 cirneco doi generate
 ```
 
+Decode DOI
+```
+cirneco doi decode 10.5072/0000-03VC
+```
+
 Check DOI for valid checksum
 ```
-cirneco doi check 10.5555/1234
+cirneco doi check 10.5072/0000-03VC
 ```
 
 Mint a DOI with metadata from a markdown file with YAML frontmatter
@@ -102,6 +107,16 @@ Mint DOIs with metadata for all markdown files in a folder
 cirneco doi mint /source/posts
 ```
 
+Mint a DOI and hide metadata from a markdown file with YAML frontmatter
+```
+cirneco doi mint_and_hide /source/posts/cool-dois.html.md
+```
+
+Mint DOIs and hide metadata for all markdown files in a folder
+```
+cirneco doi mint_and_hide /source/posts
+```
+
 Hide DOI metadata for a markdown file with YAML frontmatter
 ```
 cirneco doi hide /source/posts/cool-dois.html.md

data/lib/cirneco/doi.rb

@@ -54,6 +54,17 @@ module Cirneco
       end
     end
 
+    desc "decode DOI", "decode DOI encoded using Crockford base32 algorithm"
+    def decode(doi)
+      number = decode_doi(doi)
+
+      if number > 0
+        puts "DOI #{doi} was encoded with #{number}"
+      else
+        puts "DOI #{doi} could not be decoded"
+      end
+    end
+
     desc "check DOI", "check DOI using Crockford base32 checksum"
     def check(doi)
       if decode_doi(doi) > 0
@@ -63,7 +74,7 @@ module Cirneco
       end
     end
 
-    desc "mint DOCUMENTS", "mint documents"
+    desc "mint DOCUMENT", "mint document"
     method_option :sitepath, :default => ENV['SITE_SITEPATH']
     method_option :authorpath, :default => ENV['SITE_AUTHORPATH']
     method_option :referencespath, :default => ENV['SITE_REFERENCESPATH']
@@ -84,7 +95,28 @@ module Cirneco
       puts response
     end
 
-    desc "hide DOCUMENTS", "hide documents"
+    desc "mint and hide DOCUMENT", "mint and hide document"
+    method_option :sitepath, :default => ENV['SITE_SITEPATH']
+    method_option :authorpath, :default => ENV['SITE_AUTHORPATH']
+    method_option :referencespath, :default => ENV['SITE_REFERENCESPATH']
+    method_option :csl, :default => ENV['SITE_CSLPATH']
+    method_option :number, :type => :numeric, :aliases => '-n'
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :prefix, :default => ENV['PREFIX']
+    method_option :sandbox, :type => :boolean, :force => false
+    def mint_and_hide(filepath)
+
+      if File.directory?(filepath)
+        response = mint_and_hide_dois_for_all_files(filepath, options)
+      else
+        response = mint_and_hide_doi_for_file(filepath, options)
+      end
+
+      puts response
+    end
+
+    desc "hide DOCUMENT", "hide document"
     method_option :sitepath, :default => ENV['SITE_SITEPATH']
     method_option :authorpath, :default => ENV['SITE_AUTHORPATH']
     method_option :referencespath, :default => ENV['SITE_REFERENCESPATH']

data/lib/cirneco/utils.rb

@@ -44,6 +44,23 @@ module Cirneco
       "DOI #{new_metadata["doi"]} minted for #{filename}"
     end
 
+    # currently only supports markdown files with YAML header
+    def mint_and_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 "DOI #{old_metadata["doi"]} not changed for #{filename}" if old_metadata["doi"] && old_metadata["published"]
+
+      metadata = generate_metadata_for_work(filepath, options)
+      work = post_and_hide_metadata_for_work(metadata, options)
+
+      # return "Errors for DOI #{metadata["doi"]}:\n#{work.validation_errors}" if work.validation_errors.present?
+
+      new_metadata = Bergamasco::Markdown.update_file(filepath, "doi" => metadata["doi"], "published" => false)
+      "DOI #{new_metadata["doi"]} minted and hidden for #{filename}"
+    end
+
     # currently only supports markdown files with YAML header
     # DOIs are never deleted, but we can remove the metadata from the DataCite index
     def hide_doi_for_file(filepath, options={})
@@ -68,6 +85,12 @@ module Cirneco
       end.join("\n")
     end
 
+    def mint_and_hide_dois_for_all_files(folderpath, options={})
+      Dir.glob("#{folderpath}/*.md").map do |filepath|
+        mint_and_hide_doi_for_file(filepath, options)
+      end.join("\n")
+    end
+
     def hide_dois_for_all_files(folderpath, options={})
       Dir.glob("#{folderpath}/*.md").map do |filepath|
         hide_doi_for_file(filepath, options)
@@ -194,6 +217,19 @@ module Cirneco
       work.put_doi(metadata["doi"], options.merge(url: metadata["url"]))
     end
 
+    def post_and_hide_metadata_for_work(metadata, options={})
+      work = Cirneco::Work.new(metadata)
+      return work.validation_errors if work.validation_errors.present?
+
+      response = work.post_metadata(work.data, options)
+      return response unless response.status == 201
+
+      response = work.put_doi(metadata["doi"], options.merge(url: metadata["url"]))
+      return response unless response.status == 201
+
+      work.delete_metadata(metadata["doi"], options)
+    end
+
     def hide_metadata_for_work(metadata, options={})
       work = Cirneco::Work.new(metadata)
       return work.validation_errors if work.validation_errors.present?

data/lib/cirneco/version.rb

@@ -1,3 +1,3 @@
 module Cirneco
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

data/spec/doi_spec.rb

@@ -55,6 +55,10 @@ describe Cirneco::Doi do
       expect { subject.generate }.to output("No PREFIX provided. Use --prefix option or PREFIX ENV variable\n").to_stdout
     end
 
+    it 'decodes a doi' do
+      expect { subject.decode doi }.to output("DOI #{doi} was encoded with 123\n").to_stdout
+    end
+
     it 'checks a doi' do
       expect { subject.check doi }.to output("Checksum for #{doi} is valid\n").to_stdout
     end
@@ -76,6 +80,11 @@ describe Cirneco::Doi do
       expect { subject.hide filepath }.to output("DOI 10.5072/0000-03VC hidden for #{filename}\n").to_stdout
     end
 
+    it 'mints and hides a doi' do
+      subject.options = { csl: csl, bibliography: bibliography }
+      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
@@ -86,6 +95,11 @@ describe Cirneco::Doi do
       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
+    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

data/spec/utils_spec.rb

@@ -56,6 +56,13 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
       expect(response).to eq("DOI 10.5072/0000-03VC hidden for cool-dois.html.md")
     end
 
+    it 'should mint and hide for file' do
+      filepath = fixture_path + 'cool-dois.html.md'
+      number = 123
+      response = subject.mint_and_hide_doi_for_file(filepath, number: number, csl: csl, bibliography: bibliography)
+      expect(response).to eq("DOI 10.5072/0000-03VC minted and hidden for cool-dois.html.md")
+    end
+
     it 'should mint for all files' do
       number = 123
       response = subject.mint_dois_for_all_files(fixture_path, number: number, csl: csl, bibliography: bibliography)
@@ -68,6 +75,12 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
       expect(response).to eq("DOI 10.5072/0000-03VC hidden for cool-dois.html.md")
     end
 
+    it 'should mint and hide for all files' do
+      number = 123
+      response = subject.mint_and_hide_dois_for_all_files(fixture_path, number: number, csl: csl, bibliography: bibliography)
+      expect(response).to eq("DOI 10.5072/0000-03VC minted and hidden for cool-dois.html.md")
+    end
+
     it 'should ignore non-markdown file for mint file' do
       filepath = fixture_path + 'cool-dois.yml'
       response = subject.mint_doi_for_file(filepath)

metadata

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