cirneco 0.3.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 967bbedde54c1865ed3ef418dfce7f6367de3ee8
-  data.tar.gz: f681c1909b9575b57f085a59092bcb1566fba81c
+  metadata.gz: 659265c0ac952c44a8052b7db9f1091ebc050591
+  data.tar.gz: 6dc57c4bcd57f0ab1a4c40c32daea3f2ecfa2735
 SHA512:
-  metadata.gz: 6e115a86cae2763c551c641b91feacfadd51b48e830b7a3fc854b01c665ff4b056f6fed0cde404278846ffd7ca075d208ff347dce5c829ad68bba123f99325a7
-  data.tar.gz: 656bda3023b6a802352c4de759e2563a12c5ae3c27b01c4d5b2309384c896a8fe55849def63bc98f9e7dc2f57042055cfa65d5a5e07b76ff88aaf9a6aadc08ba
+  metadata.gz: 6c35f6d1e55fcdefd64f8097a6ec6c588bd7e76994d67143e3cbb76de77a26110403bf1d5723b7cfe8396ced125991510c07a1c55decc54254f8a5919d42605c
+  data.tar.gz: 91dac16457324d58348c96e42fca953c73c66d8129d4fe05043ba154a1545ddcdc0322168c05e45c402e1b57a584b8326b30c0054c11bbd037de7e36fed2b68e

data/.env.example

@@ -0,0 +1,3 @@
+MDS_USERNAME=USER.USER
+MDS_PASSWORD=opensesame
+PREFIX=10.5555

data/0006.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource xmlns="http://datacite.org/schema/kernel-2.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-2.2 http://schema.datacite.org/meta/kernel-2.2/metadata.xsd">
+	<identifier identifierType="DOI">10.5438/0006</identifier>
+	<creators>
+		<creator>
+			<creatorName>DataCite Metadata Working Group</creatorName>
+		</creator>
+	</creators>
+	<titles>
+		<title>DataCite Metadata Schema for the Publication and Citation of Research Data</title>
+	</titles>
+	<publisher>DataCite e.V.</publisher>
+	<publicationYear>2011</publicationYear>
+		<contributors>
+		<contributor contributorType="ProjectLeader">
+			<contributorName>Starr, Joan</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Ashton,Jan</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Brase, Jan</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Bracke, Paul</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Gastl, Angela</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Gillet, Jacqueline</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Heller, Alfred</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Krog,Birthe</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>McAvoy,Lynne</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Morgenroth,Karen</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Newbold, Elizabeth</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Smaele,Madeleine de</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Wilde, Anja</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Yeadon, Scott</contributorName>
+		</contributor>
+		<contributor contributorType="Editor">
+			<contributorName>Zenk-Möltgen, Wolfgang</contributorName>
+		</contributor>
+		<contributor contributorType="Supervisor">
+			<contributorName>Ziedorn, Frauke</contributorName>
+		</contributor>
+	</contributors>
+	<dates>
+		<date dateType="Available">July 2011</date>
+	</dates>
+	<language>eng</language>
+	<resourceType resourceTypeGeneral="Text">XSD code</resourceType>
+	<relatedIdentifiers>
+		<relatedIdentifier relatedIdentifierType="DOI" relationType="IsDocumentedBy">10.5438/0005</relatedIdentifier>
+		<relatedIdentifier relatedIdentifierType="DOI" relationType="IsNewVersionOf">10.5438/0004</relatedIdentifier>
+		<relatedIdentifier relatedIdentifierType="DOI" relationType="IsNewVersionOf">10.5438/0002</relatedIdentifier>
+	</relatedIdentifiers>
+	<formats>
+		<format>application/xml</format>
+	</formats>
+	<version>2.2</version>
+</resource>

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    cirneco (0.3.3)
+    cirneco (0.4)
       activesupport (~> 4.2, >= 4.2.5)
       builder (~> 3.2, >= 3.2.2)
       dotenv (~> 2.1, >= 2.1.1)
@@ -125,4 +125,4 @@ DEPENDENCIES
   webmock (~> 1.22, >= 1.22.3)
 
 BUNDLED WITH
