puree 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5aa6af3718ebb33cd7b19ef9142cb73b4a5d0f5c
-  data.tar.gz: b0c01d0104f64d84b9b28a8fca142d9c6fec9165
+  metadata.gz: 3f4b875fcc3fc9d0c03faf62d20332c2be02b8c7
+  data.tar.gz: eacdf05a1625cda281f653009389b16dc2d10822
 SHA512:
-  metadata.gz: a3772603849fb583fcbcc48b9d2343d06c64d17fc2d239d687556e7579804704e1b498cf568285ac49d3bd96669077644a80df3725fae21ed6a39a9fe2b4d85f
-  data.tar.gz: f5906459dedcc2ce1693e6d33d862b300196c4bc551c9bfec2e24b946fae4eacd2ac494e7a7ee8f918a3892708e317ab0ff4ee160496d4f5e30915aa21ed573c
+  metadata.gz: d644dbf426c9137f442e14b385b9535d9f65e4fd90c5bc24eb1417416d169b867f6aa828d16d44ffb95e7b39e2a49462a95aaff79b322c5385d30ae493afe25c
+  data.tar.gz: 9f40cdd393fb7606d55431c9de9ff68db7ee2341234997e48db252ec240a6fc50a55282ffb120820485379c69aa5e3d83f7f35d0c9c50dfc48adfe875250e508

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## Unreleased
 - Metadata: activity?, clipping?, externalPerson?
 
+## 1.4.0 - 2017-09-01
+- Project - external_organisations, funded.
+- Publication - associated, external_organisations.
+
 ## 1.3.0 - 2017-04-03
 ### Added
 - Publication type - JournalArticle, Paper, ConferencePaper.

data/lib/puree.rb

@@ -6,6 +6,14 @@ require 'puree/version'
 require 'puree/util/date'
 require 'puree/util/string'
 
+require 'puree/xml_extractor/mixins/associated_mixin'
+require 'puree/xml_extractor/mixins/doi_mixin'
+require 'puree/xml_extractor/mixins/event_mixin'
+require 'puree/xml_extractor/mixins/external_organisations_mixin'
+require 'puree/xml_extractor/mixins/pages_mixin'
+require 'puree/xml_extractor/mixins/page_range_mixin'
+require 'puree/xml_extractor/mixins/peer_reviewed_mixin'
+
 require 'puree/xml_extractor/shared'
 require 'puree/xml_extractor/base'
 require 'puree/xml_extractor/collection'
@@ -18,11 +26,6 @@ require 'puree/xml_extractor/organisation'
 require 'puree/xml_extractor/person'
 require 'puree/xml_extractor/project'
 
-require 'puree/xml_extractor/mixins/doi_mixin'
-require 'puree/xml_extractor/mixins/event_mixin'
-require 'puree/xml_extractor/mixins/pages_mixin'
-require 'puree/xml_extractor/mixins/page_range_mixin'
-require 'puree/xml_extractor/mixins/peer_reviewed_mixin'
 require 'puree/xml_extractor/publication'
 require 'puree/xml_extractor/thesis'
 require 'puree/xml_extractor/doctoral_thesis'
@@ -71,6 +74,7 @@ require 'puree/model/spatial_point'
 require 'puree/model/address'
 require 'puree/model/copyright_license'
 require 'puree/model/event_header'
+require 'puree/model/external_organisation_header'
 require 'puree/model/file'
 require 'puree/model/legal_condition'
 require 'puree/model/organisation_header'

data/lib/puree/extractor/project.rb

@@ -9,7 +9,7 @@ module Puree
       # @option (see Puree::Extractor::Resource#initialize)
       def initialize(config)
         super
-        @latest_api = false # stable API does not return person roles
+        @latest_api = false # current API does not return person roles
         setup :project
       end
 
@@ -18,7 +18,10 @@ module Puree
       def combine_metadata
         super
         @model.acronym = @extractor.acronym
+        # @model.associated = @extractor.associated # not present in stable API
         @model.description = @extractor.description
+        @model.external_organisations = @extractor.external_organisations
+        @model.funded = @extractor.funded?
         @model.organisations = @extractor.organisations
         @model.owner = @extractor.owner
         @model.persons_internal = @extractor.persons_internal

