puree 1.9.1 → 2.0.0

data/lib/puree/model/{publication.rb → research_output.rb}

@@ -1,12 +1,9 @@
 module Puree
   module Model
 
-    # A publication.
+    # A Research output.
     #
-    class Publication < Resource
-
-      # @return [Array<Puree::Model::RelatedContentHeader>]
-      attr_accessor :associated
+    class ResearchOutput < Resource
 
       # @return [String, nil]
       attr_accessor :bibliographical_note
@@ -17,12 +14,9 @@ module Puree
       # @return [String, nil]
       attr_accessor :description
 
-      # @return [String]
+      # @return [String, nil]
       attr_accessor :doi
 
-      # @return [Array<String>]
-      attr_accessor :dois
-
       # @return [Array<Puree::Model::ExternalOrganisationHeader>]
       attr_accessor :external_organisations
 
@@ -38,10 +32,13 @@ module Puree
       # @return [Array<String>]
       attr_accessor :links
 
-      # @return [Array<Puree::Model::OrganisationHeader>]
+      # @return [String, nil]
+      attr_accessor :open_access_permission
+
+      # @return [Array<Puree::Model::OrganisationalUnitHeader>]
       attr_accessor :organisations
 
-      # @return [Puree::Model::OrganisationHeader, nil]
+      # @return [Puree::Model::OrganisationalUnitHeader, nil]
       attr_accessor :owner
 
       # @return [Array<Puree::Model::EndeavourPerson>]
@@ -53,17 +50,18 @@ module Puree
       # @return [Array<Puree::Model::EndeavourPerson>]
       attr_accessor :persons_other
 
-      # @return [String, nil]
-      attr_accessor :publication_place
+      # @return [Array<Puree::Model::PublicationStatus>]
+      attr_accessor :publication_statuses
 
-      # @return [String, nil]
-      attr_accessor :publisher
+      # Related research outputs.
+      # @return [Array<Puree::Model::RelatedContentHeader>]
+      attr_accessor :research_outputs
 
-      # @return [String, nil]
-      attr_accessor :scopus_id
+      # @return [Fixnum, nil]
+      attr_accessor :scopus_citations_count
 
-      # @return [Array<Puree::Model::PublicationStatus>]
-      attr_accessor :statuses
+      # @return [Array<Puree::Model::ResearchOutputScopusMetric>]
+      attr_accessor :scopus_metrics
 
       # @return [String, nil]
       attr_accessor :subtitle
@@ -81,7 +79,7 @@ module Puree
       attr_accessor :type
 
       # @return [String, nil]
-      attr_accessor :workflow_state
+      attr_accessor :workflow
 
     end
   end

data/lib/puree/model/research_output_scopus_metric.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # A Scopus metric.
+    #
+    class ResearchOutputScopusMetric < Puree::Model::Structure
+
+      # @return [Fixnum, nil]
+      attr_reader :value
+
+      # @return [Fixnum, nil]
+      attr_reader :year
+
+      # @param v [Fixnum]
+      def value=(v)
+        @value = v if v && !v.empty?
+      end
+
+      # @param v [Fixnum]
+      def year=(v)
+        @year = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/resource.rb

@@ -8,33 +8,41 @@ module Puree
       # @return [String, nil]
       attr_reader :uuid
 
-      # @return [Time, nil]
-      attr_reader :created
+      # @return [String, nil]
+      attr_reader :created_by
 
       # @return [Time, nil]
-      attr_reader :modified
+      attr_reader :created_at
 
       # @return [String, nil]
-      attr_reader :locale
+      attr_reader :modified_by
+
+      # @return [Time, nil]
+      attr_reader :modified_at
 
       # @param v [String]
       def uuid=(v)
         @uuid = v if v && !v.empty?
       end
 
-      # @param v [Time]
-      def created=(v)
-        @created = v
+      # @param v [String]
+      def created_by=(v)
+        @created_by = v
       end
 
       # @param v [Time]
-      def modified=(v)
-        @modified = v
+      def created_at=(v)
+        @created_at = v
       end
 
       # @param v [String]
