puree 1.9.1 → 2.0.0

data/lib/puree/query/person.rb

@@ -1,121 +0,0 @@
-module Puree
-
-  module Query
-
-    # For querying information about a person.
-    #
-    class Person
-
-      def initialize(config)
-        @url = config[:url]
-        @headers = {}
-        basic_auth username: config[:username],
-                   password: config[:password]
-        @config = config
-      end
-
-      # Count of publications available for a person.
-      #
-      # @param uuid [String] person UUID.
-      # @return [Fixnum]
-      def publication_count(uuid:)
-        params = {}
-        params['associatedPersonUuids.uuid'] = uuid
-        params['rendering'] = :system
-        params['window.size'] = 0
-        headers
-        response = @req.get(build_publication_url, params: params)
-        doc = make_doc response.body
-        extract_publication_count doc
-      end
-
-      # Publications for a person.
-      #
-      # @param uuid [String] person UUID.
-      # @param limit [Fixnum]
-      # @param offset [Fixnum]
-      # @param published_start [String] using format YYYY-MM-DD
-      # @param published_end [String] using format YYYY-MM-DD
-      # @return [Array<Puree::Model::Publication>]
-      def publications(uuid:, limit:, offset: 0, published_start: nil, published_end: nil)
-        uuids = publication_uuids(uuid: uuid,
-                                  limit: limit,
-                                  offset: offset,
-                                  published_start: published_start,
-                                  published_end: published_end)
-        publications = []
-        uuids.each do |uuid|
-          publication_extractor = Puree::Extractor::Publication.new @config
-          publication = publication_extractor.find uuid: uuid
-          publications << publication if publication
-        end
-        publications
-      end
-
-
-      private
-
-      def publication_uuids(uuid:, limit:, offset: 0, published_start: nil, published_end: nil)
-        params = {}
-        params['associatedPersonUuids.uuid'] = uuid
-        params['rendering'] = :system
-        params['window.size'] = limit.to_s
-        params['window.offset'] = offset if limit > 0
-        params['publicationDate.fromDate'] = published_start if published_start
-        params['publicationDate.toDate'] = published_end if published_end
-        headers
-        response = @req.get(build_publication_url, params: params)
-        doc = make_doc response.body
-        extract_publication_uuids doc
-      end
-
-      def make_doc(xml)
-        doc = Nokogiri::XML xml
-        doc.remove_namespaces!
-        doc
-      end
-
-      def extract_publication_count(doc)
-        doc.xpath('/GetPublicationResponse/count').text.strip.to_i
-      end
-
-      def extract_publication_uuids(doc)
-        records = doc.xpath('/GetPublicationResponse/result/renderedItem')
-        uuids = []
-        records.each do |record|
-          uuid = extract_publication_uuid record
-          uuids << uuid
-        end
-        uuids
-      end
-
-      def extract_publication_uuid(doc)
-        doc.xpath('@renderedContentUUID').text.strip
-      end
-
-      def build_publication_url
-        "#{@url}/publication.current"
-      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
-
-      def headers
-        @headers['Accept'] = 'application/xml'
-        @req = HTTP.headers accept: @headers['Accept']
-        if @headers['Authorization']
-          @req = @req.auth @headers['Authorization']
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/query/query.rb

@@ -1,6 +0,0 @@
-module Puree
-  # For pulling data together from several places to answer important questions.
-  #
-  module Query
-  end
-end

data/lib/puree/xml_extractor/download.rb

@@ -1,42 +0,0 @@
-module Puree
-
-  module XMLExtractor
-
-    # Download XML extractor.
-    #
-    class Download < Puree::XMLExtractor::Base
-
-      def initialize(xml:)
-        @resource_type = :download
-        super
-      end
-
-      # Statistic
-      #
-      # @return [Array<Puree::Model::DownloadHeader>]
-      def statistics
-        path = "#{service_response_name}/downloadCount"
-        xpath_result = @doc.xpath(path)
-        data_arr = []
-        xpath_result.each { |i|
-          model = Puree::Model::DownloadHeader.new
-          model.uuid = i.attr('uuid').strip
-          model.count = i.attr('downloads').strip.to_i
-          data_arr << model
-        }
-        data_arr.uniq { |d| d.uuid }
-      end
-
-      # Is there any data after get?
-      #
-      # @return [Boolean]
-      def get_data?
-        # TO DO Inefficient!
-        statistics.size ? true : false
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/xml_extractor/mixins/workflow_state_mixin.rb

@@ -1,18 +0,0 @@
-module Puree
-
-  module XMLExtractor
-
-    # Workflow state extractor mixin.
-    #
-    module WorkflowStateMixin
-
-      # Workflow state
-      # @return [String, nil]
-      def workflow_state
-        xpath_query_for_single_value '/startedWorkflows/startedWorkflow/state'
-      end
-
-    end
-
-  end
-end

