puree 1.9.1 → 2.0.0

data/test/rest/base_test.rb

@@ -0,0 +1,45 @@
+require 'test_rest_helper'
+
+class TestResourceBase < Minitest::Test
+
+  def test_instance
+    base = Puree::REST::Base.new config
+    assert_instance_of Puree::REST::Base, base
+  end
+
+  # Private get_request_X methods (used by all resources) tested via Client
+  # public interface. Exemplar resource is Person.
+
+  def test_get_request_collection
+    response = client.persons.all
+    # puts response
+    assert_instance_of HTTP::Response, response
+  end
+
+  def test_get_request_singleton
+    uuid = random_singleton_uuid :person
+    response = client.persons.find id: uuid
+    # puts response
+    assert_instance_of HTTP::Response, response
+  end
+
+  def test_get_request_meta
+    response = client.persons.renderings
+    # puts response
+    assert_instance_of HTTP::Response, response
+  end
+
+  def test_get_request_collection_subcollection
+    response = client.persons.active
+    # puts response
+    assert_instance_of HTTP::Response, response
+  end
+
+  def test_get_request_singleton_subcollection
+    uuid = random_singleton_uuid :person
+    response = client.persons.projects id: uuid
+    # puts response
+    assert_instance_of HTTP::Response, response
+  end
+
+end

data/test/rest/common_test.rb

@@ -0,0 +1,44 @@
+require 'test_rest_helper'
+
+class TestResourceCommon < Minitest::Test
+
+  # all
+  resources.each do |resource|
+    test_name = "test_#{resource}_all"
+    define_method(test_name) do
+      # puts test_name
+      response = resource_instance(resource).all
+      # puts response
+      assert_instance_of HTTP::Response, response
+    end
+  end
+
+  # find
+  resources.each do |resource|
+    uuid = random_singleton_uuid resource
+    next unless uuid
+    test_name = "test_#{resource}_#{uuid}_find"
+    define_method(test_name) do
+      # puts test_name
+      resource_instance = resource_instance(resource)
+      response = resource_instance.find id: uuid
+      # puts response
+      assert_instance_of HTTP::Response, response
+    end
+  end
+
+  # meta
+  resources.each do |resource|
+    meta_methods.each do |meta_type|
+      test_name = "test_#{resource}_meta_#{meta_type}"
+      define_method(test_name) do
+        # puts test_name
+        resource_instance = resource_instance(resource)
+        response = resource_instance.send meta_type
+        # puts response
+        assert_instance_of HTTP::Response, response
+      end
+    end
+  end
+
+end

data/test/test_extractor_helper.rb

@@ -0,0 +1 @@
+require 'test_helper'

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+Minitest::Reporters.use!
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib)
+
+require 'puree'
+
+def config
+  {
+      url:      ENV['PURE_URL_TEST_59'],
+      username: ENV['PURE_USERNAME'],
+      password: ENV['PURE_PASSWORD'],
+      api_key:  ENV['PURE_API_KEY']
+  }
+end

data/test/test_rest_helper.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+def client
+  Puree::REST::Client.new config
+end
+
+def instance(klass)
+  Object.const_get(klass).new config
+end
+
+def resource_klass(resource)
+  "Puree::REST::#{titleize(resource)}"
+end
+
+def resource_instance(resource)
+  klass = resource_klass resource
+  Object.const_get(klass).new config
+end
+
+def resource_count(resource)
+  r = resource_instance resource
+  response = r.all params: { size: 0 }, accept: :json
+  hash = JSON.parse response
+  hash['count']
+end
+
+def random_singleton(resource)
+  count = resource_count resource
+  return unless count > 0
+  # get random offset
+  offset = rand(0..count - 1)
+  # get random record
+  r = resource_instance resource
+  response = r.all params: { size: 1, offset: offset }, accept: :json
+  hash = JSON.parse response
+  hash['items'][0]
+end
+
+def random_singleton_uuid(resource)
+  hash = random_singleton resource
+  return unless hash
+  hash['uuid']
+end
+
+# Assumes underscore as separator.
+# e.g. foo_bar becomes FooBar
+#
+def titleize(x)
+  arr = "#{x}".split('_')
+  caps = arr.map { |i| i.capitalize }
+  caps.join
+end
+
+def resources
+  %i(
+    activity
+    application
+    classification_scheme
+    curricula_vitae
+    dataset
+    equipment
+    event
+    external_organisation
+    external_person
+    impact
+    journal
+    organisational_unit
+    person
+    press_media
+    prize
+    project
+    publisher
+    research_output
+  )
+end
+
+def meta_methods
+  %i(
+  orderings
+  renderings
+  )
+end

