puree 0.14.0 → 0.15.0

data/lib/puree/download.rb

@@ -1,26 +1,184 @@
 module Puree
 
-  # Download resource
+  # Download
   #
-  class Download < Resource
+  class Download
+    attr_reader :response
 
     # @param endpoint [String]
     # @param optional username [String]
     # @param optional password [String]
-    def initialize(endpoint: nil, username: nil, password: nil)
-      super(api: :download,
-            endpoint: endpoint,
-            username: username,
-            password: password)
+    # @param optional basic_auth [Boolean]
+    def initialize(endpoint: nil,
+                   username: nil,
+                   password: nil,
+                   basic_auth: nil)
+      @resource_type = :download
+      @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
     end
 
+    # Get
+    #
+    # @param optional limit [Integer]
+    # @param optional offset [Integer]
+    # @param optional resource [Symbol]
+    # @return [Array<Hash>]
+    def get(limit: 20,
+            offset: 0,
+            resource: 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)
+
+      @options = {
+          basic_auth:     @basic_auth,
+          latest_api:     true,
+          resource_type:  @resource_type.to_sym,
+          rendering:      :system,
+          limit:          limit,
+          offset:         offset,
+          resource:       resource.to_sym
+      }
+      headers = {
+          'Accept' => 'application/xml',
+          'Authorization' => 'Basic ' + @auth
+      }
+      query = {}
+      query['rendering'] = @options[:rendering]
+
+      if @options[:limit]
+        query['window.size'] = @options[:limit]
+      end
+
+      if @options[:offset]
+        query['window.offset'] = @options[:offset]
+      end
+
+      if @options[:resource]
+        query['contentType'] = service_family
+      end
+
+      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
+
+      get_data? ? metadata : []
+    end
+
+
+
+
     # All metadata
     #
-    # @return [Hash]
-    # def metadata
-    #   super
-    # end
+    # @return [Array<Hash>]
+    def metadata
+      statistic
+    end
 
-  end
 
+    private
+
+    # Is there any data after get?
+    #
+    # @return [Boolean]
+    def get_data?
+      # n.b. arbitrary element existence check
+      path = service_response_name + '/downloadCount'
+      xpath_result = @doc.xpath path
+      xpath_result.size ? true : false
+    end
+
+    # Statistic
+    #
+    # @return [Array<Hash>]
+    def statistic
+      path = service_response_name + '/downloadCount'
+      xpath_result =  xpath_query path
+      data_arr = []
+      xpath_result.each { |i|
+        data = {}
+        data['uuid'] = i.attr('uuid').strip
+        data['download'] = i.attr('downloads').strip
+        data_arr << data
+      }
+      data_arr.uniq
+    end
+
+    def service_family
+      resource_type = @options[:resource]
+      if @api_map[:resource_type].has_key? resource_type
+        @api_map[:resource_type][resource_type][:family]
+      else
+        puts "#{resource_type} is an unrecognised resource type"
+        exit
+      end
+    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)
+      xml = @response.body
+      doc = Nokogiri::XML xml
+      doc.remove_namespaces!
+      doc.xpath path
+    end
+
+    def missing_credentials
+      missing = []
+      if @endpoint.nil?
+        missing << 'endpoint'
+      end
+      if @username.nil?
+        missing << 'username'
+      end
+      if @password.nil?
+        missing << 'password'
+      end
+      missing
+    end
+
+    alias :find :get
+
+  end
 end

data/lib/puree/event.rb

@@ -7,18 +7,23 @@ 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: :event,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
     end
 
+
+
+
     # City
     #
     # @return [String]
     def city
-      path = '//city'
+      path = '/city'
       xpath_query(path).text.strip
     end
 
@@ -26,7 +31,7 @@ module Puree
     #
     # @return [String]
     def country
-      path = '//country/term/localizedString'
+      path = '/country/term/localizedString'
       xpath_query(path).text.strip
     end
 
@@ -35,7 +40,7 @@ module Puree
     # @return [Hash]
     def date
       data = {}
-      path = '//dateRange'
+      path = '/dateRange'
       range = xpath_query path
       data['start'] = range.xpath('startDate').text.strip
       data['end'] = range.xpath('startDate').text.strip
@@ -46,7 +51,7 @@ module Puree
     #
     # @return [String]
     def description
-      path = '//content/description'
+      path = '/description'
       xpath_query(path).text.strip
     end
 
@@ -54,7 +59,7 @@ module Puree
     #
     # @return [String]
     def location
-      path = '//location'
+      path = '/location'
       xpath_query(path).text.strip
     end
 
@@ -62,16 +67,16 @@ module Puree
     #
     # @return [String]
     def title
-      path = '//title/localizedString'
-      xpath_query(path).text.strip
+      path = '/title/localizedString'
+      xpath_query_for_single_value path
     end
 
     # Type
     #
     # @return [String]
     def type
-      path = '//content/typeClassification/term/localizedString'
-      xpath_query(path).text.strip
+      path = '//typeClassification/term/localizedString'
+      xpath_query_for_single_value path
     end
 
     # All metadata

data/lib/puree/journal.rb

@@ -7,13 +7,16 @@ 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: :journal,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
     end
 
+
     # All metadata
     #
     # @return [Hash]

data/lib/puree/map.rb

