puree 0.14.0 → 0.15.0

data/lib/puree/project.rb

@@ -7,18 +7,178 @@ module Puree
     # @param endpoint [String]
     # @param optional username [String]
     # @param optional password [String]
-    def initialize(endpoint: nil, username: nil, password: nil)
+    # @param optional basic_auth [Boolean]
+    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
       super(api: :project,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            bleeding: false,
+            basic_auth: basic_auth)
+    end
+
+
+
+    # Acronym
+    #
+    # @return [String]
+    def acronym
+      path = '/acronym'
+      xpath_query_for_single_value path
+    end
+
+    # Description
+    #
+    # @return [String]
+    def description
+      path = '/description/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    # Organisation
+    #
+    # @return [Array<Hash>]
+    def organisation
+      path = '/organisations/association/organisation'
+      xpath_result = xpath_query path
+      data = []
+      xpath_result.each do |i|
+        o = {}
+        o['uuid'] = i.xpath('@uuid').text.strip
+        o['name'] = i.xpath('name/localizedString').text.strip
+        o['type'] = i.xpath('typeClassification/term/localizedString').text.strip
+        data << o
+      end
+      data
+    end
+
+    # Owner
+    #
+    # @return [Hash]
+    def owner
+      path = '/owner'
+      xpath_result =  xpath_query path
+      o = {}
+      o['uuid'] = xpath_result.xpath('@uuid').text.strip
+      o['name'] = xpath_result.xpath('name/localizedString').text.strip
+      o['type'] = xpath_result.xpath('typeClassification/term/localizedString').text.strip
+      o
+    end
+
+    # Person (internal, external, other)
+    #
+    # @return [Array<Hash>]
+    def person
+      data = {}
+      # internal
+      path = '/persons/participantAssociation'
+      xpath_result = xpath_query path
+      internal = []
+      external = []
+      other = []
+
+      xpath_result.each do |i|
+        o = {}
+        name = {}
+        name['first'] = i.xpath('person/name/firstName').text.strip
+        name['last'] = i.xpath('person/name/lastName').text.strip
+        o['name'] = name
+        o['role'] = i.xpath('personRole/term/localizedString').text.strip
+
+        uuid_internal = i.at_xpath('person/@uuid')
+        uuid_external = i.at_xpath('externalPerson/@uuid')
+        if uuid_internal
+          o['uuid'] = uuid_internal
+          internal << o
+        elsif uuid_external
+          o['uuid'] = uuid_external
+          external << o
+        else
+          other << o
+          o['uuid'] = ''
+        end
+      end
+      data['internal'] = internal
+      data['external'] = external
+      data['other'] = other
+      data
+    end
+
+    # Status
+    #
+    # @return [String]
+    def status
+      path = '/status/term/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    # Temporal, expected and actual start and end dates as UTC datetime.
+    #
+    # @return [Hash]
+    def temporal
+      o = {}
+      o['expected'] = {}
+      o['actual'] = {}
+
+      path = '/expectedStartDate'
+      xpath_result =  xpath_query path
+      o['expected']['start'] = xpath_result.text.strip
+
+      path = '/expectedEndDate'
+      xpath_result =  xpath_query path
+      o['expected']['end'] = xpath_result.text.strip
+
+      path = '/startFinishDate/startDate'
+      xpath_result =  xpath_query path
+      o['actual']['start'] = xpath_result.text.strip
+
+      path = '/startFinishDate/endDate'
+      xpath_result =  xpath_query path
+      o['actual']['end'] = xpath_result.text.strip
+
+      o
+    end
+
+    # Title
+    #
+    # @return [String]
+    def title
+      path = '/title/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    # Type
+    #
+    # @return [String]
+    def type
+      path = '/typeClassification/term/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    # URL
+    #
+    # @return [String]
+    def url
+      path = '/projectURL'
+      xpath_query_for_single_value path
     end
 
     # All metadata
     #
     # @return [Hash]
     def metadata
-      super
+      o = super
+      o['acronym'] = acronym
+      o['description'] = description
+      o['organisation'] = organisation
+      o['owner'] = owner
+      o['person'] = person
+      o['status'] = status
+      o['temporal'] = temporal
+      o['title'] = title
+      o['type'] = type
+      o['url'] = url
+      o
     end
 
   end