data/lib/puree/xml_extractor/organisation.rb

@@ -1,75 +0,0 @@
-module Puree
-
-  module XMLExtractor
-
-    # Organisation XML extractor.
-    #
-    class Organisation < Puree::XMLExtractor::Resource
-
-      def initialize(xml:)
-        super
-        @resource_type = :organisation
-      end
-
-      # @return [Array<Puree::Model::Address>]
-      def address
-        xpath_result = xpath_query '/addresses/classifiedAddress'
-        data = []
-        xpath_result.each do |d|
-          a = Puree::Model::Address.new
-          street = d.xpath('street').text.strip
-          a.street = street unless street.empty?
-          building = d.xpath('building').text.strip
-          a.building = building unless building.empty?
-          postcode = d.xpath('postalCode').text.strip
-          a.postcode = postcode unless building.empty?
-          city = d.xpath('city').text.strip
-          a.city = city unless city.empty?
-          country = d.xpath('country/term/localizedString').text.strip
-          a.country = country unless country.empty?
-          data << a
-        end
-        data.uniq { |d| d.street }
-      end
-
-      # @return [Array<String>]
-      def email_addresses
-        xpath_query_for_multi_value '/emails/classificationDefinedStringFieldExtension/value'
-      end
-
-      # @return [String, nil]
-      def name
-        xpath_query_for_single_value '/name/localizedString'
-      end
-
-      # @return [Array<Puree::Model::OrganisationHeader>]
-      def organisations
-        xpath_result = xpath_query '/organisations/organisation'
-        Puree::XMLExtractor::Shared.organisation_multi_header xpath_result
-      end
-
-      # @return [Puree::Model::OrganisationHeader, nil]
-      def parent
-        organisations.first unless organisations.empty?
-      end
-
-      # @return [Array<String>]
-      def phone_numbers
-        xpath_query_for_multi_value '/phoneNumbers/classificationDefinedStringFieldExtension/value'
-      end
-
-      # @return [String, nil]
-      def type
-        xpath_query_for_single_value '/typeClassification/term/localizedString'
-      end
-
-      # @return [Array<String>]
-      def urls
-        xpath_query_for_multi_value '/webAddresses/classificationDefinedFieldExtension/value/localizedString'
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/xml_extractor/paper_base.rb

@@ -1,17 +0,0 @@
-module Puree
-  module XMLExtractor
-
-    # Paper base XML extractor.
-    #
-    class PaperBase < Puree::XMLExtractor::Publication
-      include Puree::XMLExtractor::PagesMixin
-      include Puree::XMLExtractor::PageRangeMixin
-      include Puree::XMLExtractor::PeerReviewedMixin
-
-      def initialize(xml:)
-        super
-      end
-
-    end
-  end
-end

data/lib/puree/xml_extractor/publication.rb

