dina 0.5.1.0 → 0.5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52ee6aa08c01721d7d2b925a616f1800c303a7d5801ac7080ec3c2d2a270a04d
-  data.tar.gz: 0a2f3e2e2bf4d9cc8ddd4b3534fd8309dae734c02299cac986e36abaa15431cb
+  metadata.gz: f73e6c200e682c91492c0f50854dc73a9fac3537a65eb12a5fe1d974b72adf09
+  data.tar.gz: 4fa9641b7ff96f95c88b30b1e6857aa9e02dc6ae8639efd84aa034a0908fa182
 SHA512:
-  metadata.gz: 7a9352df0039a613fa279753da7f2464e572110887024be28bd486368ca2ee5d0afebc0bcffc535b30ce7779b997e8fc3f2b74e739a10d12b752a55d2c673608
-  data.tar.gz: 6f3560ea41463b841cf01affddc47165d90383c7c303f5f110bfcc96702a8f7b4ee8dbd1a7d8310ab7facc8086042a4de5eba2a1c0381a018c2a999a4a3295c2
+  metadata.gz: 394bac789e4e01efe38447edb8042ae9f6dd3510b1a97aa06f6545f07a9133466a2afbcae3fc0e9d90fa053b8ba0f3c651b46dabb7f7dd702566870d9e5e1787
+  data.tar.gz: fc3d1f5e15028d8724ff1a37bc6816f28cbe639e79c67e9d75dd8d7dfa9e70f9d017c14cb31c79184f8f0a135d23750548ad98e1127d00fd2ea1d45fff8b97a1

data/lib/dina/components/agent_role.rb

@@ -1,17 +1,28 @@
 module Dina
   class AgentRole
-    attr_accessor :agent #A known UUID for a Person
-    attr_accessor :roles #an array of roles: Owner, Borrower, Prepared By
+    attr_accessor :agent #An array of known UUIDs for a Person
+    attr_accessor :roles #An array of roles: Owner, Borrower, Prepared By
     attr_accessor :date
     attr_accessor :remarks
 
     def initialize
+      @agent = []
+      @roles = []
+    end
+
+    def add_agent(id)
+      raise PropertyValueInvalid, "Agent must be a UUID." if !id.is_uuid?
+      @agent << id
+    end
+
+    def add_role(role)
+      @roles << role
     end
 
     def to_hash
       hash = {}
       instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
-      hash
+      hash.deep_symbolize_keys
     end
 
   end

data/lib/dina/components/determination.rb

@@ -9,7 +9,7 @@ module Dina
     attr_accessor :determinationRemarks
     attr_accessor :typeStatus
     attr_accessor :typeStatusEvidence
-    attr_accessor :determiner #A known UUID for a Person
+    attr_accessor :determiner #An array of known UUIDs for Person
     attr_accessor :determinedOn
     attr_accessor :qualifier
     attr_accessor :scientificNameSource
@@ -18,13 +18,53 @@ module Dina
     attr_accessor :isFiledAs #boolean
     attr_accessor :managedAttributes #array
 
+    attr_accessor :classification
+    attr_accessor :ranks
+
     def initialize
+      @scientificNameDetails = {}
+      @determiner = []
+    end
+
+    # Add a materialized classification string to scientificNameDetails
+    # Path should use pipes, "|" as separators
+    #
+    # @param path [String] the classification
+    def classification=(path)
+      if !path.instance_of?(String)
+        raise PropertyValueInvalid, "Classification must be a string with individual items separated by pipes."
+      end
+      @classification = path
+      scientificNameDetails.merge!({ classificationPath: path })
+    end
+
+    # Add a materialized ranks string to scientificNameDetails
+    # Ranks should use pipes, "|" as separators
+    #
+    # @param ranks [String] the ranks
+    def ranks=(ranks)
+      if !ranks.instance_of?(String)
+        raise PropertyValueInvalid, "Ranks must be a string with individual items separated by pipes."
+      end
+      @ranks = ranks
+      scientificNameDetails.merge!({ classificationRanks: ranks })
+    end
+
+    # Add a determiner as UUID to the array of determiner
+    #
+    # @param id [String] a UUID for a determiner
+    def add_determiner(id)
+      raise PropertyValueInvalid, "Determiner must be a UUID." if !id.is_uuid?
+      @determiner << id
     end
 