-      def locale=(v)
-        @locale = v if v && !v.empty?
+      def modified_by=(v)
+        @modified_by = v
+      end
+
+      # @param v [Time]
+      def modified_at=(v)
+        @modified_at = v
       end
 
     end

data/lib/puree/model/thesis.rb

@@ -3,12 +3,12 @@ module Puree
 
     # A thesis.
     #
-    class Thesis < Puree::Model::Publication
+    class Thesis < Puree::Model::ResearchOutput
 
       # @return [Time, nil]
       attr_accessor :award_date
 
-      # @return [Puree::Model::OrganisationHeader, nil]
+      # @return [Puree::Model::OrganisationalUnitHeader, nil]
       attr_accessor :awarding_institution
 
       # @return [String, nil]
@@ -17,10 +17,13 @@ module Puree
       # @return [Fixnum, nil]
       attr_accessor :pages
 
+      # @return [Puree::Model::PublisherHeader, nil]
+      attr_accessor :publisher
+
       # @return [String, nil]
       attr_accessor :qualification
 
-      # @return [Array<String>, nil]
+      # @return [Array<Puree::Model::ExternalOrganisationHeader>]
       attr_accessor :sponsors
 
     end

data/lib/puree/rest/activity.rb

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

data/lib/puree/rest/application.rb

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

data/lib/puree/rest/base.rb

@@ -0,0 +1,131 @@
+require 'http'
+
+module Puree
+
+  module REST
+
+    # Requests for a resource
+    #
+    class Base
+
+      # @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)
+        @http_client = HTTP::Client.new
+        if config[:username] || config[:password]
+          options = {}
+          options[:user] = config[:username]
+          options[:pass] = config[:password]
+          @http_client = @http_client.basic_auth options
+        end
+        @http_client = @http_client.headers(api_key_header(config[:api_key]))
+        @url = config[:url]
+      end
+
+      # @param params [Hash]
+      # @param accept [Symbol]
+      # @return [HTTP::Response]
+      def all(params: {}, accept: :xml)
+        get_request_collection params: params,
+                               accept: accept
+      end
+
+      # @param id [String]
+      # @param params [Hash]
+      # @param accept [Symbol]
+      # @return [HTTP::Response]
+      def find(id:, params: {}, accept: :xml)
+        get_request_singleton id: id,
+                          params: params,
+                          accept: accept
+      end
+
+      # @param accept [Symbol]
+      # @return (see Puree::REST::Base#all)
+      def orderings(accept: :xml)
+        get_request_meta meta_type: 'orderings',
+                     accept: accept
+      end
+
+      # @param accept [Symbol]
+      # @return (see Puree::REST::Base#all)
+      def renderings(accept: :xml)
+        get_request_meta meta_type: 'renderings',
+                     accept: accept
+      end
+
+      private
+
+      def accept_header(accept)
+        case accept
+          when :json
+            return { 'Accept' => 'application/json' }
+          when :xml
+            return { 'Accept' => 'application/xml' }
+        end
+      end
+
+      def api_key_header(key)
+        msg = 'API key incomplete in configuration'
+        raise msg if !key
+        { 'api-key' => key }
+      end
+
+      def url_collection
+        File.join @url, collection
+      end
+
+      def url_collection_subcollection(subcollection)
+        File.join url_collection, subcollection
+      end
+
+      def url_singleton(id)
+        File.join url_collection, id
+      end
+
+      def url_singleton_subcollection(id, subcollection)
+        File.join url_singleton(id), subcollection
+      end
+
+      def meta(type)
+        File.join "#{url_collection}-meta", type
+      end
+
+      # @return (see Puree::REST::Base#all)
+      def get_request_collection(params: {}, accept: :xml)
+        @http_client = @http_client.headers(accept_header(accept))
+        @http_client.get url_collection, params: params
+      end
+
+      # @return (see Puree::REST::Base#all)
+      def get_request_collection_subcollection(subcollection:, params: {}, accept: :xml)
+        @http_client = @http_client.headers(accept_header(accept))
+        @http_client.get meta(url_collection_subcollection(subcollection)), params: params
+      end
+
+      # @return (see Puree::REST::Base#all)
+      def get_request_singleton(id:, params: {}, accept: :xml)
+        @http_client = @http_client.headers(accept_header(accept))
+        @http_client.get url_singleton(id), params: params
+      end
+
+      # @return (see Puree::REST::Base#all)
+      def get_request_singleton_subcollection(id:, subcollection:, params: {}, accept: :xml)
+        @http_client = @http_client.headers(accept_header(accept))
+        @http_client.get url_singleton_subcollection(id, subcollection), params: params
+      end
+
+      # @return (see Puree::REST::Base#all)
+      def get_request_meta(meta_type:, accept: :xml)
+        @http_client = @http_client.headers(accept_header(accept))
+        @http_client.get meta(meta_type)
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/rest/classification_scheme.rb

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

