puree 0.14.0 → 0.15.0

data/lib/puree/collection.rb

@@ -1,25 +1,31 @@
 module Puree
 
-  # Collection resource
+  # Collection of resources
   #
-  class Collection < Resource
+  class Collection
 
-    # @param api [Symbol]
+    # @param resource [Symbol]
     # @param endpoint [String]
     # @param optional username [String]
     # @param optional password [String]
-    def initialize(api: nil,
+    # @param optional basic_auth [Boolean]
+    def initialize(resource: nil,
                    endpoint: nil,
                    username: nil,
-                   password: nil)
-      super(api: api,
-            endpoint: endpoint,
-            username: username,
-            password: password)
+                   password: nil,
+                   basic_auth: nil)
+      @resource_type = resource
+      @api_map = Puree::Map.new.get
+      @endpoint = endpoint.nil? ? Puree.endpoint : endpoint
+      @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
       @uuids = []
     end
 
-    # Get
+    # Gets an array of objects of resource type specified in constructor
     #
     # @param optional limit [Integer]
     # @param optional offset [Integer]
@@ -27,27 +33,21 @@ module Puree
     # @param optional created_end [String]
     # @param optional modified_start [String]
     # @param optional modified_end [String]
-    # @return [HTTParty::Response]
+    # @param optional full [Boolean]
+    # @return [Array<Object>]
     def get(
             limit:            20,
             offset:           0,
             created_start:    nil,
             created_end:      nil,
             modified_start:   nil,
-            modified_end:     nil)
-
-      missing = missing_credentials
-      if !missing.empty?
-        missing.each do |m|
-          puts "#{self.class.name}" + '#' + "#{__method__} missing #{m}"
-        end
-        exit
-      end
-      # strip any trailing slash
-      @endpoint = @endpoint.sub(/(\/)+$/, '')
-      @auth = Base64::strict_encode64(@username + ':' + @password)
+            modified_end:     nil,
+            full:             true,
+            rendering:        :xml_long
+    )
 
       @options = {
+          basic_auth:       @basic_auth,
           latest_api:       true,
           resource_type:    @resource_type.to_sym,
           rendering:        :system,
@@ -56,12 +56,30 @@ module Puree
           created_start:    created_start,
           created_end:      created_end,
           modified_start:   modified_start,
-          modified_end:     modified_end
-      }
-      headers = {
-          'Accept' => 'application/xml',
-          'Authorization' => 'Basic ' + @auth
+          modified_end:     modified_end,
+          full:             full,
+          record_rendering: rendering
       }
+
+      missing = missing_credentials
+      if !missing.empty?
+        missing.each do |m|
+          puts "#{self.class.name}" + '#' + "#{__method__} missing #{m}"
+        end
+        exit
+      end
+
+      # strip any trailing slash
+      @endpoint = @endpoint.sub(/(\/)+$/, '')
+
+      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]
@@ -90,10 +108,54 @@ module Puree
         query['modifiedDate.toDate'] = @options[:modified_end]
       end
 
-      @response = HTTParty.get(build_url, query: query, headers: headers)
+      if @options['rendering']
+        query['rendering'] = @options['rendering']
+      end
+
+      # @response = HTTParty.get(build_url, query: query, headers: headers)
+
+      begin
+        # p self.inspect
+        # p build_url
+        # p query
+        # p headers
+        # @response = HTTParty.get(build_url, query: query, headers: headers, timeout: 120)
+        url = build_url
+        req = HTTP.headers accept: 'application/xml'
+        if @options[:basic_auth]
+          req = req.auth headers['Authorization']
+        end
+        @response = req.get(url, params: query)
+        @doc = Nokogiri::XML @response.body
+        @doc.remove_namespaces!
+
+        code = @response.code
+        # body = @response.body
+        # puts "#{self.class.name} #{code}"
+          # puts "#{self.class.name} #{body}"
+
+      rescue HTTP::Error => e
+        puts 'HTTP::Error '+ e.message
+      end
+
+      if @options[:full]
+        collect_resource
+      else
+        data = []
+        uuid.each do |u|
+          o = {}
+          o['uuid'] = u
+          data << o
+        end
+        data
+      end
+
     end
 
 
+    private
+
+
     # Array of UUIDs
     #
     # @return [Array<String>]
@@ -103,18 +165,85 @@ module Puree
     end
 
 
+    def collect_resource
+      data = []
+      resource_class = 'Puree::' + @resource_type.to_s.capitalize
 
