cirneco 0.6.9 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 340962d18c91ee11a3722511c861fc49e0bb6e4e
-  data.tar.gz: 91f07300e1859bbb79ca161c8305d133530c2cf1
+  metadata.gz: ce6afcc62d30c257c822973dece42aa9a6135ec4
+  data.tar.gz: 0e6193614e00ecec144969b52b2f09d1b679269d
 SHA512:
-  metadata.gz: 9a6c516820e7ceadd04e6cbc62667e21c978e02a9f0d2479658905062296fcd15156911086fee8b8adb985b5bb3369d2aa6f8a15236496192ec78c28b7e58991
-  data.tar.gz: 71e05301cc30f995cc2843edde2390aa909f1d23f443d067de7f49c498180cd17aba2f29a5b465753b6df474081eb859b6194007d336c1d0f5966391a2273f59
+  metadata.gz: 037e8115820da820333cfb6ee5a41a87234ed2226a4b2e590017a66ce5d195a03a23acd1e9332c29a6e1beb93aeb1c270307c8ba9b34d216e4832fd9d8cd963a
+  data.tar.gz: cdfd61cbe754c4651378c67e49bf9819ac1e064db49fcc45f615c4cc9d3811c13245a74db305b89b0bf72844c67b0feaf5aa347813b7b48fdbe0f9bb00d6557c

data/Gemfile.lock

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

data/Rakefile

@@ -1,5 +1,31 @@
 #!/usr/bin/env rake
 
-# Get useful helper tasks from Bundler
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake'
+require 'yaml'
+require 'rspec/core/rake_task'
 
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new('spec')
+
+namespace :repo do
+  desc "push files generated with cirneco to remote"
+  task :push do
+
+    # Configure git if this is run in Travis CI
+    if ENV["TRAVIS"]
+      sh "git config --global user.name '#{ENV['GIT_NAME']}'"
+      sh "git config --global user.email '#{ENV['GIT_EMAIL']}'"
+      sh "git config --global push.default simple"
+    end
+
+    # Commit and push to github
+    sh "git add --all ."
+    sh "git commit -m 'Committing changed files.'"
+    sh "git push https://${GH_TOKEN}@github.com/datacite/cirneco.rb master --quiet"
+    puts "Pushed changed files to repo"
+  end
+end
+
+# default task is running rspec tests
+task :default => :spec

data/lib/cirneco/api.rb

@@ -30,10 +30,10 @@ module Cirneco
       Maremma.delete(url, username: options[:username], password: options[:password])
     end
 
-    def put_doi(doi, url, options={})
+    def put_doi(doi, options={})
       return OpenStruct.new(body: { "errors" => [{ "title" => "Username or password missing" }] }) unless options[:username].present? && options[:password].present?
 
-      payload = "doi=#{doi}\nurl=#{url}"
+      payload = "doi=#{doi}\nurl=#{options[:url]}"
 
       mds_url = options[:sandbox] ? 'https://mds.test.datacite.org' : 'https://mds.datacite.org'
 
@@ -61,10 +61,10 @@ module Cirneco
       response
     end
 
-    def post_media(doi, media, options={})
+    def post_media(doi, options={})
       return OpenStruct.new(body: { "errors" => [{ "title" => "Username or password missing" }] }) unless options[:username].present? && options[:password].present?
 
-      payload = options[:raw] ? media : media.map { |m| "#{m[:mime_type]}=#{m[:url]}" }.join("\n")
+      payload = options[:raw] ? options[:media] : options[:media].map { |m| "#{m[:mime_type]}=#{m[:url]}" }.join("\n")
 
       mds_url = options[:sandbox] ? 'https://mds.test.datacite.org' : 'https://mds.datacite.org'
 

data/lib/cirneco/doi.rb

@@ -28,6 +28,21 @@ module Cirneco
       end
     end
 
