dina 0.7.4.0 → 0.8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620e59a87be3c3adb55fba2d7d4084a12fbb12a78427ca53de33426ae8510110
-  data.tar.gz: 6c2c5daff310c35f43b165156fc06944d44e4a74db84da12af055fb4d0be401d
+  metadata.gz: 25a15f64f21867881cc89efca164d7753aff7916b1399bc3525f5375bb13c38f
+  data.tar.gz: 27e916b183b9413093544901367e3103553f9a91b4c9c5de476fe15d0bfc12e2
 SHA512:
-  metadata.gz: 3b5913b6fe291bbcb26b4c5bf298bf4f6307077e006442952ad1937833952074728352cc1f0e1e01a6abfa8f5197b06161ddf1ef674dc29a4012761f46ed231a
-  data.tar.gz: dea42bb62339358120b3d890edd22727c81058e30e6b9b3c7443d90e515e10942a12533bc94e52b5d8a6a8578d1ba67e70e6c4e1366672c828a789c1bace37e0
+  metadata.gz: a6e8b0c69ea6169539823a31d3ea10dab1b4a3f62f5358eaf2bf10d484472356610c317c1dbfb0a187957aca071daf68a142d207872fdaca71d8655fab8ed639
+  data.tar.gz: 15894af41ce11caa23c126e86fc31be365bae97cee056b8c7f90dee4585fde800ab05537c87a8749c2ffdd3625a693eb6533a4af4fd1c4c8371d9494693bc73c

data/lib/dina/components/address.rb

@@ -0,0 +1,22 @@
+module Dina
+  class Address
+    attr_accessor :receiverName
+    attr_accessor :companyName
+    attr_accessor :addressLine1
+    attr_accessor :addressLine2
+    attr_accessor :city
+    attr_accessor :provinceState
+    attr_accessor :zipCode
+    attr_accessor :country
+
+    def initialize
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
+      hash.deep_symbolize_keys
+    end
+
+  end
+end

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

@@ -35,6 +35,10 @@ module Dina
       where("email": email).all
     end
 
+    # Searches for a Person by name using the search module
+    #
+    # @param name [String] any portion of a person's name
+    # @return array [Array] an array of Person objects, ordered by relevance
     def self.search_by_name(name)
       payload = {
         query: {
@@ -51,7 +55,7 @@ module Dina
           }
         }
       }
-      hits = Dina::Search.execute(index: "agent", payload: payload)[:hits]
+      hits = Search.execute(index: "agent", payload: payload)[:hits]
       hits.map{|a| self.find(a[:_source][:data][:id]).first }
     end
 

data/lib/dina/models/base_model.rb

@@ -2,6 +2,7 @@ module Dina
   class BaseModel < JsonApiClient::Resource
     include JsonApiClient::Helpers::Callbacks
 
+    self.raise_on_blank_find_param = true
     self.json_key_format = :camelized_key
     self.paginator = JsonApiClient::Paginating::NestedParamPaginator
 
@@ -38,44 +39,20 @@ module Dina
       symbolized_params = params.transform_keys(&:to_sym)
       params["id"] = SecureRandom.uuid if !symbolized_params[:id]
       super
+      extend_model_methods
     end
 
-    # Adds or updates a multilingualDescription with a language key
-    #
-    # @param opts [Hash] the description expessed as { en: "My description" }
-    def set_multilingualDescription(opts = {})
+    private
+
+    def extend_model_methods
       if self.respond_to?(:multilingualDescription)
-        if self.multilingualDescription.nil?
-          self.multilingualDescription = opts
-        else
-          descriptions = multilingualDescription["descriptions"]
-          descriptions.delete_if{|o| o["lang"] == opts.keys[0].to_s}
-          descriptions << { "lang" => opts.keys[0].to_s, "desc" => opts[opts.keys[0]] }
-        end
-      else
-        raise PropertyInvalid, "#{self.class} does not have the property multilingualDescription"
+        extend MultiLingualDescription
       end
-    end
-
-    # Adds or updates a multilingualTitle with a language key
-    #
-    # @param opts [Hash] the title expessed as { en: "My title" }
-    def set_multilingualTitle(opts = {})
       if self.respond_to?(:multilingualTitle)
-        if self.multilingualTitle.nil?
-          self.multilingualTitle = opts
-        else
-          titles = multilingualTitle["titles"]
-          titles.delete_if{|o| o["lang"] == opts.keys[0].to_s}
-          titles << { "lang" => opts.keys[0].to_s, "title" => opts[opts.keys[0]] }
-        end
-      else
-        raise PropertyInvalid, "#{self.class} does not have the property multilingualTitle"
+        extend MultiLingualTitle
       end
     end
 
-    private
-
     def on_before_create
       self.attributes.delete_if { |k, v| v.nil? || v == "" }
       self.attributes = self.attributes.deep_symbolize_keys