-    private
-
+      if @options[:basic_auth] === true
+        r = Object.const_get(resource_class).new endpoint:   @endpoint,
+                                                 username:   @username,
+                                                 password:   @password,
+                                                 basic_auth: true
+      else
+        r = Object.const_get(resource_class).new endpoint:   @endpoint
+      end
+      # whitelist symbol
+      if @api_map[:resource_type].has_key?(@resource_type)
+        uuid.each do |u|
+          record = r.find uuid: u,
+                          rendering:  @options[:record_rendering]
+          # puts JSON.pretty_generate( record, :indent => '  ')
+          # p u
+          data << record
+        end
+        data
+      else
+        puts 'Invalid resource class'
+        exit
+      end
+    end
 
     def collect_uuid
+      @uuids = []
       path = '//renderedItem/@renderedContentUUID'
       xpath_result = xpath_query path
       xpath_result.each { |i| @uuids << i.text.strip }
     end
 
+    def service_name
+      resource_type = @options[:resource_type]
+      @api_map[:resource_type][resource_type][:service]
+    end
+
+    def service_response_name
+      resource_type = @options[:resource_type]
+      @api_map[:resource_type][resource_type][:response]
+    end
+
+    def build_url
+      service = service_name
+      if @options[:latest_api] === false
+        service_api_mode = service
+      else
+        service_api_mode = service + '.current'
+      end
+      @endpoint + '/' + service_api_mode
+    end
+
+    def xpath_query(path)
+      @doc.xpath path
+    end
+
+
+    def missing_credentials
+      missing = []
+      if @endpoint.nil?
+        missing << 'endpoint'
+      end
+
+      if @options[:basic_auth] === true
+        if @username.nil?
+          missing << 'username'
+        end
+        if @password.nil?
+          missing << 'password'
+        end
+      end
+
+      missing
+    end
+
     alias :find :get
 
   end
-
 end

data/lib/puree/configuration.rb

@@ -2,16 +2,12 @@ module Puree
 
   module Configuration
 
-    class << self
-
-      attr_accessor :endpoint, :username, :password
+      attr_accessor :endpoint, :username, :password, :basic_auth
 
       def configure
         yield self
       end
 
-    end
-
   end
 
 end

data/lib/puree/dataset.rb

@@ -7,18 +7,21 @@ 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: :dataset,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
     end
 
+
     # Link
     #
     # @return [Array<Hash>]
     def link
