puree 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951d9defbfc0c08a02ce5a113e567fe2483bb0273fdaf6357b8b69b1af8f82d5
-  data.tar.gz: 644f09fe6de39e789ef0b186ece794a044bacc49aed60912d3c6ccf8cb6f958b
+  metadata.gz: d4e5029fa4e6560d831820e7a7852891d3d5aba9ab46fdc0b96d2db151ba0b07
+  data.tar.gz: 53c2ccd0e77dc22cc61b9e2813e6c97f8bc7c070074de26dde67dfe2b28c8575
 SHA512:
-  metadata.gz: 0c5ae5ad398b0f593d0a89535bddf7ac9b42335457305d60657176b933d42d56ece5ed3d45b8366e46002bfdc9c225682506898a7b6ad24e6d75198256f7b973
-  data.tar.gz: ce2ad05d7fe37585fa768988b506be9de69c927e8156fb1c51d8e48197bb416c3e6c58b2b87fad242f0a7da8dd347c587d0d97af77273612a3e346f79d779915
+  metadata.gz: 9764da69c66d18d6ff3f4ae53e35154f2ca509df28d157be2f751a576cbec4421b47ee722635de65850758493ec2d74148f9b70f081b791d7ca9bc1146d18184
+  data.tar.gz: 350872633c7a925cf81ef4c67a527b1205a720882860abf71ae81236c93c9adaccaa6f4f7e921efd4e92d06f9c52a51627fc3f1f032eeb7015a2533ced37f92e

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.5.0 2019-01-04
+### Added
+- REST timeouts.
+
+### Changed
+- For Pure API 511 due to change in source XML for Scopus ID in research output.
+
+### Added
+- Organisational unit - parents.
+
+### Fixed
+- Organisational unit - parent, for multiple parents. 
+
 ## 2.4.0 2018-10-17
 ### Added
 - Research output - dois.

data/README.md

@@ -25,13 +25,21 @@ Or install it yourself as:
 ```ruby
 # For Extractor and REST modules.
 config = {
-  url:      'https://YOUR_HOST/ws/api/59',
+  url:      'https://YOUR_HOST/ws/api/YOUR_API_VERSION',
   username: 'YOUR_USERNAME',
   password: 'YOUR_PASSWORD',
   api_key:  'YOUR_API_KEY'
 }
 ```
 