data/test/test_xml_extractor_helper.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+def asserts_resource(x)
+  assert_instance_of Time, x.created_at
+
+  assert_instance_of String, x.created_by
+
+  assert_instance_of Time, x.modified_at
+
+  assert_instance_of String, x.modified_by
+
+  assert_instance_of String, x.uuid
+end
+
+def collection_size
+  3
+end

data/test/xml_extractor/xml_extractor_collection_test.rb

@@ -0,0 +1,120 @@
+require 'test_xml_extractor_helper'
+
+class TestXMLExtractorCollection < Minitest::Test
+
+  def test_datasets
+    client = Puree::REST::Client.new config
+    response = client.datasets.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.datasets response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::Dataset, data.first if !data.empty?
+  end
+
+  def test_events
+    client = Puree::REST::Client.new config
+    response = client.events.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.events response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::Event, data.first if !data.empty?
+  end
+
+  def test_external_organisations
+    client = Puree::REST::Client.new config
+    response = client.external_organisations.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.external_organisations response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::ExternalOrganisation, data.first if !data.empty?
+  end
+
+  def test_journals
+    client = Puree::REST::Client.new config
+    response = client.journals.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.journals response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::Journal, data.first if !data.empty?
+  end
+
+  def test_organisations
+    client = Puree::REST::Client.new config
+    response = client.organisational_units.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.organisational_units response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::OrganisationalUnit, data.first if !data.empty?
+  end
+
+  def test_persons
+    client = Puree::REST::Client.new config
+    response = client.persons.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.persons response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::Person, data.first if !data.empty?
+  end
+
+  def test_projects
+    client = Puree::REST::Client.new config
+    response = client.projects.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.projects response.to_s
+    # puts data
+    assert_instance_of Array, data
+    assert_instance_of Puree::Model::Project, data.first if !data.empty?
+  end
+
+  def test_research_outputs
+    client = Puree::REST::Client.new config
+    response = client.research_outputs.all params: { size: collection_size }
+    data = Puree::XMLExtractor::Collection.research_outputs response.to_s
+
+    # puts data
+
+    assert_instance_of Hash, data
+
+    journal_articles = data[:journal_articles]
+    assert_instance_of Array, journal_articles
+    assert_instance_of Puree::Model::JournalArticle, journal_articles.first if !journal_articles.empty?
+    assert_equal 'Journal article', journal_articles.first.type if !journal_articles.empty?
+
+    conference_papers = data[:conference_papers]
+    assert_instance_of Array, conference_papers
+    assert_instance_of Puree::Model::ConferencePaper, conference_papers.first if !conference_papers.empty?
+    assert_equal 'Conference paper', conference_papers.first.type if !conference_papers.empty?
+
+    theses = data[:theses]
+    assert_instance_of Array, theses
+    assert_instance_of Puree::Model::Thesis, theses.first if !theses.empty?
+    assert_equal 'Thesis', theses.first.type if !theses.empty?
+
+    others = data[:other]
+    assert_instance_of Array, others
+    assert_instance_of Puree::Model::ResearchOutput, others.first if !others.empty?
+
+  end
+
+  def test_research_outputs_absence
+    xml = '<foo/>'
+    data = Puree::XMLExtractor::Collection.research_outputs xml
+
+    assert_instance_of Hash, data
+
+    journal_articles = data[:journal_articles]
+    assert_instance_of Array, journal_articles
+    assert_empty journal_articles
+
+    conference_papers = data[:conference_papers]
+    assert_instance_of Array, conference_papers
+    assert_empty conference_papers
+
+    theses = data[:theses]
+    assert_instance_of Array, theses
+    assert_empty theses
+
+    others = data[:other]
+    assert_instance_of Array, others
+    assert_empty others
+  end
+end

data/test/xml_extractor/xml_extractor_conference_paper_test.rb

