puree 0.20.0 → 1.0.0

data/lib/puree/model/download_header.rb

@@ -0,0 +1,21 @@
+module Puree
+  module Model
+
+    # A minimal representation of a Download.
+    #
+    class DownloadHeader < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :uuid
+
+      # @return [Fixnum, nil]
+      attr_accessor :count
+
+      # @param v [String]
+      def uuid=(v)
+        @uuid = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/endeavour_person.rb

@@ -0,0 +1,34 @@
+module Puree
+  module Model
+
+    # A person involved in an endeavour.
+    #
+    class EndeavourPerson < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :uuid
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @return [String, nil]
+      attr_reader :role
+
+      # @param v [String]
+      def uuid=(v)
+        @uuid = v if v && !v.empty?
+      end
+
+      # @param v [Puree::Model::PersonName]
+      def name=(v)
+        @name = v if v && v.data?
+      end
+
+      # @param v [String]
+      def role=(v)
+        @role = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/event.rb

@@ -0,0 +1,31 @@
+module Puree
+  module Model
+
+    # An organised event.
+    #
+    class Event < Resource
+
+      # @return [String, nil]
+      attr_accessor :city
+
+      # @return [String, nil]
+      attr_accessor :country
+
+      # @return [Puree::Model::TemporalRange, nil]
+      attr_accessor :date
+
+      # @return [String, nil]
+      attr_accessor :description
+
+      # @return [String, nil]
+      attr_accessor :location
+
+      # @return [String, nil]
+      attr_accessor :title
+
+      # @return [String, nil]
+      attr_accessor :type
+
+    end
+  end
+end

data/lib/puree/model/event_header.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # A minimal representation of an Event.
+    #
+    class EventHeader < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :uuid
+
+      # @return [String, nil]
+      attr_reader :title
+
+      # @param v [String]
+      def uuid=(v)
+        @uuid = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def title=(v)
+        @title = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/file.rb

@@ -0,0 +1,45 @@
+module Puree
+  module Model
+
+    # Description of a file.
+    #
+    class File < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @return [String, nil]
+      attr_reader :mime
+
+      # @return [Fixnum, nil]
+      attr_accessor :size
+
+      # @return [String, nil]
+      attr_reader :url
+
+      # @return [Puree::Model::CopyrightLicense, nil]
+      attr_reader :license
+
+      # @param v [String]
+      def name=(v)
+        @name = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def mime=(v)
+        @mime = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def url=(v)
+        @url = v if v && !v.empty?
+      end
+
+      # @param v [Puree::Model::CopyrightLicense]
+      def license=(v)
+        @license = v if v && v.data?
+      end
+
+    end
+  end
+end

data/lib/puree/model/helper/validation.rb

@@ -0,0 +1,15 @@
+module Puree
+  module Model
+
+    # Model validation.
+    #
+    module Validation
+      def enforce_class(v, klass)
+        raise ArgumentError, "Expected #{klass}. Got #{v.class}." unless v && v.is_a?(klass)
+      end
+    end
+
+  end
+end
+
+

data/lib/puree/model/journal.rb

@@ -0,0 +1,20 @@
+module Puree
+  module Model
+
+    # A journal.
+    #
+    class Journal < Resource
+
+      # @return [String, nil]
+      attr_accessor :issn
+
+      # @return [String, nil]
+      attr_accessor :publisher
+
+      # @return [String, nil]
+      attr_accessor :title
+
+    end
+  end
+
+end

data/lib/puree/model/legal_condition.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # A legal condition.
+    #
+    class LegalCondition < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @return [String, nil]
+      attr_reader :description
+
+      # @param v [String]
+      def name=(v)
+        @name = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def description=(v)
+        @description = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/link.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # URL which points to something of interest.
+    #
+    class Link < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :description
+
+      # @return [String, nil]
+      attr_reader :url
+
+      # @param v [String]
+      def description=(v)
+        @description = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def url=(v)
+        @url = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/model.rb

@@ -0,0 +1,7 @@
+module Puree
+  # A model is a data structure.
+  #
+  module Model
+
+  end
+end

data/lib/puree/model/organisation.rb

