dina 0.1.0.0 → 0.2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9d082cc5779c2164cc62c37dc96ccb9518172dd7d4906e5e7de7ca9270af35
-  data.tar.gz: 0fe67de260e7fab5f9167175dfc85bd8fe64f000887941648d7b003bbab16ab5
+  metadata.gz: ac8691de71d4edf3e8c55134a2eab3907db3330ab74e40d12779c960178d5d23
+  data.tar.gz: b3f6cb667ce6d648ff804ebec0d172b98801b877d38145d5e819e98f7e489f7d
 SHA512:
-  metadata.gz: b1bc2b324d1c9d970aaba2703f347734dff1624f55104c924779e1ddf5a8f3cc0244403cd18c4de355e13dd7949251db844fc992414fb9652329b6d0e09afcae
-  data.tar.gz: c3e36505634d44f74c9068988a90ccdd41bf4a9d8462491131665ffb53af15bfd1fc9d64d2527bf43dd2e352457de4a7f8bf228e29f72cb6069a5717e7e6cf0d
+  metadata.gz: e9ba7de4e15555f92494770785e1ac42f97cea709a0542dfedce95fe19227536c36ef6bf5ee8cf009728c75ea4268a685f7bab88948ca277477c179ecfeb639b
+  data.tar.gz: 75d2b0e52d5399cca2ab1b9785338d5a3f51b58aa1d82452eb103e6bbecce9b4642aab3e1c309a9a1625587edecfd4a380715ed454a72bb53497e8d0737393ae

data/lib/dina/authentication/authentication.rb

@@ -3,6 +3,20 @@
 module Dina
   module Authentication
 
+    # Sets Authentication configuration
+    # Options hash as follows:
+    # {
+    #    token_store_file: "file to store the token",
+    #    user: "username provided by DINA admin in Keycloak",
+    #    password: "password provided by DINA admin in Keycloak",
+    #    server_name: "used locally to reference the token",
+    #    client_id: "provided by DINA admin in Keycloak",
+    #    endpoint_url: "DINA API URL",
+    #    authorization_url: "Keycloak authorization URL".
+    #    realm: "provided by DINA admin in Keycloak"
+    # }
+    #
+    # @param options [Hash] the configuration options
     def self.config(options = {})
       @token_store_file = options[:token_store_file]
       @user = options[:user]
@@ -16,6 +30,10 @@ module Dina
       Keycloak.realm = @realm
     end
 
+    # Gets, sets, and renews a Bearer access token as required
+    # and produces a Header string
+    #
+    # @return [String] the Bearer token
     def self.header
       if access_token.nil? || refresh_token.nil?
         set_token

data/lib/dina/components/agent_role.rb

@@ -0,0 +1,18 @@
+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 :date
+    attr_accessor :remarks
+
+    def initialize
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
+      hash
+    end
+
+  end
+end

data/lib/dina/components/determination.rb

@@ -14,9 +14,9 @@ module Dina
     attr_accessor :qualifier
     attr_accessor :scientificNameSource
     attr_accessor :scientificNameDetails #in the form { classificationPath: "", classificationRanks: "" }
-    attr_accessor :isPrimary
-    attr_accessor :isFiledAs
-    attr_accessor :managedAttributes
+    attr_accessor :isPrimary #boolean
+    attr_accessor :isFiledAs #boolean
+    attr_accessor :managedAttributes #array
 
     def initialize
     end

data/lib/dina/components/shipment.rb

@@ -0,0 +1,24 @@
+module Dina
+  class Shipment
+    attr_accessor :contentRemarks
+    attr_accessor :value
+    attr_accessor :currency
+    attr_accessor :itemCount
+    attr_accessor :shippedOn
+    attr_accessor :status
+    attr_accessor :packingMethod
+    attr_accessor :trackingNumber
+    attr_accessor :shipmentRemarks
+    attr_accessor :address # with properties receiverName, companyName, addressLine1, addressLine2, city, provinceState, zipCode, country
+
+    def initialize
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
+      hash
+    end
+
+  end
+end