@@ -0,0 +1,69 @@
+require 'test_xml_extractor_helper'
+
+class TestXMLExtractorPaper < Minitest::Test
+
+  def xml_extractor_from_id(id)
+    client = Puree::REST::Client.new config
+    response = client.research_outputs.find id: id
+    Puree::XMLExtractor::ConferencePaper.new response.to_s
+  end
+
+  def test_initialize
+    xml = '<foo/>'
+    xml_extractor = Puree::XMLExtractor::ConferencePaper.new xml
+
+    assert_instance_of Puree::XMLExtractor::ConferencePaper, xml_extractor
+  end
+
+  def test_core
+    # A Negative Effect of Evaluation Upon Analogical Problem Solving
+    id = '96e1495e-70a2-4529-9721-33b2cb62df8d'
+    x = xml_extractor_from_id id
+
+    asserts_resource x
+
+    assert_instance_of Puree::Model::EventHeader, x.event
+    assert_equal true, x.event.data?
+
+    assert_instance_of Fixnum, x.pages
+  end
+
+  def test_page_range
+    # Development of a Motion Tracking 3D CAD Input System
+    id = 'db2193b7-5cc7-496d-9bd5-35192c6d7ece'
+    x = xml_extractor_from_id id
+
+    assert_instance_of String, x.page_range
+    refute_empty x.page_range
+  end
+
+  def test_peer_reviewed
+    # Development of a Motion Tracking 3D CAD Input System
+    id = 'db2193b7-5cc7-496d-9bd5-35192c6d7ece'
+    x = xml_extractor_from_id id
+
+    assert_equal true, x.peer_reviewed
+  end
+
+  def test_absence
+    xml = '<foo/>'
+    x = Puree::XMLExtractor::ConferencePaper.new xml
+
+    assert_nil x.event
+
+    assert_nil x.pages
+
+    assert_nil x.page_range
+
+    assert_nil x.peer_reviewed
+  end
+
+  def test_model
+    # A Negative Effect of Evaluation Upon Analogical Problem Solving
+    id = '96e1495e-70a2-4529-9721-33b2cb62df8d'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Puree::Model::ConferencePaper, x.model
+  end
+
+end

data/test/xml_extractor/xml_extractor_dataset_test.rb

@@ -0,0 +1,156 @@
+require 'test_xml_extractor_helper'
+
+class TestXMLExtractorDataset < Minitest::Test
+
+  def xml_extractor_from_id(id)
+    client = Puree::REST::Client.new config
+    response = client.datasets.find id: id
+    Puree::XMLExtractor::Dataset.new response.to_s
+  end
+
+  def test_initialize
+    xml = '<foo/>'
+    x = Puree::XMLExtractor::Dataset.new xml
+
+    assert_instance_of Puree::XMLExtractor::Dataset, x
+  end
+
+  def test_core
+    # The 2014 Ebola virus disease outbreak in West Africa
+    id = 'b050f4b5-e272-4914-8cac-3bdc1e673c58'
+    x = xml_extractor_from_id id
+
+    asserts_resource x
+
+    assert_instance_of Time, x.available
+
+    assert_instance_of String, x.description
+    refute_empty x.description
+
+    assert_instance_of String, x.doi
+    refute_empty x.doi
+
+    assert_instance_of Array, x.files
+    assert_instance_of Puree::Model::File, x.files.first
+    assert_equal true, x.files.first.data?
+
+    assert_instance_of Array, x.keywords
+    assert_instance_of String, x.keywords.first
+    refute_empty x.keywords.first
+
+    assert_instance_of Array, x.organisational_units
+    assert_instance_of Puree::Model::OrganisationalUnitHeader, x.organisational_units.first
+    assert_equal true, x.organisational_units.first.data?
+
+    assert_instance_of Puree::Model::OrganisationalUnitHeader, x.owner
+    assert_equal true, x.owner.data?
+
+    assert_instance_of Array, x.persons_internal
+    assert_instance_of Puree::Model::EndeavourPerson, x.persons_internal.first
+    assert_equal true, x.persons_internal.first.data?
+
+    assert_instance_of Array, x.persons_external
+    assert_instance_of Puree::Model::EndeavourPerson, x.persons_external.first
+    assert_equal true, x.persons_external.first.data?
+
+    assert_instance_of Puree::Model::TemporalRange, x.production
+    assert_equal true, x.production.data?
+
+    assert_instance_of Array, x.research_outputs
+    assert_instance_of Puree::Model::RelatedContentHeader, x.research_outputs.first
+    assert_equal true, x.research_outputs.first.data?
+
+    assert_instance_of Puree::Model::PublisherHeader, x.publisher
+    assert_equal true, x.publisher.data?
+
+    assert_instance_of Array, x.spatial_places
+    assert_instance_of String, x.spatial_places.first
+    refute_empty x.spatial_places.first
+
+    assert_instance_of Puree::Model::TemporalRange, x.temporal
+    assert_equal true, x.temporal.data?
+
+    assert_instance_of String, x.title
+    refute_empty x.title
+
+    assert_instance_of String, x.workflow
+    refute_empty x.workflow
+  end
+
+  def test_persons_other
+    # Plant diversity and root traits influence soil physical properties
+    id = '18cb8b7c-c3dd-43b8-ac65-bdf76910a6cc'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Array, x.persons_other
+    assert_instance_of Puree::Model::EndeavourPerson, x.persons_other.first
+    assert_equal true, x.persons_other.first.data?
+  end
+
+  def test_spatial_point
+    # Influenza C in Lancaster, winter 2014-2015
+    id = 'a762a8a2-a9ed-4abb-ba91-a67752b1c54d'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Puree::Model::SpatialPoint, x.spatial_point
+    assert_equal true, x.spatial_point.data?
+  end
+
+  def test_absence
+    xml = '<foo/>'
+    x = Puree::XMLExtractor::Dataset.new xml
+
+    assert_nil x.available
+
+    assert_nil x.description
+
+    assert_nil x.doi
+
+    assert_instance_of Array, x.files
+    assert_empty x.files
+
+    assert_instance_of Array, x.keywords
+    assert_empty x.keywords
+
+    assert_instance_of Array, x.organisational_units
+    assert_empty x.organisational_units
+
+    assert_nil x.owner
+
+    assert_instance_of Array, x.persons_internal
+    assert_empty x.persons_internal
+
+    assert_instance_of Array, x.persons_external
+    assert_empty x.persons_external
+
+    assert_instance_of Array, x.persons_other
+    assert_empty x.persons_other
+
+    assert_nil x.production
+
+    assert_instance_of Array, x.research_outputs
+    assert_empty x.research_outputs
+
+    assert_nil x.publisher
+
+    assert_instance_of Array, x.spatial_places
+    assert_empty x.spatial_places
+
+    assert_nil x.spatial_point
+
+    assert_nil x.temporal
+
+    assert_nil x.title
+
+    assert_nil x.workflow
+  end
+
+  def test_model
+    # The 2014 Ebola virus disease outbreak in West Africa
+    id = 'b050f4b5-e272-4914-8cac-3bdc1e673c58'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Puree::Model::Dataset, x.model
+  end
+
+end

