puree 0.20.0 → 1.0.0

data/lib/puree/extractor/organisation.rb

@@ -0,0 +1,34 @@
+module Puree
+
+  module Extractor
+
+    # Organisation extractor.
+    #
+    class Organisation < Puree::Extractor::Resource
+
+      # @option (see Puree::Extractor::Resource#initialize)
+      def initialize(config)
+        super
+        setup :organisation
+      end
+
+      private
+
+      def combine_metadata
+        super
+        @model.address = @extractor.address
+        @model.email_addresses = @extractor.email_addresses
+        @model.name = @extractor.name
+        @model.organisations = @extractor.organisations
+        @model.parent = @extractor.parent
+        @model.phone_numbers = @extractor.phone_numbers
+        @model.type = @extractor.type
+        @model.urls = @extractor.urls
+        @model
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/person.rb

@@ -0,0 +1,32 @@
+module Puree
+
+  module Extractor
+
+    # Person extractor.
+    #
+    class Person < Puree::Extractor::Resource
+
+      # @option (see Puree::Extractor::Resource#initialize)
+      def initialize(config)
+        super
+        setup :person
+      end
+
+      private
+
+      def combine_metadata
+        super
+        @model.affiliations = @extractor.affiliations
+        @model.email_addresses = @extractor.email_addresses
+        @model.image_urls = @extractor.image_urls
+        @model.keywords = @extractor.keywords
+        @model.name = @extractor.name
+        @model.orcid = @extractor.orcid
+        @model
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/project.rb

@@ -0,0 +1,40 @@
+module Puree
+
+  module Extractor
+
+    # Project extractor.
+    #
+    class Project < Puree::Extractor::Resource
+
+      # @option (see Puree::Extractor::Resource#initialize)
+      def initialize(config)
+        super
+        @latest_api = false # stable API does not return person roles
+        setup :project
+      end
+
+      private
+
+      def combine_metadata
+        super
+        @model.acronym = @extractor.acronym
+        @model.description = @extractor.description
+        @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
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/publication.rb

@@ -0,0 +1,40 @@
+module Puree
+
+  module Extractor
+
+    # Publication extractor.
+    #
+    class Publication < Puree::Extractor::Resource
+
+      # @option (see Puree::Extractor::Resource#initialize)
+      def initialize(config)
+        super
+        setup :publication
+      end
+
+      private
+
+      def combine_metadata
+        super
+        @model.category = @extractor.category
+        @model.description = @extractor.description
+        @model.doi = @extractor.doi
+        @model.event = @extractor.event
+        @model.files = @extractor.files
+        @model.organisations = @extractor.organisations
+        @model.pages = @extractor.pages
+        @model.persons_internal = @extractor.persons_internal
+        @model.persons_external = @extractor.persons_external
+        @model.persons_other = @extractor.persons_other
+        @model.statuses = @extractor.statuses
+        @model.subtitle = @extractor.subtitle
+        @model.title = @extractor.title
+        @model.type = @extractor.type
+        @model
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/publisher.rb

@@ -0,0 +1,27 @@
+module Puree
+
+  module Extractor
+
+    # Publisher extractor.
+    #
+    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
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/resource.rb

@@ -0,0 +1,69 @@
+module Puree
+
+  module Extractor
+
+    # 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
+      end
+
+      private
+
+      # 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
+        resource_class = "Puree::Model::#{resource.to_s.capitalize}"
+        @model = Object.const_get(resource_class).new
+      end
+
+      def make_xml_extractor xml
+        resource_class = "Puree::XMLExtractor::#{@resource_type.to_s.capitalize}"
+        @extractor = Object.const_get(resource_class).new xml: xml
+      end
+
+      # All metadata
+      # @return [Hash]
+      def combine_metadata
+        @model.uuid = @extractor.uuid
+        @model.created = @extractor.created
+        @model.modified = @extractor.modified
+        @model.locale = @extractor.locale
+      end
+
+      alias :find :get
+
+    end
+
+  end
+
+end

data/lib/puree/extractor/server.rb

@@ -0,0 +1,56 @@
+module Puree
+
+  module Extractor
+
+    # Server extractor.
+    #
+    class Server
+      include Puree::API::Authentication
+
+      # @option (see Puree::API::Authentication#configure_api)
+      def initialize(config)
+        @resource_type = :server
+        configure_api config
+      end
+
+      # Get server information.
+      #
+      # @return [Puree::Model::Server, nil]
+      def get
+        raise 'Cannot perform a request without a configuration' if @config.nil?
+        @response = @request.get resource_type: @resource_type
+        set_content @response.body
+      end
+
+      private
+
+      def combine_metadata
+        model = Puree::Model::Server.new
+        model.version = @extractor.version
+        model
+      end
+
+      # Set content from XML. In order for metadata extraction to work, the XML must have
+      # been retrieved using the .current version of the Pure API endpoints
+      #
+      # @param xml [String]
+      # @return [Puree::Model::Server, nil]
+      def set_content(xml)
+        if xml
+          make_extractor
+          @extractor.get_data? ? combine_metadata : nil
+        end
+      end
+
+      def make_extractor
+        @extractor = Puree::XMLExtractor::Server.new xml: @response.body
+      end
+
+      alias :find :get
+
+    end
+
+  end
+
+end
+

data/lib/puree/model/address.rb

@@ -0,0 +1,50 @@
+module Puree
+  module Model
+
+    # Address where something is located.
+    #
+    class Address < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :street
+
+      # @return [String, nil]
+      attr_reader :building
+
+      # @return [String, nil]
+      attr_reader :postcode
+
+      # @return [String, nil]
+      attr_reader :city
+
+      # @return [String, nil]
+      attr_reader :country
+
+      # @param v [String]
+      def street=(v)
+        @street = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def building=(v)
+        @building = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def postcode=(v)
+        @postcode = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def city=(v)
+        @city = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def country=(v)
+        @country = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/copyright_license.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # A copyright license.
+    #
+    class CopyrightLicense < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @return [String, nil]
+      attr_reader :url
+
+      # @param v [String]
+      def name=(v)
+        @name = 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/dataset.rb

@@ -0,0 +1,84 @@
+module Puree
+  module Model
+
+    # A dataset produced during some research.
+    #
+    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.
+      # @return [Time, nil]
+      attr_accessor :available
+
+      # @return [String, nil]
+      attr_accessor :description
+
+      # Digital Object Identifier.
+      # @return [String, nil]
+      attr_accessor :doi
+
+      # Supporting files.
+      # @return [Array<Puree::Model::File>]
+      attr_accessor :files
+
+      # @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 [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
+
+      # Date of data production.
+      # @return [Puree::Model::TemporalRange, nil]
+      attr_accessor :production
+
+      # @return [Array<Puree::Model::RelatedContentHeader>]
+      attr_accessor :projects
+
+      # @return [Array<Puree::Model::RelatedContentHeader>]
+      attr_accessor :publications
+
+      # @return [String, nil]
+      attr_accessor :publisher
+
+      # @return [Array<String>]
+      attr_accessor :spatial_places
+
+      # Spatial coverage point.
+      # @return [Puree::Model::SpatialPoint, nil]
+      attr_accessor :spatial_point
+
+      # Temporal coverage.
+      # @return [Puree::Model::TemporalRange, nil]
+      attr_accessor :temporal
+
+      # @return [String, nil]
+      attr_accessor :title
+
+    end
+  end
+end