-   1.13.6
+   1.12.5

data/README.md

@@ -13,7 +13,7 @@ The following functionality is supported:
 
 * the MDS API (DOI, Metadata and Media APIs) is fully supported
 * generates valid metadata, using Schema 4.0 (currently only partial support of available metadata fields)
-* generates a DOI name to be used for registration, using [Base32 Crockford encoded](https://github.com/levinalex/base32) sequential numbers that include a checksum
+* generates a DOI name to be used for registration, using a random number that is [Base32 Crockford encoded](https://github.com/levinalex/base32) and includes a checksum
 
 ## Requirements
 
@@ -35,9 +35,56 @@ You can also install the gem system-wide in the usual way:
 gem install cirneco
 ```
 
-## Use
+## Configuration
 
-TBD.
+Configure ENV variables `MDS_USERNAME`, `MDS_PASSWORD` and `PREFIX`, e.g. by storing them in file `.env` in same folder (see `.env.xample`).
+
+## Commands
+
+Return all DOIs registered for the data center
+```
+cirneco doi get all
+```
+
+Return URL registered for DOI in the handle system
+```
+cirneco doi get 10.5555/1234
+```
+
+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
+```
+
+Save metadata for DOI into file `1234.xml` in same directory
+```
+cirneco metadata get 10.5555/1234
+```
+
+Post metadata from file `1234.xml` in same directory
+```
+cirneco metadata post 1234.xml
+```
+
+Delete metadata for DOI (set `is_active` flag to false)
+```
+cirneco metadata delete 10.5555/1234
+```
+
+Save media information for DOI into file `1234.txt` in same directory
+```
+cirneco media get 10.5555/1234
+```
+
+Post media information from file `1234.txt` in same directory
+```
+cirneco media post 1234.xml
+```
 
 ## License
 

data/lib/cirneco/api.rb

@@ -1,4 +1,5 @@
-require "uri"
+require 'uri'
+require 'maremma'
 
 module Cirneco
   module Api
@@ -63,7 +64,7 @@ module Cirneco
     def post_media(doi, media, options={})
       return OpenStruct.new(body: { "errors" => [{ "title" => "Username or password missing" }] }) unless options[:username].present? && options[:password].present?
 
-      payload = media.map { |m| "#{m[:mime_type]}=#{m[:url]}" }.join("\n")
+      payload = options[:raw] ? media : media.map { |m| "#{m[:mime_type]}=#{m[:url]}" }.join("\n")
 
       mds_url = options[:sandbox] ? 'https://mds.test.datacite.org' : 'https://mds.datacite.org'
 
@@ -78,7 +79,7 @@ module Cirneco
 
       url = "#{mds_url}/media/#{doi}"
       response = Maremma.get(url, accept: 'application/xml', username: options[:username], password: options[:password])
-      if response.body["data"].present?
+      if response.body["data"].present? && !options[:raw]
         response.body["data"] = response.body["data"].split("\n").map do |m|
           mime_type, url = m.split('=', 2)
           { mime_type: mime_type, url: url }

data/lib/cirneco/cli.rb

@@ -12,6 +12,13 @@ module Cirneco
     include Cirneco::Api
     include Cirneco::Utils
 
+    # load ENV variables from .env file if it exists
+    env_file = File.expand_path("../../.env", __FILE__)
+    if File.exist?(env_file)
+      require 'dotenv'
+      Dotenv.load! env_file
+    end
+
     def self.exit_on_failure?
       true
     end
@@ -24,5 +31,11 @@ module Cirneco
 
     desc "parentcommand SUBCOMMAND", "Some Parent Command"
     subcommand "doi", Cirneco::Doi
+
+    desc "parentcommand SUBCOMMAND", "Some Parent Command"
+    subcommand "metadata", Cirneco::Metadata
+
+    desc "parentcommand SUBCOMMAND", "Some Parent Command"
+    subcommand "media", Cirneco::Media
   end
 end

data/lib/cirneco/doi.rb

@@ -10,24 +10,42 @@ module Cirneco
     include Cirneco::Api
     include Cirneco::Utils
 
-    method_option :sandbox, :type => :boolean
-    method_option :prefix, :default => ENV['PREFIX']
+    desc "get DOI", "get handle url for DOI"
     method_option :username, :default => ENV['MDS_USERNAME']
     method_option :password, :default => ENV['MDS_PASSWORD']
-
-    desc "get DOI", "get handle url for DOI"
+    method_option :sandbox, :type => :boolean, default: true
     def get(doi)
-      get_doi(doi)
+      if doi == "all"
+        response = get_dois(options)
+      else
+        response = get_doi(doi, options)
+      end
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        puts response.body["data"]
+      end
     end
 
-    desc "encode NUMBER", "say hello to NAME"
-    def encode(number)
-      puts encode_doi(prefix, number)
+    desc "generate PREFIX", "generate a DOI name"
+    method_option :prefix, :default => ENV['PREFIX']
+    method_option :number, :type => :numeric, :aliases => '-n'
+    def generate
+      if options[:prefix]
+        puts encode_doi(options[:prefix], number: options[:number])
+      else
+        puts "No PREFIX provided. Use --prefix option or PREFIX ENV variable"
+      end
     end
 
-    desc "command", "an example task"
-    def command
-      puts "I'm a thor task!"
+    desc "check DOI", "check DOI using Crockford base32 checksum"
+    def check(doi)
+      if decode_doi(doi) > 0
+        puts "Checksum for #{doi} is valid"
+      else
+        puts "Checksum for #{doi} is not valid"
+      end
     end
   end
 end

data/lib/cirneco/media.rb

@@ -11,5 +11,40 @@ module Cirneco
     include Cirneco::Api
     include Cirneco::Utils
 
+    desc "get DOI", "get media for DOI"
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :sandbox, :type => :boolean, default: true
+    def get(doi)
+      response = get_media(doi, options.merge(raw: true))
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        filename  = doi.split("/", 2).last + ".txt"
+        content = response.body["data"]
+        IO.write(filename, content)
+        puts "Media for #{doi} saved as #{filename}"
+      end
+    end
+
+    desc "post DOI", "post media for DOI"
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :sandbox, :type => :boolean, default: true
+    method_option :file, :aliases => '-f'
+    def post(doi)
+      filename  = options[:file] || doi.split("/", 2).last + ".txt"
+      data = IO.read(filename)
+      response = post_media(doi, data, options.merge(raw: true))
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        puts response.body["data"]
+      end
+    end
+
+
   end
 end

data/lib/cirneco/metadata.rb

@@ -11,5 +11,50 @@ module Cirneco
     include Cirneco::Api
     include Cirneco::Utils
 
+    desc "get DOI", "get metadata for DOI"
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :sandbox, :type => :boolean, default: true
+    def get(doi)
+      response = get_metadata(doi, options)
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        filename  = doi.split("/", 2).last + ".xml"
+        content = response.body["data"]
+        IO.write(filename, content)
+        puts "Metadata for #{doi} saved as #{filename}"
+      end
+    end
+
+    desc "post DOI", "post metadata for DOI"
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :sandbox, :type => :boolean, default: true
+    def post(file)
+      data = IO.read(file)
+      response = post_metadata(data, options)
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        puts response.headers["Location"]
+      end
+    end
+
+    desc "delete DOI", "hide metadata for DOI"
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :sandbox, :type => :boolean, default: true
+    def delete(doi)
+      response = delete_metadata(doi, options)
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        puts response.body["data"]
+      end
+    end
   end
 end

data/lib/cirneco/version.rb

@@ -1,3 +1,3 @@
 module Cirneco
-  VERSION = "0.3.3"
+  VERSION = "0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cirneco
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: '0.4'
 platform: ruby
 authors:
 - Martin Fenner
@@ -304,8 +304,10 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".env.example"
 - ".gitignore"
 - ".travis.yml"
+- 0006.xml
 - Gemfile
 - Gemfile.lock
 - LICENSE.md