+    desc "put DOI", "put handle url for DOI"
+    method_option :username, :default => ENV['MDS_USERNAME']
+    method_option :password, :default => ENV['MDS_PASSWORD']
+    method_option :sandbox, :default => ENV['SANDBOX']
+    method_option :url
+    def put(doi)
+      response = put_doi(doi, options)
+
+      if response.body["errors"]
+        puts "Error: " + response.body["errors"].first.fetch("title", "An error occured")
+      else
+        puts response.body["data"]
+      end
+    end
+
     desc "generate DOI", "generate a DOI name"
     method_option :prefix, :default => ENV['PREFIX']
     method_option :number, :type => :numeric, :aliases => '-n'

data/lib/cirneco/version.rb

@@ -1,3 +1,3 @@
 module Cirneco
-  VERSION = "0.6.9"
+  VERSION = "0.6.10"
 end

data/spec/api_spec.rb

@@ -22,20 +22,20 @@ describe Cirneco::Work, vcr: true, :order => :defined do
   let(:fixture_path) { "spec/fixtures/" }
   let(:samples_path) { "resources/kernel-4.0/samples/" }
 
- subject { Cirneco::Work.new(metadata,
-                             media: media,
-                             username: username,
-                             password: password) }
+  subject { Cirneco::Work.new(metadata,
+                              media: media,
+                              username: username,
+                              password: password) }
 
   describe "Metadata API" do
-    describe "get" do
+    context "get" do
       it 'should get metadata' do
         response = subject.get_metadata(doi, options)
         expect(response.body["data"]).to eq(subject.data)
       end
     end
 
-    describe "delete" do
+    context "delete" do
       it 'should delete metadata' do
         response = subject.delete_metadata(doi, options)
         expect(response.body["data"]).to eq("OK")
@@ -43,7 +43,7 @@ describe Cirneco::Work, vcr: true, :order => :defined do
       end
     end
 
-    describe "post" do
+    context "post" do
       it 'should post metadata' do
         response = subject.post_metadata(subject.data, options)
         expect(response.body["data"]).to eq("OK (10.23725/0000-03VC)")
@@ -56,7 +56,7 @@ describe Cirneco::Work, vcr: true, :order => :defined do
   describe "DOI API" do
     describe "put" do
       it 'should put doi' do
-        response = subject.put_doi(doi, url, options)
+        response = subject.put_doi(doi, options.merge(url: url))
         expect(response.body["data"]).to eq("OK")
         expect(response.status).to eq(201)
       end
@@ -86,7 +86,7 @@ describe Cirneco::Work, vcr: true, :order => :defined do
   describe "Media API" do
     describe "post" do
       it 'should post media' do
-        response = subject.post_media(doi, media, options)
+        response = subject.post_media(doi, options.merge(media: media))
         expect(response.body["data"]).to eq("OK")
         expect(response.status).to eq(200)
       end

