puree 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5f9f37e95e788189e6f4acb7a066e5732e157e8
-  data.tar.gz: b1f37ec7f78e5adef5d0443f565b5526bc2f85c9
+  metadata.gz: 585ed698743104873457d87a11f27bb057dbf058
+  data.tar.gz: d07c203393a1bf086334717f3ba1a7522b6ad112
 SHA512:
-  metadata.gz: 7356834acf18066281420d8794360b747828f684fe7a709f22b01a38f4cc2c67768a66aa7f72f4b3b7c7b227014115a8eae66d22e1f77221e892b5ecfc56b33d
-  data.tar.gz: 499e3b30bedd4b2d08c957f041fd070488a63af104f5bcc06689f3df2a0086e6b290d35c2e39370c9c43aafbe5785f43439e6eacaf6aa2aabfea2e92de803560
+  metadata.gz: 18bf2dc5e85692a4a9f575426c8716ace87239070f84545a57de4cb9936ebee91c4321ac53a1e87e0fe7ad20409c663efd3fe09f434ac28487e15acacfc343bb
+  data.tar.gz: 0e6696e6c19c715186622a29bb73e2175a8ed0aed1c69bf220aed3d03f9653fbe86614ee317657d56c276d9779fc582b54aba324e0030d540b41e13c5a45a6fd

data/CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## Unreleased
 - Metadata: activity?, clipping?, externalPerson?
 
+## 1.7.0 - 2017-11-03
+### Added
+- Person extractor - find by identifier.
+- Person - HESA id, Scopus id.
+
+### Fixed
+- Person - employee_id presence.
+
 ## 1.6.0 - 2017-10-24
 ### Added
 - ExternalOrganisation.

data/README.md

@@ -1,4 +1,4 @@
-     # Purée
+# Purée
 
 Metadata extraction from the Pure Research Information System.
 
@@ -126,7 +126,7 @@ funding_query.project_funders uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 #<Puree::Model::ExternalOrganisation:0x98986f0>
 ```
 
-Who are the funders (if any) for a publication, via a project?
+Who are the funders (if any) for a publication?
 
 ```ruby
 funding_query.publication_funders uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'

data/lib/puree.rb

@@ -42,6 +42,7 @@ require 'puree/xml_extractor/server'
 
 require 'puree/api/map'
 require 'puree/api/request'
+require 'puree/api/person_request'
 require 'puree/api/configuration'
 require 'puree/api/authentication'
 

data/lib/puree/api/person_request.rb

@@ -0,0 +1,64 @@
+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

data/lib/puree/api/request.rb

@@ -25,6 +25,7 @@ module Puree
       #
       # @param uuid [String]
       # @param id [String]
+      # @param params [Hash]
       # @param rendering [String]
       # @param latest_api [Boolean]
       # @param resource_type [String]
