puree 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b99d2257bc1a5acc9a02e0518d722e741f75953d
-  data.tar.gz: f29a0057bcd27d84c01b90c2a1316986765442a4
+  metadata.gz: 1ddcb83b0373dc8b7ed99439c036f9df30e78e33
+  data.tar.gz: 725e1793dfce63c7ef1508a136e370e3854059f6
 SHA512:
-  metadata.gz: 8a043447e965f65c4ef360cd2cb8eaf7eff0043bf252c232207f2d55428573c915e8989150053e4a2cb0640e4d1976c0a73041fbcd9a711819853c0ec9b4d0d3
-  data.tar.gz: 09cde7525b2d29e54529b4a1710ff02fa8774aca8e051ebf5fefa3e223dc75324c8ffae2e5c68d46e9695a0b2aba52c6691aae053f82109ee5b7c641d16fa90f
+  metadata.gz: ec189df00f33a2024f24071ec2723e34a147bc6fad2b6bd759e5728aca27d8b434582e01502a68c8ed183abf7abd113ba8dff9734e9ea7e8e6c48aa3eaf69efc
+  data.tar.gz: 71c81c922c09a0b501d3229ff0dbcaa6d1d26cdd051f7224952c51e5d8a72b5c5cbf48148ef3ad63bcf93284c2ebd8cd5dda8fab11e639fdfdfa7a01cbc57f3c

data/CHANGELOG.md

@@ -3,8 +3,18 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
-Metadata :journal, publisher
-Factory to make resource objects?
+- Metadata: clipping?, externalPerson?, journal?, publisher?
+- Factory to make resource objects?
+- Make ALL dates ISO 8601 YYYY-MM-DD, rather than mirror varying formats from Pure?
+
+## 0.16.0 - 2016-08-19
+### Added
+- Collection - instance parameter.
+
+### Changed
+- Parameter endpoint renamed to base_url.
+- Dataset (geographical renamed to spatial).
+- Metadata methods return pre-extracted data.
 
 ## 0.15.0 - 2016-06-22
 ### Added

data/README.md

