puree 1.9.1 → 2.0.0

data/lib/puree/extractor/project.rb

@@ -6,34 +6,11 @@ module Puree
     #
     class Project < Puree::Extractor::Resource
 
-      # @option (see Puree::Extractor::Resource#initialize)
-      def initialize(config)
-        super
-        @latest_api = false # current API does not return person roles
-        setup :project
-      end
-
-      private
-
-      def combine_metadata
-        super
-        @model.acronym = @extractor.acronym
-        # @model.associated = @extractor.associated # not present in stable API
-        @model.description = @extractor.description
-        @model.external_organisations = @extractor.external_organisations
-        @model.funded = @extractor.funded?
-        @model.organisations = @extractor.organisations
-        @model.owner = @extractor.owner
-        @model.persons_internal = @extractor.persons_internal
-        @model.persons_external = @extractor.persons_external
-        @model.persons_other = @extractor.persons_other
-        @model.status = @extractor.status
-        @model.temporal_actual = @extractor.temporal_actual
-        @model.temporal_expected = @extractor.temporal_expected
-        @model.title = @extractor.title
-        @model.type = @extractor.type
-        @model.url = @extractor.url
-        @model
+      # @param id [String]
+      def find(id)
+        find_and_extract id: id,
+                         api_resource_type: :project,
+                         xml_extractor_resource_type: :project
       end
 
     end

data/lib/puree/extractor/publisher.rb

@@ -6,18 +6,11 @@ module Puree
     #
     class Publisher < Puree::Extractor::Resource
 
-      # @option (see Puree::Extractor::Resource#initialize)
-      def initialize(config)
-        super
-        setup :publisher
-      end
-
-      private
-
-      def combine_metadata
-        super
-        @model.name = @extractor.name
-        @model
+      # @param id [String]
+      def find(id)
+        find_and_extract id: id,
+                         api_resource_type: :publisher,
+                         xml_extractor_resource_type: :publisher
       end
 
     end

data/lib/puree/extractor/research_output.rb

@@ -0,0 +1,20 @@
+module Puree
+
+  module Extractor
+
+    # Research output extractor.
+    #
+    class ResearchOutput < Puree::Extractor::Resource
+
+      # @param id [String]
+      def find(id)
+        find_and_extract id: id,
+                         api_resource_type: :research_output,
+                         xml_extractor_resource_type: :research_output
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/resource.rb

@@ -5,75 +5,39 @@ module Puree
     # Resource extractor.
     #
     class Resource
-      include Puree::API::Authentication
 
-      # @option (see Puree::API::Authentication#configure_api)
-      # @param bleeding [Boolean]
-      def initialize(config, bleeding: true)
-        @latest_api = bleeding
-        configure_api config
-      end
-
-      # Get a resource.
-      #
-      # @param uuid [String]
-      # @param id [String]
-      # @return [Puree::Model::Resource subclass, nil] Resource metadata e.g. Puree::Model::Dataset
-      def get(uuid: nil, id: nil)
-        raise 'Cannot perform a request without a configuration' if @config.nil?
-        @response = @request.get uuid:           uuid,
-                                 id:             id,
-                                 latest_api:     @latest_api,
-                                 resource_type:  @resource_type
-        set_content @response.body
+      # @param config [Hash]
+      # @option config [String] :url URL of the Pure host
+      # @option config [String] :username Username of the Pure host account
+      # @option config [String] :password Password of the Pure host account
+      # @option config [String] :api_key API key of the Pure host account
+      def initialize(config)
+        @config = config
       end
 
       private
 
-      # For specialised extraction such as Publication subtypes e.g. doctoral_thesis
-      def set_model_type(type)
-        @model_type = type
-      end
-
-      # Set content from XML.
-      #
-      # @param xml [String]
-      def set_content(xml)
-        if xml
-          make_xml_extractor xml
-          @extractor.get_data? ? combine_metadata : nil
-        end
-      end
-
-      def setup(resource)
-        @resource_type = resource
-        if @model_type
-          resource_class = "Puree::Model::#{Puree::Util::String.titleize(@model_type)}"
-        else
-          resource_class = "Puree::Model::#{Puree::Util::String.titleize(resource)}"
-        end
-        @model = Object.const_get(resource_class).new
+      # @param id [String]
+      # @param api_resource_type [Symbol]
+      # @param xml_extractor_resource_type [Symbol]
+      def find_and_extract(id:, api_resource_type:, xml_extractor_resource_type:)
+        api_resource = make_api_resource api_resource_type
+        response = api_resource.find id: id
+        return unless response.code === 200
+        xml_extractor = make_xml_extractor response.body, xml_extractor_resource_type
+        xml_extractor.model
       end
 
