puree 0.15.0 → 0.16.0

data/lib/puree/publisher.rb

@@ -4,25 +4,31 @@ module Puree
   #
   class Publisher < 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: :publisher,
-            endpoint: endpoint,
+            base_url: base_url,
             username: username,
             password: password,
             basic_auth: basic_auth)
     end
 
-
-
     # All metadata
     #
     # @return [Hash]
     def metadata
-      super
+      @metadata
+    end
+
+
+    private
+
+    def combine_metadata
+      o = super
+      @metadata = o
     end
 
   end

data/lib/puree/resource.rb

@@ -7,20 +7,20 @@ module Puree
     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]
+    # @param base_url [String]
+    # @param username [String]
+    # @param password [String]
+    # @param bleeding [Boolean]
+    # @param basic_auth [Boolean]
     def initialize( api: nil,
-                    endpoint: nil,
+                    base_url: nil,
                     username: nil,
                     password: nil,
                     bleeding: true,
                     basic_auth: nil)
       @resource_type = api
       @api_map = Puree::Map.new.get
-      @endpoint = endpoint.nil? ? Puree.endpoint : endpoint
+      @base_url = base_url.nil? ? Puree.base_url : base_url
       @latest_api = bleeding
       @basic_auth = basic_auth.nil? ? Puree.basic_auth : basic_auth
       if @basic_auth === true
@@ -55,7 +55,7 @@ module Puree
       end
 
       # strip any trailing slash
-      @endpoint = @endpoint.sub(/(\/)+$/, '')
+      @base_url = @base_url.sub(/(\/)+$/, '')
 
       headers = {}
       headers['Accept'] = 'application/xml'
@@ -94,7 +94,7 @@ module Puree
         puts 'HTTP::Error '+ e.message
       end
 
-      get_data? ? metadata : {}
+      get_data? ? combine_metadata : {}
 
     end
 
@@ -116,10 +116,14 @@ module Puree
       @content ? @content : {}
     end
 
+
+
+    private
+
     # Created (UTC datetime)
     #
     # @return [String]
-    def created
+    def extract_created
       path = '/created'
       xpath_query_for_single_value path
     end
@@ -127,7 +131,7 @@ module Puree
     # Modified (UTC datetime)
     #
     # @return [String]
-    def modified
+    def extract_modified
       path = '/modified'
       xpath_query_for_single_value path
     end
@@ -135,7 +139,7 @@ module Puree
     # UUID
     #
     # @return [String]
-    def uuid
+    def extract_uuid
       path = '/@uuid'
       xpath_query_for_single_value path
     end
@@ -143,19 +147,14 @@ module Puree
     # All metadata
     #
     # @return [Hash]
-    def metadata
+    def combine_metadata
       o = {}
-      o['uuid'] = uuid
-      o['created'] = created
-      o['modified'] = modified
+      o['uuid'] = extract_uuid
+      o['created'] = extract_created
+      o['modified'] = extract_modified
       o
     end
 
-
-
-    private
-
-
     # Is there any data after get? For a response that provides a count of the results.
     #
     # @return [Boolean]
@@ -194,7 +193,7 @@ module Puree
       else
         service_api_mode = service + '.current'
       end
-      @endpoint + '/' + service_api_mode
+      @base_url + '/' + service_api_mode
     end
 
     # content based
@@ -211,8 +210,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/server.rb

@@ -6,17 +6,17 @@ module Puree
 
     attr_reader :response
 
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
-    def initialize(endpoint: 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)
       @resource_type = :server
       @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
@@ -37,7 +37,7 @@ module Puree
       end
 
       # strip any trailing slash
