puree 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 098c3fc6fe0dc9773261d20e4f2f8e021e9f8255
-  data.tar.gz: 49b91baf4a68f02a337b986c15f6fe35c67b4396
+  metadata.gz: 5010e60daa336c9d45804049400f946af67d8d9e
+  data.tar.gz: 9c6d97bce8924ad81b3213c9066b344f268811ea
 SHA512:
-  metadata.gz: d3670c89f2adb4ff43f1c262ab10dbb140b4ab5438103a267f63524894292a760e41fc4af0839243cb61688608375b1c996a0960fe31e902b483861dddd1c723
-  data.tar.gz: c962958c92997235fc5730e310e15593cdd9d3ad6c7ab9db7c60db7ef61577c0abac86cd3ee359385354753a4ff899a2dd46d397413e0e624fc56f53bfc8d6b1
+  metadata.gz: 1f15e9d9255f39007b9f1659c2210cfc061298b9e33d0df8fa67bea84a8ecb0d37f5f0de20816fc2da8c97d7c650f613d6afc8fdced6bc7700621b77a376a971
+  data.tar.gz: 2ce7fb3d3b2a7727fc8fea763e901fcc70c50daf04ab701df90be6e63f65fdf0c3628b53e28a8068a5b48cc6a056bc94fcdfe4a321717dbe5a41b4873d83eb2d

data/CHANGELOG.md

@@ -2,9 +2,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.11.0 - 2016-05-19
+### Added
+- Event metadata (city, country, date, description, location, title, type).
+- Organisation metadata (address, email, phone, type, url).
+
+### Changed
+- Dataset metadata (return string not array for description, title).
+- Publication metadata (return string not array for description, subtitle, title).
+
 ## 0.10.0 - 2016-05-17
 ### Added
 - Dataset metadata (associated, link, project, production as range, person for those without uuid, publication for all research outputs, publisher).
+
 ### Fixed
 - Dataset metadata (description splitting, geographical stripping).
 

data/README.md

@@ -48,10 +48,12 @@ d.doi
 d.file
 d.geographical
 d.keyword
+d.link
 d.person
-d.project
 d.production
+d.project
 d.publication
+d.publisher
 d.temporal
 d.title
 
@@ -215,7 +217,7 @@ An array of research outputs associated with the dataset.
 ]
 ```
 
-### temporal
+### production, temporal
 Date range. If year is present, month and day will have data or an empty string.
 
 ```ruby
@@ -233,6 +235,23 @@ Date range. If year is present, month and day will have data or an empty string.
 }
 ```
 
+## Organisation data structures
+
+### address
+An array of addresses.
+
+```ruby
+[
+  {
+    "street"=>"Lancaster University",
+    "building"=>"Bowland North",
+    "postcode"=>"LA1 4YN",
+    "city"=>"Lancaster",
+    "country"=>"United Kingdom"
+  }
+]
+```
+
 ## Publication data structures
 
 ### file
@@ -281,6 +300,7 @@ Resource metadata
 
 ```ruby
 :dataset
+:event
 :organisation
 :person
 :publication