data/lib/puree/extractor/publication.rb

@@ -17,10 +17,12 @@ module Puree
       def combine_metadata
         super
 
+        @model.associated = @extractor.associated
         @model.bibliographical_note = @extractor.bibliographical_note
         @model.category = @extractor.category
         @model.description = @extractor.description
         @model.dois = @extractor.dois
+        @model.external_organisations = @extractor.external_organisations
         @model.files = @extractor.files
         @model.keywords = @extractor.keywords
         @model.language = @extractor.language

data/lib/puree/model/external_organisation_header.rb

@@ -0,0 +1,26 @@
+module Puree
+  module Model
+
+    # A minimal representation of an ExternalOrganisation.
+    #
+    class ExternalOrganisationHeader < Puree::Model::Structure
+
+      # @return [String, nil]
+      attr_reader :uuid
+
+      # @return [String, nil]
+      attr_reader :name
+
+      # @param v [String]
+      def uuid=(v)
+        @uuid = v if v && !v.empty?
+      end
+
+      # @param v [String]
+      def name=(v)
+        @name = v if v && !v.empty?
+      end
+
+    end
+  end
+end

data/lib/puree/model/project.rb

@@ -8,9 +8,19 @@ module Puree
       # @return [String, nil]
       attr_accessor :acronym
 
+      # not present in stable API
+      # @return [Array<Puree::Model::RelatedContentHeader>]
+      # attr_accessor :associated
+
       # @return [String, nil]
       attr_accessor :description
 
+      # @return [Array<Puree::Model::ExternalOrganisationHeader>]
+      attr_accessor :external_organisations
+
+      # @return [Boolean]
+      attr_accessor :funded
+
       # @return [Array<Puree::Model::OrganisationHeader>]
       attr_accessor :organisations
 

data/lib/puree/model/publication.rb

@@ -5,6 +5,9 @@ module Puree
     #
     class Publication < Resource
 
+      # @return [Array<Puree::Model::RelatedContentHeader>]
+      attr_accessor :associated
+
       # @return [String, nil]
       attr_accessor :bibliographical_note
 
@@ -17,6 +20,9 @@ module Puree
       # @return [Array<String>]
       attr_accessor :dois
 
+      # @return [Array<Puree::Model::ExternalOrganisationHeader>]
+      attr_accessor :external_organisations
+
       # @return [Array<Puree::Model::File>]
       attr_accessor :files
 

data/lib/puree/version.rb

@@ -1,5 +1,5 @@
 module Puree
   # Semantic version number
   #
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/puree/xml_extractor/dataset.rb

@@ -5,6 +5,7 @@ module Puree
     # Dataset XML extractor.
     #
     class Dataset < Puree::XMLExtractor::Resource
+      include Puree::XMLExtractor::AssociatedMixin
 
       def initialize(xml:)
         super
@@ -17,21 +18,6 @@ module Puree
         xpath_query_for_single_value '/openAccessPermission/term/localizedString'
       end
 
-      # Combines projects and publications
-      # @return [Array<Puree::Model::RelatedContentHeader>]
-      def associated
-        xpath_result = xpath_query '/associatedContent/relatedContent'
-        data_arr = []
-        xpath_result.each { |i|
-          related = Puree::Model::RelatedContentHeader.new
-          related.type = i.xpath('typeClassification').text.strip
-          related.title = i.xpath('title').text.strip
-          related.uuid = i.attr('uuid').strip
-          data_arr << related
-        }
-        data_arr.uniq { |d| d.uuid }
-      end
-
       # Date made available
       # @return [Time, nil]
       def available

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

@@ -0,0 +1,27 @@
+module Puree
+
+  module XMLExtractor
+
+    # Associated extractor mixin.
+    #
+    module AssociatedMixin
+
+      # Combines projects and publications
+      # @return [Array<Puree::Model::RelatedContentHeader>]
+      def associated
+        xpath_result = xpath_query '/associatedContent/relatedContent'
+        data_arr = []
+        xpath_result.each { |i|
+          related = Puree::Model::RelatedContentHeader.new
+          related.type = i.xpath('typeClassification').text.strip
+          related.title = i.xpath('title').text.strip
+          related.uuid = i.attr('uuid').strip
+          data_arr << related
+        }
+        data_arr.uniq { |d| d.uuid }
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,18 @@
+module Puree
+
+  module XMLExtractor
+
+    # External organisations extractor mixin.
+    #
+    module ExternalOrganisationsMixin
+
+      # @return [Array<Puree::Model::ExternalOrganisationHeader>]
+      def external_organisations
+        xpath_result = xpath_query '/associatedExternalOrganisations/externalOrganisation'
+        Puree::XMLExtractor::Shared.external_organisation_multi_header xpath_result
+      end
+
+    end
+
+  end
+end

