puree 0.14.0 → 0.15.0

data/lib/puree/server.rb

@@ -0,0 +1,147 @@
+module Puree
+
+  # Server
+  #
+  class Server
+
+    attr_reader :response
+
+    # @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)
+      @resource_type = :server
+      @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
+    #
+    # @return [Hash]
+    def get
+      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,
+      }
+      headers = {
+          'Accept' => 'application/xml',
+          'Authorization' => 'Basic ' + @auth
+      }
+      query = {}
+      query['rendering'] = @options[:rendering]
+
+      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
+      o = {}
+      o['version'] = version
+      o
+    end
+
+    # Version
+    #
+    # @return [String]
+    def version
+      path = service_response_name + '/baseVersion'
+      xpath_query(path).text.strip
+    end
+
+    private
+
+
+    # Is there any data after get?
+    #
+    # @return [Boolean]
+    def get_data?
+      # n.b. arbitrary element existence check
+      path = service_response_name + '/baseVersion'
+      xpath_result = @doc.xpath path
+      xpath_result.size ? true : false
+    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/version.rb

@@ -1,3 +1,3 @@
 module Puree
-  VERSION = "0.14.0"
+  VERSION = "0.15.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{Consumes the Pure Research Information System API and facilitates post-processing of metadata into simple data structures.}
+  spec.description   = %q{Purée 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"
 
@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.1'
 
-  spec.add_runtime_dependency 'httparty', '~> 0.13'
+  spec.add_runtime_dependency 'http', '~> 2.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.6'
 end

data/spec/collection.rb

@@ -3,7 +3,15 @@ require 'spec_helper'
 describe 'Collection' do
 
   it '#new' do
-    p = Puree::Collection.new(api: :dataset)
+    endpoint = ENV['PURE_ENDPOINT']
+    username = ENV['PURE_USERNAME']
+    password = ENV['PURE_PASSWORD']
+    p = Puree::Collection.new(resource: :dataset,
+                              endpoint: endpoint,
+                              username: username,
+                              password: password,
+                              basic_auth: true
+    )
     expect(p).to be_an_instance_of Puree::Collection
   end
 
@@ -12,15 +20,16 @@ describe 'Collection' do
       endpoint = ENV['PURE_ENDPOINT']
       username = ENV['PURE_USERNAME']
       password = ENV['PURE_PASSWORD']
-      @p = Puree::Collection.new(api: :dataset,
+      @p = Puree::Collection.new(resource: :dataset,
                                  endpoint: endpoint,
                                  username: username,
-                                 password: password)
-      @p.find limit: 5
+                                 password: password,
+                                 basic_auth: true)
+      @metadata = @p.find limit: 5
     end
 
-    it '#UUID' do
-      expect(@p.uuid).to be_an_instance_of(Array)
+    it '@metadata' do
+      expect(@metadata).to be_an_instance_of(Array)
     end
 
   end

data/spec/dataset.rb

@@ -15,84 +15,85 @@ describe 'Dataset' do
       uuid = ENV['PURE_DATASET_UUID']
       @p = Puree::Dataset.new(endpoint: endpoint,
                               username: username,
-                              password: password)
-      @p.find uuid: uuid
+                              password: password,
+                              basic_auth: true)
+      @metadata = @p.find uuid: uuid
+    end
+
+    it '@metadata' do
+      expect(@metadata).to be_an_instance_of(Hash)
     end
 
     it '#access' do
-      expect(@p.access).to be_an_instance_of(String)
+      expect(@metadata['access']).to be_an_instance_of(String)
     end
 
     it '#associated' do
-      expect(@p.associated).to be_an_instance_of(Array)
+      expect(@metadata['associated']).to be_an_instance_of(Array)
     end
 
     it '#available' do
-      expect(@p.available).to be_an_instance_of(Hash)
+      expect(@metadata['available']).to be_an_instance_of(Hash)
     end
 
     it '#created' do
-      expect(@p.created).to be_an_instance_of(String)
+      expect(@metadata['created']).to be_an_instance_of(String)
     end
 
     it '#description' do
-      expect(@p.description).to be_an_instance_of(String)
+      expect(@metadata['description']).to be_an_instance_of(String)
     end
 
     it '#doi' do
-      expect(@p.doi).to be_an_instance_of(String)
+      expect(@metadata['doi']).to be_an_instance_of(String)
     end
 
     it '#file' do
-      expect(@p.file).to be_an_instance_of(Array)
+      expect(@metadata['file']).to be_an_instance_of(Array)
     end
 
     it '#geographical' do
-      expect(@p.geographical).to be_an_instance_of(Array)
+      expect(@metadata['geographical']).to be_an_instance_of(Array)
     end
 
     it '#keyword' do
-      expect(@p.keyword).to be_an_instance_of(Array)
+      expect(@metadata['keyword']).to be_an_instance_of(Array)
     end
 
     it '#link' do
-      expect(@p.link).to be_an_instance_of(Array)
-    end
-
-    it '#metadata' do
-      expect(@p.metadata).to be_an_instance_of(Hash)
+      expect(@metadata['link']).to be_an_instance_of(Array)
     end
 
     it '#modified' do
-      expect(@p.modified).to be_an_instance_of(String)
+      expect(@metadata['modified']).to be_an_instance_of(String)
     end
 
     it '#person' do
-      expect(@p.person).to be_an_instance_of(Hash)
+      expect(@metadata['person']).to be_an_instance_of(Hash)
     end
 
     it '#production' do
-      expect(@p.production).to be_an_instance_of(Hash)
+      expect(@metadata['production']).to be_an_instance_of(Hash)
     end
 
     it '#project' do
-      expect(@p.project).to be_an_instance_of(Array)
+      expect(@metadata['project']).to be_an_instance_of(Array)
     end
 
     it '#publication' do
-      expect(@p.publication).to be_an_instance_of(Array)
+      expect(@metadata['publication']).to be_an_instance_of(Array)
     end
 
     it '#publisher' do
-      expect(@p.publisher).to be_an_instance_of(String)
+      expect(@metadata['publisher']).to be_an_instance_of(String)
     end
 
     it '#temporal' do
-      expect(@p.temporal).to be_an_instance_of(Hash)
+      expect(@metadata['temporal']).to be_an_instance_of(Hash)
     end
 
     it '#title' do
-      expect(@p.title).to be_an_instance_of(String)
+      expect(@metadata['title']).to be_an_instance_of(String)
     end
 
 

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'httparty'
+require 'http'
 require 'nokogiri'
 require 'puree/configuration'
 require 'puree/date'
@@ -12,4 +12,16 @@ require 'puree/person'
 require 'puree/project'
 require 'puree/publication'
 require 'puree/publisher'
-require 'puree/collection'
+require 'puree/collection'
+require 'puree/download'
+require 'puree/server'
+
+module Puree
+
+  class << self
+
+    include Puree::Configuration
+
+  end
+
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-description: Consumes the Pure Research Information System API and facilitates post-processing
-  of metadata into simple data structures.
+description: Purée consumes the Pure Research Information System API and puts
+  the metadata into simple data structures.
 email:
 - a.albin-clark@lancaster.ac.uk
 executables: []
@@ -67,6 +67,7 @@ files:
 - lib/puree/publication.rb
 - lib/puree/publisher.rb
 - lib/puree/resource.rb
+- lib/puree/server.rb
 - lib/puree/version.rb
 - puree.gemspec
 - spec/collection.rb