data/lib/dina/models/managed_attribute.rb

@@ -6,7 +6,7 @@ module Dina
     property :group, type: :string
     property :name, type: :string
     property :key, type: :string
-    property :managedAttributeType, type: :string
+    property :vocabularyElementType, type: :string
     property :managedAttributeComponent, type: :string
     property :acceptedValues, type: :array
     property :multilingualDescription, type: :multilingual_description
@@ -15,7 +15,7 @@ module Dina
 
     validates_presence_of :group, message: "group is required"
     validates_presence_of :name, message: "name is required"
-    validates_presence_of :managedAttributeType, message: "managedAttributeType is required"
+    validates_presence_of :vocabularyElementType, message: "vocabularyElementType is required"
 
     attr_accessor :accepted_components, :accepted_types
 
@@ -52,8 +52,8 @@ module Dina
       if !self.managedAttributeComponent.nil? && !self.class.accepted_components.include?(self.managedAttributeComponent)
         raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for managedAttributeComponent is one of #{self.class.accepted_components.join(", ")}"
       end
-      if !self.managedAttributeType.nil? && !self.class.accepted_types.include?(self.managedAttributeType)
-        raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for managedAttributeType is one of #{self.class.accepted_types.join(", ")}"
+      if !self.vocabularyElementType.nil? && !self.class.accepted_types.include?(self.vocabularyElementType)
+        raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for vocabularyElementType is one of #{self.class.accepted_types.join(", ")}"
       end
       super
     end

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

@@ -5,7 +5,7 @@ module Dina
     property :id, type: :string, default: SecureRandom.uuid
     property :name, type: :string
     property :key, type: :string
-    property :managedAttributeType, type: :string
+    property :vocabularyElementType, type: :string
     property :acceptedValues, type: :array
     property :multilingualDescription, type: :multilingual_description
     property :createdBy, type: :string
@@ -22,8 +22,8 @@ module Dina
     private
 
     def on_before_save
-      if !self.managedAttributeType.nil? && !ManagedAttribute.accepted_types.include?(self.managedAttributeType)
-        raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for managedAttributeType is one of #{ManagedAttribute.accepted_types.join(", ")}"
+      if !self.vocabularyElementType.nil? && !ManagedAttribute.accepted_types.include?(self.vocabularyElementType)
+        raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for vocabularyElementType is one of #{ManagedAttribute.accepted_types.join(", ")}"
       end
       super
     end

data/lib/dina/models/sequence/index_set.rb

@@ -4,8 +4,14 @@ module Dina
   class IndexSet < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :name, type: :string
+    property :forwardAdapter, type: :string
+    property :reverseAdapter, type: :string
+    property :createdBy, type: :string
+    property :createdOn, type: :time
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
 
     def self.endpoint_path
       "seqdb-api/"

data/lib/dina/models/sequence/molecular_sample.rb

@@ -4,8 +4,15 @@ module Dina
   class MolecularSample < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :name, type: :string
+    property :createdBy, type: :string
+    property :createdOn, type: :time
+
+    has_one :kit, class_name: "Product"
+    has_one :materialSample, class_name: "MaterialSample"
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
 
     def self.endpoint_path
       "seqdb-api/"
@@ -15,5 +22,20 @@ module Dina
       "molecular-sample"
     end
 
+    def self.sample_type
+      [
+        "DNA"
+      ]
+    end
+
+    private
+
+    def on_before_save
+      if !self.sampleType.nil? && !self.class.sample_type.include?(self.type)
+        raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for sampleType is one of #{self.class.sample_type.join(", ")}"
+      end
+      super
+    end
+
   end
 end

data/lib/dina/models/sequence/pcr_batch.rb

@@ -4,8 +4,10 @@ module Dina
   class PcrBatch < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :name, type: :string
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
 
     def self.endpoint_path
       "seqdb-api/"

data/lib/dina/models/sequence/pcr_primer.rb

@@ -4,8 +4,36 @@ module Dina
   class PcrPrimer < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :type, type: :string
+    property :name, type: :string
+    property :version, type: :integer
+    property :seq, type: :string
+    property :position, type: :string
+    property :tmCalculated, type: :string
+    property :tmPe, type: :integer
+    property :application, type: :string
+    property :direction, type: :string
+    property :reference, type: :string
+    property :pooledPrimer, type: :string
+    property :lotNumber, type: :string
+    property :sequenceLength, type: :integer
+    property :targetSpecies, type: :string
+    property :supplier, type: :string
+    property :dateOrdered, type: :time
+    property :dateDestroyed, type: :time
+    property :purification, type: :string
+    property :designedBy, type: :string
+    property :stockConcentration, type: :string
+    property :lotNumber, type: :integer
+    property :region, type: :string
+    property :note, type: :string
+    property :createdBy, type: :string
+    property :createdOn, type: :time
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
+    validates_presence_of :type, message: "type is required"
+    validates_presence_of :lotNumber, message: "lotNumber is required"
 
     def self.endpoint_path
       "seqdb-api/"
