puree 1.9.1 → 2.0.0

data/test/xml_extractor/xml_extractor_thesis_test.rb

@@ -0,0 +1,80 @@
+require 'test_xml_extractor_helper'
+
+class TestXMLExtractorThesis < Minitest::Test
+
+  def xml_extractor_from_id(id)
+    client = Puree::REST::Client.new config
+    response = client.research_outputs.find id: id
+    Puree::XMLExtractor::Thesis.new response.to_s
+  end
+
+  def test_initialize
+    xml = '<foo/>'
+    xml_extractor = Puree::XMLExtractor::Thesis.new xml
+
+    assert_instance_of Puree::XMLExtractor::Thesis, xml_extractor
+  end
+
+  def test_core
+    # Multimodalita e 'city branding'
+    id = '376173c0-fd7a-4d63-93d3-3f2e58e8dc01'
+    x = xml_extractor_from_id id
+
+    asserts_resource x
+
+    assert_instance_of Time, x.award_date
+
+    assert_instance_of Puree::Model::ExternalOrganisationHeader, x.awarding_institution
+    assert_equal true,  x.awarding_institution.data?
+
+    assert_instance_of Puree::Model::PublisherHeader, x.publisher
+    assert_equal true, x.publisher.data?
+
+    assert_instance_of String, x.type
+    refute_empty x.type
+  end
+
+  def test_sponsors
+    # A comparative study of the fundamental juridical nature, classification and private law enforcement of jurisdiction and choice of law agreements in the English Common Law of Conflict of Laws, the European Union Private International Law Regime and the Hague Convention on Choice of Court Agreements
+    id = 'c5b50358-4c42-48fb-ae53-8f360edcb51d'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Array, x.sponsors
+    assert_instance_of Puree::Model::ExternalOrganisationHeader, x.sponsors.first
+    assert_equal true,  x.sponsors.first.data?
+  end
+
+  def test_qualification
+    # A comparative study of the fundamental juridical nature, classification and private law enforcement of jurisdiction and choice of law agreements in the English Common Law of Conflict of Laws, the European Union Private International Law Regime and the Hague Convention on Choice of Court Agreements
+    id = 'c5b50358-4c42-48fb-ae53-8f360edcb51d'
+    x = xml_extractor_from_id id
+
+    assert_instance_of String, x.qualification
+    refute_empty x.qualification
+  end
+
+  def test_absence
+    xml = '<foo/>'
+    x = Puree::XMLExtractor::Thesis.new xml
+
+    assert_nil x.awarding_institution
+
+    assert_nil x.publisher
+
+    assert_instance_of Array, x.sponsors
+    assert_empty x.sponsors
+
+    assert_nil x.qualification
+
+    assert_nil x.type
+  end
+
+  def test_model
+    # Multimodalita e 'city branding'
+    id = '376173c0-fd7a-4d63-93d3-3f2e58e8dc01'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Puree::Model::Thesis, x.model
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 description: 
 email: a.albin-clark@lancaster.ac.uk
 executables: []
@@ -66,39 +66,28 @@ files:
 - README.md
 - Rakefile
 - lib/puree.rb
-- lib/puree/api/api.rb
-- lib/puree/api/authentication.rb
-- lib/puree/api/configuration.rb
-- lib/puree/api/map.rb
-- lib/puree/api/person_request.rb
-- lib/puree/api/request.rb
-- lib/puree/extractor/collection.rb
 - lib/puree/extractor/conference_paper.rb
 - lib/puree/extractor/dataset.rb
 - lib/puree/extractor/doctoral_thesis.rb
-- lib/puree/extractor/download.rb
 - lib/puree/extractor/event.rb
 - lib/puree/extractor/external_organisation.rb
 - lib/puree/extractor/extractor.rb
 - lib/puree/extractor/journal.rb
 - lib/puree/extractor/journal_article.rb
 - lib/puree/extractor/masters_thesis.rb
-- lib/puree/extractor/organisation.rb
+- lib/puree/extractor/organisational_unit.rb
 - lib/puree/extractor/paper.rb