data/lib/puree/publication.rb

@@ -7,20 +7,41 @@ module Puree
     # @param endpoint [String]
     # @param optional username [String]
     # @param optional password [String]
-    def initialize(endpoint: nil, username: nil, password: nil)
+    # @param optional basic_auth [Boolean]
+    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
       super(api: :publication,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
+    end
+
+    # Category
+    #
+    # @return [String]
+    def category
+      path = '/publicationCategory/publicationCategory/term/localizedString'
+      xpath_query_for_single_value path
     end
 
     # Description
     #
     # @return [String]
     def description
-      path = '//abstract/localizedString'
-      xpath_result =  xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/abstract/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    # Event
+    #
+    # @return [Hash]
+    def event
+      path = '/event'
+      xpath_result = xpath_query path
+      o = {}
+      o['uuid'] = xpath_result.xpath('@uuid').text.strip
+      o['title'] = xpath_result.xpath('title/localizedString').text.strip
+      o
     end
 
     # Digital Object Identifier
@@ -28,16 +49,15 @@ module Puree
     # @return [String]
     def doi
       path = '//doi'
-      xpath_result =  xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      xpath_query_for_single_value path
     end
 
     # Supporting file
     #
     # @return [Array<Hash>]
     def file
-      path = '//electronicVersionFileAssociations/electronicVersionFileAssociation/file'
-      xpath_result =  xpath_query path
+      path = '/electronicVersionAssociations/electronicVersionFileAssociations/electronicVersionFileAssociation/file'
+      xpath_result = xpath_query path
       docs = []
       xpath_result.each do |d|
         doc = {}
@@ -51,22 +71,112 @@ module Puree
       docs.uniq
     end
 
+    # Organisation
+    #
+    # @return [Array<Hash>]
+    def organisation
+      path = '/organisations/association/organisation'
+      xpath_result = xpath_query path
+      data = []
+      xpath_result.each do |i|
+        o = {}
+        o['uuid'] = i.xpath('@uuid').text.strip
+        o['name'] = i.xpath('name/localizedString').text.strip
+        o['type'] = i.xpath('typeClassification/term/localizedString').text.strip
+        data << o
+      end
+      data
+    end
+
+    # Page
+    #
+    # @return [Array<String>]
+    def page
+      path = '/numberOfPages'
+      xpath_query_for_single_value path
+    end
+
+    # Person (internal, external, other)
+    #
+    # @return [Array<Hash>]
+    def person
+      data = {}
+      # internal
+      path = '/persons/personAssociation'
+      xpath_result = xpath_query path
+      internal = []
+      external = []
+      other = []
+
+      xpath_result.each do |i|
+        o = {}
+        name = {}
+        name['first'] = i.xpath('name/firstName').text.strip
+        name['last'] = i.xpath('name/lastName').text.strip
+        o['name'] = name
+        o['role'] = i.xpath('personRole/term/localizedString').text.strip
+
+        uuid_internal = i.at_xpath('person/@uuid')
+        uuid_external = i.at_xpath('externalPerson/@uuid')
+        if uuid_internal
+          o['uuid'] = uuid_internal
+          internal << o
+        elsif uuid_external
+          o['uuid'] = uuid_external
+          external << o
+        else
+          other << o
+          o['uuid'] = ''
+        end
+      end
+      data['internal'] = internal
+      data['external'] = external
+      data['other'] = other
+      data
+    end
+
+    # Status
+    #
+    # @return [Array<Hash>]
+    def status
+      path = '/publicationStatuses/publicationStatus'
+      xpath_result = xpath_query path
+      data = []
+      xpath_result.each do |i|
+        o = {}
+        o['stage'] = i.xpath('publicationStatus/term/localizedString').text.strip
+        ymd = {}
+        ymd['year'] = i.xpath('publicationDate/year').text.strip
+        ymd['month'] = i.xpath('publicationDate/month').text.strip
+        ymd['day'] = i.xpath('publicationDate/day').text.strip
+        o['date'] = Puree::Date.normalise(ymd)
+        data << o
+      end
+      data
+    end
+
     # Title
     #
     # @return [String]
     def title
-      path = '//content/title'
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/title'
+      xpath_query_for_single_value path
     end
 
     # Subtitle
     #
     # @return [String]
     def subtitle
-      path = '//content/subtitle'
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/subtitle'
+      xpath_query_for_single_value path
+    end
+
+    # Type
+    #
+    # @return [String]
+    def type
+      path = '/typeClassification/term/localizedString'
+      xpath_query_for_single_value path
     end
 
     # All metadata
@@ -74,11 +184,18 @@ module Puree
     # @return [Hash]
     def metadata
       o = super
+      o['category'] = category
       o['description'] = description
       o['doi'] = doi
+      o['event'] = event
       o['file'] = file
+      o['organisation'] = organisation
+      o['page'] = page
+      o['person'] = person
+      o['status'] = status
       o['subtitle'] = subtitle
       o['title'] = title
+      o['type'] = type
       o
     end
 

data/lib/puree/publisher.rb

@@ -7,13 +7,17 @@ module Puree
     # @param endpoint [String]
     # @param optional username [String]
     # @param optional password [String]
-    def initialize(endpoint: nil, username: nil, password: nil)
+    # @param optional basic_auth [Boolean]
+    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
       super(api: :publisher,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
     end
 
+
+
     # All metadata
     #
     # @return [Hash]

data/lib/puree/resource.rb

@@ -4,27 +4,48 @@ module Puree
   #
   class Resource
 
+    attr_reader :response
+
     # @param api [String]
     # @param endpoint [String]
     # @param optional username [String]
     # @param optional password [String]
+    # @param optional bleeding [Boolean]
+    # @param optional basic_auth [Boolean]
     def initialize( api: nil,
                     endpoint: nil,
                     username: nil,
-                    password: nil)
+                    password: nil,
+                    bleeding: true,
+                    basic_auth: nil)
       @resource_type = api
       @api_map = Puree::Map.new.get
-      @endpoint = endpoint.nil? ? Puree::Configuration.endpoint : endpoint
-      @username = username.nil? ? Puree::Configuration.username : username
-      @password = password.nil? ? Puree::Configuration.password : password
+      @endpoint = endpoint.nil? ? Puree.endpoint : endpoint
+      @latest_api = bleeding
+      @basic_auth = basic_auth.nil? ? Puree.basic_auth : basic_auth
+      if @basic_auth === true
+        @username = username.nil? ? Puree.username : username
+        @password = password.nil? ? Puree.password : password
+      end
     end
 
     # Get
     #
     # @param uuid [String]
     # @param id [String]
-    # @return [HTTParty::Response]
-    def get(uuid: nil, id: nil)
+    # @return [Hash]
+    def get(uuid: nil, id: nil, rendering: :xml_long)
+      reset
+
+      @options = {
+          basic_auth:     @basic_auth,
+          latest_api:     @latest_api,
+          resource_type:  @resource_type.to_sym,
+          rendering:      rendering,
+          uuid:           uuid,
+          id:             id
+      }
+
       missing = missing_credentials
       if !missing.empty?
         missing.each do |m|
@@ -35,19 +56,15 @@ module Puree
 
       # strip any trailing slash
       @endpoint = @endpoint.sub(/(\/)+$/, '')
-      @auth = Base64::strict_encode64(@username + ':' + @password)
 
-      @options = {
-          latest_api:     true,
-          resource_type: @resource_type.to_sym,
-          rendering:      :xml_long,
-          uuid:           uuid,
-          id:             id
-      }
-      headers = {
-          'Accept' => 'application/xml',
-          'Authorization' => 'Basic ' + @auth
-      }
+      headers = {}
+      headers['Accept'] = 'application/xml'
+
+      if @options[:basic_auth] === true
+        @auth = Base64::strict_encode64(@username + ':' + @password)
+        headers['Authorization'] = 'Basic ' + @auth
+      end
+
       query = {}
       query['rendering'] = @options[:rendering]
 
@@ -59,26 +76,26 @@ module Puree
         end
       end
 
-      begin
-        @response = HTTParty.get(build_url, query: query, headers: headers, timeout: 120)
-      rescue HTTParty::Error => e
-        puts 'HttParty::Error '+ e.message
+      if @options['rendering']
+        query['rendering'] = @options['rendering']
       end
 
-      if get_data?
-        response_name = service_response_name
-        content = @response.parsed_response[response_name]['result']['content']
-        set_content(content)
+      begin
+        url = build_url
+        req = HTTP.headers accept: headers['Accept']
+        if @options[:basic_auth]
+          req = req.auth headers['Authorization']
+        end
+        @response = req.get(url, params: query)
+        @doc = Nokogiri::XML @response.body
+        @doc.remove_namespaces!
+
+      rescue HTTP::Error => e
+        puts 'HTTP::Error '+ e.message
       end
-      @response
-    end
 
-    # Response, if get method has been called
-    #
-    # @return [HTTParty::Response]
-    # @return [Nil]
-    def response
-      @response ? @response : nil
+      get_data? ? metadata : {}
+
     end
 
     # Set content
@@ -103,24 +120,24 @@ module Puree
     #
     # @return [String]
     def created
-      data = node 'created'
-      !data.nil? && !data.empty? ? data.strip : ''
+      path = '/created'
+      xpath_query_for_single_value path
     end
 
     # Modified (UTC datetime)
     #
     # @return [String]
     def modified
-      data = node 'modified'
-      !data.nil? && !data.empty? ? data.strip : ''
+      path = '/modified'
+      xpath_query_for_single_value path
     end
 
     # UUID
     #
     # @return [String]
     def uuid
-      data = node 'uuid'
-      !data.nil? && !data.empty? ? data.strip : ''
+      path = '/@uuid'
+      xpath_query_for_single_value path
     end
 
     # All metadata
@@ -139,30 +156,13 @@ module Puree
     private
 
 
-    def collect_uuid
-      path = '//renderedItem/@renderedContentUUID'
-      xpath_result = xpath_query path
-      xpath_result.each { |i| @uuids << i.text.strip }
-    end
-
-
-
-
-
-    # Node
-    #
-    # @return [Hash]
-    def node(path)
-      @content ? @content[path] : {}
-    end
-
-
-    # Is there any data after get?
+    # Is there any data after get? For a response that provides a count of the results.
     #
     # @return [Boolean]
     def get_data?
-      response_name = service_response_name
-      @response.parsed_response[response_name]['count'] != '0' ? true : false
+      path = service_xpath_count
+      xpath_result = @doc.xpath path
+      xpath_result.text.strip === '1' ? true : false
     end
 
     def service_name
@@ -175,6 +175,18 @@ module Puree
       @api_map[:resource_type][resource_type][:response]
     end
 
+    def service_xpath_base
+      service_response_name + '/result/content'
+    end
+
+    def service_xpath_count
+      service_response_name + '/count'
+    end
+
+    def service_xpath(str_to_find)
+      service_xpath_base + str_to_find
+    end
+
     def build_url
       service = service_name
       if @options[:latest_api] === false
@@ -185,27 +197,40 @@ module Puree
       @endpoint + '/' + service_api_mode
     end
 
+    # content based
     def xpath_query(path)
-      xml = @response.body
-      doc = Nokogiri::XML xml
-      doc.remove_namespaces!
-      doc.xpath path
+      path_from_root = service_xpath path
+      @doc.xpath path_from_root
     end
 
+    def xpath_query_for_single_value(path)
+      xpath_result = xpath_query path
+      xpath_result ? xpath_result.text.strip : ''
+    end
+
+
     def missing_credentials
       missing = []
       if @endpoint.nil?
         missing << 'endpoint'
       end
-      if @username.nil?
-        missing << 'username'
-      end
-      if @password.nil?
-        missing << 'password'
+
+      if @options[:basic_auth] === true
+        if @username.nil?
+          missing << 'username'
+        end
+        if @password.nil?
+          missing << 'password'
+        end
       end
+
       missing
     end
 
+    def reset
+      @response = nil
+    end
+
     alias :find :get
 
   end