dina 0.5.2.0 → 0.5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d9beaf0e0b3193f1fb555df9915df0ec6de3dbeae45c066c536e0a2509ede5
-  data.tar.gz: '0963571341f6fc59cef4c7b8403f271eac7cf275e123bee258fdefd4beb6051f'
+  metadata.gz: 4bd91960b1bdd12e80298ec10a00fbb667f4eb54d1395c6ffa8f9a623c74baee
+  data.tar.gz: e323a54e622ea8b29f0ac6d0f61b36194df1f59308ebb15f7df65d2c29668612
 SHA512:
-  metadata.gz: da34d372945da32fb37edeb09b6fa796e1a48bc832d098973c2386a2dc8870d92c8663b6b21c580b6f94fa0b0b5ca30f1cfc30a5af8f36e26741ad65a2c82754
-  data.tar.gz: b7aa54b8030c827919f270eed92f8dff3f2f23078d6c32d7dd180a22b37ff082da22ade4a850a2a5fb8a3afd87c6e6b5e96559b831fd91244591abad630aaab3
+  metadata.gz: '08981c9cab7306ceaafd89e5fa86f91f6abe96dbfcef74604bab6636da5b5b42084f55228d08f1001b8573e424046094965f6f9ad5cc7ffbfcf6470af62f4a0b'
+  data.tar.gz: d846e3986c30490f49745b35356796ab058ed2ab608c4554ccf3af2b1253aaa84e2b2d424ba1b42f0083f82d7aae90994380f2698f51808d7d66314fe499c66d

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/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/collection.rb

@@ -28,10 +28,18 @@ module Dina
       "collection"
     end
 
+    # Finds a Collection object by name
+    #
+    # @param email [String] a name
+    # @return object [Object] a Collection object
     def self.find_by_name(name)
       where(name: name).all.first
     end
 
+    # Finds a Collection object by code
+    #
+    # @param code [String] a code
+    # @return object [Object] a Collection object
     def self.find_by_code(code)
       where(code: code).all.first
     end

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/file.rb

@@ -24,7 +24,7 @@ module Dina
     end
 
     def url
-      Dina::Authentication.endpoint_url + endpoint_path + table_name
+      Dina::Authentication.endpoint_url + "/" + endpoint_path + table_name
     end
 
     def file

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
@@ -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/search/base_search.rb

@@ -30,7 +30,7 @@ module Dina
       begin
         response = RestClient::Request.execute(
           method: method,
-          url: endpoint + endpoint_path + "?" + params.to_query,
+          url: endpoint + "/" + endpoint_path + "?" + params.to_query,
           payload: payload.to_json,
           headers: {
             accept: 'application/json',

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 = 2
+    PATCH = 4
     BUILD = 0
 
     def self.version

metadata

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