puree 1.9.1 → 2.0.0

data/lib/puree/rest/mixins/active_mixin.rb

@@ -0,0 +1,14 @@
+module Puree
+  module REST
+    module ActiveMixin
+
+      # (see Puree::REST::Base#all)
+      def active(params: {}, accept: :xml)
+        get_request_collection_subcollection(subcollection: 'active',
+                                         params: params,
+                                         accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/activity_mixin.rb

@@ -0,0 +1,14 @@
+module Puree
+  module REST
+    module ActivityMixin
+
+      # (see Puree::REST::Base#find)
+      def activities(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'activities',
+                                        params: params,
+                                        accept: accept)
+      end
+    end
+  end
+end

data/lib/puree/rest/mixins/application_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+      module ApplicationMixin
+
+        # (see Puree::REST::Base#find)
+        def applications(id:, params: {}, accept: :xml)
+          get_request_singleton_subcollection(id: id,
+                                          subcollection: 'applications',
+                                          params: params,
+                                          accept: accept)
+        end
+
+      end
+  end
+end

data/lib/puree/rest/mixins/award_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module AwardMixin
+
+        # (see Puree::REST::Base#find)
+        def awards(id:, params: {}, accept: :xml)
+          get_request_singleton_subcollection(id: id,
+                                          subcollection: 'awards',
+                                          params: params,
+                                          accept: accept)
+        end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/dataset_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module DatasetMixin
+
+        # (see Puree::REST::Base#find)
+        def datasets(id:, params: {}, accept: :xml)
+          get_request_singleton_subcollection(id: id,
+                                          subcollection: 'datasets',
+                                          params: params,
+                                          accept: accept)
+        end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/former_mixin.rb

@@ -0,0 +1,14 @@
+module Puree
+  module REST
+    module FormerMixin
+
+      # (see Puree::REST::Base#all)
+      def former(params: {}, accept: :xml)
+        get_request_collection_subcollection(subcollection: 'former',
+                                         params: params,
+                                         accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/impact_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+    module REST
+      module ImpactMixin
+
+      # (see Puree::REST::Base#find)
+      def impacts(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'impacts',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/person_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module PersonMixin
+
+      # (see Puree::REST::Base#find)
+      def persons(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'persons',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/press_media_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module PressMediaMixin
+
+      # (see Puree::REST::Base#find)
+      def press_media(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'press-media',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/prize_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module PrizeMixin
+
+      # (see Puree::REST::Base#find)
+      def prizes(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'prizes',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/project_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module ProjectMixin
+
+      # (see Puree::REST::Base#find)
+      def projects(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'projects',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/research_output_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module ResearchOutputMixin
+
+      # (see Puree::REST::Base#find)
+      def research_outputs(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'research-outputs',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/mixins/student_thesis_mixin.rb

@@ -0,0 +1,15 @@
+module Puree
+  module REST
+    module StudentThesisMixin
+
+      # (see Puree::REST::Base#find)
+      def student_theses(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                        subcollection: 'student-theses',
+                                        params: params,
+                                        accept: accept)
+      end
+
+    end
+  end
+end

data/lib/puree/rest/organisational_unit.rb

@@ -0,0 +1,51 @@
+require 'puree/rest/mixins/active_mixin'
+require 'puree/rest/mixins/activity_mixin'
+require 'puree/rest/mixins/application_mixin'
+require 'puree/rest/mixins/award_mixin'
+require 'puree/rest/mixins/dataset_mixin'
+require 'puree/rest/mixins/former_mixin'
+require 'puree/rest/mixins/impact_mixin'
+require 'puree/rest/mixins/person_mixin'
+require 'puree/rest/mixins/press_media_mixin'
+require 'puree/rest/mixins/prize_mixin'
+require 'puree/rest/mixins/project_mixin'
+require 'puree/rest/mixins/research_output_mixin'
+require 'puree/rest/mixins/student_thesis_mixin'
+
+module Puree
+
+  module REST
+
+    # Requests for the Organisational Unit resource
+    #
+    class OrganisationalUnit < Puree::REST::Base
+      include Puree::REST::ActiveMixin
+      include Puree::REST::ActivityMixin
+      include Puree::REST::ApplicationMixin
+      include Puree::REST::AwardMixin
+      include Puree::REST::DatasetMixin
+      include Puree::REST::FormerMixin
+      include Puree::REST::ImpactMixin
+      include Puree::REST::PersonMixin
+      include Puree::REST::PressMediaMixin
+      include Puree::REST::PrizeMixin
+      include Puree::REST::ProjectMixin
+      include Puree::REST::ResearchOutputMixin
+      include Puree::REST::StudentThesisMixin
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      private
+
+      def collection
+        'organisational-units'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/person.rb

@@ -0,0 +1,58 @@
+require 'puree/rest/mixins/active_mixin'
+require 'puree/rest/mixins/activity_mixin'
+require 'puree/rest/mixins/application_mixin'
+require 'puree/rest/mixins/award_mixin'
+require 'puree/rest/mixins/dataset_mixin'
+require 'puree/rest/mixins/former_mixin'
+require 'puree/rest/mixins/impact_mixin'
+require 'puree/rest/mixins/press_media_mixin'
+require 'puree/rest/mixins/prize_mixin'
+require 'puree/rest/mixins/project_mixin'
+require 'puree/rest/mixins/research_output_mixin'
+require 'puree/rest/mixins/student_thesis_mixin'
+
+module Puree
+
+  module REST
+
+    # Requests for the Person resource
+    #
+    # @note :id can be UUID, ID, Employee ID or HESA Staff ID
+    class Person < Puree::REST::Base
+      include Puree::REST::ActiveMixin
+      include Puree::REST::ActivityMixin
+      include Puree::REST::ApplicationMixin
+      include Puree::REST::AwardMixin
+      include Puree::REST::DatasetMixin
+      include Puree::REST::FormerMixin
+      include Puree::REST::ImpactMixin
+      include Puree::REST::PressMediaMixin
+      include Puree::REST::PrizeMixin
+      include Puree::REST::ProjectMixin
+      include Puree::REST::ResearchOutputMixin
+      include Puree::REST::StudentThesisMixin
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      # (see Puree::REST::Base#find)
+      def curricula_vitae(id:, params: {}, accept: :xml)
+        get_request_singleton_subcollection(id: id,
+                                         subcollection: 'curricula-vitae',
+                                         params: params,
+                                         accept: accept)
+      end
+
+      private
+
+      def collection
+        'persons'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/press_media.rb

@@ -0,0 +1,24 @@
+module Puree
+
+  module REST
+
+    # Requests for the Press Media resource
+    #
+    class PressMedia < Puree::REST::Base
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      private
+
+      def collection
+        'press-media'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/prize.rb

@@ -0,0 +1,24 @@
+module Puree
+
+  module REST
+
+    # Requests for the Prize resource
+    #
+    class Prize < Puree::REST::Base
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      private
+
+      def collection
+        'prizes'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/project.rb

@@ -0,0 +1,27 @@
+require 'puree/rest/mixins/active_mixin'
+
+module Puree
+
+  module REST
+
+    # Requests for the Project resource
+    #
+    class Project < Puree::REST::Base
+      include Puree::REST::ActiveMixin
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      private
+
+      def collection
+        'projects'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/publisher.rb

@@ -0,0 +1,31 @@
+module Puree
+
+  module REST
+
+    # Requests for the Publisher resource
+    #
+    class Publisher < Puree::REST::Base
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      # (see Puree::REST::Base#all)
+      def approved(params: {}, accept: :xml)
+        get_request_collection_subcollection(subcollection: 'approved',
+                                         params: params,
+                                         accept: accept)
+      end
+
+      private
+
+      def collection
+        'publishers'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/research_output.rb

@@ -0,0 +1,24 @@
+module Puree
+
+  module REST
+
+    # Requests for the Research Output resource
+    #
+    class ResearchOutput < Puree::REST::Base
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        super
+      end
+
+      private
+
+      def collection
+        'research-outputs'
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/rest.rb

@@ -0,0 +1,30 @@
+require 'http'
+
+require 'puree/rest/base'
+require 'puree/rest/activity'
+require 'puree/rest/application'
+require 'puree/rest/classification_scheme'
+require 'puree/rest/curricula_vitae'
+require 'puree/rest/dataset'
+require 'puree/rest/equipment'
+require 'puree/rest/event'
+require 'puree/rest/external_organisation'
+require 'puree/rest/external_person'
+require 'puree/rest/impact'
+require 'puree/rest/journal'
+require 'puree/rest/organisational_unit'
+require 'puree/rest/person'
+require 'puree/rest/press_media'
+require 'puree/rest/prize'
+require 'puree/rest/project'
+require 'puree/rest/publisher'
+require 'puree/rest/research_output'
+
+require 'puree/rest/client'
+
+module Puree
+  # Query the Pure REST API.
+  #
+  module REST
+  end
+end

data/lib/puree/util/util.rb

@@ -1,3 +1,6 @@
+require 'puree/util/date'
+require 'puree/util/string'
+
 module Puree
 
   # Utilities.

data/lib/puree/version.rb

@@ -1,5 +1,5 @@
 module Puree
   # Semantic version number
   #
-  VERSION = "1.9.1"
+  VERSION = "2.0.0"
 end

data/lib/puree/xml_extractor/base.rb

@@ -6,8 +6,7 @@ module Puree
     #
     class Base
 
-      def initialize(xml:)
-        @api_map = Puree::API::Map.new.get
+      def initialize(xml)
         make_doc xml
       end
 
@@ -31,15 +30,16 @@ module Puree
 
       private
 
+      def setup_model(resource)
+        resource_class = "Puree::Model::#{Puree::Util::String.titleize(resource)}"
+        @model = Object.const_get(resource_class).new
+      end
+
       def make_doc(xml)
         @doc = Nokogiri::XML xml
         @doc.remove_namespaces!
       end
 
-      def service_response_name
-        @api_map[:resource_type][@resource_type][:response]
-      end
-
     end
 
   end

data/lib/puree/xml_extractor/collection.rb

@@ -2,35 +2,128 @@ module Puree
 
   module XMLExtractor
 
-    # Collection XML extractor.
+    # Resource collection XML extractor.
     #
-    class Collection < Puree::XMLExtractor::Base
+    module Collection
 
-      def initialize(xml:)
-        super
+      # Get models from any multi-record dataset XML response
+      #
+      # @param xml [String]
+      # @return [Array<Puree::Model::Dataset>]
+      def self.datasets(xml)
+        models :dataset, xml, '/dataSet'
+      end
+
+      # Get models from any multi-record event XML response
+      #
+      # @param xml [String]
+      # @return [Array<Puree::Model::Event>]
+      def self.events(xml)
+        models :event, xml, '/event'
+      end
+
+      # Get models from any multi-record external organisation XML response
+      #
+      # @param xml [String]
+      # @return [Array<Puree::Model::ExternalOrganisation>]
+      def self.external_organisations(xml)
+        models :external_organisation, xml, '/externalOrganisation'
+      end
+
+      # Get models from any multi-record journal XML response
+      #
+      # @param xml [String]
+      # @return [Array<Puree::Model::Journal>]
+      def self.journals(xml)
+        models :journal, xml, '/journal'
       end
 
-      # Records available in collection.
+      # Get models from any multi-record organisation XML response
       #
-      # @return [Fixnum]
-      def count
-        @doc.xpath('//count').text.strip.to_i
+      # @param xml [String]
+      # @return [Array<Puree::Model::OrganisationalUnit>]
+      def self.organisational_units(xml)
+        models :organisational_unit, xml, '/organisationalUnit'
       end
 
-      # Resource UUIDs in collection response.
+      # Get models from any multi-record project XML response
+      #
+      # @param xml [String]
+      # @return [Array<Puree::Model::Project>]
+      def self.projects(xml)
+        models :project, xml, '/project'
+      end
+
+      # Get models from any multi-record person XML response
+      #
+      # @param xml [String]
+      # @return [Array<Puree::Model::Person>]
+      def self.persons(xml)
+        models :person, xml, '/person'
+      end
+
+      # Get models from any multi-record Research output XML response
+      #
+      # @param xml [String]
+      # @return [Hash{Symbol => Array<Puree::Model::ResearchOutput class/subclass>}]
+      def self.research_outputs(xml)
+        path_from_root = File.join 'result', '/*'
+        doc = Nokogiri::XML xml
+        doc.remove_namespaces!
+        xpath_result = doc.xpath path_from_root
+        data = {
+            journal_articles: [],
+            conference_papers: [],
+            theses: [],
+            other: []
+        }
+        xpath_result.each do |research_output|
+          type = research_output.xpath('type').text.strip
+          unless type.empty?
+            case type
+              when 'Journal article'
+                extractor = Puree::XMLExtractor::JournalArticle.new research_output.to_s
+                data[:journal_articles] << extractor.model
+              when 'Conference paper'
+                extractor = Puree::XMLExtractor::ConferencePaper.new research_output.to_s
+                data[:conference_papers] << extractor.model
+              when 'Doctoral Thesis'
+                extractor = Puree::XMLExtractor::Thesis.new research_output.to_s
+                data[:theses] << extractor.model
+              when "Master's Thesis"
+                extractor = Puree::XMLExtractor::Thesis.new research_output.to_s
+                data[:theses] << extractor.model
+              else
+                extractor = Puree::XMLExtractor::ResearchOutput.new research_output.to_s
+                data[:other] << extractor.model
+            end
+          end
+        end
+        data
+      end
+
+      private
+
+      # Get models from any multi-record resource XML response
       #
-      # @return [Array<String>]
-      def uuids
-        arr = []
-        xpath_result = @doc.xpath '//renderedItem/@renderedContentUUID'
-        xpath_result.each { |i| arr << i.text.strip }
-        arr
+      # @param xml [String]
+      # @return [Array<Puree::Model::Resource subclass>]
+      def self.models(resource_type, xml, xpath_root)
+        doc = Nokogiri::XML xml
+        doc.remove_namespaces!
+        path_from_root = File.join 'result', xpath_root
+        xpath_result = doc.xpath path_from_root
+        data = []
+        xpath_result.each do |i|
+          xml_extractor = make_xml_extractor resource_type, i.to_s
+          data << xml_extractor.model
+        end
+        data
       end
 
-      # Is there any data after get?
-      # @return [Boolean]
-      def get_data?
-        count >= 1 ? true : false
+      def self.make_xml_extractor(resource_type, xml)
+        resource_class = "Puree::XMLExtractor::#{Puree::Util::String.titleize(resource_type)}"
+        Object.const_get(resource_class).new xml
       end
 
     end