-      def make_xml_extractor xml
-        if @model_type
-          resource_class = "Puree::XMLExtractor::#{Puree::Util::String.titleize(@model_type)}"
-        else
-          resource_class = "Puree::XMLExtractor::#{Puree::Util::String.titleize(@resource_type)}"
-        end
-        @extractor = Object.const_get(resource_class).new xml: xml
+      def make_api_resource(resource_type)
+        resource_class = "Puree::REST::#{Puree::Util::String.titleize(resource_type)}"
+        Object.const_get(resource_class).new @config
       end
 
-      # All metadata
-      # @return [Hash]
-      def combine_metadata
-        @model.uuid = @extractor.uuid
-        @model.created = @extractor.created
-        @model.modified = @extractor.modified
-        @model.locale = @extractor.locale
+      def make_xml_extractor(xml, resource_type)
+        resource_class = "Puree::XMLExtractor::#{Puree::Util::String.titleize(resource_type)}"
+        Object.const_get(resource_class).new xml
       end
 
-      alias :find :get
 
     end
 

data/lib/puree/extractor/thesis.rb

@@ -3,29 +3,18 @@ module Puree
 
     # Thesis extractor.
     #
-    class Thesis < Puree::Extractor::Publication
+    class Thesis < Puree::Extractor::ResearchOutput
 
       # @option (see Puree::Extractor::Resource#initialize)
       def initialize(config)
-        set_model_type 'thesis'
         super
       end
 
-      private
-
-      def combine_metadata
-        super
-
-        thesis_types = ["Master's Thesis", 'Doctoral Thesis']
-        return nil if !thesis_types.include? @model.type
-
-        @model.award_date = @extractor.award_date
-        @model.awarding_institution = @extractor.awarding_institution
-        @model.doi = @extractor.doi
-        @model.pages = @extractor.pages
-        @model.qualification = @extractor.qualification
-        @model.sponsors = @extractor.sponsors
-        @model
+      # @param id [String]
+      def find(id)
+        find_and_extract id: id,
+                         api_resource_type: :research_output,
+                         xml_extractor_resource_type: :thesis
       end
 
     end

data/lib/puree/model/conference_paper.rb

@@ -3,7 +3,7 @@ module Puree
 
     # A conference paper.
     #
-    class ConferencePaper < Puree::Model::PaperBase
+    class ConferencePaper < Puree::Model::Paper
 
       # @return [Puree::Model::EventHeader, nil]
       attr_accessor :event

data/lib/puree/model/dataset.rb

@@ -5,15 +5,7 @@ module Puree
     #
     class Dataset < Resource
 
-      # Open access permission.
-      # @return [String, nil]
-      attr_accessor :access
-
-      # Combines projects and publications.
-      # @return [Array<Puree::Model::RelatedContentHeader>]
-      attr_accessor :associated
-
-      # Date made available.
+     # Date made available.
       # @return [Time, nil]
       attr_accessor :available
 
@@ -31,16 +23,10 @@ module Puree
       # @return [Array<String>]
       attr_accessor :keywords
 
-      # @return [Array<Puree::Model::LegalCondition>]
-      attr_accessor :legal_conditions
-
-      # @return [Array<Puree::Model::Link>]
-      attr_accessor :links
-
-      # @return [Array<Puree::Model::OrganisationHeader>]
-      attr_accessor :organisations
+      # @return [Array<Puree::Model::OrganisationalUnitHeader>]
+      attr_accessor :organisational_units
 
-      # @return [Puree::Model::OrganisationHeader, nil]
+      # @return [Puree::Model::OrganisationalUnitHeader, nil]
       attr_accessor :owner
 
       # @return [Array<Puree::Model::EndeavourPerson>]
@@ -56,14 +42,11 @@ module Puree
       # @return [Puree::Model::TemporalRange, nil]
       attr_accessor :production
 
-      # @return [Array<Puree::Model::RelatedContentHeader>]
-      attr_accessor :projects
+      # @return [Puree::Model::PublisherHeader, nil]
+      attr_accessor :publisher
 
       # @return [Array<Puree::Model::RelatedContentHeader>]
-      attr_accessor :publications
-
-      # @return [String, nil]
-      attr_accessor :publisher
+      attr_accessor :research_outputs
 
       # @return [Array<String>]
       attr_accessor :spatial_places
@@ -80,7 +63,7 @@ module Puree
       attr_accessor :title
 
       # @return [String, nil]
-      attr_accessor :workflow_state
+      attr_accessor :workflow
 
     end
   end

data/lib/puree/model/event.rb

@@ -8,18 +8,9 @@ module Puree
       # @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
 

data/lib/puree/model/external_organisation.rb

@@ -1,7 +1,7 @@
 module Puree
   module Model
 
-    # An external organisational unit as defined by the institution.
+    # An external organisation as defined by the institution.
     #
     class ExternalOrganisation < Resource
 

data/lib/puree/model/external_organisation_header.rb

@@ -1,26 +1,9 @@
 module Puree
   module Model
 
-    # A minimal representation of an ExternalOrganisation.
+    # A minimal representation of an external organisation.
     #
-    class ExternalOrganisationHeader < Puree::Model::Structure
-
-      # @return [String, nil]
-      attr_reader :uuid
-
-      # @return [String, nil]
-      attr_reader :name
-
-      # @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
-
+    class ExternalOrganisationHeader < Puree::Model::OrganisationHeaderBase
     end
   end
 end

data/lib/puree/model/identifier.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # An identifier.
+    #
+    class Identifier < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :id
+
+      # @return [String, nil]
+      attr_reader :type
+
+      # @param v [String]
+      def id=(v)
+        @id = 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/journal.rb

@@ -8,7 +8,7 @@ module Puree
       # @return [String, nil]
       attr_accessor :issn
 
-      # @return [String, nil]
+      # @return [Puree::Model::PublisherHeader, nil]
       attr_accessor :publisher
 
       # @return [String, nil]

data/lib/puree/model/journal_article.rb

@@ -3,10 +3,7 @@ module Puree
 
     # A journal article.
     #
-    class JournalArticle < Puree::Model::Publication
-
-      # @return [Fixnum, nil]
-      attr_accessor :article_number
+    class JournalArticle < Puree::Model::ResearchOutput
 
       # @return [Puree::Model::JournalHeader, nil]
       attr_accessor :journal

data/lib/puree/model/model.rb

@@ -1,3 +1,46 @@
+require 'puree/model/helper/validation'
+require 'puree/model/structure'
+
+require 'puree/model/resource'
+require 'puree/model/dataset'
+require 'puree/model/event'
+require 'puree/model/event_header'
+require 'puree/model/external_organisation'
+require 'puree/model/journal'
+require 'puree/model/journal_header'
+require 'puree/model/link'
+require 'puree/model/organisational_unit'
+require 'puree/model/person'
+require 'puree/model/project'
+
+require 'puree/model/research_output'
+require 'puree/model/thesis'
+require 'puree/model/doctoral_thesis'
+require 'puree/model/masters_thesis'
+require 'puree/model/journal_article'
+require 'puree/model/paper'
+require 'puree/model/conference_paper'
+
+require 'puree/model/publisher'
+require 'puree/model/related_content_header'
+require 'puree/model/spatial_point'
+
+require 'puree/model/organisation_header_base'
+require 'puree/model/address'
+require 'puree/model/copyright_license'
+require 'puree/model/event_header'
+require 'puree/model/external_organisation_header'
+require 'puree/model/file'
+require 'puree/model/legal_condition'
+require 'puree/model/organisational_unit_header'
+require 'puree/model/endeavour_person'
+require 'puree/model/person_name'
+require 'puree/model/publisher_header'
+require 'puree/model/identifier'
+require 'puree/model/publication_status'
+require 'puree/model/research_output_scopus_metric'
+require 'puree/model/temporal_range'
+
 module Puree
   # A model is a data structure.
   #

data/lib/puree/model/{organisation_header.rb → organisation_header_base.rb}

@@ -1,9 +1,9 @@
 module Puree
   module Model
 
-    # A minimal representation of an Organisation.
+    # A minimal representation of an external organisation.
     #
-    class OrganisationHeader < Puree::Model::Structure
+    class OrganisationHeaderBase < Puree::Model::Structure
 
       # @return [String, nil]
       attr_reader :uuid

data/lib/puree/model/{organisation.rb → organisational_unit.rb}

@@ -3,9 +3,9 @@ module Puree
 
     # An organisational unit as defined by the institution.
     #
-    class Organisation < Resource
+    class OrganisationalUnit < Resource
 
-      # @return [Array<Puree::Model::Address>]
+      # @return [Puree::Model::Address]
       attr_accessor :address
 
       # @return [Array<String>]
@@ -14,10 +14,7 @@ module Puree
       # @return [String, nil]
       attr_accessor :name
 
-      # @return [Array<Puree::Model::OrganisationHeader>]
-      attr_accessor :organisations
-
-      # @return [Puree::Model::OrganisationHeader, nil]
+      # @return [Puree::Model::OrganisationalUnitHeader, nil]
       attr_accessor :parent
 
       # @return [Array<String>]

data/lib/puree/model/organisational_unit_header.rb

@@ -0,0 +1,9 @@
+module Puree
+  module Model
+
+    # A minimal representation of an organisational unit.
+    #
+    class OrganisationalUnitHeader <  Puree::Model::OrganisationHeaderBase
+    end
+  end
+end

data/lib/puree/model/paper.rb

@@ -3,7 +3,16 @@ module Puree
 
     # A paper.
     #
-    class Paper < Puree::Model::PaperBase
+    class Paper < Puree::Model::ResearchOutput
+
+      # @return [Fixnum, nil]
+      attr_accessor :pages
+
+      # @return [String, nil]
+      attr_accessor :page_range
+
+      # @return [Boolean, nil]
+      attr_accessor :peer_reviewed
 
     end
   end

data/lib/puree/model/person.rb

@@ -5,17 +5,14 @@ module Puree
     #
     class Person < Resource
 
-      # @return [Array<Puree::Model::OrganisationHeader>]
+      # @return [Array<Puree::Model::OrganisationalUnitHeader>]
       attr_accessor :affiliations
 
       # @return [Array<String>]
       attr_accessor :email_addresses
 
-      # @return [String, nil]
-      attr_accessor :employee_id
-
-      # @return [String, nil]
-      attr_accessor :hesa_id
+      # @return [Array<Model::Identifier>]
+      attr_accessor :identifiers
 
       # @return [Array<String>]
       attr_accessor :image_urls
@@ -29,9 +26,6 @@ module Puree
       # @return [String, nil]
       attr_accessor :orcid
 
-      # @return [String, nil]
-      attr_accessor :scopus_id
-
     end
   end
 end

data/lib/puree/model/project.rb

@@ -8,23 +8,16 @@ module Puree
       # @return [String, nil]
       attr_accessor :acronym
 
-      # not present in stable API
-      # @return [Array<Puree::Model::RelatedContentHeader>]
-      # attr_accessor :associated
-
       # @return [String, nil]
       attr_accessor :description
 
       # @return [Array<Puree::Model::ExternalOrganisationHeader>]
       attr_accessor :external_organisations
 
-      # @return [Boolean]
-      attr_accessor :funded
-
-      # @return [Array<Puree::Model::OrganisationHeader>]
-      attr_accessor :organisations
+      # @return [Array<Puree::Model::OrganisationalUnitHeader>]
+      attr_accessor :organisational_units
 
-      # @return [Puree::Model::OrganisationHeader, nil]
+      # @return [Puree::Model::OrganisationalUnitHeader, nil]
       attr_accessor :owner
 
       # @return [Array<Puree::Model::EndeavourPerson>]
@@ -36,14 +29,14 @@ module Puree
       # @return [Array<Puree::Model::EndeavourPerson>]
       attr_accessor :persons_other
 
+      # @return [Array<Model::Identifier>]
+      attr_accessor :identifiers
+
       # @return [String, nil]
       attr_accessor :status
 
       # @return [Puree::Model::TemporalRange, nil]
-      attr_accessor :temporal_actual
-
-      # @return [Puree::Model::TemporalRange, nil]
-      attr_accessor :temporal_expected
+      attr_accessor :temporal
 
       # @return [String, nil]
       attr_accessor :title

data/lib/puree/model/publication_status.rb

@@ -1,7 +1,7 @@
 module Puree
   module Model
 
-    # Status of a publication.
+    # Publication status of a research output.
     #
     class PublicationStatus < Puree::Model::Structure
 

data/lib/puree/model/publisher.rb

@@ -8,6 +8,9 @@ module Puree
       # @return [String, nil]
       attr_accessor :name
 
+      # @return [String, nil]
+      attr_accessor :type
+
     end
   end
 end

data/lib/puree/model/publisher_header.rb

@@ -0,0 +1,9 @@
+module Puree
+  module Model
+
+    # A minimal representation of a publisher.
+    #
+    class PublisherHeader <  Puree::Model::OrganisationHeaderBase
+    end
+  end
+end