-- lib/puree/extractor/paper_base.rb
 - lib/puree/extractor/person.rb
 - lib/puree/extractor/project.rb
-- lib/puree/extractor/publication.rb
 - lib/puree/extractor/publisher.rb
+- lib/puree/extractor/research_output.rb
 - lib/puree/extractor/resource.rb
-- lib/puree/extractor/server.rb
 - lib/puree/extractor/thesis.rb
 - lib/puree/model/address.rb
 - lib/puree/model/conference_paper.rb
 - lib/puree/model/copyright_license.rb
 - lib/puree/model/dataset.rb
 - lib/puree/model/doctoral_thesis.rb
-- lib/puree/model/download_header.rb
 - lib/puree/model/endeavour_person.rb
 - lib/puree/model/event.rb
 - lib/puree/model/event_header.rb
@@ -106,6 +95,7 @@ files:
 - lib/puree/model/external_organisation_header.rb
 - lib/puree/model/file.rb
 - lib/puree/model/helper/validation.rb
+- lib/puree/model/identifier.rb
 - lib/puree/model/journal.rb
 - lib/puree/model/journal_article.rb
 - lib/puree/model/journal_header.rb
@@ -113,26 +103,58 @@ files:
 - lib/puree/model/link.rb
 - lib/puree/model/masters_thesis.rb
 - lib/puree/model/model.rb
-- lib/puree/model/organisation.rb
-- lib/puree/model/organisation_header.rb
+- lib/puree/model/organisation_header_base.rb
+- lib/puree/model/organisational_unit.rb
+- lib/puree/model/organisational_unit_header.rb
 - lib/puree/model/paper.rb
-- lib/puree/model/paper_base.rb
 - lib/puree/model/person.rb
 - lib/puree/model/person_name.rb
 - lib/puree/model/project.rb
-- lib/puree/model/publication.rb
 - lib/puree/model/publication_status.rb
 - lib/puree/model/publisher.rb
+- lib/puree/model/publisher_header.rb
 - lib/puree/model/related_content_header.rb
+- lib/puree/model/research_output.rb
+- lib/puree/model/research_output_scopus_metric.rb
 - lib/puree/model/resource.rb
-- lib/puree/model/server.rb
 - lib/puree/model/spatial_point.rb
 - lib/puree/model/structure.rb
 - lib/puree/model/temporal_range.rb
 - lib/puree/model/thesis.rb
-- lib/puree/query/funding.rb
-- lib/puree/query/person.rb
-- lib/puree/query/query.rb
+- lib/puree/rest/activity.rb
+- lib/puree/rest/application.rb
+- lib/puree/rest/base.rb
+- lib/puree/rest/classification_scheme.rb
+- lib/puree/rest/client.rb
+- lib/puree/rest/curricula_vitae.rb
+- lib/puree/rest/dataset.rb
+- lib/puree/rest/equipment.rb
+- lib/puree/rest/event.rb
+- lib/puree/rest/external_organisation.rb
+- lib/puree/rest/external_person.rb
+- lib/puree/rest/impact.rb
+- lib/puree/rest/journal.rb
+- lib/puree/rest/mixins/active_mixin.rb
+- lib/puree/rest/mixins/activity_mixin.rb
+- lib/puree/rest/mixins/application_mixin.rb
+- lib/puree/rest/mixins/award_mixin.rb
+- lib/puree/rest/mixins/dataset_mixin.rb
+- lib/puree/rest/mixins/former_mixin.rb
+- lib/puree/rest/mixins/impact_mixin.rb
+- lib/puree/rest/mixins/person_mixin.rb
+- lib/puree/rest/mixins/press_media_mixin.rb
+- lib/puree/rest/mixins/prize_mixin.rb
+- lib/puree/rest/mixins/project_mixin.rb
+- lib/puree/rest/mixins/research_output_mixin.rb
+- lib/puree/rest/mixins/student_thesis_mixin.rb
+- lib/puree/rest/organisational_unit.rb
+- lib/puree/rest/person.rb
+- lib/puree/rest/press_media.rb
+- lib/puree/rest/prize.rb
+- lib/puree/rest/project.rb
+- lib/puree/rest/publisher.rb
+- lib/puree/rest/research_output.rb
+- lib/puree/rest/rest.rb
 - lib/puree/util/date.rb
 - lib/puree/util/string.rb
 - lib/puree/util/util.rb