@@ -15,5 +43,24 @@ module Dina
       "pcr-primer"
     end
 
+    def self.accepted_types
+      [
+        "PRIMER",
+        "MID",
+        "FUSION_PRIMER",
+        "ILLUMINA_INDEX",
+        "ITRU_PRIMER"
+      ]
+    end
+
+    private
+
+    def on_before_save
+      if !self.type.nil? && !self.class.accepted_types.include?(self.type)
+        raise PropertyValueInvalid, "#{self.class} is invalid. Accepted value for type is one of #{self.class.accepted_types.join(", ")}"
+      end
+      super
+    end
+
   end
 end

data/lib/dina/models/sequence/product.rb

@@ -4,8 +4,15 @@ module Dina
   class Product < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :name, type: :string
+    property :upc, type: :string
+    property :type, type: :string
+    property :description, type: :string
+    property :createdBy, type: :string
+    property :createdOn, type: :time
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
 
     def self.endpoint_path
       "seqdb-api/"

data/lib/dina/models/sequence/region.rb

@@ -4,8 +4,16 @@ module Dina
   class Region < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :name, type: :string
+    property :symbol, type: :string
+    property :description, type: :string
+    property :aliases, type: :string
+    property :applicableOrganisms, type: :string
+    property :createdBy, type: :string
+    property :createdOn, type: :time
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :symbol, message: "symbol is required"
 
     def self.endpoint_path
       "seqdb-api/"

data/lib/dina/models/sequence/thermocycler_profile.rb

@@ -4,8 +4,17 @@ module Dina
   class ThermocyclerProfile < BaseModel
     property :id, type: :string, default: SecureRandom.uuid
     property :group, type: :string
+    property :name, type: :string
+    property :application, type: :string
+    property :cycles, type: :string
+    property :steps, type: :array
+    property :createdBy, type: :string
+    property :createdOn, type: :time
+
+    has_one :region, class_name: "Region"
 
     validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
 
     def self.endpoint_path
       "seqdb-api/"

data/lib/dina/utils/multi_lingual_description.rb

@@ -0,0 +1,18 @@
+module Dina
+  module MultiLingualDescription
+
+    # Adds or updates a multilingualDescription with a language key
+    #
+    # @param opts [Hash] the description expessed as { en: "My description" }
+    def set_multilingualDescription(opts = {})
+      if self.multilingualDescription.nil?
+        self.multilingualDescription = opts
+      else
+        descriptions = multilingualDescription["descriptions"]
+        descriptions.delete_if{|o| o["lang"] == opts.keys[0].to_s}
+        descriptions << { "lang" => opts.keys[0].to_s, "desc" => opts[opts.keys[0]] }
+      end
+    end
+
+  end
+end

data/lib/dina/utils/multi_lingual_title.rb

@@ -0,0 +1,18 @@
+module Dina
+  module MultiLingualTitle
+
+    # Adds or updates a multilingualTitle with a language key
+    #
+    # @param opts [Hash] the title expessed as { en: "My title" }
+    def set_multilingualTitle(opts = {})
+      if self.multilingualTitle.nil?
+        self.multilingualTitle = opts
+      else
+        titles = multilingualTitle["titles"]
+        titles.delete_if{|o| o["lang"] == opts.keys[0].to_s}
+        titles << { "lang" => opts.keys[0].to_s, "title" => opts[opts.keys[0]] }
+      end
+    end
+
+  end
+end

data/lib/dina/version.rb

@@ -2,8 +2,8 @@ module Dina
   class Version
 
     MAJOR = 0
-    MINOR = 7
-    PATCH = 4
+    MINOR = 8
+    PATCH = 0
     BUILD = 0
 
     def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dina
 version: !ruby/object:Gem::Version
-  version: 0.7.4.0
+  version: 0.8.0.0
 platform: ruby
 authors:
 - David P. Shorthouse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -150,6 +150,7 @@ files:
 - lib/dina/casters/multilingual_title.rb
 - lib/dina/casters/multilingual_title_caster.rb
 - lib/dina/casters/object_caster.rb
+- lib/dina/components/address.rb
 - lib/dina/components/agent_role.rb
 - lib/dina/components/determination.rb
 - lib/dina/components/georeference_assertion.rb
@@ -199,6 +200,8 @@ files:
 - lib/dina/search/search_mapping.rb
 - lib/dina/utils/identifier.rb
 - lib/dina/utils/identifier_type.rb
+- lib/dina/utils/multi_lingual_description.rb
+- lib/dina/utils/multi_lingual_title.rb
 - lib/dina/version.rb
 homepage: https://github.com/dshorthouse/dina
 licenses: