cirneco 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaeaad21cf2a466a9c9cd5f263c3023ffbb06d88
-  data.tar.gz: e8a4c0677b9c1b295b08df6cfba35059c245836f
+  metadata.gz: 6b5f9904e8936e7a886b1502b61d63a6046a66ad
+  data.tar.gz: 4ad9a39a16a5683f376cc0d53ba1913c62fbe18a
 SHA512:
-  metadata.gz: c77a6e9d70d11a4452b7ae5d8167fba20aaeaedfbced8b79008f2b0c4fbe8d1e77095b20198b51b25c756a0a01478cd90a5a607b147415ba8876d48940f42fdd
-  data.tar.gz: 8e995c12b58effd10dea51965c8d2874f1bf925cb4ccf95d033f646b424ccc99ebdb6001522847ce991c70316a6d2d18604ecec4849b7d74b7983340678db5fb
+  metadata.gz: 4dcf18fab90ab424a399d84f7fffa3913c2edf564485720a3cce0e74eb3dd134ede1519be8375e68c344d9454bdb79135f2ff783f4acb64a617ef8ba1b6133b7
+  data.tar.gz: f56f7cbe7433c420eb931a80e7c644b1ebe3326c7c3706d9ca93b1d9644e5a0eec41651aca2cf36adc0483beee8f7f7904aca3d8113c3047e8b17cf7071d45e9

data/.env.example

@@ -1,3 +1,11 @@
 MDS_USERNAME=USER.USER
 MDS_PASSWORD=opensesame
-PREFIX=10.5555
+SANDBOX=1
+PREFIX=10.23725
+
+SITE_URL=https://blog.datacite.org/
+SITE_TITLE=DataCite Blog
+SITE_SITEPATH=spec/fixtures/site.yml
+SITE_AUTHORPATH=spec/fixtures/authors.yml
+SITE_CSLPATH=spec/fixtures/apa.csl
+SITE_REFERENCESPATH=spec/fixtures/references.yaml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cirneco (0.6.2)
+    cirneco (0.6.3)
       activesupport (~> 4.2, >= 4.2.5)
       base32-crockford-checksum (~> 0.2.2)
       bergamasco (~> 0.2)
@@ -127,4 +127,4 @@ DEPENDENCIES
   webmock (~> 1.22, >= 1.22.3)
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -39,19 +39,9 @@ gem install cirneco
 
 Configure ENV variables `MDS_USERNAME`, `MDS_PASSWORD` and `PREFIX`, e.g. by storing them in file `.env` (see `.env.xample`) in same directory you run the command.
 
-## Commands
+## DataCite MDS API Commands
 
-The commands map to the commands available in the [DataCite MDS API](https://mds.datacite.org/static/apidoc), and two additional commands allow the generation and check of random DOIs.
-
-Generate a random DOI in the format `xxxx-xxxy` where `y` is the checksum
-```
-cirneco doi generate
-```
-
-Check DOI for valid checksum
-```
-cirneco doi check 10.5555/1234
-```
+The commands map to the commands available in the [DataCite MDS API](https://mds.datacite.org/static/apidoc).
 
 Return all DOIs registered for the data center
 ```
@@ -88,6 +78,40 @@ Post media information from file `1234.txt` in same directory
 cirneco media post 1234.xml
 ```
 
+## Utility Commands
+Commands to generate and check random DOIs, and for registering DOIs using
+markdown files with metadata in YAML frontmatter
+
+Generate a random DOI in the format `xxxx-xxxy` where `y` is the checksum
+```
+cirneco doi generate
+```
+
+Check DOI for valid checksum
+```
+cirneco doi check 10.5555/1234
+```
+
+Mint a DOI with metadata from a markdown file with YAML frontmatter
+```
+cirneco doi mint /source/posts/cool-dois.html.md
+```
+
+Mint DOIs with metadata for all markdown files in a folder
+```
+cirneco doi mint /source/posts
+```
+
+Hide DOI metadata for a markdown file with YAML frontmatter
+```
+cirneco doi hide /source/posts/cool-dois.html.md
+```
+
+Hide DOIs with metadata for all markdown files in a folder
+```
+cirneco doi hide /source/posts
+```
+
 ## Development
 
 We use rspec for unit testing:

data/lib/cirneco/doi.rb

@@ -49,6 +49,8 @@ module Cirneco
     end
 
     desc "mint DOCUMENTS", "mint documents"
+    method_option :csl, :default => ENV['SITE_CSLPATH']
+    method_option :bibliography, :default => ENV['SITE_REFERENCESPATH']
     method_option :username, :default => ENV['MDS_USERNAME']
     method_option :password, :default => ENV['MDS_PASSWORD']
     method_option :prefix, :default => ENV['PREFIX']
@@ -65,6 +67,8 @@ module Cirneco
     end
 
     desc "hide DOCUMENTS", "hide documents"
+    method_option :csl, :default => ENV['SITE_CSLPATH']
+    method_option :bibliography, :default => ENV['SITE_REFERENCESPATH']
     method_option :username, :default => ENV['MDS_USERNAME']
     method_option :password, :default => ENV['MDS_PASSWORD']
     method_option :sandbox, :default => ENV['SANDBOX']

data/lib/cirneco/utils.rb

@@ -100,7 +100,7 @@ module Cirneco
       references = referencespath.present? ? Bergamasco::Markdown.read_yaml(referencespath) : {}
 
       # required metadata
-      prefix = options[:prefix] || site_options["prefix"] || ENV['SITE_PREFIX']
+      prefix = options[:prefix] || site_options["prefix"] || ENV['PREFIX']
       metadata["doi"] ||= encode_doi(prefix, options)
 
       site_url = site_options["site_url"] || ENV['SITE_URL']

data/lib/cirneco/version.rb

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

data/spec/utils_spec.rb

@@ -81,7 +81,7 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
     it 'should generate metadata for work' do
       filepath = fixture_path + 'cool-dois.html.md'
       number = 123
-      metadata = subject.generate_metadata_for_work(filepath, number: number, csl: 'spec/fixtures/apa.csl', bibliography: 'spec/fixtures/references.bib')
+      metadata = subject.generate_metadata_for_work(filepath, number: number, csl: 'spec/fixtures/apa.csl', bibliography: 'spec/fixtures/references.yaml')
       expect(metadata["url"]).to eq("https://blog.datacite.org/cool-dois/")
       expect(metadata["creators"]).to eq([{:given_name=>"Martin", :family_name=>"Fenner", :orcid=>"0000-0003-1419-2405"}])
       expect(metadata["descriptions"]).to eq([{:value=>"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 the referenced resource.",:description_type=>"Abstract"}])
@@ -96,7 +96,7 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
     it 'should register_work_for_metadata' do
       filepath = fixture_path + 'cool-dois.html.md'
       number = 123
-      metadata = subject.generate_metadata_for_work(filepath, number: number, csl: 'spec/fixtures/apa.csl', bibliography: 'spec/fixtures/references.bib')
+      metadata = subject.generate_metadata_for_work(filepath, number: number, csl: 'spec/fixtures/apa.csl', bibliography: 'spec/fixtures/references.yaml')
       work = subject.register_work_for_metadata(metadata)
       expect(work.validation_errors).to be_empty
     end

metadata

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