-      @endpoint = @endpoint.sub(/(\/)+$/, '')
+      @base_url = @base_url.sub(/(\/)+$/, '')
       @auth = Base64::strict_encode64(@username + ':' + @password)
 
       @options = {
@@ -66,28 +66,36 @@ module Puree
         puts 'HTTP::Error '+ e.message
       end
 
-      get_data? ? metadata : {}
+      get_data? ? combine_metadata : {}
     end
 
     # All metadata
     #
     # @return [Hash]
     def metadata
-      o = {}
-      o['version'] = version
-      o
+      @metadata
     end
 
     # Version
     #
     # @return [String]
     def version
-      path = service_response_name + '/baseVersion'
-      xpath_query(path).text.strip
+      @metadata['version']
     end
 
     private
 
+    def combine_metadata
+      o = {}
+      o['version'] = extract_version
+      @metadata = o
+    end
+
+    def extract_version
+      path = service_response_name + '/baseVersion'
+      xpath_query(path).text.strip
+    end
+
 
     # Is there any data after get?
     #
@@ -116,7 +124,7 @@ module Puree
       else
         service_api_mode = service + '.current'
       end
-      @endpoint + '/' + service_api_mode
+      @base_url + '/' + service_api_mode
     end
 
     def xpath_query(path)
@@ -128,8 +136,8 @@ module Puree
 
     def missing_credentials
       missing = []
-      if @endpoint.nil?
-        missing << 'endpoint'
+      if @base_url.nil?
+        missing << 'base_url'
       end
       if @username.nil?
         missing << 'username'

data/lib/puree/version.rb

@@ -1,3 +1,3 @@
 module Puree
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/puree.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Adrian Albin-Clark"]
   spec.email         = ["a.albin-clark@lancaster.ac.uk"]
   spec.summary       = %q{A client for the Pure Research Information System API.}
-  spec.description   = %q{Purée consumes the Pure Research Information System API and puts the metadata into simple data structures.}
+  spec.description   = %q{Puree consumes the Pure Research Information System API and puts the metadata into simple data structures.}
   spec.homepage      = "https://github.com/lulibrary/puree.git"
   spec.license       = "MIT"
 

data/spec/collection.rb

@@ -3,11 +3,11 @@ require 'spec_helper'
 describe 'Collection' do
 
   it '#new' do
-    endpoint = ENV['PURE_ENDPOINT']
+    base_url = ENV['PURE_BASE_URL']
     username = ENV['PURE_USERNAME']
     password = ENV['PURE_PASSWORD']
     p = Puree::Collection.new(resource: :dataset,
-                              endpoint: endpoint,
+                              base_url: base_url,
                               username: username,
                               password: password,
                               basic_auth: true
@@ -17,11 +17,11 @@ describe 'Collection' do
 
   describe 'data retrieval' do
     before(:all) do
-      endpoint = ENV['PURE_ENDPOINT']
+      base_url = ENV['PURE_BASE_URL']
       username = ENV['PURE_USERNAME']
       password = ENV['PURE_PASSWORD']
       @p = Puree::Collection.new(resource: :dataset,
-                                 endpoint: endpoint,
+                                 base_url: base_url,
                                  username: username,
                                  password: password,
                                  basic_auth: true)

data/spec/dataset.rb

@@ -9,11 +9,11 @@ describe 'Dataset' do
 
   describe 'data retrieval' do
     before(:all) do
-      endpoint = ENV['PURE_ENDPOINT']
+      base_url = ENV['PURE_BASE_URL']
       username = ENV['PURE_USERNAME']
       password = ENV['PURE_PASSWORD']
       uuid = ENV['PURE_DATASET_UUID']
-      @p = Puree::Dataset.new(endpoint: endpoint,
+      @p = Puree::Dataset.new(base_url: base_url,
                               username: username,
                               password: password,
                               basic_auth: true)
@@ -52,10 +52,6 @@ describe 'Dataset' do
       expect(@metadata['file']).to be_an_instance_of(Array)
     end
 
-    it '#geographical' do
-      expect(@metadata['geographical']).to be_an_instance_of(Array)
-    end
-
     it '#keyword' do
       expect(@metadata['keyword']).to be_an_instance_of(Array)
     end
@@ -88,6 +84,10 @@ describe 'Dataset' do
       expect(@metadata['publisher']).to be_an_instance_of(String)
     end
 
+    it '#spatial' do
+      expect(@metadata['spatial']).to be_an_instance_of(Array)
+    end
+
     it '#temporal' do
       expect(@metadata['temporal']).to be_an_instance_of(Hash)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-description: Purée consumes the Pure Research Information System API and puts
-  the metadata into simple data structures.
+description: Puree consumes the Pure Research Information System API and puts the
+  metadata into simple data structures.
 email:
 - a.albin-clark@lancaster.ac.uk
 executables: []