+    # Produce a hash with symbolized keys
     def to_hash
       hash = {}
+      remove_instance_variable(:@classification) if @classification
+      remove_instance_variable(:@ranks) if @ranks
       instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
-      hash
+      hash.deep_symbolize_keys
     end
 
   end

data/lib/dina/components/georeference_assertion.rb

@@ -9,17 +9,27 @@ module Dina
     attr_accessor :dwcGeoreferenceProtocol
     attr_accessor :dwcGeoreferenceSources
     attr_accessor :dwcGeoreferenceRemarks
-    attr_accessor :dwcGeodeticDatum #A known UUID for a Person
+    attr_accessor :dwcGeodeticDatum
     attr_accessor :isPrimary
     attr_accessor :dwcGeoreferenceVerificationStatus
+    attr_accessor :createdOn
 
     def initialize
+      @georeferencedBy = []
+    end
+
+    # Add a georeferencedBy as UUID to the array
+    #
+    # @param id [String] a UUID for a georeferencedBy
+    def add_georeferencedBy(id)
+      raise PropertyValueInvalid, "georeferencedBy must be a UUID." if !id.is_uuid?
+      @georeferencedBy << id
     end
 
     def to_hash
       hash = {}
       instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
-      hash
+      hash.deep_symbolize_keys
     end
 
   end

data/lib/dina/components/shipment.rb

@@ -12,12 +12,20 @@ module Dina
     attr_accessor :address # with properties receiverName, companyName, addressLine1, addressLine2, city, provinceState, zipCode, country
 
     def initialize
+      @address = {}
+    end
+
+    def add_address(address)
+      if !address.instance_of?(Hash)
+        raise PropertyValueInvalid, "Address must be a Hash."
+      end
+      @address.merge!(address)
     end
 
     def to_hash
       hash = {}
       instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
-      hash
+      hash.deep_symbolize_keys
     end
 
   end

data/lib/dina/models/agent/identifier.rb

@@ -10,6 +10,9 @@ module Dina
 
     belongs_to :person, shallow_path: true, class_name: "Person"
 
+    validates_presence_of :namespace, message: "namespace is required"
+    validates_presence_of :value, message: "value is required"
+
     def self.endpoint_path
       "agent-api/"
     end

data/lib/dina/models/base_model.rb

@@ -24,7 +24,8 @@ module Dina
     end
 
     def initialize(params = {})
-      params[:id] = SecureRandom.uuid if !params[:id]
+      symbolized_params = params.transform_keys(&:to_sym)
+      params["id"] = SecureRandom.uuid if !symbolized_params[:id]
       super
     end
 

data/lib/dina/models/material_sample/collecting_event.rb

@@ -30,7 +30,7 @@ module Dina
     property :dwcMaximumDepthInMeters, type: :float
     property :substrate, type: :string
     property :remarks, type: :string
-    property :publiclyReleasable, type: :boolean
+    property :publiclyReleasable, type: :boolean, default: true
     property :notPubliclyReleasableReason, type: :string, default: nil
     property :tags, type: :array, default: []
     property :geographicPlaceNameSource, type: :string

data/lib/dina/models/material_sample/material_sample.rb

@@ -29,7 +29,7 @@ module Dina
     property :materialSampleChildren, type: :array
     property :associations, type: :array, default: []
     property :tags, type: :array, default: []
-    property :publiclyReleasable, type: :boolean
+    property :publiclyReleasable, type: :boolean, default: true
     property :notPubliclyReleasableReason, type: :string
     property :hostOrganism, type: :object, default: { name: nil, remarks: nil }
     property :scheduledActions, type: :object

data/lib/dina/models/object_store/object_store.rb

@@ -6,7 +6,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
     property :group, type: :string
-    property :dcFormat, type: :string
+    property :dcFormat, type: :string, default: "image/jpeg"
     property :dcType, type: :string
     property :acSubtype, type: :string
     property :fileIdentifier, type: :string
@@ -20,7 +20,7 @@ module Dina
     property :acHashValue, type: :string
     property :xmpRightsUsageTerms, type: :string, default: "Government of Canada Usage Term"
     property :xmpRightsWebStatement, type: :string, default: "https://open.canada.ca/en/open-government-licence-canada"