@@ -0,0 +1,34 @@
+module Puree
+  module Model
+
+    # An organisational unit as defined by the institution.
+    #
+    class Organisation < Resource
+
+      # @return [Array<Puree::Model::Address>]
+      attr_accessor :address
+
+      # @return [Array<String>]
+      attr_accessor :email_addresses
+
+      # @return [String, nil]
+      attr_accessor :name
+
+      # @return [Array<Puree::Model::OrganisationHeader>]
+      attr_accessor :organisations
+
+      # @return [Puree::Model::OrganisationHeader, nil]
+      attr_accessor :parent
+
+      # @return [Array<String>]
+      attr_accessor :phone_numbers
+
+      # @return [String, nil]
+      attr_accessor :type
+
+      # @return [Array<String>]
+      attr_accessor :urls
+
+    end
+  end
+end

data/lib/puree/model/organisation_header.rb

@@ -0,0 +1,34 @@
+module Puree
+  module Model
+
+    # A minimal representation of an Organisation.
+    #
+    class OrganisationHeader < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :uuid
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @return [String, nil]
+      attr_reader :type
+
+      # @param v [String]
+      def uuid=(v)
+        @uuid = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def name=(v)
+        @name = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def type=(v)
+        @type = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/person.rb

@@ -0,0 +1,28 @@
+module Puree
+  module Model
+
+    # A person.
+    #
+    class Person < Resource
+
+      # @return [Array<Puree::Model::OrganisationHeader>]
+      attr_accessor :affiliations
+
+      # @return [Array<String>]
+      attr_accessor :email_addresses
+
+      # @return [Array<String>]
+      attr_accessor :image_urls
+
+      # @return [Array<String>]
+      attr_accessor :keywords
+
+      # @return [Puree::Model::PersonName, nil]
+      attr_accessor :name
+
+      # @return [String, nil]
+      attr_accessor :orcid
+
+    end
+  end
+end

data/lib/puree/model/person_name.rb

@@ -0,0 +1,52 @@
+module Puree
+  module Model
+
+    # The name of a person.
+    #
+    class PersonName < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :first
+
+      # @return [String, nil]
+      attr_reader :last
+
+      # @param v [String]
+      def first=(v)
+        @first = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def last=(v)
+        @last = v if v && !v.empty?
+      end
+
+      # @return [String]
+      def first_last
+        both? ? "#{first} #{last}" : 'One or both names missing'
+      end
+
+      # @return [String]
+      def last_first
+        both? ? "#{last}, #{first}" : 'One or both names missing'
+      end
+
+      # @return [String]
+      def initial_last
+        both? ? "#{first[0, 1]}. #{last}" : 'One or both names missing'
+      end
+
+      # @return [String]
+      def last_initial
+        both? ? "#{last}, #{first[0, 1]}." : 'One or both names missing'
+      end
+
+      private
+
+      def both?
+        !@first.nil? && !@last.nil? || false
+      end
+
+    end
+  end
+end

data/lib/puree/model/project.rb

@@ -0,0 +1,49 @@
+module Puree
+  module Model
+
+    # A project.
+    #
+    class Project < Resource
+
+      # @return [String, nil]
+      attr_accessor :acronym
+
+      # @return [String, nil]
+      attr_accessor :description
+
+      # @return [Array<Puree::Model::OrganisationHeader>]
+      attr_accessor :organisations
+
+      # @return [Puree::Model::OrganisationHeader, nil]
+      attr_accessor :owner
+
+      # @return [Array<Puree::Model::EndeavourPerson>]
+      attr_accessor :persons_internal
+
+      # @return [Array<Puree::Model::EndeavourPerson>]
+      attr_accessor :persons_external
+
+      # @return [Array<Puree::Model::EndeavourPerson>]
+      attr_accessor :persons_other
+
+      # @return [String, nil]
+      attr_accessor :status
+
+      # @return [Puree::Model::TemporalRange, nil]
+      attr_accessor :temporal_actual
+
+      # @return [Puree::Model::TemporalRange, nil]
+      attr_accessor :temporal_expected
+
+      # @return [String, nil]
+      attr_accessor :title
+
+      # @return [String, nil]
+      attr_accessor :type
+
+      # @return [String, nil]
+      attr_accessor :url
+
+    end
+  end
+end