puree 1.9.1 → 2.0.0

data/lib/puree/api/request.rb

@@ -1,119 +0,0 @@
-module Puree
-
-  module API
-
-    # Handles requests to Pure.
-    #
-    class Request
-
-      def initialize(url:)
-        @url = url
-        @api_map = Puree::API::Map.new
-        @headers = {}
-      end
-
-      # Provide credentials if necessary
-      #
-      # @param username [String]
-      # @param password [String]
-      def basic_auth(username:, password:)
-        auth = Base64::strict_encode64("#{username}:#{password}")
-        @headers['Authorization'] = 'Basic ' + auth
-      end
-
-      # Perform a GET request to Pure
-      #
-      # @param uuid [String]
-      # @param id [String]
-      # @param params [Hash]
-      # @param rendering [String]
-      # @param latest_api [Boolean]
-      # @param resource_type [String]
-      # @param limit [Fixnum]
-      # @param offset [Fixnum]
-      # @param created_start [String]
-      # @param created_end [String]
-      # @param modified_start [String]
-      # @param modified_end [String]
-      # @param content_type [String]
-      # @return [HTTP::Response]
-      def get(uuid: nil,
-              id: nil,
-              params: {},
-              rendering: :xml_long,
-              latest_api: true,
-              resource_type:,
-              limit: 20,
-              offset: 0,
-              created_start: nil,
-              created_end: nil,
-              modified_start: nil,
-              modified_end: nil,
-              content_type: nil)
-            @latest_api =    latest_api
-            @resource_type =  resource_type.to_sym
-            @rendering =      rendering
-            @uuid =           uuid
-            @id =             id
-            @params =         params
-            @limit =          limit
-            @offset =         offset
-            @created_start =  created_start
-            @created_end =    created_end
-            @modified_start = modified_start
-            @modified_end =   modified_end
-            @content_type =   content_type
-
-        # strip any trailing slash
-        @url = @url.sub(/(\/)+$/, '')
-        @headers['Accept'] = 'application/xml'
-        @req = HTTP.headers accept: @headers['Accept']
-        if @headers['Authorization']
-          @req = @req.auth @headers['Authorization']
-        end
-        @req.get(build_url, params: parameters)
-      end
-
-      private
-
-      def parameters
-        query = {}
-        if @uuid
-          query['uuids.uuid'] = @uuid
-        else
-          if @id
-            query['pureInternalIds.id'] = @id
-          end
-        end
-        query['rendering'] = @rendering
-        if @resource_type != :server
-          query['window.size'] = @limit
-          query['window.offset'] = @offset if @limit > 0
-        end
-
-        # Pure does allow blank value
-        query['contentType'] = @content_type if @content_type
-
-        # Pure does not allow blanks for these
-        query['createdDate.toDate'] = @created_start if @created_start
-        query['createdDate.fromDate'] = @created_end if @created_end
-        query['modifiedDate.toDate'] = @modified_start if @modified_start
-        query['modifiedDate.fromDate'] = @modified_end if @modified_end
-        query
-      end
-
-      def build_url
-        service = @api_map.service_name(@resource_type)
-        if @latest_api === false
-          service_api_mode = service
-        else
-          service_api_mode = service + '.current'
-        end
-        @url + '/' + service_api_mode
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/extractor/collection.rb