+Purée is tested using known data within a Pure installation.
+ 
+Purée version | Pure API version
+:---: | :---:
+< 2 | < 59
+< 2.5 |	59, 510
+2.5 |	511, 512
+
 ## Extractor module
 ```ruby
 # Configure an extractor for a resource

data/lib/puree/extractor/resource.rb

@@ -6,11 +6,7 @@ module Puree
     #
     class Resource
 
-      # @param config [Hash]
-      # @option config [String] :url URL of the Pure host
-      # @option config [String] :username Username of the Pure host account
-      # @option config [String] :password Password of the Pure host account
-      # @option config [String] :api_key API key of the Pure host account
+      # (see Puree::REST::Base#initialize)
       def initialize(config)
         @config = config
       end

data/lib/puree/model/dataset.rb

@@ -13,7 +13,7 @@ module Puree
       attr_accessor :description
 
       # Digital Object Identifier.
-      # @return [String, nil]
+      # @return [Puree::Model::DOI, nil]
       attr_accessor :doi
 
       # Supporting files.

data/lib/puree/model/organisational_unit.rb

@@ -17,6 +17,9 @@ module Puree
       # @return [Puree::Model::OrganisationalUnitHeader, nil]
       attr_accessor :parent
 
+      # @return [Array<Puree::Model::OrganisationalUnitHeader>]
+      attr_accessor :parents
+
       # @return [Array<String>]
       attr_accessor :phone_numbers
 

data/lib/puree/model/research_output.rb

@@ -14,10 +14,10 @@ module Puree
       # @return [String, nil]
       attr_accessor :description
 
-      # @return [String, nil]
+      # @return [Puree::Model::DOI, nil]
       attr_accessor :doi
 
-      # @return [Array<String>]
+      # @return [Array<Puree::Model::DOI>]
       attr_accessor :dois
 
       # @return [Array<Puree::Model::ExternalOrganisationHeader>]

data/lib/puree/rest/base.rb

@@ -13,7 +13,11 @@ module Puree
       # @option config [String] :username Username of the Pure host account
       # @option config [String] :password Password of the Pure host account
       # @option config [String] :api_key API key of the Pure host account
+      # @option config [Float] :http_read_timeout Read timeout in seconds
+      # @option config [Float] :http_write_timeout Write timeout in seconds
+      # @option config [Float] :http_connection_timeout Connection timeout in seconds
       def initialize(config)
+        config = http_defaults.merge config
         @http_client = HTTP::Client.new
         if config[:username] || config[:password]
           options = {}
@@ -22,6 +26,9 @@ module Puree
           @http_client = @http_client.basic_auth options
         end
         @http_client = @http_client.headers(api_key_header(config[:api_key]))
+        @http_client = @http_client.timeout read: config[:http_read_timeout],
+                                            write: config[:http_write_timeout],
+                                            connection: config[:http_connection_timeout]
         @url = config[:url]
       end
 
@@ -67,6 +74,14 @@ module Puree
 
       private
 
+      def http_defaults
+        {
+          http_read_timeout: 10,
+          http_write_timeout: 10,
+          http_connection_timeout: 10
+        }
+      end
+
       def accept_header(accept)
         case accept
           when :json

data/lib/puree/version.rb

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

data/lib/puree/xml_extractor/organisational_unit.rb

@@ -41,10 +41,17 @@ module Puree
         xpath_query_for_single_value '/name'
       end
 
+      # First parent
       # @return [Puree::Model::OrganisationalUnitHeader, nil]
       def parent
+        multiple_parents = parents
+        multiple_parents.empty? ? nil : multiple_parents.first
+      end
+
+      # @return [Array<Puree::Model::OrganisationalUnitHeader>]
+      def parents
         xpath_result = xpath_query '/parents/parent'
-        Puree::XMLExtractor::Shared.organisation_header xpath_result
+        Puree::XMLExtractor::Shared.organisation_multi_header xpath_result if xpath_result
       end
 
       # @return [Array<String>]
@@ -69,6 +76,7 @@ module Puree
         @model.email_addresses = email_addresses
         @model.name = name
         @model.parent = parent
+        @model.parents = parents
         @model.phone_numbers = phone_numbers
         @model.type = type
         @model.urls = urls

data/lib/puree/xml_extractor/research_output.rb

@@ -32,7 +32,7 @@ module Puree
       end
 
       # Digital Object Identifier (first one, if many)
-      # @return [String, nil]
+      # @return [Puree::Model::DOI, nil]
       def doi
         multiple_dois = dois
         multiple_dois.empty? ? nil : multiple_dois.first
@@ -129,11 +129,10 @@ module Puree
 
       # @return [String, nil]
       def scopus_id
-        xpath_result = xpath_query '/externalableInfo/secondarySources/secondarySource'
-        return if xpath_result.empty?
-        source = xpath_result.xpath('source')
-        if source && source.text.strip.downcase === 'scopus'
-          return xpath_result.xpath('sourceId').text.strip
+        external_identifiers.each do |i|
+          if i.type.downcase === 'scopus'
+            return i.id
+          end
         end
       end
 
@@ -203,6 +202,18 @@ module Puree
         @model
       end
 
+      def external_identifiers
+        xpath_result = xpath_query '/info/additionalExternalIds/id'
+        data = []
+        xpath_result.each do |d|
+          identifier = Puree::Model::Identifier.new
+          identifier.id = d.text.strip
+          identifier.type = d.attr('idSource').strip
+          data << identifier
+        end
+        data.uniq { |d| d.id }
+      end
+
     end
 
   end

data/test/xml_extractor/xml_extractor_dataset_test.rb

@@ -28,7 +28,7 @@ class TestXMLExtractorDataset < Minitest::Test
     refute_empty x.description
 
     assert_instance_of String, x.doi
-    refute_empty x.doi
+    refute_empty x.doi.to_s
 
     assert_instance_of Array, x.files
     assert_instance_of Puree::Model::File, x.files.first

data/test/xml_extractor/xml_extractor_organisation_test.rb

@@ -35,6 +35,10 @@ class TestXMLExtractorOrganisation < Minitest::Test
     assert_instance_of Puree::Model::OrganisationalUnitHeader, x.parent
     assert_equal true, x.parent.data?
 
+    assert_instance_of Array, x.parents
+    assert_instance_of Puree::Model::OrganisationalUnitHeader, x.parents.first
+    assert_equal true, x.parents.first.data?
+
     assert_instance_of Array, x.phone_numbers
     assert_instance_of String, x.phone_numbers.first
     refute_empty x.phone_numbers.first
@@ -60,6 +64,9 @@ class TestXMLExtractorOrganisation < Minitest::Test
 
     assert_nil x.parent
 
+    assert_instance_of Array, x.parents
+    assert_empty x.parents
+
     assert_instance_of Array, x.phone_numbers
     assert_empty x.phone_numbers
 

data/test/xml_extractor/xml_extractor_research_output_test.rb

@@ -31,7 +31,7 @@ class TestXMLExtractorResearchOutput < Minitest::Test
     refute_empty x.description
 
     assert_instance_of String, x.doi
-    refute_empty x.doi
+    refute_empty x.doi.to_s
 
     assert_instance_of Array, x.files
     assert_instance_of Puree::Model::File, x.files.first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http