cirneco 0.3.1

data/lib/cirneco/work.rb

@@ -0,0 +1,206 @@
+require 'active_support/all'
+require 'nokogiri'
+require 'sanitize'
+
+require_relative 'api'
+require_relative 'utils'
+require_relative 'base'
+
+module Cirneco
+  class Work
+    include Cirneco::Base
+    include Cirneco::Api
+    include Cirneco::Utils
+
+    attr_accessor :doi, :creators, :title, :publisher, :publication_year, :resource_type, :version, :related_identifiers, :rights_list, :descriptions, :subjects, :url, :media, :username, :password, :validation_errors
+
+    def initialize(doi:, creators:, title:, publisher:, publication_year:, resource_type:, **options)
+      @doi = doi
+      @creators = creators
+      @title = title
+      @publisher = publisher
+      @publication_year = publication_year
+      @resource_type = resource_type
+
+      @url = options.fetch(:url, nil)
+      @media = options.fetch(:media, nil)
+
+      @username = options.fetch(:username, nil)
+      @password = options.fetch(:password, nil)
+
+      @version = options.fetch(:version, nil)
+      @rights_list = options.fetch(:rights_list, nil)
+      @descriptions = options.fetch(:descriptions, nil)
+      @related_identifiers = options.fetch(:related_identifiers, nil)
+    end
+
+    SCHEMA = File.expand_path("../../../resources/kernel-4.0/metadata.xsd", __FILE__)
+
+
+    def sanitize(string)
+      Sanitize.fragment(string).squish
+    end
+
+    def has_required_elements?
+      doi && creators && title && publisher && publication_year && resource_type
+    end
+
+    def data
+      return nil unless has_required_elements?
+
+      Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.send(:'resource', root_attributes) do
+          insert_work(xml)
+        end
+      end.to_xml
+    end
+
+    def insert_work(xml)
+      insert_identifier(xml)
+      insert_creators(xml)
+      insert_titles(xml)
+      insert_publisher(xml)
+      insert_publication_year(xml)
+      insert_subjects(xml)
+      insert_resource_type(xml)
+      insert_version(xml)
+      insert_rights_list(xml)
+      insert_descriptions(xml)
+    end
+
+    def insert_identifier(xml)
+      xml.identifier(doi, 'identifierType' => "DOI")
+    end
+
+    def insert_creators(xml)
+      return nil unless creators.present?
+
+      xml.send(:'creators') do
+        creators.each do |creator|
+          xml.creator do
+            insert_creator(xml, creator)
+          end
+        end
+      end
+    end
+
+    def insert_creator(xml, creator)
+      creator_name = [creator[:family_name], creator[:given_name], creator[:literal]].compact.join(", ")
+
+      xml.send(:'creatorName', creator_name)
+      xml.send(:'givenName', creator[:given_name]) if creator[:given_name].present?
+      xml.send(:'familyName', creator[:family_name]) if creator[:family_name].present?
+      xml.nameIdentifier(creator[:orcid], 'schemeURI' => 'http://orcid.org/', 'nameIdentifierScheme' => 'ORCID') if creator[:orcid].present?
+    end
+
+    def insert_titles(xml)
+      xml.send(:'titles') do
+        insert_title(xml)
+      end
+    end
+
+    def insert_title(xml)
+      xml.title(title)
+    end
+
+    def insert_publisher(xml)
+      xml.publisher(publisher)
+    end
+
+    def insert_publication_year(xml)
+      xml.publicationYear(publication_year)
+    end
+
+    def insert_subjects(xml)
+      return xml unless subjects.present?
+
+      xml.subjects do
+        subjects.each do |subject|
+          xml.subject(subject)
+        end
+      end
+    end
+
+    def insert_resource_type(xml)
+      xml.resourceType(resource_type[:value], 'resourceTypeGeneral' => resource_type[:resource_type_general])
+    end
+
+    def insert_version(xml)
+      return xml unless version.present?
+
+      xml.version(version)
+    end
+
+    def insert_rights_list(xml)
+      return xml unless rights_list.present?
+
+      xml.rightsList do
+        rights_list.each do |rights|
+          xml.rights(rights[:value], 'rightsURI' => rights[:rights_uri])
+        end
+      end
+    end
+
+    def insert_descriptions(xml)
+      return xml unless descriptions.present?
+
+      xml.descriptions do
+        descriptions.each do |description|
+          xml.description(description[:value], 'descriptionType' => description[:description_type])
+        end
+      end
+    end
+
+    def insert_contributors(xml)
+      return nil unless contributors.present?
+
+      xml.send(:'work:contributors') do
+        contributors.each do |contributor|
+          xml.contributor do
+            insert_contributor(xml, contributor)
+          end
+        end
+      end
+    end
+
+    def insert_contributor(xml, contributor)
+      if contributor[:orcid].present?
+        xml.send(:'common:contributor-orcid') do
+          xml.send(:'common:uri', contributor[:orcid])
+          xml.send(:'common:path', contributor[:orcid][17..-1])
+          xml.send(:'common:host', 'orcid.org')
+        end
+      end
+      xml.send(:'credit-name', contributor[:credit_name])
+      if contributor[:role]
+        xml.send(:'contributor-attributes') do
+          xml.send(:'contributor-role', contributor[:role])
+        end
+      end
+    end
+
+    def without_control(s)
+      r = ''
+      s.each_codepoint do |c|
+        if c >= 32
+          r << c
+        end
+      end
+      r
+    end
+
+    def root_attributes
+      { :'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        :'xsi:schemaLocation' => 'http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd',
+        :'xmlns' => 'http://datacite.org/schema/kernel-4' }
+    end
+
+    def schema
+      Nokogiri::XML::Schema(open(SCHEMA))
+    end
+
+    def validation_errors
+      @validation_errors ||= schema.validate(Nokogiri::XML(data)).map { |error| error.to_s }
+    end
+  end
+end