@@ -1,131 +0,0 @@
-module Puree
-
-  module Extractor
-
-    # A collection extractor can retrieve any number of resources of the same type.
-    #
-    class Collection
-      include Puree::API::Authentication
-
-      # @option (see Puree::API::Authentication#configure_api)
-      # @param resource [Symbol]
-      def initialize(config:, resource:)
-        @resource_type = resource
-        @api_map = Puree::API::Map.new.get
-        configure_api config
-      end
-
-      # Gets an array of objects of resource type specified in constructor.
-      #
-      # @param limit [Fixnum]
-      # @param offset [Fixnum]
-      # @param created_start [String] using format YYYY-MM-DD
-      # @param created_end [String] using format YYYY-MM-DD
-      # @param modified_start [String] using format YYYY-MM-DD
-      # @param modified_end [String] using format YYYY-MM-DD
-      # @return [Array<Puree::Model::Resource subclass>] Resource metadata e.g. Puree::Model::Dataset.
-      def get(
-              limit:            0,
-              offset:           0,
-              created_start:    nil,
-              created_end:      nil,
-              modified_start:   nil,
-              modified_end:     nil
-      )
-        @response = @request.get rendering:        :system,
-                                 limit:            limit,
-                                 offset:           offset,
-                                 resource_type:    @resource_type,
-                                 created_start:    created_start,
-                                 created_end:      created_end,
-                                 modified_start:   modified_start,
-                                 modified_end:     modified_end
-        set_content @response.body
-      end
-
-      # Gets a random resource of type specified in constructor.
-      #
-      # @return [Puree::Model::Resource subclass, nil] Resource metadata e.g. Puree::Model::Dataset.
-      def random_resource
-        @response = @request.get rendering:        :system,
-                                 limit:            1,
-                                 offset:           rand(0..count-1),
-                                 resource_type:    @resource_type
-        content = set_content @response.body
-        content[0] if content
-      end
-
-
-      # Count of records available for a resource type.
-      #
-      # @return [Fixnum]
-      def count
-        get_count
-      end
-
-      private
-
-      # Array of UUIDs (from system response).
-      #
-      # @return [Array<String>]
-      def uuids
-        @extractor.uuids
-      end
-
-      def combine_metadata
-        collect_resources
-      end
-
-      def get_count
-        @response = @request.get resource_type: @resource_type,
-                                 rendering: :system,
-                                 limit: 0
-        make_xml_extractor
-        @extractor.count
-      end
-
-      def collect_resources
-        data = []
-        resource_class = "Puree::Extractor::#{Puree::Util::String.titleize(@resource_type)}"
-
-        # whitelist symbol
-        if @api_map[:resource_type].has_key?(@resource_type)
-          config = {
-            url: @config.url,
-            username: @config.username,
-            password: @config.password
-          }
-
-          uuids.each do |u|
-            r = Object.const_get(resource_class).new config
-            record = r.find uuid: u
-            data << record
-          end
-          data
-        else
-          raise 'Invalid resource class'
-        end
-      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]
-      def set_content(xml)
-        if xml
-          make_xml_extractor
-          @extractor.get_data? ? combine_metadata : nil
-        end
-      end
-
-      def make_xml_extractor
-        @extractor = Puree::XMLExtractor::Collection.new xml: @response.body
-      end
-
-      alias :find :get
-
-    end
-
-  end
-
-end

data/lib/puree/extractor/download.rb

@@ -1,71 +0,0 @@
-module Puree
-
-  module Extractor
-
-    # Download extractor.
-    #
-    class Download
-      include Puree::API::Authentication
-
-      # @option (see Puree::API::Authentication#configure_api)
-      def initialize(config)
-        @resource_type = :download
-        @api_map = Puree::API::Map.new.get # Workararound to provide access to service_family
-        configure_api config
-      end
-
-      # Get download statistics. Only for Datasets.
-      #
-      # @param limit [Fixnum]
-      # @param offset [Fixnum]
-      # @param resource [Symbol] The resource being reported
-      # @return [Array<Puree::Model::DownloadHeader>]
-      def get(limit: 0,
-              offset: 0,
-              resource:)
-        raise 'Cannot perform a request without a configuration' if @config.nil?
-        @response = @request.get rendering:      :system,
-                                 limit:          limit,
-                                 offset:         offset,
-                                 resource_type:  @resource_type,
-                                 content_type:   service_family(resource)
-        set_content @response.body
-      end
-
-      private
-
-      def combine_metadata
-        @extractor.statistics
-      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]
-      def set_content(xml)
-        if xml
-          make_extractor
-          @extractor.get_data? ? combine_metadata : []
-        end
-      end
-
-      def make_extractor
-        @extractor = Puree::XMLExtractor::Download.new xml: @response.body
-      end
-
-      def service_family(resource_type)
-        if @api_map[:resource_type].has_key? resource_type
-          # Family data is only populated for datasets (required for download)
-          @api_map[:resource_type][resource_type][:family]
-        else
-          raise "#{resource_type} is an unrecognised resource type"
-        end
-      end
-
-      alias :find :get
-
-    end
-
-  end
-
-end

data/lib/puree/extractor/organisation.rb