@@ -21,13 +21,19 @@ module Puree
             family: 'dk.atira.pure.modules.datasets.external.model.dataset.DataSet'
           },
           download: {
-              service: 'downloadcount',
-              response: 'GetDownloadCountResponse'
+            service: 'downloadcount',
+            response: 'GetDownloadCountResponse'
           },
+          server: {
+            service: 'servermeta',
+            response: 'GetServerMetaResponse'
+          },
+
         }
       }
 
       add_convention
+      # add_family
     end
 
     # Pure API map
@@ -38,6 +44,7 @@ module Puree
     end
 
 
+
     private
 
     def add_convention
@@ -49,6 +56,10 @@ module Puree
       end
     end
 
+    # def add_family
+    #   @api_map[:resource_type][:event][:family] = 'dk.atira.pure.api.shared.model.event.Event'
+    # end
+
 
   end
 

data/lib/puree/organisation.rb

@@ -7,19 +7,23 @@ 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: :organisation,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
     end
 
+
+
     # Address
     #
     # @return [Array<Hash>]
     def address
-      path = '//addresses/classifiedAddress'
-      xpath_result =  xpath_query path
+      path = '/addresses/classifiedAddress'
+      xpath_result = xpath_query path
 
       data = []
 
@@ -39,7 +43,7 @@ module Puree
     #
     # @return [Array<String>]
     def email
-      path = '//emails/classificationDefinedStringFieldExtension/value'
+      path = '/emails/classificationDefinedStringFieldExtension/value'
       xpath_result =  xpath_query path
       arr = []
       xpath_result.each { |i| arr << i.text.strip }
@@ -50,8 +54,8 @@ module Puree
     #
     # @return [String]
     def name
-      data = node 'name'
-      !data.nil? && !data.empty? ? data['localizedString']['__content__'].strip : ''
+      path = '/name/localizedString'
+      xpath_query_for_single_value path
     end
 
     # Parent
@@ -70,7 +74,7 @@ module Puree
     #
     # @return [Array<String>]
     def phone
-      path = '//phoneNumbers/classificationDefinedStringFieldExtension/value'
+      path = '/phoneNumbers/classificationDefinedStringFieldExtension/value'
       xpath_result =  xpath_query path
       arr = []
       xpath_result.each { |i| arr << i.text.strip }
@@ -81,16 +85,15 @@ module Puree
     #
     # @return [String]
     def type
-      path = '//content/typeClassification/term/localizedString'
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
+      path = '/typeClassification/term/localizedString'
+      xpath_query_for_single_value path
     end
 
     # URL
     #
     # @return [Array<String>]
     def url
-      path = '//content/webAddresses/classificationDefinedFieldExtension/value/localizedString'
+      path = '/webAddresses/classificationDefinedFieldExtension/value/localizedString'
       xpath_result = xpath_query path
       arr = []
       xpath_result.each { |i| arr << i.text.strip }
@@ -113,14 +116,12 @@ module Puree
     end
 
 
-    private
-
 
     # Organisation
     #
     # @return [Array<Hash>]
     def organisation
-      path = '//organisations/organisation'
+      path = '/organisations/organisation'
       xpath_result =  xpath_query path
 
       data = []

data/lib/puree/person.rb

@@ -7,29 +7,49 @@ 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: :person,
             endpoint: endpoint,
             username: username,
-            password: password)
+            password: password,
+            basic_auth: basic_auth)
     end
 
+
+
     # Affiliation
     #
-    # @return [Array<String>]
+    # @return [Array<Hash>]
     def affiliation
-      path = '//organisation/name/localizedString'
+      path = '//organisation'
       xpath_result =  xpath_query path
-      affiliations = []
-      xpath_result.each { |i| affiliations << i.text }
-      affiliations.uniq
+      data_arr = []
+      xpath_result.each { |i|
+        data = {}
+        data['uuid'] = i.attr('uuid').strip
+        data['name'] = i.xpath('name/localizedString').text.strip
+        data_arr << data
+      }
+      data_arr.uniq
     end
 
-    # Image
+    # Email
+    #
+    # @return [Array]
+    def email
+      path = '//emails/classificationDefinedStringFieldExtension/value'
+      xpath_result =  xpath_query path
+      data = []
+      xpath_result.each { |i| data << i.text }
+      data.uniq
+    end
+
+    # Image URL
     #
     # @return [Array<String>]
     def image
-      path = '//photos/file/url'
+      path = '/photos/file/url'
       xpath_result =  xpath_query path
       data = []
       xpath_result.each { |i| data << i.text }
@@ -51,12 +71,13 @@ module Puree
     #
     # @return [Hash]
     def name
-      data = node 'name'
+      path = '/name'
+      xpath_result =  xpath_query path
+      first = xpath_result.xpath('firstName').text.strip
+      last = xpath_result.xpath('lastName').text.strip
       o = {}
-      if !data.nil? && !data.empty?
-        o['first'] = data['firstName'].strip
-        o['last'] = data['lastName'].strip
-      end
+      o['first'] = first
+      o['last'] = last
       o
     end
 
@@ -64,8 +85,8 @@ module Puree
     #
     # @return [String]
     def orcid
-      data = node 'orcid'
-      !data.nil? && !data.empty? ? data.strip : ''
+      path = '/orcid'
+      xpath_query_for_single_value path
     end
 
     # All metadata
@@ -74,6 +95,7 @@ module Puree
     def metadata
       o = super
       o['affiliation'] = affiliation
+      o['email'] = email
       o['image'] = image
       o['keyword'] = keyword
       o['name'] = name