data/spec/doi_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'cirneco/cli'
+
+describe Cirneco::Doi do
+  let(:subject) do
+    described_class.new
+  end
+
+  let(:number) { 123 }
+  let(:prefix) { ENV['PREFIX'] }
+  let(:doi) { "10.23725/0000-03VC" }
+  let(:url) { "http://www.datacite.org" }
+  let(:filename) { 'cool-dois.html.md' }
+  let(:filepath) { fixture_path + filename }
+  let(:username) { ENV['MDS_USERNAME'] }
+  let(:password) { ENV['MDS_PASSWORD'] }
+  let(:sandbox) { ENV['SANDBOX'] }
+  let(:api_options) { { username: username, password: password, sandbox: true } }
+
+  describe "MDS DOI API", vcr: true, :order => :defined do
+    context "put" do
+      it 'should put doi' do
+        subject.options = api_options.merge(url: url)
+        expect { subject.put doi }.to output("OK\n").to_stdout
+      end
+    end
+
+    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.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
+      end
+
+      it 'should get doi' do
+        subject.options = api_options
+        expect { subject.get doi }.to output("http://www.datacite.org\n").to_stdout
+      end
+
+      it 'username missing' do
+        subject.options = { username: username, sandbox: true }
+        expect { subject.get doi }.to output("Error: Username or password missing\n").to_stdout
+      end
+    end
+  end
+
+  context "base32" do
+    it 'generates a doi' do
+      subject.options = { number: number, prefix: prefix }
+      expect { subject.generate }.to output("10.23725/0000-03VC\n").to_stdout
+    end
+
+    it 'requires a prefix' do
+      subject.options = { number: number }
+      expect { subject.generate }.to output("No PREFIX provided. Use --prefix option or PREFIX ENV variable\n").to_stdout
+    end
+
+    it 'checks a doi' do
+      expect { subject.check doi }.to output("Checksum for #{doi} is valid\n").to_stdout
+    end
+
+    it 'checks a doi invalid checksum' do
+      doi = "10.23725/0000-03VA"
+      expect { subject.check doi }.to output("Checksum for #{doi} is not valid\n").to_stdout
+    end
+  end
+
+  context "mint and hide DOIs", :order => :defined do
+    it 'mints a doi' do
+      expect { subject.mint filepath }.to output("DOI 10.23725/0000-03VC minted for #{filename}\n").to_stdout
+    end
+
+    it 'hides a doi' do
+      expect { subject.hide filepath }.to output("DOI 10.23725/0000-03VC hidden for #{filename}\n").to_stdout
+    end
+
+    it 'mints dois for contents of a folder' do
+      expect { subject.mint fixture_path }.to output("DOI 10.23725/0000-03VC minted for #{filename}\n").to_stdout
+    end
+
+    it 'hides dois for contents of a folder' do
+      expect { subject.hide fixture_path }.to output("DOI 10.23725/0000-03VC 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
+    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
+    end
+  end
+end
+
+

data/spec/fixtures/vcr_cassettes/Cirneco_Doi/MDS_DOI_API/get/should_get_all_dois.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://mds.test.datacite.org/doi
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Maremma - https://github.com/datacite/maremma
+      Accept:
+      - text/html,application/json,application/xml;q=0.9, text/plain;q=0.8,image/png,*/*;q=0.5
+      Authorization:
+      - Basic <MDS_TOKEN>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Sun, 18 Dec 2016 21:24:43 GMT
+      Content-Type:
+      - text/html;charset=UTF-8
+      Connection:
+      - keep-alive
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache, no-store
+    body:
+      encoding: UTF-8
+      string: |-
+        10.23725/0000-03VC
+        10.23725/0000-0A53
+        10.23725/GQZDGNZW
+        10.23725/MDS-CLIENT-RUBY-TEST
+        10.5438/0001
+        10.5438/0002
+        10.5438/0003
+        10.5438/0004
+        10.5438/0005
+        10.5438/0006
+        10.5438/EXAMPLE-FULL
+        10.5438/MDS-CLIENT-RUBY-TEST
+    http_version: 
+  recorded_at: Sun, 18 Dec 2016 21:24:43 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/Cirneco_Doi/MDS_DOI_API/get/should_get_doi.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://mds.test.datacite.org/doi/10.23725/0000-03VC
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Maremma - https://github.com/datacite/maremma
+      Accept:
+      - text/html,application/json,application/xml;q=0.9, text/plain;q=0.8,image/png,*/*;q=0.5
+      Authorization:
+      - Basic <MDS_TOKEN>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Sun, 18 Dec 2016 21:24:43 GMT
+      Content-Type:
+      - text/html;charset=UTF-8
+      Connection:
+      - keep-alive
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache, no-store
+    body:
+      encoding: UTF-8
+      string: http://www.datacite.org
+    http_version: 
+  recorded_at: Sun, 18 Dec 2016 21:24:43 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/Cirneco_Doi/MDS_DOI_API/put/should_put_doi.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://mds.test.datacite.org/doi/10.23725/0000-03VC
+    body:
+      encoding: UTF-8
+      string: |-
+        doi=10.23725/0000-03VC
+        url=http://www.datacite.org
+    headers:
+      User-Agent:
+      - Maremma - https://github.com/datacite/maremma
+      Content-Type:
+      - text/plain;charset=UTF-8
+      Accept:
+      - text/html,application/json,application/xml;q=0.9, text/plain;q=0.8,image/png,*/*;q=0.5
+      Authorization:
+      - Basic <MDS_TOKEN>
+  response:
+    status:
+      code: 201
+      message: ''
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Sun, 18 Dec 2016 21:24:42 GMT
+      Content-Type:
+      - text/html;charset=UTF-8
+      Connection:
+      - keep-alive
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache, no-store
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version: 
+  recorded_at: Sun, 18 Dec 2016 21:24:42 GMT
+recorded_with: VCR 3.0.3

data/spec/spec_helper.rb

@@ -21,8 +21,64 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
+
+  config.before do
+    ARGV.replace []
+  end
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__) + '/'
 end
 
+# This code was adapted from Thor, available under MIT-LICENSE
+# Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
+def capture(stream)
+  begin
+    stream = stream.to_s
+    eval "$#{stream} = StringIO.new"
+    yield
+    result = eval("$#{stream}").string
+  ensure
+    eval("$#{stream} = #{stream.upcase}")
+  end
+
+  result
+end
+
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  fake.string
+end
+
+def capture_stderr(&block)
+  original_stderr = $stderr
+  $stderr = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stderr = original_stderr
+  end
+  fake.string
+end
+
+# This code was adapted from Ruby on Rails, available under MIT-LICENSE
+# Copyright (c) 2004-2013 David Heinemeier Hansson
+def silence_warnings
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+ensure
+  $VERBOSE = old_verbose
+end
+
+alias silence capture
+
 VCR.configure do |c|
   mds_token = Base64.encode64("#{ENV['MDS_USERNAME']}:#{ENV['MDS_PASSWORD'].to_s}").rstrip
 
@@ -33,7 +89,3 @@ VCR.configure do |c|
   c.filter_sensitive_data("<MDS_TOKEN>") { mds_token }
   c.configure_rspec_metadata!
 end
-
-def fixture_path
-  File.expand_path("../fixtures", __FILE__) + '/'
-end

data/spec/utils_spec.rb

@@ -19,7 +19,7 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
     end
   end
 
-  describe "base32" do
+  context "base32" do
     it 'should decode doi' do
       doi = "10.23725/0000-03WD"
       expect(subject.decode_doi(doi)).to eq(124)
@@ -40,7 +40,7 @@ describe Cirneco::DataCenter, vcr: true, :order => :defined do
     end
   end
 
-  describe "mint and hide DOIs" do
+  context "mint and hide DOIs" do
     it 'should mint for file' do
       filepath = fixture_path + 'cool-dois.html.md'
       number = 123

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cirneco
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.6.10
 platform: ruby
 authors:
 - Martin Fenner
@@ -341,6 +341,7 @@ files:
 - resources/kernel-4.0/samples/datacite-example-video-v4.0.xml
 - resources/kernel-4.0/samples/datacite-example-workflow-v4.0.xml
 - spec/api_spec.rb
+- spec/doi_spec.rb
 - spec/fixtures/apa.csl
 - spec/fixtures/authors.yml
 - spec/fixtures/cool-dois.html.md
@@ -351,6 +352,9 @@ files:
 - spec/fixtures/vcr_cassettes/Cirneco_DataCenter/get/should_get_all_dois_by_prefix.yml
 - spec/fixtures/vcr_cassettes/Cirneco_DataCenter/get/should_get_next_doi.yml
 - spec/fixtures/vcr_cassettes/Cirneco_DataCenter/get/should_get_number_of_latest_doi.yml
+- spec/fixtures/vcr_cassettes/Cirneco_Doi/MDS_DOI_API/get/should_get_all_dois.yml
+- spec/fixtures/vcr_cassettes/Cirneco_Doi/MDS_DOI_API/get/should_get_doi.yml
+- spec/fixtures/vcr_cassettes/Cirneco_Doi/MDS_DOI_API/put/should_put_doi.yml
 - spec/fixtures/vcr_cassettes/Cirneco_Work/DOI_API/get/should_get_all_dois.yml
 - spec/fixtures/vcr_cassettes/Cirneco_Work/DOI_API/get/should_get_doi.yml
 - spec/fixtures/vcr_cassettes/Cirneco_Work/DOI_API/put/should_put_doi.yml