@@ -1,257 +0,0 @@
-module Puree
-
-  module XMLExtractor
-
-    # Publication XML extractor.
-    #
-    class Publication < Puree::XMLExtractor::Resource
-      include Puree::XMLExtractor::AssociatedMixin
-      include Puree::XMLExtractor::ExternalOrganisationsMixin
-      include Puree::XMLExtractor::WorkflowStateMixin
-
-      def initialize(xml:)
-        @resource_type = :publication
-        super
-      end
-
-      # @return [String, nil]
-      def bibliographical_note
-        xpath_query_for_single_value('/bibliographicalNote')
-      end
-
-      # @return [String, nil]
-      def category
-        xpath_query_for_single_value '/publicationCategory/publicationCategory/term/localizedString'
-      end
-
-      # @return [String, nil]
-      def description
-        xpath_query_for_single_value '/abstract/localizedString'
-      end
-
-      # @return [String, nil]
-      def doi
-        multiple_dois = dois
-        multiple_dois.empty? ? nil : multiple_dois.first
-      end
-
-      # @deprecated Please use {#doi} instead
-      # @return [Array<String>, nil]
-      def dois
-        xpath_query_for_multi_value '/electronicVersionAssociations/electronicVersionDOIAssociations/electronicVersionDOIAssociation/doi'
-      end
-
-      # @return [Array<Puree::Model::File>]
-      def files
-        xpath_result = xpath_query '/electronicVersionAssociations/electronicVersionFileAssociations/electronicVersionFileAssociation'
-        docs = []
-        xpath_result.each do |d|
-          model = Puree::Model::File.new
-          model.name = d.xpath('file/fileName').text.strip
-          model.mime = d.xpath('file/mimeType').text.strip
-          model.size = d.xpath('file/size').text.strip.to_i
-          model.url = d.xpath('file/url').text.strip
-          document_license = d.xpath('licenseType')
-          if !document_license.empty?
-            license = Puree::Model::CopyrightLicense.new
-            license.name = document_license.xpath('term/localizedString').text.strip
-            license.url = document_license.xpath('description/localizedString').text.strip
-            model.license = license if license.data?
-          end
-          docs << model
-        end
-        docs.uniq { |d| d.url }
-      end
-
-      # @return [Array<String>]
-      def keywords
-        xpath_result =  xpath_query '/keywordGroups/keywordGroup/keyword/userDefinedKeyword/freeKeyword'
-        data_arr = xpath_result.map { |i| i.text.strip }
-        data_arr.uniq
-      end
-
-      # @return [String, nil]
-      def language
-        xpath_query_for_single_value '/language/term/localizedString'
-      end
-
-      # @return [Array<String>, nil]
-      def links
-        xpath_query_for_multi_value '/electronicVersionAssociations/electronicVersionLinkAssociations/electronicVersionLinkAssociation/link'
-      end
-
-      # @return [Array<Puree::Model::OrganisationHeader>]
-      def organisations
-        xpath_result = xpath_query '/organisations/association/organisation'
-        Puree::XMLExtractor::Shared.organisation_multi_header xpath_result
-      end
-
-      # @return [Puree::Model::OrganisationHeader, nil]
-      def owner
-        xpath_result = xpath_query '/owner'
-        Puree::XMLExtractor::Shared.organisation_header xpath_result
-      end
-
-      # @return [Array<Puree::Model::EndeavourPerson>]
-      def persons_internal
-        persons 'internal'
-      end
-
-      # @return [Array<Puree::Model::EndeavourPerson>]
-      def persons_external
-        persons 'external'
-      end
-
-      # @return [Array<Puree::Model::EndeavourPerson>]
-      def persons_other
-        persons 'other'
-      end
-
-      # @return [String, nil]
-      def publication_place
-        # handles variations in path
-        xpath_result = xpath_query_for_single_value '/associatedPublisher/placeOfPublication'
-        xpath_result = xpath_query_for_single_value '/associatedPublishers/placeOfPublication' if !xpath_result
-        xpath_result
-      end
-
-      # @return [String, nil]
-      def publisher
-        # handles variations in path
-        xpath_result = xpath_query_for_single_value '/associatedPublisher/publisher/name'
-        xpath_result = xpath_query_for_single_value '/associatedPublishers/publisher/name' if !xpath_result
-        xpath_result
-      end
-
-      # @return [String, nil]
-      def scopus_id
-        xpath_result = xpath_query '/external/secondarySource'
-        return if xpath_result.empty?
-        source = xpath_result.xpath('@source')
-        if source && source.text.strip === 'Scopus'
-          return xpath_result.xpath('@source_id').text.strip
-        end
-      end
-
-      # @return [Array<Puree::Model::PublicationStatus>]
-      def statuses
-        xpath_result = xpath_query '/publicationStatuses/publicationStatus'
-        data = []
-        xpath_result.each do |i|
-          s = Puree::Model::PublicationStatus.new
-          s.stage = i.xpath('publicationStatus/term/localizedString').text.strip
-
-          ymd = {}
-          ymd['year'] = i.xpath('publicationDate/year').text.strip
-          ymd['month'] = i.xpath('publicationDate/month').text.strip
-          ymd['day'] = i.xpath('publicationDate/day').text.strip
-
-          s.date = Puree::Util::Date.hash_to_time ymd
-
-          data << s
-        end
-        data.uniq { |d| d.stage }
-      end
-
-      # @return [String, nil]
-      def subtitle
-        xpath_query_for_single_value '/subtitle'
-      end
-
-      # @return [String, nil]
-      def title
-        xpath_query_for_single_value '/title'
-      end
-
-      # @return [String, nil]
-      def translated_subtitle
-        xpath_query_for_single_value '/translatedSubtitle/localizedString'
-      end
-
-      # @return [String, nil]
-      def  translated_title
-        xpath_query_for_single_value '/translatedTitle/localizedString'
-      end
-
-      # @return [String, nil]
-      def type
-        xpath_query_for_single_value '/typeClassification/term/localizedString'
-      end
-
-      private
-
-      # @return [Array<Endeavour::Person>]
-      def persons(type)
-        xpath_result = xpath_query '/persons/personAssociation'
-        arr = []
-        xpath_result.each do |i|
-          uuid_internal = i.at_xpath('person/@uuid')
-          uuid_external = i.at_xpath('externalPerson/@uuid')
-          if uuid_internal
-            person_type = 'internal'
-            uuid = uuid_internal.text.strip
-          elsif uuid_external
-            person_type = 'external'
-            uuid = uuid_external.text.strip
-          else
-            person_type = 'other'
-            uuid = ''
-          end
-          if person_type === type
-            person = Puree::Model::EndeavourPerson.new
-            person.uuid = uuid
-
-            name = Puree::Model::PersonName.new
-            name.first = i.xpath('name/firstName').text.strip
-            name.last = i.xpath('name/lastName').text.strip
-            person.name = name
-
-            role_uri = i.xpath('personRole/uri').text.strip
-            person.role = roles[role_uri]
-
-            arr << person if person.data?
-          end
-        end
-        arr.uniq { |d| d.uuid }
-      end
-
-      def roles
-        {
-            # Should build using '/dk/atira/pure/researchoutput/roles/' as prefix, with parameter
-
-            ## Article
-            '/dk/atira/pure/researchoutput/roles/contributiontojournal/author'          => 'Author',
-            '/dk/atira/pure/researchoutput/roles/contributiontojournal/illustrator'     => 'Illustrator',
-            '/dk/atira/pure/researchoutput/roles/contributiontojournal/editor'          => 'Editor',
-            '/dk/atira/pure/researchoutput/roles/contributiontojournal/translator'      => 'Translator',
-            '/dk/atira/pure/researchoutput/roles/contributiontojournal/publisher'       => 'Publisher',
-            '/dk/atira/pure/researchoutput/roles/contributiontojournal/guesteditor'     => 'Guest Editor',
-
-            ## Chapter
-            # Author
-            # Illustrator
-            # Editor
-            # Translator      # # @return [Fixnum, nil]
-      # def pages
-      #   xpath_result = xpath_query_for_single_value('/numberOfPages')
-      #   xpath_result ? xpath_result.to_i : nil
-      # end
-            # Publisher
-
-            # ... many, many more research output types ...
-
-            # Examples of others
-            '/dk/atira/pure/researchoutput/roles/bookanthology/author'                   => 'Author',
-            '/dk/atira/pure/researchoutput/roles/othercontribution/author'               => 'Author',
-            '/dk/atira/pure/researchoutput/roles/thesis/author'                          => 'Author',
-            '/dk/atira/pure/researchoutput/roles/workingpaper/author'                    => 'Author',
-            '/dk/atira/pure/researchoutput/roles/internalexternal/thesis/supervisor'     => 'Supervisor',
-            '/dk/atira/pure/researchoutput/roles/nontextual/artist'                      => 'Artist'
-        }
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/xml_extractor/server.rb

@@ -1,32 +0,0 @@
-module Puree
-
-  module XMLExtractor
-
-    # Server XML extractor.
-    #
-    class Server < Puree::XMLExtractor::Base
-
-      def initialize(xml:)
-        @resource_type = :server
-        super
-      end
-
-      # @return [String]
-      def version
-        path = "#{service_response_name}/baseVersion"
-        @doc.xpath(path).text.strip
-      end
-
-      # Is there any data after get?
-      #
-      # @return [Boolean]
-      def get_data?
-        # n.b. arbitrary element existence check
-        version.empty? ? false : true
-      end
-
-    end
-
-  end
-
-end

data/spec/download_http_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-describe 'Download' do
-
-  before(:all) do
-
-  end
-
-  it '#new' do
-    p = Puree::Extractor::Download.new config
-    expect(p).to be_a Puree::Extractor::Download
-  end
-
-  describe 'data retrieval' do
-    before(:all) do
-      @p = Puree::Extractor::Download.new config
-      @metadata = @p.find resource: :dataset,
-                          limit:    10
-    end
-
-    it '#find' do
-      expect(@metadata).to all( be_a Puree::Model::DownloadHeader )
-    end
-
-    it '#find' do
-      expect(@metadata).not_to be_empty
-    end
-
-  end
-
-end

data/spec/open_api_dataset_http_spec.rb

@@ -1,15 +0,0 @@
-require 'spec_helper'
-
-describe 'Open API' do
-
-  describe 'dataset retrieval' do
-    before(:all) do
-      resource = :dataset
-      request_open resource
-    end
-
-    resource_header
-
-  end
-
-end

data/spec/query/funding_http_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-describe 'Funding' do
-
-  it '#new' do
-    q = Puree::Query::Funding.new config
-    expect(q).to be_a Puree::Query::Funding
-  end
-
-  describe 'project data retrieval' do
-    before(:all) do
-      request :project
-      @project_uuid = @p.uuid
-      @q = Puree::Query::Funding.new config
-    end
-
-    it '#project_funders' do
-      funders = @q.project_funders uuid: @project_uuid
-      expect(funders).to all( be_a Puree::Model::ExternalOrganisation )
-    end
-
-    it '#publication_funders' do
-      funders = @q.publication_funders uuid: @project_uuid
-      expect(funders).to all( be_a Puree::Model::ExternalOrganisation )
-    end
-
-  end
-
-end