@@ -1,34 +0,0 @@
-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/paper_base.rb

@@ -1,28 +0,0 @@
-module Puree
-  module Extractor
-
-    # Paper base extractor.
-    # Do not use directly.
-    #
-    class PaperBase < Puree::Extractor::Publication
-
-      # @option (see Puree::Extractor::Resource#initialize)
-      def initialize(config)
-        super
-      end
-
-      private
-
-      def combine_metadata
-        super
-
-        @model.pages = @extractor.pages
-        @model.page_range = @extractor.page_range
-        @model.peer_reviewed = @extractor.peer_reviewed
-        @model
-      end
-
-    end
-
-  end
-end

data/lib/puree/extractor/publication.rb

@@ -1,53 +0,0 @@
-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.associated = @extractor.associated
-        @model.bibliographical_note = @extractor.bibliographical_note
-        @model.category = @extractor.category
-        @model.description = @extractor.description
-        @model.doi = @extractor.doi
-        @model.dois = @extractor.dois
-        @model.external_organisations = @extractor.external_organisations
-        @model.files = @extractor.files
-        @model.keywords = @extractor.keywords
-        @model.language = @extractor.language
-        @model.links = @extractor.links
-        @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.publication_place = @extractor.publication_place
-        @model.publisher = @extractor.publisher
-        @model.scopus_id = @extractor.scopus_id
-        @model.statuses = @extractor.statuses
-        @model.subtitle = @extractor.subtitle
-        @model.title = @extractor.title
-        @model.translated_subtitle = @extractor.translated_subtitle
-        @model.translated_title = @extractor.translated_title
-        @model.type = @extractor.type
-        @model.workflow_state = @extractor.workflow_state
-        @model
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/extractor/server.rb

@@ -1,56 +0,0 @@
-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/download_header.rb

@@ -1,21 +0,0 @@
-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/paper_base.rb

@@ -1,19 +0,0 @@
-module Puree
-  module Model
-
-    # A base paper.
-    #
-    class PaperBase < Puree::Model::Publication
-
-      # @return [Fixnum, nil]
-      attr_accessor :pages
-
-      # @return [String, nil]
-      attr_accessor :page_range
-
-      # @return [Boolean, nil]
-      attr_accessor :peer_reviewed
-
-    end
-  end
-end

data/lib/puree/model/server.rb

@@ -1,13 +0,0 @@
-module Puree
-  module Model
-
-    # Pure host information.
-    #
-    class Server
-
-    # @return [String, nil]
-    attr_accessor :version
-
-    end
-  end
-end

data/lib/puree/query/funding.rb

@@ -1,54 +0,0 @@
-module Puree
-
-  module Query
-
-    # For querying information about funding.
-    #
-    class Funding
-
-      def initialize(config)
-        @config = config
-      end
-
-      # Project funders
-      # @param uuid [String] Project UUID.
-      # @return [Array<Puree::Model::ExternalOrganisation>] List of funders which have funded this project.
-      def project_funders(uuid:)
-        funders = []
-        project_extractor = Puree::Extractor::Project.new @config
-        project = project_extractor.find uuid: uuid
-        if project
-          if project.funded
-            project.external_organisations.each do |org|
-              external_organisation_extractor = Puree::Extractor::ExternalOrganisation.new @config
-              external_organisation = external_organisation_extractor.find uuid: org.uuid
-              funders << external_organisation if external_organisation.type == '/dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes/ueoexternalorganisation/researchFundingBody'
-            end
-          end
-        end
-        funders.uniq { |i| i.uuid }
-      end
-
-      # Publication funders
-      # @param uuid [String] Publication UUID.
-      # @return [Array<Puree::Model::ExternalOrganisation>] List of funders which have funded this publication via a project.
-      def publication_funders(uuid:)
-        funders = []
-        publication_extractor = Puree::Extractor::Publication.new @config
-        publication = publication_extractor.find uuid: uuid
-        if publication
-          publication.associated.each do |associated|
-            if associated.type == 'Research'
-              single_project_funders = project_funders uuid: associated.uuid
-              funders += single_project_funders
-            end
-          end
-        end
-        funders.uniq { |i| i.uuid }
-      end
-
-    end
-
-  end
-
-end