@@ -32,14 +32,20 @@ metadata = d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 metadata['doi']
 ```
 
-### Collection of 50 resources
+...or using a method...
+
+```ruby
+d.doi
+```
+
+### Collection of resources
 Tell Purée what you are looking for...
 
 ```ruby
 c = Puree::Collection.new resource: :dataset
 metadata = c.find limit: 50
 ```
-...and get the data from an array of hashes.
+...and get the data from an array of hashes or from an array of instances.
 
 ## Documentation
 [API in YARD](http://www.rubydoc.info/gems/puree/frames)

data/lib/puree/collection.rb

@@ -5,18 +5,18 @@ module Puree
   class Collection
 
     # @param resource [Symbol]
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
+    # @param base_url [String]
+    # @param username [String]
+    # @param password [String]
+    # @param basic_auth [Boolean]
     def initialize(resource: nil,
-                   endpoint: nil,
+                   base_url: nil,
                    username: nil,
                    password: nil,
                    basic_auth: nil)
       @resource_type = resource
       @api_map = Puree::Map.new.get
-      @endpoint = endpoint.nil? ? Puree.endpoint : endpoint
+      @base_url = base_url.nil? ? Puree.base_url : base_url
       @basic_auth = basic_auth.nil? ? Puree.basic_auth : basic_auth
       if @basic_auth === true
         @username = username.nil? ? Puree.username : username
@@ -27,14 +27,16 @@ module Puree
 
     # Gets an array of objects of resource type specified in constructor
     #
-    # @param optional limit [Integer]
-    # @param optional offset [Integer]
-    # @param optional created_start [String]
-    # @param optional created_end [String]
-    # @param optional modified_start [String]
-    # @param optional modified_end [String]
-    # @param optional full [Boolean]
+    # @param limit [Integer]
+    # @param offset [Integer]
+    # @param created_start [String]
+    # @param created_end [String]
+    # @param modified_start [String]
+    # @param modified_end [String]
+    # @param full [Boolean]
+    # @param instance [Boolean]
     # @return [Array<Object>]
+    # @return [Array<Resource subtype>]
     def get(
             limit:            20,
             offset:           0,
@@ -43,6 +45,7 @@ module Puree
             modified_start:   nil,
             modified_end:     nil,
             full:             true,
+            instance:         false,
             rendering:        :xml_long
     )
 
@@ -58,6 +61,7 @@ module Puree
           modified_start:   modified_start,
           modified_end:     modified_end,
           full:             full,
+          instance:         instance,
           record_rendering: rendering
       }
 
@@ -70,7 +74,7 @@ module Puree
       end
 
       # strip any trailing slash
-      @endpoint = @endpoint.sub(/(\/)+$/, '')
+      @base_url = @base_url.sub(/(\/)+$/, '')
 
       headers = {}
       headers['Accept'] = 'application/xml'
@@ -129,7 +133,7 @@ module Puree
         @doc = Nokogiri::XML @response.body
         @doc.remove_namespaces!
 
-        code = @response.code
+        # code = @response.code
         # body = @response.body
         # puts "#{self.class.name} #{code}"
           # puts "#{self.class.name} #{body}"
@@ -170,12 +174,12 @@ module Puree
       resource_class = 'Puree::' + @resource_type.to_s.capitalize
 
       if @options[:basic_auth] === true
-        r = Object.const_get(resource_class).new endpoint:   @endpoint,
+        r = Object.const_get(resource_class).new base_url:   @base_url,
                                                  username:   @username,
                                                  password:   @password,
                                                  basic_auth: true
       else
-        r = Object.const_get(resource_class).new endpoint:   @endpoint
+        r = Object.const_get(resource_class).new base_url:   @base_url
       end
       # whitelist symbol
       if @api_map[:resource_type].has_key?(@resource_type)
@@ -184,7 +188,12 @@ module Puree
                           rendering:  @options[:record_rendering]
           # puts JSON.pretty_generate( record, :indent => '  ')
           # p u
-          data << record
+          if @options[:instance]
+            data << r
+          else
+            # just the data
+            data << record
+          end
         end
         data
       else
@@ -217,7 +226,7 @@ module Puree
       else
         service_api_mode = service + '.current'
       end
-      @endpoint + '/' + service_api_mode
+      @base_url + '/' + service_api_mode
     end
 
     def xpath_query(path)
@@ -227,8 +236,8 @@ module Puree
 
     def missing_credentials
       missing = []
-      if @endpoint.nil?
-        missing << 'endpoint'
+      if @base_url.nil?
+        missing << 'base_url'
       end
 
       if @options[:basic_auth] === true

data/lib/puree/configuration.rb

@@ -2,7 +2,7 @@ module Puree
 
   module Configuration
 
-      attr_accessor :endpoint, :username, :password, :basic_auth
+      attr_accessor :base_url, :username, :password, :basic_auth
 
       def configure
         yield self

data/lib/puree/dataset.rb

@@ -4,60 +4,160 @@ module Puree
   #
   class Dataset < Resource
 
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
-    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
+    # @param base_url [String]
+    # @param username [String]
+    # @param password [String]
+    # @param basic_auth [Boolean]
+    def initialize(base_url: nil, username: nil, password: nil, basic_auth: nil)
       super(api: :dataset,
-            endpoint: endpoint,
+            base_url: base_url,
             username: username,
             password: password,
             basic_auth: basic_auth)
     end
 
+    # Open access permission
+    #
+    # @return [String]
+    def access
+      @metadata['access']
+    end
+
+    # Combines project and publication
+    #
+    # @return [Array<Hash>]
+    def associated
+      @metadata['associated']
+    end
+
+    # Date made available
+    #
+    # @return [Hash]
+    def available
+      @metadata['available']
+    end
+
+    # Description
+    #
+    # @return [String]
+    def description
+      @metadata['description']
+    end
+
+    # Digital Object Identifier
+    #
+    # @return [String]
+    def doi
+      @metadata['doi']
+    end
+
+    # Supporting file
+    #
+    # @return [Array<Hash>]
+    def file
+      @metadata['file']
+    end
+
+    # Keyword
+    #
+    # @return [Array<String>]
+    def keyword
+      @metadata['keyword']
+    end
 
     # Link
     #
     # @return [Array<Hash>]
     def link
-      path = '/links/link'
-      xpath_result = xpath_query path
-      data = []
-      xpath_result.each { |i|
-        o = {}
-        o['url'] = i.xpath('url').text.strip
-        o['description'] = i.xpath('description').text.strip
-        data << o
-      }
-      data.uniq
+      @metadata['link']
+    end
+
+    # Organisation
+    #
+    # @return [Array<Hash>]
+    def organisation
+      @metadata['organisation']
     end
 
     # Owner
     #
     # @return [Hash]
     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
+      @metadata['owner']
+    end
+
+    # Person (internal, external, other)
+    #
+    # @return [Array<Hash>]
+    def person
+      @metadata['person']
+    end
+
+    # Date of data production
+    #
+    # @return [Hash]
+    def production
+      @metadata['production']
+    end
+
+    # Project
+    #
+    # @return [Array<Hash>]
+    def project
+      @metadata['project']
+    end
+
+    # Publication
+    #
+    # @return [Array<Hash>]
+    def publication
+      @metadata['publication']
     end
 
     # Publisher
     #
     # @return [String]
     def publisher
-      path = '/publisher/name'
-      xpath_query_for_single_value path
+      @metadata['publisher']
     end
 
-    # Combines project and publication
+    # Spatial coverage
     #
-    # @return [Array<Hash>]
-    def associated
+    # @return [Array<String>]
+    def spatial
+      @metadata['spatial']
+    end
+
+    # Temporal coverage
+    #
+    # @return [Hash]
+    def temporal
+      @metadata['temporal']
+    end
+
+    # Title
+    #
+    # @return [String]
+    def title
+      @metadata['title']
+    end
+
+    # All metadata
+    #
+    # @return [Hash]
+    def metadata
+      @metadata
+    end
+
+
+    private
+
+    def extract_access
+      path = '/openAccessPermission/term/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    def extract_associated
       path = '/associatedContent//relatedContent'
       xpath_result =  xpath_query path
       data_arr = []
@@ -71,57 +171,71 @@ module Puree
       data_arr.uniq
     end
 
-    # Project
-    #
-    # @return [Array<Hash>]
-    def project
-      associated_type('Research').uniq
+    def extract_available
+      temporal_start_date 'dateMadeAvailable'
     end
 
-    # Publication
-    #
-    # @return [Array<Hash>]
-    def publication
-      data_arr = []
-      associated.each do |i|
-        if i['type'] != 'Research'
-          data_arr << i
-        end
-      end
-      data_arr.uniq
+    def extract_description
+      path = '/descriptions/classificationDefinedField/value/localizedString'
+      xpath_query_for_single_value path
     end
 
-
-    # Title
-    #
-    # @return [String]
-    def title
-      path = '/title/localizedString'
+    def extract_doi
+      path = '/doi'
       xpath_query_for_single_value path
     end
 
-    # Keyword
-    #
-    # @return [Array<String>]
-    def keyword
+    def extract_file
+      path = '/documents/document'
+      xpath_result = xpath_query path
+
+      docs = []
+
+      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
+      docs.uniq
+    end
+
+    def extract_keyword
       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 [String]
-    def description
-      path = '/descriptions/classificationDefinedField/value/localizedString'
-      xpath_query_for_single_value path
+    def extract_link
+      path = '/links/link'
+      xpath_result = xpath_query path
+      data = []
+      xpath_result.each { |i|
+        o = {}
+        o['url'] = i.xpath('url').text.strip
+        o['description'] = i.xpath('description').text.strip
+        data << o
+      }
+      data.uniq
     end
 
-    # Organisation
-    #
-    # @return [Array<Hash>]
-    def organisation
+    def extract_organisation
       path = '/organisations/organisation'
       xpath_result = xpath_query path
       data = []
@@ -135,10 +249,17 @@ module Puree
       data
     end
 
-    # Person (internal, external, other)
-    #
-    # @return [Array<Hash>]
-    def person
+    def extract_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
+    end
+
+    def extract_person
       data = {}
       # internal
       path = '/persons/dataSetPersonAssociation'
@@ -174,17 +295,30 @@ module Puree
       data
     end
 
-    # Date made available
-    #
-    # @return [Hash]
-    def available
-      temporal_start_date 'dateMadeAvailable'
+    def extract_production
+      temporal_range 'dateOfDataProduction', 'endDateOfDataProduction'
     end
 
-    # Geographical coverage
-    #
-    # @return [Array<String>]
-    def geographical
+    def extract_project
+      associated_type('Research').uniq
+    end
+
+    def extract_publication
+      data_arr = []
+      extract_associated.each do |i|
+        if i['type'] != 'Research'
+          data_arr << i
+        end
+      end
+      data_arr.uniq
+    end
+
+    def extract_publisher
+      path = '/publisher/name'
+      xpath_query_for_single_value path
+    end
+
+    def extract_spatial
       path = '/geographicalCoverage/localizedString'
       xpath_result = xpath_query path
       data = []
@@ -194,68 +328,12 @@ module Puree
       data
     end
 
-    # Date of data production
-    #
-    # @return [Hash]
-    def production
-      temporal_range 'dateOfDataProduction', 'endDateOfDataProduction'
-    end
-
-
-    # Temporal coverage
-    #
-    # @return [Hash]
-    def temporal
+    def extract_temporal
       temporal_range 'temporalCoverageStartDate', 'temporalCoverageEndDate'
     end
 
-    # Open access permission
-    #
-    # @return [String]
-    def access
-      path = '/openAccessPermission/term/localizedString'
-      xpath_query_for_single_value path
-    end
-
-
-    # Supporting file
-    #
-    # @return [Array<Hash>]
-    def file
-      path = '/documents/document'
-      xpath_result = xpath_query path
-
-      docs = []
-
-      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
-      docs.uniq
-    end
-
-    # Digital Object Identifier
-    #
-    # @return [String]
-    def doi
-      path = '/doi'
+    def extract_title
+      path = '/title/localizedString'
       xpath_query_for_single_value path
     end
 
@@ -265,34 +343,29 @@ module Puree
     #    !data.empty? ? data['startedWorkflow']['state'] : ''
     # end
 
-    # All metadata
-    #
-    # @return [Hash]
-    def metadata
+    def combine_metadata
       o = super
-      o['access'] = access
-      o['associated'] = associated
-      o['available'] = available
-      o['description'] = description
-      o['doi'] = doi
-      o['file'] = file
-      o['geographical'] = geographical
-      o['keyword'] = keyword
-      o['link'] = link
-      o['organisation'] = organisation
-      o['owner'] = owner
-      o['person'] = person
-      o['project'] = project
-      o['production'] = production
-      o['publication'] = publication
-      o['publisher'] = publisher
-      o['temporal'] = temporal
-      o['title'] = title
-      o
+      o['access'] = extract_access
+      o['associated'] = extract_associated
+      o['available'] = extract_available
+      o['description'] = extract_description
+      o['doi'] = extract_doi
+      o['file'] = extract_file
+      o['keyword'] = extract_keyword
+      o['link'] = extract_link
+      o['organisation'] = extract_organisation
+      o['owner'] = extract_owner
+      o['person'] = extract_person
+      o['project'] = extract_project
+      o['production'] = extract_production
+      o['publication'] = extract_publication
+      o['publisher'] = extract_publisher
+      o['spatial'] = extract_spatial
+      o['temporal'] = extract_temporal
+      o['title'] = extract_title
+      @metadata = o
     end
 
-    private
-
     # Assembles basic information about a person
     #
     # @param generic_data [Hash]
@@ -355,7 +428,7 @@ module Puree
     #
     # @return [Hash]
     def associated_type(type)
-      associated_arr = associated
+      associated_arr = extract_associated
       data_arr = []
       associated_arr.each do |i|
         data = {}