data/test/xml_extractor/xml_extractor_event_test.rb

@@ -0,0 +1,58 @@
+require 'test_xml_extractor_helper'
+
+class TestXMLEventJournal < Minitest::Test
+
+  def xml_extractor_from_id(id)
+    client = Puree::REST::Client.new config
+    response = client.events.find id: id
+    Puree::XMLExtractor::Event.new response.to_s
+  end
+
+  def test_initialize
+    xml = '<foo/>'
+    xml_extractor = Puree::XMLExtractor::Event.new xml
+
+    assert_instance_of Puree::XMLExtractor::Event, xml_extractor
+  end
+
+  def test_core
+    # 31st Annual European Meeting on Atmospheric Studies by Optical Methods and 1st International Riometer Workshop
+    id = 'cd2bf302-4629-4f71-9c02-2dfe50a384bf'
+    x = xml_extractor_from_id id
+
+    asserts_resource x
+
+    assert_instance_of String, x.city
+    refute_empty x.city
+
+    assert_instance_of Puree::Model::TemporalRange, x.date
+    assert_equal true, x.date.data?
+
+    assert_instance_of String, x.title
+    refute_empty x.title
+
+    assert_instance_of String, x.type
+    refute_empty x.type
+  end
+
+  def test_absence
+    xml = '<foo/>'
+    x = Puree::XMLExtractor::Event.new xml
+
+    assert_nil x.city
+
+    assert_nil x.date
+
+    assert_nil x.title
+
+    assert_nil x.type
+  end
+
+  def test_model
+    # 31st Annual European Meeting on Atmospheric Studies by Optical Methods and 1st International Riometer Workshop
+    id = 'cd2bf302-4629-4f71-9c02-2dfe50a384bf'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Puree::Model::Event, x.model
+  end
+end

data/test/xml_extractor/xml_extractor_external_organisation_test.rb

@@ -0,0 +1,49 @@
+require 'test_xml_extractor_helper'
+
+class TestXMLExtractorExternalOrganisation < Minitest::Test
+
+  def xml_extractor_from_id(id)
+    client = Puree::REST::Client.new config
+    response = client.external_organisations.find id: id
+    Puree::XMLExtractor::ExternalOrganisation.new response.to_s
+  end
+
+  def test_initialize
+    xml = '<foo/>'
+    xml_extractor = Puree::XMLExtractor::ExternalOrganisation.new xml
+
+    assert_instance_of Puree::XMLExtractor::ExternalOrganisation, xml_extractor
+  end
+
+  def test_core
+    # STFC
+    id = '2ea6bbc4-c957-4a07-a1e7-604a2d944c20'
+    x = xml_extractor_from_id id
+
+    asserts_resource x
+
+    assert_instance_of String, x.name
+    refute_empty x.name
+
+    assert_instance_of String, x.type
+    refute_empty x.type
+  end
+
+  def test_absence
+    xml = '<foo/>'
+    x = Puree::XMLExtractor::ExternalOrganisation.new xml
+
+    assert_nil x.name
+
+    assert_nil x.type
+  end
+
+  def test_model
+    # STFC
+    id = '2ea6bbc4-c957-4a07-a1e7-604a2d944c20'
+    x = xml_extractor_from_id id
+
+    assert_instance_of Puree::Model::ExternalOrganisation, x.model
+  end
+
+end