data/lib/puree/rest/client.rb

@@ -0,0 +1,105 @@
+module Puree
+
+  module REST
+
+    # Requests for all resources
+    #
+    class Client
+
+      # (see Puree::REST::Base#initialize)
+      def initialize(config)
+        @config = config
+      end
+
+      # @return [Puree::REST::Activity]
+      def activities
+        Puree::REST::Activity.new @config
+      end
+
+      # @return [Puree::REST::Application]
+      def applications
+        Puree::REST::Application.new @config
+      end
+
+      # @return [Puree::REST::ClassificationScheme]
+      def classification_schemes
+        Puree::REST::ClassificationScheme.new @config
+      end
+
+      # @return [Puree::REST::CurriculaVitae]
+      def curricula_vitae
+        Puree::REST::CurriculaVitae.new @config
+      end
+
+      # @return [Puree::REST::Dataset]
+      def datasets
+        Puree::REST::Dataset.new @config
+      end
+
+      # @return [Puree::REST::Equipment]
+      def equipments
+        Puree::REST::Equipment.new @config
+      end
+
+      # @return [Puree::REST::Event]
+      def events
+        Puree::REST::Event.new @config
+      end
+
+      # @return [Puree::REST::ExternalOrganisation]
+      def external_organisations
+        Puree::REST::ExternalOrganisation.new @config
+      end
+
+      # @return [Puree::REST::ExternalPerson]
+      def external_persons
+        Puree::REST::ExternalPerson.new @config
+      end
+
+      # @return [Puree::REST::Impact]
+      def impacts
+        Puree::REST::Impact.new @config
+      end
+
+      # @return [Puree::REST::Journal]
+      def journals
+        Puree::REST::Journal.new @config
+      end
+
+      # @return [Puree::REST::OrganisationalUnit]
+      def organisational_units
+        Puree::REST::OrganisationalUnit.new @config
+      end
+
+      # @return [Puree::REST::Person]
+      def persons
+        Puree::REST::Person.new @config
+      end
+
+      # @return [Puree::REST::PressMedia]
+      def press_media
+        Puree::REST::PressMedia.new @config
+      end
+
+      # @return [Puree::REST::Prize]
+      def prizes
+        Puree::REST::Prize.new @config
+      end
+
+      # @return [Puree::REST::Project]
+      def projects
+        Puree::REST::Project.new @config
+      end
+
+      # @return [Puree::REST::Publisher]
+      def publishers
+        Puree::REST::Publisher.new @config
+      end
+
+      # @return [Puree::REST::ResearchOutput]
+      def research_outputs
+        Puree::REST::ResearchOutput.new @config
+      end
+    end
+  end
+end

data/lib/puree/rest/curricula_vitae.rb

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

data/lib/puree/rest/dataset.rb

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

data/lib/puree/rest/equipment.rb

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

data/lib/puree/rest/event.rb

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

data/lib/puree/rest/external_organisation.rb

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

data/lib/puree/rest/external_person.rb

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

data/lib/puree/rest/impact.rb

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

data/lib/puree/rest/journal.rb

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