data/lib/puree/xml_extractor/project.rb

@@ -5,6 +5,8 @@ module Puree
     # Project XML extractor.
     #
     class Project < Puree::XMLExtractor::Resource
+      # include Puree::XMLExtractor::AssociatedMixin # not present in stable API
+      include Puree::XMLExtractor::ExternalOrganisationsMixin
 
       def initialize(xml:)
         super
@@ -21,6 +23,13 @@ module Puree
         xpath_query_for_single_value '/description/localizedString'
       end
 
+      # @return [Boolean]
+      def funded?
+        xpath_result = xpath_query_for_single_value '/type'
+        return false if xpath_result.downcase.include? 'nonfunded'
+        true
+      end
+
       # @return [Array<Puree::Model::OrganisationHeader>]
       def organisations
         xpath_result = xpath_query '/organisations/association/organisation'

data/lib/puree/xml_extractor/publication.rb

@@ -5,6 +5,8 @@ module Puree
     # Publication XML extractor.
     #
     class Publication < Puree::XMLExtractor::Resource
+      include Puree::XMLExtractor::AssociatedMixin
+      include Puree::XMLExtractor::ExternalOrganisationsMixin
 
       def initialize(xml:)
         @resource_type = :publication

data/lib/puree/xml_extractor/shared.rb

@@ -6,6 +6,23 @@ module Puree
     #
     module Shared
 
+      # @return [Puree::Model::ExternalOrganisationHeader]
+      def self.external_organisation_header(nokogiri_xml_element)
+        h = Puree::Model::ExternalOrganisationHeader.new
+        h.uuid = nokogiri_xml_element.xpath('@uuid').text.strip
+        h.name = nokogiri_xml_element.xpath('name').text.strip
+        h
+      end
+
+      # @return [Array<Puree::Model::ExternalOrganisationHeader>]
+      def self.external_organisation_multi_header(nokogiri_xml_nodeset)
+        data = []
+        nokogiri_xml_nodeset.each do |i|
+          data << external_organisation_header(i)
+        end
+        data.uniq { |d| d.uuid }
+      end
+
       # @return [Puree::Model::OrganisationHeader]
       def self.organisation_header(nokogiri_xml_element)
         h = Puree::Model::OrganisationHeader.new

data/spec/resource/project_http_spec.rb

@@ -23,10 +23,23 @@ describe 'Project' do
       expect(@p.acronym).to be_a String if @p.acronym
     end
 
+    # not present in stable API
+    # it '#associated' do
+    #   expect(@p.associated).to all( be_a Puree::Model::RelatedContentHeader )
+    # end
+
     it '#description' do
       expect(@p.description).to be_a String if @p.description
     end
 
+    it '#external_organisations' do
+      expect(@p.external_organisations).to all( be_a Puree::Model::ExternalOrganisationHeader )
+    end
+
+    it '#funded' do
+      expect(@p.funded).to be(true).or be(false)
+    end
+
     it '#organisations' do
       expect(@p.organisations).to all( be_a Puree::Model::OrganisationHeader )
     end

data/spec/resource/publication_http_spec.rb

@@ -17,6 +17,14 @@ describe 'Publication' do
       expect(@p).to be_a Puree::Model::Publication
     end
 
+    it '#associated' do
+      expect(@p.associated).to all( be_a Puree::Model::RelatedContentHeader )
+    end
+
+    it '#bibliographical_note' do
+      expect(@p.bibliographical_note).to be_a String if @p.bibliographical_note
+    end
+
     it '#category' do
       expect(@p.category).to be_a String if @p.category
     end
@@ -25,10 +33,30 @@ describe 'Publication' do
       expect(@p.description).to be_a String if @p.description
     end
 