-      path = '//links/link'
+      path = '/links/link'
       xpath_result = xpath_query path
       data = []
       xpath_result.each { |i|
@@ -30,33 +33,32 @@ module Puree
       data.uniq
     end
 
-    # Organisation
+    # Owner
     #
     # @return [Hash]
-    def organisation
-      path = '//content/managedBy'
+    def owner
+      path = '/managedBy'
       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
+       o
     end
 
     # Publisher
     #
     # @return [String]
     def publisher
-      path = '//publisher/name'
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/publisher/name'
+      xpath_query_for_single_value path
     end
 
     # Combines project and publication
     #
-    # @return [Hash]
+    # @return [Array<Hash>]
     def associated
-      path = '//associatedContent//relatedContent'
+      path = '/associatedContent//relatedContent'
       xpath_result =  xpath_query path
       data_arr = []
       xpath_result.each { |i|
@@ -94,16 +96,15 @@ module Puree
     #
     # @return [String]
     def title
-      path = '//title/localizedString'
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/title/localizedString'
+      xpath_query_for_single_value path
     end
 
     # Keyword
     #
     # @return [Array<String>]
     def keyword
-      path = '//keywordGroups/keywordGroup/keyword/userDefinedKeyword/freeKeyword'
+      path = '/keywordGroups/keywordGroup/keyword/userDefinedKeyword/freeKeyword'
       xpath_result =  xpath_query path
       data_arr = xpath_result.map { |i| i.text.strip }
       data_arr.uniq
@@ -113,84 +114,84 @@ module Puree
     #
     # @return [String]
     def description
-      path = '//descriptions/classificationDefinedField/value/localizedString'
+      path = '/descriptions/classificationDefinedField/value/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    # Organisation
+    #
+    # @return [Array<Hash>]
+    def organisation
+      path = '/organisations/organisation'
       xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      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
 
     # Person (internal, external, other)
     #
-    # @return [Hash]
+    # @return [Array<Hash>]
     def person
-      data = node('persons')
-      persons = {}
-      if !data.nil? && !data.empty?
-        data = data['dataSetPersonAssociation']
-      else
-        return persons
-      end
-      internal_persons = []
-      external_persons = []
-      other_persons = []
-      case data
-        when Array
-          data.each do |d|
-            person = generic_person d
-            if d.key? 'person'
-              person['uuid'] = d['person']['uuid'].strip
-              internal_persons << person
-            end
-            if d.key? 'externalPerson'
-              person['uuid'] = d['externalPerson']['uuid'].strip
-              external_persons << person
-            end
-            if !d.key?('person') && !d.key?('externalPerson')
-              person['uuid'] = ''
-              other_persons << person
-            end
-          end
-        when Hash
-          person = generic_person data
-          if data.key? 'person'
-            person['uuid'] = data['person']['uuid'].strip
-            internal_persons << person
-          end
-          if data.key? 'externalPerson'
-            person['uuid'] = data['externalPerson']['uuid'].strip
-            external_persons << person
-          end
-          if !data.key?('person') && !data.key?('externalPerson')
-            person['uuid'] = ''
-            other_persons << person
-          end
+      data = {}
+      # internal
+      path = '/persons/dataSetPersonAssociation'
+      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
-      persons['internal'] = internal_persons.uniq
-      persons['external'] = external_persons.uniq
-      persons['other'] = other_persons.uniq
-      persons
+      data['internal'] = internal
+      data['external'] = external
+      data['other'] = other
+      data
     end
 
-
-
     # Date made available
     #
     # @return [Hash]
     def available
-      data = node('dateMadeAvailable')
-      Puree::Date.normalise(data)
+      temporal_start_date 'dateMadeAvailable'
     end
 
     # Geographical coverage
     #
     # @return [Array<String>]
     def geographical
-      data = node 'geographicalCoverage'
-      if !data.nil? && !data.empty?
-        data = data['localizedString']["__content__"]
-        data.is_a?(Array) ? data.uniq : data.split(',').map(&:strip).uniq
-      else
-        []
+      path = '/geographicalCoverage/localizedString'
+      xpath_result = xpath_query path
+      data = []
+      xpath_result.each do |i|
+        data << i.text.strip
       end
+      data
     end
 
     # Date of data production
@@ -212,8 +213,8 @@ module Puree
     #
     # @return [String]
     def access
-      data = node 'openAccessPermission'
-      !data.nil? && !data.empty? ? data['term']['localizedString']["__content__"].strip : ''
+      path = '/openAccessPermission/term/localizedString'
+      xpath_query_for_single_value path
     end
 
 
@@ -221,7 +222,7 @@ module Puree
     #
     # @return [Array<Hash>]
     def file
-      path = '//documents/document'
+      path = '/documents/document'
       xpath_result = xpath_query path
 
       docs = []
@@ -254,9 +255,8 @@ module Puree
     #
     # @return [String]
     def doi
-      path = '//content/doi'
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/doi'
+      xpath_query_for_single_value path
     end
 
     # def state
@@ -280,6 +280,7 @@ module Puree
       o['keyword'] = keyword
       o['link'] = link
       o['organisation'] = organisation
+      o['owner'] = owner
       o['person'] = person
       o['project'] = project
       o['production'] = production
@@ -290,12 +291,8 @@ module Puree
       o
     end
 
-
-
     private
 
-
-
     # Assembles basic information about a person
     #
     # @param generic_data [Hash]
@@ -332,16 +329,26 @@ module Puree
     #
     # @return [Hash]
     def temporal_start_date(start_node)
-      data = node start_node
-      !data.nil? && !data.empty? ? Puree::Date.normalise(data) : {}
+      path = start_node
+      xpath_result = xpath_query path
+      o = {}
+      o['day'] = xpath_result.xpath('day').text.strip
+      o['month'] = xpath_result.xpath('month').text.strip
+      o['year'] = xpath_result.xpath('year').text.strip
+      Puree::Date.normalise(o)
     end
 
     # Temporal coverage end date
     #
     # @return [Hash]
     def temporal_end_date(end_node)
-      data = node end_node
-      !data.nil? && !data.empty? ? Puree::Date.normalise(data) : {}
+      path = end_node
+      xpath_result = xpath_query path
+      o = {}
+      o['day'] = xpath_result.xpath('day').text.strip
+      o['month'] = xpath_result.xpath('month').text.strip
+      o['year'] = xpath_result.xpath('year').text.strip
+      Puree::Date.normalise(o)
     end
 
     # Associated type