data/lib/dina/exceptions.rb

@@ -1,4 +1,5 @@
 module Dina
   class DinaException < StandardError; end
   class TokenStoreFileNotFound < DinaException; end
+  class ObjectInvalid < DinaException; end
 end

data/lib/dina/models/acquisition_event.rb

@@ -11,7 +11,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/assemblage.rb

@@ -13,7 +13,8 @@ module Dina
 
     has_many :attachment, class_name: "ObjectStore"
 
-    validates_presence_of :group, :name
+    validates_presence_of :group, message: "group is required"
+    validates_presence_of :name, message: "name is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/base_model.rb

@@ -6,6 +6,7 @@ module Dina
     self.paginator = JsonApiClient::Paginating::NestedParamPaginator
 
     before_create :on_before_create
+    before_save :on_before_save
 
     def self.endpoint_path
     end
@@ -41,5 +42,11 @@ module Dina
       self.attributes = self.attributes.deep_symbolize_keys
     end
 
+    def on_before_save
+      if !self.valid?
+        raise ObjectInvalid, "#{self.class} is invalid. #{self.errors.map(&:message).join("; ")}"
+      end
+    end
+
   end
 end

data/lib/dina/models/collecting_event.rb

@@ -45,7 +45,7 @@ module Dina
     has_many :collectors, class_name: "Person"
     has_many :attachment, class_name: "Attachment"
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     before_save :on_before_save
 
@@ -70,6 +70,7 @@ module Dina
       if !self.geoReferenceAssertions.empty? && self.geoReferenceAssertions[0][:dwcDecimalLatitude].nil?
         self.geoReferenceAssertions = nil
       end
+      super
     end
 
   end

data/lib/dina/models/collecting_method.rb

@@ -9,7 +9,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/collection.rb

@@ -18,7 +18,7 @@ module Dina
     has_one :institution, class_name: "Institution"
     has_one :parent_collection, class_name: "Collection"
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/collection_sequence_generator.rb

@@ -0,0 +1,17 @@
+require_rel 'base_model'
+
+module Dina
+  class CollectionSequenceGenerator < BaseModel
+    property :id, type: :string, default: SecureRandom.uuid
+    property :amount, type: :string
+
+    def self.endpoint_path
+      "collection-api/"
+    end
+
+    def self.table_name
+      "collection-sequence-generator"
+    end
+
+  end
+end

data/lib/dina/models/managed_attribute.rb

@@ -13,7 +13,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/material_sample.rb

@@ -48,7 +48,8 @@ module Dina
     has_many :preparation_attachment, class_name: "Attachment" #TODO: error requesting Dina::MaterialSample::Metadatum
     has_many :organism, class_name: "Organism"
 
-    validates_presence_of :group, :materialSampleName
+    validates_presence_of :group, message: "group is required"
+    validates_presence_of :materialSampleName, message: "materialSampleName is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/object_store.rb

@@ -36,7 +36,7 @@ module Dina
     has_one :dc_creator, class_name: "Person"
     has_many :derivatives, class_name: "Derivative"
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "objectstore-api/"

data/lib/dina/models/organism.rb

@@ -12,7 +12,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/person.rb

@@ -16,7 +16,8 @@ module Dina
     has_many :organizations
     has_many :identifiers
 
-    validates_presence_of :familyNames
+    validates_presence_of :familyNames, message: "familyNames is required"
+    validates_presence_of :displayName
 
     def self.endpoint_path
       "agent-api/"
@@ -26,13 +27,17 @@ module Dina
       "person"
     end
 
+    # Finds a Person object using an email address
+    #
+    # @param email [String] an email address
+    # @return Person [Object] a Person object
     def self.find_by_email(email)
       where("email": email).all.first
     end
 
     private
 
-    def set_defaults
+    def on_before_save
       if self.displayName.nil? || self.displayName == ""
         self.displayName = [familyNames, givenNames].compact.join(", ")
       end

data/lib/dina/models/preparation_type.rb