+    it '#dois' do
+      expect(@p.dois).to all( be_a String )
+    end
+
+    it '#external_organisations' do
+      expect(@p.external_organisations).to all( be_a Puree::Model::ExternalOrganisationHeader )
+    end
+
     it '#files' do
       expect(@p.files).to all( be_a Puree::Model::File )
     end
 
+    it '#keywords' do
+      expect(@p.keywords).to all( be_a String )
+    end
+
+    it '#language' do
+      expect(@p.language).to be_a String if @p.language
+    end
+
+    it '#links' do
+      expect(@p.links).to all( be_a String )
+    end
+
     it '#organisations' do
       expect(@p.organisations).to all( be_a Puree::Model::OrganisationHeader )
     end
@@ -49,6 +77,14 @@ describe 'Publication' do
       expect(@p.persons_other).to all( be_a Puree::Model::EndeavourPerson )
     end
 
+    it '#publication_place' do
+      expect(@p.publication_place).to be_a String if @p.publication_place
+    end
+
+    it '#publisher' do
+      expect(@p.publisher).to be_a String if @p.publisher
+    end
+
     it '#statuses' do
       expect(@p.statuses).to all( be_a Puree::Model::PublicationStatus )
     end
@@ -61,14 +97,14 @@ describe 'Publication' do
       expect(@p.title).to be_a String if @p.title
     end
 
-    it '#translated_title' do
-      expect(@p.translated_title).to be_a String if @p.translated_title
-    end
-
     it '#translated_subtitle' do
       expect(@p.translated_subtitle).to be_a String if @p.translated_subtitle
     end
 
+    it '#translated_title' do
+      expect(@p.translated_title).to be_a String if @p.translated_title
+    end
+
     it '#type' do
       expect(@p.type).to be_a String if @p.type
     end

data/spec/spec_helper.rb

@@ -6,6 +6,14 @@ require 'puree/version'
 require 'puree/util/date'
 require 'puree/util/string'
 
+require 'puree/xml_extractor/mixins/associated_mixin'
+require 'puree/xml_extractor/mixins/doi_mixin'
+require 'puree/xml_extractor/mixins/event_mixin'
+require 'puree/xml_extractor/mixins/external_organisations_mixin'
+require 'puree/xml_extractor/mixins/pages_mixin'
+require 'puree/xml_extractor/mixins/page_range_mixin'
+require 'puree/xml_extractor/mixins/peer_reviewed_mixin'
+
 require 'puree/xml_extractor/shared'
 require 'puree/xml_extractor/base'
 require 'puree/xml_extractor/collection'
@@ -18,11 +26,6 @@ require 'puree/xml_extractor/organisation'
 require 'puree/xml_extractor/person'
 require 'puree/xml_extractor/project'
 
-require 'puree/xml_extractor/mixins/doi_mixin'
-require 'puree/xml_extractor/mixins/event_mixin'
-require 'puree/xml_extractor/mixins/pages_mixin'
-require 'puree/xml_extractor/mixins/page_range_mixin'
-require 'puree/xml_extractor/mixins/peer_reviewed_mixin'
 require 'puree/xml_extractor/publication'
 require 'puree/xml_extractor/thesis'
 require 'puree/xml_extractor/doctoral_thesis'
@@ -71,6 +74,7 @@ require 'puree/model/spatial_point'
 require 'puree/model/address'
 require 'puree/model/copyright_license'
 require 'puree/model/event_header'
+require 'puree/model/external_organisation_header'
 require 'puree/model/file'
 require 'puree/model/legal_condition'
 require 'puree/model/organisation_header'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -100,6 +100,7 @@ files:
 - lib/puree/model/endeavour_person.rb
 - lib/puree/model/event.rb
 - lib/puree/model/event_header.rb
+- lib/puree/model/external_organisation_header.rb
 - lib/puree/model/file.rb
 - lib/puree/model/helper/validation.rb
 - lib/puree/model/journal.rb
@@ -140,8 +141,10 @@ files:
 - 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/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/page_range_mixin.rb
 - lib/puree/xml_extractor/mixins/pages_mixin.rb
 - lib/puree/xml_extractor/mixins/peer_reviewed_mixin.rb