@@ -38,6 +39,7 @@ module Puree
       # @return [HTTP::Response]
       def get(uuid: nil,
               id: nil,
+              params: {},
               rendering: :xml_long,
               latest_api: true,
               resource_type:,
@@ -53,6 +55,7 @@ module Puree
             @rendering =      rendering
             @uuid =           uuid
             @id =             id
+            @params =         params
             @limit =          limit
             @offset =         offset
             @created_start =  created_start
@@ -68,12 +71,12 @@ module Puree
         if @headers['Authorization']
           @req = @req.auth @headers['Authorization']
         end
-        @req.get(build_url, params: params)
+        @req.get(build_url, params: parameters)
       end
 
       private
 
-      def params
+      def parameters
         query = {}
         if @uuid
           query['uuids.uuid'] = @uuid

data/lib/puree/extractor/dataset.rb

@@ -42,6 +42,18 @@ module Puree
         @model
       end
 
+      def configure_api(config)
+        @config = Puree::API::Configuration.new url: config[:url]
+        @config.basic_auth username: config[:username],
+                           password: config[:password]
+
+        @request = Puree::API::PersonRequest.new url: @config.url
+        if @config.basic_auth?
+          @request.basic_auth username: @config.username,
+                              password: @config.password
+        end
+      end
+
     end
 
   end

data/lib/puree/extractor/person.rb

@@ -12,6 +12,22 @@ module Puree
         setup :person
       end
 
+      # Find a person by identifier.
+      #
+      # @param uuid [String]
+      # @param id [String]
+      # @param employee_id [String]
+      # @return [Puree::Model::Person]
+      def find_by_id(uuid: nil, id: nil, employee_id: nil)
+        raise 'Cannot perform a request without a configuration' if @config.nil?
+        @response = @request.get uuid:           uuid,
+                                 id:             id,
+                                 employee_id:    employee_id,
+                                 latest_api:     @latest_api,
+                                 resource_type:  @resource_type
+        set_content @response.body
+      end
+
       private
 
       def combine_metadata
@@ -19,13 +35,33 @@ module Puree
         @model.affiliations = @extractor.affiliations
         @model.email_addresses = @extractor.email_addresses
         @model.employee_id = @extractor.employee_id
+        @model.hesa_id = @extractor.hesa_id
         @model.image_urls = @extractor.image_urls
         @model.keywords = @extractor.keywords
         @model.name = @extractor.name
         @model.orcid = @extractor.orcid
+        @model.scopus_id = @extractor.scopus_id
         @model
       end
 
+      # 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::PersonRequest.new url: @config.url
+        if @config.basic_auth?
+          @request.basic_auth username: @config.username,
+                              password: @config.password
+        end
+      end
+
     end
 
   end

data/lib/puree/model/person.rb

@@ -14,6 +14,9 @@ module Puree
       # @return [String, nil]
       attr_accessor :employee_id
 
+      # @return [String, nil]
+      attr_accessor :hesa_id
+
       # @return [Array<String>]
       attr_accessor :image_urls
 
@@ -26,6 +29,9 @@ module Puree
       # @return [String, nil]
       attr_accessor :orcid
 
+      # @return [String, nil]
+      attr_accessor :scopus_id
+
     end
   end
 end

data/lib/puree/query/funding.rb

@@ -26,7 +26,7 @@ module Puree
             end
           end
         end
-        deduplicate_funders funders
+        funders.uniq { |i| i.uuid }
       end
 
       # Publication funders
@@ -44,22 +44,7 @@ module Puree
             end
           end
         end
-        deduplicate_funders funders
-      end
-
-      private
-
-      def deduplicate_funders(funders)
-        uuids_in_list = []
-        funder_list = []
-        funders.each do |funder|
-          uuid = funder.uuid
-          unless uuids_in_list.include? uuid
-            funder_list << funder
-            uuids_in_list << uuid
-          end
-        end
-        funder_list
+        funders.uniq { |i| i.uuid }
       end
 
     end

data/lib/puree/version.rb

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

data/lib/puree/xml_extractor/person.rb

@@ -24,14 +24,12 @@ module Puree
 
       # @return [String, nil]
       def employee_id
-        xpath_result = xpath_query '/sources/classificationDefinedStringFieldExtension'
-        if xpath_result
-          xpath_result.each do |i|
-            if i.xpath('classification/uri').text.strip === '/dk/atira/pure/person/personsources/employee'
-              return i.xpath('value').text.strip
-            end
-          end
-        end
+        id '/dk/atira/pure/person/personsources/employee'
+      end
+
+      # @return [String, nil]
+      def hesa_id
+        id '/dk/atira/pure/person/personsources/hesastaff'
       end
 
       # @return [Array<String>]
@@ -62,6 +60,26 @@ module Puree
         xpath_query_for_single_value '/orcid'
       end
 
+      # @return [String, nil]
+      def scopus_id
+        id '/dk/atira/pure/person/personsources/scopusauthor'
+      end
+
+      private
+
+      # @return [String, nil]
+      def id(uri)
+        xpath_result = xpath_query '/sources/classificationDefinedStringFieldExtension'
+        if xpath_result
+          xpath_result.each do |i|
+            if i.xpath('classification/uri').text.strip === uri
+              return i.xpath('value').text.strip
+            end
+          end
+        end
+        nil
+      end
+
     end
 
   end

data/spec/query/person_http_spec.rb

@@ -25,6 +25,28 @@ describe 'Person' do
       expect(publications).to all( be_a Puree::Model::Publication )
     end
 
+    it '#publications_offset' do
+      publications = @q.publications uuid: @person_uuid,
+                                     limit: 3,
+                                     offset: 1
+      expect(publications).to all( be_a Puree::Model::Publication )
+    end
+
+    it '#publications_published_start' do
+      publications = @q.publications uuid: @person_uuid,
+                                     limit: 3,
+                                     published_start: '2017-01-01'
+      expect(publications).to all( be_a Puree::Model::Publication )
+    end
+
+    it '#publications_published_start_published_end' do
+      publications = @q.publications uuid: @person_uuid,
+                                     limit: 3,
+                                     published_start: '2017-01-01',
+                                     published_end: '2017-12-31'
+      expect(publications).to all( be_a Puree::Model::Publication )
+    end
+
   end
 
 end

data/spec/resource/person_http_spec.rb

@@ -31,6 +31,10 @@ describe 'Person' do
       expect(@p.employee_id).to be_a String if @p.employee_id
     end
 
+    it '#hesa_id' do
+      expect(@p.hesa_id).to be_a String if @p.hesa_id
+    end
+
     it '#image_urls' do
       expect(@p.image_urls).to all( be_a String )
     end
@@ -47,6 +51,10 @@ describe 'Person' do
       expect(@p.orcid).to be_a String if @p.orcid
     end
 
+    it '#scopus_id' do
+      expect(@p.scopus_id).to be_a String if @p.scopus_id
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -42,6 +42,7 @@ require 'puree/xml_extractor/server'
 
 require 'puree/api/map'
 require 'puree/api/request'
+require 'puree/api/person_request'
 require 'puree/api/configuration'
 require 'puree/api/authentication'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -70,6 +70,7 @@ files:
 - 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