-    property :dcRights, type: :string, default: "© Her Majesty The Queen in Right of Canada, as represented by the Minister of Agriculture and Agri-Food | © Sa Majesté la Reine du chef du Canada, représentée par le ministre de l’Agriculture et de l’Agroalimentaire"
+    property :dcRights, type: :string, default: "© His Majesty The King in Right of Canada, as represented by the Minister of Agriculture and Agri-Food | © Sa Majesté le Roi du chef du Canada, représentée par le ministre de l’Agriculture et de l’Agroalimentaire"
     property :xmpRightsOwner, type: :string, default: "Government of Canada"
     property :publiclyReleasable, type: :boolean, default: true
     property :notPubliclyReleasableReason, type: :string
@@ -34,6 +34,10 @@ module Dina
     has_many :derivatives, class_name: "Derivative"
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :dcFormat, message: "dcFormat is required"
+    validates_presence_of :dcType, message: "dcType is required"
+    validates_presence_of :xmpRightsUsageTerms, message: "xmpRightsUsageTerms is required"
+    validates_presence_of :dcRights, message: "dcRights is required"
 
     attr_accessor :accepted_types
 

data/lib/dina/models/transaction/transaction.rb

@@ -16,8 +16,8 @@ module Dina
     property :dueDate, type: :time
     property :remarks, type: :string
     property :managedAttributes, type: :object
-    property :agentRoles, type: :array
-    property :shipment, type: :object
+    property :agentRoles, type: :array # Each of type Dina::AgentRole
+    property :shipment, type: :object # Of type Dina::Shipment
     property :createdBy, type: :string
     property :createdOn, type: :time
 
@@ -26,6 +26,7 @@ module Dina
     has_many :involved_agents, class_name: "Person"
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :materialDirection, message: "materialDirection is required"
 
     attr_accessor :accepted_directions
 

data/lib/dina/utils/identifier.rb

@@ -1,30 +1,34 @@
 # encoding: utf-8
 class String
   def is_orcid?
-    ::Dina::Identifier.is_orcid_regex.match?(self) &&
+    ::Dina::PersistentIdentifier.is_orcid_regex.match?(self) &&
     ::Dina::Identifier.orcid_valid_checksum(self)
   end
 
   def is_wiki_id?
-    ::Dina::Identifier.is_wiki_regex.match?(self)
+    ::Dina::PersistentIdentifier.is_wiki_regex.match?(self)
   end
 
   def is_doi?
-    ::Dina::Identifier.is_doi_regex.match?(self)
+    ::Dina::PersistentIdentifier.is_doi_regex.match?(self)
+  end
+
+  def is_uuid?
+    ::Dina::PersistentIdentifier.is_uuid_regex.match?(self)
   end
 
   def orcid_from_url
-    ::Dina::Identifier.extract_orcid_regex.match(self)[0] rescue nil
+    ::Dina::PersistentIdentifier.extract_orcid_regex.match(self)[0] rescue nil
   end
 
   def wiki_from_url
-    ::Dina::Identifier.extract_wiki_regex.match(self)[0] rescue nil
+    ::Dina::PersistentIdentifier.extract_wiki_regex.match(self)[0] rescue nil
   end
 
 end
 
 module Dina
-  class Identifier
+  class PersistentIdentifier
 
     class << self
       def is_orcid_regex
@@ -39,6 +43,10 @@ module Dina
         /^10.\d{4,9}\/[-._;()\/:<>A-Z0-9]+$/i
       end
 
+      def is_uuid_regex
+        /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+      end
+
       def orcid_valid_checksum(orcid_string)
         parts = orcid_string.scan(/[0-9X]/)
         mod = parts[0..14].map(&:to_i)

data/lib/dina/version.rb

@@ -3,7 +3,7 @@ module Dina
 
     MAJOR = 0
     MINOR = 5
-    PATCH = 1
+    PATCH = 3
     BUILD = 0
 
     def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dina
 version: !ruby/object:Gem::Version
-  version: 0.5.1.0
+  version: 0.5.3.0
 platform: ruby
 authors:
 - David P. Shorthouse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client