@@ -298,6 +318,7 @@ Collections (for obtaining identifiers)
 
 ```ruby
 :dataset
+:event
 :journal
 :organisation
 :person

data/lib/puree.rb

@@ -4,6 +4,7 @@ require 'puree/date'
 require 'puree/map'
 require 'puree/resource'
 require 'puree/dataset'
+require 'puree/event'
 require 'puree/journal'
 require 'puree/organisation'
 require 'puree/person'

data/lib/puree/collection.rb

@@ -37,7 +37,7 @@ module Puree
         query['window.size'] = @options[:qty]
       end
 
-      @response = HTTParty.get(url, query: query, headers: headers)
+      @response = HTTParty.get(build_url, query: query, headers: headers)
     end
 
 

data/lib/puree/dataset.rb

@@ -17,8 +17,8 @@ module Puree
       data = []
       xpath_result.each { |i|
         o = {}
-        o['url'] = i.xpath('url').text
-        o['description'] = i.xpath('description').text
+        o['url'] = i.xpath('url').text.strip
+        o['description'] = i.xpath('description').text.strip
         data << o
       }
       return data.uniq
@@ -30,7 +30,7 @@ module Puree
     def publisher
       path = '//publisher/name'
       xpath_result =  xpath_query path
-      xpath_result ? xpath_result.text : ''
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # Combines project and publication
@@ -42,15 +42,14 @@ module Puree
       data_arr = []
       xpath_result.each { |i|
         data = {}
-        data['type'] = i.xpath('typeClassification').text
-        data['title'] = i.xpath('title').text
-        data['uuid'] = i.attr('uuid')
+        data['type'] = i.xpath('typeClassification').text.strip
+        data['title'] = i.xpath('title').text.strip
+        data['uuid'] = i.attr('uuid').strip
         data_arr << data
       }
       data_arr.uniq
     end
 
-
     # Project
     #
     # @return [Array<Hash>]
@@ -74,41 +73,30 @@ module Puree
 
     # Title
     #
-    # @return [Array<String>]
+    # @return [String]
     def title
-      data = node 'title'
-      data_arr = []
-      if !data.nil? && !data.empty?
-        data = data['localizedString']["__content__"]
-        data.is_a?(Array) ? data_arr = data : data_arr << data
-      end
-      data_arr.uniq
+      path = '//title/localizedString'
+      xpath_result =  xpath_query path
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # Keyword
     #
     # @return [Array<String>]
     def keyword
-      data = node 'keywordGroups'
-      data_arr = []
-      if !data.nil? && !data.empty?
-        data = data['keywordGroup']['keyword']['userDefinedKeyword']['freeKeyword']
-        data.is_a?(Array) ? data_arr = data : data_arr << data
-      end
+      path = '//keywordGroups/keywordGroup/keyword/userDefinedKeyword/freeKeyword'
+      xpath_result =  xpath_query path
+      data_arr = xpath_result.map { |i| i.text.strip }
       data_arr.uniq
     end
 
     # Description
     #
-    # @return [Array<String>]
+    # @return [String]
     def description
-      data = node 'descriptions'
-      data_arr = []
-      if !data.nil? && !data.empty?
-        data = data['classificationDefinedField']['value']['localizedString']['__content__'].tr("\n", '')
-        data.is_a?(Array) ? data_arr = data : data_arr << data
-      end
-      data_arr.uniq
+      path = '//descriptions/classificationDefinedField/value/localizedString'
+      xpath_result =  xpath_query path
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # Person (internal, external, other)
@@ -130,11 +118,11 @@ module Puree
           data.each do |d|
             person = generic_person d
             if d.key? 'person'
-              person['uuid'] = d['person']['uuid']
+              person['uuid'] = d['person']['uuid'].strip
               internal_persons << person
             end
             if d.key? 'externalPerson'
-              person['uuid'] = d['externalPerson']['uuid']
+              person['uuid'] = d['externalPerson']['uuid'].strip
               external_persons << person
             end
             if !d.key?('person') && !d.key?('externalPerson')
@@ -145,11 +133,11 @@ module Puree
         when Hash
           person = generic_person data
           if data.key? 'person'
-            person['uuid'] = data['person']['uuid']
+            person['uuid'] = data['person']['uuid'].strip
             internal_persons << person
           end
           if data.key? 'externalPerson'
-            person['uuid'] = data['externalPerson']['uuid']
+            person['uuid'] = data['externalPerson']['uuid'].strip
             external_persons << person
           end
           if !data.key?('person') && !data.key?('externalPerson')
@@ -206,7 +194,7 @@ module Puree
     # @return [String]
     def access
       data = node 'openAccessPermission'
-      !data.nil? && !data.empty? ? data['term']['localizedString']["__content__"] : ''
+      !data.nil? && !data.empty? ? data['term']['localizedString']["__content__"].strip : ''
     end
 
 
@@ -214,41 +202,31 @@ module Puree
     #
     # @return [Array<Hash>]
     def file
-      data = node 'documents'
+      path = '//documents/document'
+      xpath_result =  xpath_query path
 
       docs = []
-      if !data.nil? && !data.empty?
-        # convert to array
-        data_arr = []
-        if data['document'].is_a?(Array)
-          data_arr = data['document']
-        else
-          data_arr << data['document']
-        end
 
-        data_arr.each do |d|
-          doc = {}
-          # doc['id'] = d['id']
-          doc['name'] = d['fileName']
-          doc['mime'] = d['mimeType']
-          doc['size'] = d['size']
-          doc['url'] = d['url']
-          doc['title'] = d['title']
-          # doc['createdDate'] = doc['createdDate']
-          # doc['visibleOnPortalDate'] = doc['visibleOnPortalDate']
-          # doc['limitedVisibility'] = doc['limitedVisibility']
-
-          license = {}
-          if d['documentLicense']
-            license_name = d['documentLicense']['term']['localizedString']['__content__']
-            license['name'] = license_name
-            license_url = d['documentLicense']['description']['localizedString']['__content__']
-            license['url'] = license_url
-            doc['license'] = license
-          end
-          docs << doc
+      xpath_result.each do |d|
+        doc = {}
+        # doc['id'] = f.xpath('id').text.strip
+        doc['name'] = d.xpath('fileName').text.strip
+        doc['mime'] = d.xpath('mimeType').text.strip
+        doc['size'] = d.xpath('size').text.strip
+        doc['url'] = d.xpath('url').text.strip
+        doc['title'] = d.xpath('title').text.strip
+        # doc['createdDate'] = d.xpath('createdDate').text.strip
+        # doc['visibleOnPortalDate'] = d.xpath('visibleOnPortalDate').text.strip
+        # doc['limitedVisibility'] = d.xpath('limitedVisibility').text.strip
+
+        license = {}
+        license_name = d.xpath('documentLicense/term/localizedString').text.strip
+        license['name'] = license_name
+        license_url = d.xpath('documentLicense/description/localizedString').text.strip
+        license['url'] = license_url
+        doc['license'] = license
+        docs << doc
 
-        end
       end
       docs.uniq
     end
@@ -257,8 +235,9 @@ module Puree
     #
     # @return [String]
     def doi
-      data = node 'doi'
-      !data.nil? && !data.empty? ? data['doi'] : ''
+      path = '//content/doi'
+      xpath_result =  xpath_query path
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # def state

data/lib/puree/event.rb

@@ -0,0 +1,88 @@
+module Puree
+
+  # Event resource
+  #
+  class Event < Resource
+
+    def initialize
+      super(:event)
+    end
+
+    # City
+    #
+    # @return [String]
+    def city
+      path = '//city'
+      xpath_query(path).text.strip
+    end
+
+    # Country
+    #
+    # @return [String]
+    def country
+      path = '//country/term/localizedString'
+      xpath_query(path).text.strip
+    end
+
+    # Date
+    #
+    # @return [Hash]
+    def date
+      data = {}
+      path = '//dateRange'
+      range = xpath_query path
+      data['start'] = range.xpath('startDate').text.strip
+      data['end'] = range.xpath('startDate').text.strip
+      data
+    end
+
+    # Description
+    #
+    # @return [String]
+    def description
+      path = '//content/description'
+      xpath_query(path).text.strip
+    end
+
+    # Location
+    #
+    # @return [String]
+    def location
+      path = '//location'
+      xpath_query(path).text.strip
+    end
+
+    # Title
+    #
+    # @return [String]
+    def title
+      path = '//title/localizedString'
+      xpath_query(path).text.strip
+    end
+
+    # Type
+    #
+    # @return [String]
+    def type
+      path = '//content/typeClassification/term/localizedString'
+      xpath_query(path).text.strip
+    end
+
+    # All metadata
+    #
+    # @return [Hash]
+    def metadata
+      o = {}
+      o['city'] = city
+      o['country'] = country
+      o['date'] = date
+      o['description'] = description
+      o['location'] = location
+      o['title'] = title
+      o['type'] = type
+      o
+    end
+
+  end
+
+end

data/lib/puree/map.rb

@@ -4,6 +4,7 @@ module Puree
 
     def initialize
       @convention = %w(
+        event
         journal
         organisation
         person

data/lib/puree/organisation.rb

@@ -8,12 +8,75 @@ module Puree
       super(:organisation)
     end
 
+    # Address
+    #
+    # @return [Array<Hash>]
+    def address
+      path = '//addresses/classifiedAddress'
+      xpath_result =  xpath_query path
+
+      data = []
+
+      xpath_result.each do |d|
+        o = {}
+        o['street'] = d.xpath('street').text.strip
+        o['building'] = d.xpath('building').text.strip
+        o['postcode'] = d.xpath('postalCode').text.strip
+        o['city'] = d.xpath('city').text.strip
+        o['country'] = d.xpath('country/term/localizedString').text.strip
+        data << o
+      end
+      data.uniq
+    end
+
+    # Email
+    #
+    # @return [Array<String>]
+    def email
+      path = '//emails/classificationDefinedStringFieldExtension/value'
+      xpath_result =  xpath_query path
+      arr = []
+      xpath_result.each { |i| arr << i.text.strip }
+      arr.uniq
+    end
+
     # Name
     #
     # @return [String]
     def name
       data = node 'name'
-      !data.nil? && !data.empty? ? data['localizedString']['__content__'] : ''
+      !data.nil? && !data.empty? ? data['localizedString']['__content__'].strip : ''
+    end
+
+    # Phone
+    #
+    # @return [Array<String>]
+    def phone
+      path = '//phoneNumbers/classificationDefinedStringFieldExtension/value'
+      xpath_result =  xpath_query path
+      arr = []
+      xpath_result.each { |i| arr << i.text.strip }
+      arr.uniq
+    end
+
+    # Type
+    #
+    # @return [String]
+    def type
+      path = '//content/typeClassification/term/localizedString'
+      xpath_result =  xpath_query path
+      xpath_result ? xpath_result.text.strip : ''
+    end
+
+    # URL
+    #
+    # @return [Array<String>]
+    def url
+      path = '//content/webAddresses/classificationDefinedFieldExtension/value/localizedString'
+      xpath_result =  xpath_query path
+      arr = []
+      xpath_result.each { |i| arr << i.text.strip }
+      arr.uniq
     end
 
     # All metadata
@@ -21,7 +84,12 @@ module Puree
     # @return [Hash]
     def metadata
       o = {}
+      o['address'] = address
+      o['email'] = email
       o['name'] = name
+      o['phone'] = phone
+      o['type'] = type
+      o['url'] = url
       o
     end
 

data/lib/puree/person.rb

@@ -48,8 +48,8 @@ module Puree
       data = node 'name'
       o = {}
       if !data.nil? && !data.empty?
-        o['first'] = data['firstName']
-        o['last'] = data['lastName']
+        o['first'] = data['firstName'].strip
+        o['last'] = data['lastName'].strip
       end
       o
     end
@@ -59,7 +59,7 @@ module Puree
     # @return [String]
     def orcid
       data = node 'orcid'
-      !data.nil? && !data.empty? ? data : ''
+      !data.nil? && !data.empty? ? data.strip : ''
     end
 
     # All metadata

data/lib/puree/publication.rb

@@ -10,13 +10,11 @@ module Puree
 
     # Description
     #
-    # @return [Array<String>]
+    # @return [String]
     def description
       path = '//abstract/localizedString'
       xpath_result =  xpath_query path
-      data_arr = []
-      xpath_result.each { |i| data_arr << i.text }
-      data_arr.uniq
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # Digital Object Identifier
@@ -25,7 +23,7 @@ module Puree
     def doi
       path = '//doi'
       xpath_result =  xpath_query path
-      xpath_result ? xpath_result.text : ''
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # Supporting file
@@ -38,10 +36,10 @@ module Puree
       xpath_result.each do |d|
         doc = {}
         # doc['id'] = d.xpath('id').text
-        doc['name'] = d.xpath('fileName').text
-        doc['mime'] = d.xpath('mimeType').text
-        doc['size'] = d.xpath('size').text
-        doc['url'] = d.xpath('url').text
+        doc['name'] = d.xpath('fileName').text.strip
+        doc['mime'] = d.xpath('mimeType').text.strip
+        doc['size'] = d.xpath('size').text.strip
+        doc['url'] = d.xpath('url').text.strip
         docs << doc
       end
       docs.uniq
@@ -49,24 +47,20 @@ module Puree
 
     # Title
     #
-    # @return [Array<String>]
+    # @return [String]
     def title
       path = '//content/title'
       xpath_result =  xpath_query path
-      data_arr = []
-      xpath_result.each { |i| data_arr << i.text }
-      data_arr.uniq
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # Subtitle
     #
-    # @return [Array<String>]
+    # @return [String]
     def subtitle
       path = '//content/subtitle'
       xpath_result =  xpath_query path
-      data_arr = []
-      xpath_result.each { |i| data_arr << i.text }
-      data_arr.uniq
+      xpath_result ? xpath_result.text.strip : ''
     end
 
     # All metadata

data/lib/puree/resource.rb

@@ -43,7 +43,11 @@ module Puree
         end
       end
 
-      @response = HTTParty.get(url, query: query, headers: headers)
+      begin
+        @response = HTTParty.get(build_url, query: query, headers: headers, timeout: 120)
+      rescue HTTParty::Error => e
+        puts 'HttParty::Error '+ e.message
+      end
 
       if get_data?
         response_name = service_response_name
@@ -111,7 +115,7 @@ module Puree
       @api_map[:resource_type][resource_type][:response]
     end
 
-    def url
+    def build_url
       service = service_name
       if @options[:latest_api] === false
         service_api_mode = service

data/lib/puree/version.rb

@@ -1,3 +1,3 @@
 module Puree
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/spec/dataset.rb

@@ -20,54 +20,75 @@ describe 'Dataset' do
              uuid: uuid
     end
 
-    it '#title' do
-      expect(@p.title).to be_an_instance_of(Array)
+    it '#access' do
+      expect(@p.access).to be_an_instance_of(String)
     end
 
-    it '#keyword' do
-      expect(@p.keyword).to be_an_instance_of(Array)
+    it '#associated' do
+      expect(@p.associated).to be_an_instance_of(Array)
     end
 
-    it '#description' do
-      expect(@p.description).to be_an_instance_of(Array)
+    it '#available' do
+      expect(@p.available).to be_an_instance_of(Hash)
     end
 
-    it '#person' do
-      expect(@p.person).to be_an_instance_of(Hash)
+    it '#description' do
+      expect(@p.description).to be_an_instance_of(String)
     end
 
-    it '#publication' do
-      expect(@p.publication).to be_an_instance_of(Array)
+    it '#doi' do
+      expect(@p.doi).to be_an_instance_of(String)
     end
 
-    it '#available' do
-      expect(@p.available).to be_an_instance_of(Hash)
+    it '#file' do
+      expect(@p.file).to be_an_instance_of(Array)
     end
 
     it '#geographical' do
       expect(@p.geographical).to be_an_instance_of(Array)
     end
 
-    it '#temporal' do
-      expect(@p.temporal).to be_an_instance_of(Hash)
+    it '#keyword' do
+      expect(@p.keyword).to be_an_instance_of(Array)
     end
 
-    it '#access' do
-      expect(@p.access).to be_an_instance_of(String)
+    it '#link' do
+      expect(@p.link).to be_an_instance_of(Array)
     end
 
-    it '#file' do
-      expect(@p.file).to be_an_instance_of(Array)
+    it '#metadata' do
+      expect(@p.metadata).to be_an_instance_of(Hash)
     end
 
-    it '#doi' do
-      expect(@p.doi).to be_an_instance_of(String)
+    it '#person' do
+      expect(@p.person).to be_an_instance_of(Hash)
     end
 
-    it '#metadata' do
-      expect(@p.metadata).to be_an_instance_of(Hash)
+    it '#production' do
+      expect(@p.production).to be_an_instance_of(Hash)
+    end
+
+    it '#project' do
+      expect(@p.project).to be_an_instance_of(Array)
     end
 
+    it '#publication' do
+      expect(@p.publication).to be_an_instance_of(Array)
+    end
+
+    it '#publisher' do
+      expect(@p.publisher).to be_an_instance_of(String)
+    end
+
+    it '#temporal' do
+      expect(@p.temporal).to be_an_instance_of(Hash)
+    end
+
+    it '#title' do
+      expect(@p.title).to be_an_instance_of(String)
+    end
+
+
   end
 
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'puree/date'
 require 'puree/map'
 require 'puree/resource'
 require 'puree/dataset'
+require 'puree/event'
 require 'puree/journal'
 require 'puree/organisation'
 require 'puree/person'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -56,6 +56,7 @@ files:
 - lib/puree/collection.rb
 - lib/puree/dataset.rb
 - lib/puree/date.rb
+- lib/puree/event.rb
 - lib/puree/journal.rb
 - lib/puree/map.rb
 - lib/puree/organisation.rb