data/lib/cirneco.rb

@@ -0,0 +1,7 @@
+require "cirneco/work"
+require "cirneco/data_center"
+require "cirneco/cli"
+require "cirneco/doi"
+require "cirneco/media"
+require "cirneco/metadata"
+require "cirneco/version"

data/resources/kernel-4.0/include/datacite-contributorType-v4.xsd

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2011-01-13 - FZ, TIB, Germany
+   2013-05 v3.0: Addition of ID to simpleType element, added values "ResearchGroup" & "Other"
+   2014-08-20 v3.1: Addition of value "DataCurator"
+   2015-05-14 v4.0 dropped value "Funder", use new "funderReference" -->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="contributorType" id="contributorType">
+    <xs:annotation>
+      <xs:documentation>The type of contributor of the resource.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="ContactPerson"/>
+      <xs:enumeration value="DataCollector"/>
+      <xs:enumeration value="DataCurator"/>
+      <xs:enumeration value="DataManager"/>
+      <xs:enumeration value="Distributor"/>
+      <xs:enumeration value="Editor"/>
+      <xs:enumeration value="HostingInstitution"/>
+      <xs:enumeration value="Other"/>
+      <xs:enumeration value="Producer"/>
+      <xs:enumeration value="ProjectLeader"/>
+      <xs:enumeration value="ProjectManager"/>
+      <xs:enumeration value="ProjectMember"/>
+      <xs:enumeration value="RegistrationAgency"/>
+      <xs:enumeration value="RegistrationAuthority"/>
+      <xs:enumeration value="RelatedPerson"/>
+      <xs:enumeration value="ResearchGroup"/>
+      <xs:enumeration value="RightsHolder"/>
+      <xs:enumeration value="Researcher"/>
+      <xs:enumeration value="Sponsor"/>
+      <xs:enumeration value="Supervisor"/>
+      <xs:enumeration value="WorkPackageLeader"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-dateType-v4.xsd

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2011-01-13 - FZ, TIB, Germany
+     2013-05 v3.0: Addition of ID to simpleType element; addition of value "Collected"; deleted "StartDate" & "EndDate"-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="dateType" id="dateType">
+    <xs:annotation>
+      <xs:documentation>The type of date. Use RKMS‐ISO8601 standard for depicting date ranges.To indicate the end of an embargo period, use Available. To indicate the start of an embargo period, use Submitted or Accepted, as appropriate.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="Accepted"/>
+      <xs:enumeration value="Available"/>
+      <xs:enumeration value="Collected"/>
+      <xs:enumeration value="Copyrighted"/>
+      <xs:enumeration value="Created"/>
+      <xs:enumeration value="Issued"/>
+      <xs:enumeration value="Submitted"/>
+      <xs:enumeration value="Updated"/>
+      <xs:enumeration value="Valid"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-descriptionType-v4.xsd

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2011-01-13 - FZ, TIB, Germany
+     2013-05 v3.0: Addition of ID to simpleType element, addition of value "Methods"
+     2015-02-12 v4.0: Addition of value "TechnicalInfo"-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="descriptionType" id="descriptionType">
+    <xs:annotation>
+      <xs:documentation>The type of the description.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="Abstract"/>
+      <xs:enumeration value="Methods"/>
+      <xs:enumeration value="SeriesInformation"/>
+      <xs:enumeration value="TableOfContents"/>
+      <xs:enumeration value="TechnicalInfo"/>
+      <xs:enumeration value="Other"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-funderIdentifierType-v4.xsd

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2016-05-14 -->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="funderIdentifierType" id="funderIdentifierType">
+    <xs:annotation>
+      <xs:documentation>The type of the funderIdentifier.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="ISNI"/>
+      <xs:enumeration value="GRID"/>
+      <xs:enumeration value="Crossref Funder ID"/>
+      <xs:enumeration value="Other"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-relatedIdentifierType-v4.xsd

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2011-01-13 - FZ, TIB, Germany
+  2013-05 v3.0: Addition of ID to simpleType element; addition of value "PMID"
+  2014-08-20 v3.1: Addition of values "arxiv" and "bibcode"
+  2015-02-12 v4.0 Addition of value "IGSN" -->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="relatedIdentifierType" id="relatedIdentifierType">
+    <xs:annotation>
+      <xs:documentation>The type of the RelatedIdentifier.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="ARK"/>
+      <xs:enumeration value="arXiv"/>
+      <xs:enumeration value="bibcode"/>
+      <xs:enumeration value="DOI"/>
+      <xs:enumeration value="EAN13"/>
+      <xs:enumeration value="EISSN"/>
+      <xs:enumeration value="Handle"/>
+      <xs:enumeration value="IGSN"/>
+      <xs:enumeration value="ISBN"/>
+      <xs:enumeration value="ISSN"/>
+      <xs:enumeration value="ISTC"/>
+      <xs:enumeration value="LISSN"/>
+      <xs:enumeration value="LSID"/>
+      <xs:enumeration value="PMID"/>
+      <xs:enumeration value="PURL"/>
+      <xs:enumeration value="UPC"/>
+      <xs:enumeration value="URL"/>
+      <xs:enumeration value="URN"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-relationType-v4.xsd

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  2011-01-13 v1.0 - FZ, TIB, Germany
+  2013-05 v3.0: Addition of ID to simpleType element, addition of values "IsIdenticalTo", "HasMetadata" & "IsMetadataFor"
+  2014-08-20 v3.1: Addition of values "Reviews" & "IsReviewedBy" and "IsDerivedFrom" & "IsSourceOf"-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="relationType" id="relationType">
+    <xs:annotation>
+      <xs:documentation>Description of the relationship of the resource being registered (A) and the related resource (B).</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="IsCitedBy"/>
+      <xs:enumeration value="Cites"/>
+      <xs:enumeration value="IsSupplementTo"/>
+      <xs:enumeration value="IsSupplementedBy"/>
+      <xs:enumeration value="IsContinuedBy"/>
+      <xs:enumeration value="Continues"/>
+      <xs:enumeration value="IsNewVersionOf"/>
+      <xs:enumeration value="IsPreviousVersionOf"/>
+      <xs:enumeration value="IsPartOf"/>
+      <xs:enumeration value="HasPart"/>
+      <xs:enumeration value="IsReferencedBy"/>
+      <xs:enumeration value="References"/>
+      <xs:enumeration value="IsDocumentedBy"/>
+      <xs:enumeration value="Documents"/>
+      <xs:enumeration value="IsCompiledBy"/>
+      <xs:enumeration value="Compiles"/>
+      <xs:enumeration value="IsVariantFormOf"/>
+      <xs:enumeration value="IsOriginalFormOf"/>
+      <xs:enumeration value="IsIdenticalTo"/>
+      <xs:enumeration value="HasMetadata"/>
+      <xs:enumeration value="IsMetadataFor"/>
+      <xs:enumeration value="Reviews"/>
+      <xs:enumeration value="IsReviewedBy"/>
+      <xs:enumeration value="IsDerivedFrom"/>
+      <xs:enumeration value="IsSourceOf"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-resourceType-v4.xsd

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2011-01-13 - FZ, TIB, Germany
+     2013-05 v3.0: Addition of ID to simpleType element; added values "Audiovisual", "Workflow" & "Other"; deleted value "Film" -->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="resourceType" id="resourceType">
+    <xs:annotation>
+      <xs:documentation>The general type of a resource.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="Audiovisual"/>
+      <xs:enumeration value="Collection"/>
+      <xs:enumeration value="Dataset"/>
+      <xs:enumeration value="Event"/>
+      <xs:enumeration value="Image"/>
+      <xs:enumeration value="InteractiveResource"/>
+      <xs:enumeration value="Model"/>
+      <xs:enumeration value="PhysicalObject"/>
+      <xs:enumeration value="Service"/>
+      <xs:enumeration value="Software"/>
+      <xs:enumeration value="Sound"/>
+      <xs:enumeration value="Text"/>
+      <xs:enumeration value="Workflow"/>
+      <xs:enumeration value="Other"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/resources/kernel-4.0/include/datacite-titleType-v4.xsd

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Version 1.0 - Created 2011-01-13 - FZ, TIB, Germany
+  2013-05 v3.0: Addition of ID to simpleType element
+  2015-02-12 v4.0 Added value "Other" -->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://datacite.org/schema/kernel-4" targetNamespace="http://datacite.org/schema/kernel-4" elementFormDefault="qualified">
+  <xs:simpleType name="titleType" id="titleType">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="AlternativeTitle"/>
+      <xs:enumeration value="Subtitle"/>
+      <xs:enumeration value="TranslatedTitle"/>
+      <xs:enumeration value="Other"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>