@@ -142,49 +164,60 @@ files:
 - lib/puree/xml_extractor/conference_paper.rb
 - lib/puree/xml_extractor/dataset.rb
 - lib/puree/xml_extractor/doctoral_thesis.rb
-- lib/puree/xml_extractor/download.rb
 - lib/puree/xml_extractor/event.rb
 - lib/puree/xml_extractor/external_organisation.rb
 - lib/puree/xml_extractor/journal.rb
 - lib/puree/xml_extractor/journal_article.rb
 - lib/puree/xml_extractor/masters_thesis.rb
-- lib/puree/xml_extractor/mixins/associated_mixin.rb
+- lib/puree/xml_extractor/mixins/abstract_mixin.rb
+- lib/puree/xml_extractor/mixins/description_mixin.rb
 - lib/puree/xml_extractor/mixins/doi_mixin.rb
 - lib/puree/xml_extractor/mixins/event_mixin.rb
-- lib/puree/xml_extractor/mixins/external_organisations_mixin.rb
+- lib/puree/xml_extractor/mixins/external_organisation_mixin.rb
+- lib/puree/xml_extractor/mixins/identifier_mixin.rb
+- lib/puree/xml_extractor/mixins/keyword_mixin.rb
+- lib/puree/xml_extractor/mixins/organisational_unit_mixin.rb
+- lib/puree/xml_extractor/mixins/owner_mixin.rb
 - lib/puree/xml_extractor/mixins/page_range_mixin.rb
 - lib/puree/xml_extractor/mixins/pages_mixin.rb
 - lib/puree/xml_extractor/mixins/peer_reviewed_mixin.rb
-- lib/puree/xml_extractor/mixins/workflow_state_mixin.rb
-- lib/puree/xml_extractor/organisation.rb
+- lib/puree/xml_extractor/mixins/person_mixin.rb
+- lib/puree/xml_extractor/mixins/publisher_mixin.rb
+- lib/puree/xml_extractor/mixins/research_output_mixin.rb
+- lib/puree/xml_extractor/mixins/title_mixin.rb
+- lib/puree/xml_extractor/mixins/type_mixin.rb
+- lib/puree/xml_extractor/mixins/workflow_mixin.rb
+- lib/puree/xml_extractor/organisational_unit.rb
 - lib/puree/xml_extractor/paper.rb
-- lib/puree/xml_extractor/paper_base.rb
 - lib/puree/xml_extractor/person.rb
 - lib/puree/xml_extractor/project.rb
-- lib/puree/xml_extractor/publication.rb
 - lib/puree/xml_extractor/publisher.rb
+- lib/puree/xml_extractor/research_output.rb
 - lib/puree/xml_extractor/resource.rb
-- lib/puree/xml_extractor/server.rb
 - lib/puree/xml_extractor/shared.rb
 - lib/puree/xml_extractor/thesis.rb
 - lib/puree/xml_extractor/xml_extractor.rb
 - puree.gemspec
-- spec/download_http_spec.rb
-- spec/open_api_dataset_http_spec.rb
-- spec/query/funding_http_spec.rb
-- spec/query/person_http_spec.rb
-- spec/resource/collection_all_http_spec.rb
-- spec/resource/collection_http_spec.rb
-- spec/resource/dataset_http_spec.rb
-- spec/resource/event_http_spec.rb
-- spec/resource/journal_http_spec.rb
-- spec/resource/organisation_http_spec.rb
-- spec/resource/person_http_spec.rb
-- spec/resource/project_http_spec.rb
-- spec/resource/publication_http_spec.rb
-- spec/resource/publisher_http_spec.rb
-- spec/server_http_spec.rb
-- spec/spec_helper.rb
+- test/extractor/resource_test.rb
+- test/rest/base_test.rb
+- test/rest/common_test.rb
+- test/test_extractor_helper.rb
+- test/test_helper.rb
+- test/test_rest_helper.rb
+- test/test_xml_extractor_helper.rb
+- test/xml_extractor/xml_extractor_collection_test.rb
+- test/xml_extractor/xml_extractor_conference_paper_test.rb
+- test/xml_extractor/xml_extractor_dataset_test.rb
+- test/xml_extractor/xml_extractor_event_test.rb
+- test/xml_extractor/xml_extractor_external_organisation_test.rb
+- test/xml_extractor/xml_extractor_journal_article_test.rb
+- test/xml_extractor/xml_extractor_journal_test.rb
+- test/xml_extractor/xml_extractor_organisation_test.rb
+- test/xml_extractor/xml_extractor_person_test.rb
+- test/xml_extractor/xml_extractor_project_test.rb
+- test/xml_extractor/xml_extractor_publisher_test.rb
+- test/xml_extractor/xml_extractor_research_output_test.rb
+- test/xml_extractor/xml_extractor_thesis_test.rb
 homepage: https://github.com/lulibrary/puree
 licenses:
 - MIT
@@ -210,19 +243,23 @@ signing_key:
 specification_version: 4
 summary: Metadata extraction from the Pure Research Information System.
 test_files:
-- spec/download_http_spec.rb
-- spec/open_api_dataset_http_spec.rb
-- spec/query/funding_http_spec.rb
-- spec/query/person_http_spec.rb
-- spec/resource/collection_all_http_spec.rb
-- spec/resource/collection_http_spec.rb
-- spec/resource/dataset_http_spec.rb
-- spec/resource/event_http_spec.rb
-- spec/resource/journal_http_spec.rb
-- spec/resource/organisation_http_spec.rb
-- spec/resource/person_http_spec.rb
-- spec/resource/project_http_spec.rb
-- spec/resource/publication_http_spec.rb
-- spec/resource/publisher_http_spec.rb
-- spec/server_http_spec.rb
-- spec/spec_helper.rb
+- test/extractor/resource_test.rb
+- test/rest/base_test.rb
+- test/rest/common_test.rb
+- test/test_extractor_helper.rb
+- test/test_helper.rb
+- test/test_rest_helper.rb
+- test/test_xml_extractor_helper.rb
+- test/xml_extractor/xml_extractor_collection_test.rb
+- test/xml_extractor/xml_extractor_conference_paper_test.rb
+- test/xml_extractor/xml_extractor_dataset_test.rb
+- test/xml_extractor/xml_extractor_event_test.rb
+- test/xml_extractor/xml_extractor_external_organisation_test.rb
+- test/xml_extractor/xml_extractor_journal_article_test.rb
+- test/xml_extractor/xml_extractor_journal_test.rb
+- test/xml_extractor/xml_extractor_organisation_test.rb
+- test/xml_extractor/xml_extractor_person_test.rb
+- test/xml_extractor/xml_extractor_project_test.rb
+- test/xml_extractor/xml_extractor_publisher_test.rb
+- test/xml_extractor/xml_extractor_research_output_test.rb
+- test/xml_extractor/xml_extractor_thesis_test.rb

data/lib/puree/api/api.rb

@@ -1,9 +0,0 @@
-module Puree
-
-  # Pure-specific details concerning requests and responses.
-  #
-  module API
-
-  end
-
-end

data/lib/puree/api/authentication.rb

@@ -1,33 +0,0 @@
-module Puree
-
-  module API
-
-    # Mixin to configure authentication.
-    #
-    module Authentication
-
-      private
-
-      # Configure a Pure host for API access.
-      #
-      # @param config [Hash]
-      # @option config [String] :url The URL of the Pure host.
-      # @option config [String] :username The username of the Pure host account.
-      # @option config [String] :password The password of the Pure host account.
-      def configure_api(config)
-        @config = Puree::API::Configuration.new url: config[:url]
-        @config.basic_auth username: config[:username],
-                           password: config[:password]
-
-        @request = Puree::API::Request.new url: @config.url
-        if @config.basic_auth?
-          @request.basic_auth username: @config.username,
-                              password: @config.password
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/api/configuration.rb

@@ -1,43 +0,0 @@
-module Puree
-
-  module API
-
-    # Configuration for Pure host and credentials.
-    #
-    class Configuration
-
-      # @return [String]
-      attr_reader :url
-
-      # @return [String, nil]
-      attr_reader :username
-
-      # @return [String, nil]
-      attr_reader :password
-
-      def initialize(url:)
-        raise 'Missing URL in configuration' if !url
-        @url = url
-      end
-
-      # Provide Basic Authentication credentials if required
-      #
-      # @param username [String]
-      # @param password [String]
-      def basic_auth(username:, password:)
-        @username = username
-        @password = password
-        msg = 'Credentials incomplete in configuration'
-        raise msg if username && !password
-        raise msg if password && !username
-      end
-
-      def basic_auth?
-        @username && @password
-      end
-
-    end
-
-  end
-
-end

data/lib/puree/api/map.rb

@@ -1,80 +0,0 @@
-module Puree
-
-  module API
-
-    # Pure endpoints and corresponding XML root element in response.
-    #
-    class Map
-
-      def initialize
-        @convention = %w(
-          event
-          journal
-          organisation
-          person
-          project
-          publication
-          publisher
-        )
-
-        @api_map = {
-          resource_type: {
-            dataset: {
-              service: 'datasets',
-              response: 'GetDataSetsResponse',
-              family: 'dk.atira.pure.modules.datasets.external.model.dataset.DataSet'
-            },
-            download: {
-              service: 'downloadcount',
-              response: 'GetDownloadCountResponse'
-            },
-            server: {
-              service: 'servermeta',
-              response: 'GetServerMetaResponse'
-            },
-            external_organisation: {
-              service: 'externalOrganisation',
-              response: 'GetExternalOrganisationResponse'
-            }
-          }
-        }
-
-        add_convention
-        # add_family
-      end
-
-      # Gets endpoints with their corresponding XML response names.
-      #
-      # @return [Hash]
-      def get
-        @api_map
-      end
-
-      # Endpoint for resource type.
-      #
-      # @param resource_type [Symbol]
-      # @return [String, nil]
-      def service_name(resource_type)
-        @api_map[:resource_type][resource_type][:service]
-      end
-
-      private
-
-      def add_convention
-        @convention.each do |c|
-          resource_type = {}
-          resource_type[:service] = c
-          resource_type[:response] = 'Get' + c.capitalize + 'Response'
-          @api_map[:resource_type][c.to_sym] = resource_type
-        end
-      end
-
-      # def add_family
-      #   @api_map[:resource_type][:event][:family] = 'dk.atira.pure.api.shared.model.event.Event'
-      # end
-
-    end
-
-  end
-
-end

data/lib/puree/api/person_request.rb

@@ -1,64 +0,0 @@
-module Puree
-
-  module API
-
-    # Handles requests to Pure.
-    #
-    class PersonRequest < Puree::API::Request
-
-      def initialize(url:)
-        super
-      end
-
-      # Perform a GET request to Pure
-      #
-      # @param uuid [String]
-      # @param id [String]
-      # @param employee_id [String]
-      # @param rendering [String]
-      # @param latest_api [Boolean]
-      # @param resource_type [String]
-      # @return [HTTP::Response]
-      def get(uuid: nil,
-              id: nil,
-              employee_id: nil,
-              rendering: :xml_long,
-              latest_api: true,
-              resource_type:)
-            @latest_api =     latest_api
-            @resource_type =  resource_type.to_sym
-            @rendering =      rendering
-            @uuid =           uuid
-            @id =             id
-            @employee_id =    employee_id
-
-        # 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
-        elsif @id
-          query['pureInternalIds.id'] = @id
-        elsif @employee_id
-          query['personEmployeeIds.value'] = @employee_id
-        end
-        query['rendering'] = @rendering
-        query
-      end
-
-    end
-
-  end
-
-end