@@ -9,7 +9,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/project.rb

@@ -14,7 +14,7 @@ module Dina
 
     has_many :attachment, class_name: "ObjectStore"
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/protocol.rb

@@ -11,7 +11,7 @@ module Dina
 
     has_many :attachment, class_name: "ObjectStore"
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/storage_unit.rb

@@ -13,7 +13,7 @@ module Dina
     has_one :storage_unit_type
     has_one :parent_storage_unit, class_name: "StorageUnit"
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/storage_unit_type.rb

@@ -9,7 +9,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :group
+    validates_presence_of :group, message: "group is required"
 
     def self.endpoint_path
       "collection-api/"

data/lib/dina/models/transaction.rb

@@ -0,0 +1,39 @@
+require_rel 'base_model'
+
+module Dina
+  class Transaction < BaseModel
+    property :id, type: :string, default: SecureRandom.uuid
+    property :transactionNumber, type: :string
+    property :materialDirection, type: :string
+    property :materialToBeReturned, type: :boolean
+    property :group, type: :string
+    property :transactionType, type: :string
+    property :otherIdentifiers, type: :array, default: []
+    property :status, type: :string
+    property :purpose, type: :string
+    property :openedDate, type: :time
+    property :closedDate, type: :time
+    property :dueDate, type: :time
+    property :remarks, type: :string
+    property :managedAttributes, type: :object
+    property :agentRoles, type: :array
+    property :shipment, type: :object
+    property :createdBy, type: :string
+    property :createdOn, type: :time
+
+    has_many :material_samples, class_name: "MaterialSample"
+    has_many :attachment
+    has_many :involved_agents, class_name: "Person"
+
+    validates_presence_of :group, message: "group is required"
+
+    def self.endpoint_path
+      "loan-transaction/"
+    end
+
+    def self.table_name
+      "transaction"
+    end
+
+  end
+end

data/lib/dina/models/user.rb

@@ -12,7 +12,7 @@ module Dina
     property :createdBy, type: :string
     property :createdOn, type: :time
 
-    validates_presence_of :username
+    validates_presence_of :username, message: "username is required"
 
     def self.endpoint_path
       "user-api/"

data/lib/dina/version.rb

@@ -2,7 +2,7 @@ module Dina
   class Version
 
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     BUILD = 0
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dina
 version: !ruby/object:Gem::Version
-  version: 0.1.0.0
+  version: 0.2.0.0
 platform: ruby
 authors:
 - David P. Shorthouse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -136,8 +136,10 @@ files:
 - lib/dina/casters/multilingual_title.rb
 - lib/dina/casters/multilingual_title_caster.rb
 - lib/dina/casters/object_caster.rb
+- lib/dina/components/agent_role.rb
 - lib/dina/components/determination.rb
 - lib/dina/components/georeference_assertion.rb
+- lib/dina/components/shipment.rb
 - lib/dina/exceptions.rb
 - lib/dina/models/acquisition_event.rb
 - lib/dina/models/assemblage.rb
@@ -147,6 +149,7 @@ files:
 - lib/dina/models/collecting_event.rb
 - lib/dina/models/collecting_method.rb
 - lib/dina/models/collection.rb
+- lib/dina/models/collection_sequence_generator.rb
 - lib/dina/models/derivative.rb
 - lib/dina/models/file.rb
 - lib/dina/models/identifier.rb
@@ -164,6 +167,7 @@ files:
 - lib/dina/models/protocol.rb
 - lib/dina/models/storage_unit.rb
 - lib/dina/models/storage_unit_type.rb
+- lib/dina/models/transaction.rb
 - lib/dina/models/user.rb
 - lib/dina/search/base_search.rb
 - lib/dina/search/search.rb
@@ -173,7 +177,7 @@ files:
 - lib/dina/utils/identifier.rb
 - lib/dina/utils/identifier_type.rb
 - lib/dina/version.rb
-homepage: ''
+homepage: https://github.com/dshorthouse/dina
 licenses:
 - MIT
 metadata: {}