puree 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 589862f38fbdf73c8255cfd00e51191fbbdde42a
+  data.tar.gz: 146680ea5def8f36b7a4bc377413949e2c244de4
+SHA512:
+  metadata.gz: 9728d190508de23b7b08e3fb0094700f9ec190b40573d32dd8740fad263fca7447b3ff169b89eff6831dc2cf933a3cc2224e6947601610d31c203ffff615018e
+  data.tar.gz: 470051d32055bbd820d7e44a3d931a48419a087cad860a8522c890c8e58a16321fbe60167609f25d528c38b7c8813ae764df6f037c5b4315d61c48c2abeac85f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.6.0 - 2016-05-06
+### Added
+- API map factored out of Resource.
+- Collections (journal, organisation, person, project, publication, publisher).
+- Resource classes with HTTParty metadata (journal, organisation, person, project, publication, publisher).
+
+## 0.5.0 - 2016-04-29
+### Added
+- Refactoring ctor.
+- Populate resource metadata from get and assignment.
+- Dataset collection.
+- RSpec tests for dataset collection.
+
+## 0.4.0 - 2016-04-27
+### Added
+- Date normalisation and conversion to ISO8601.
+
+## 0.3.0 - 2016-04-26
+### Added
+- Yard documentation.
+- Simplification of public interface method names.
+
+## 0.2.0 - 2016-04-25
+### Added
+- RSpec tests for datasets.
+
+## 0.1.0 - 2016-04-21
+### Added
+- Working product supports datasets.
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Adrian Albin-Clark
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,232 @@
+# Purée
+
+A Ruby client for the Pure Research Information System API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'puree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puree
+
+## Usage
+```ruby
+endpoint = 'http://example.com/ws/rest'
+```
+
+Dataset.
+
+```ruby
+d = Puree::Dataset.new
+
+# Get metadata using ID
+d.get id:       12345678,
+      endpoint: endpoint,
+      username: username,
+      password: password
+
+# Get metadata using UUID
+d.get uuid:     'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx',
+      endpoint: endpoint,
+      username: username,
+      password: password
+
+# Filter metadata into simple data structures
+d.title
+d.description
+d.keyword
+d.person
+d.temporal
+d.geographical
+d.file
+d.publication
+d.available
+d.access
+d.doi
+
+# Combine metadata into one simple data structure
+d.metadata
+
+# Access HTTParty functionality
+d.response # HTTParty object
+d.response.body # XML
+d.response.code
+d.response.message
+d.response.headers # hash
+```
+
+Collection.
+
+```ruby
+c = Puree::Collection.new(resource_type: :dataset)
+
+# Get minimal datasets, optionally specifying a quantity (default is 20)
+c.get endpoint: endpoint,
+      username: username,
+      password: password,
+      qty:      100000
+
+# Get UUIDs for datasets
+uuids = c.uuid
+
+# Get metadata using UUID
+datasets = []
+uuids.each do |uuid|
+    d = Puree::Dataset.new
+    d.get endpoint: endpoint,
+          username: username,
+          password: password,
+          uuid:     uuid
+    datasets << d.metadata
+end
+```
+
+
+## Dataset data structures
+
+### available
+Date made available. If year is present, month and day will have data or an empty string.
+
+```ruby
+{
+  "year"=>"2016",
+  "month"=>"2",
+  "day"=>"4"
+}
+```
+
+### file
+An array of files.
+
+```ruby
+[
+  {
+    "name"=>"foo.csv",
+    "mime"=>"application/octet-stream",
+    "size"=>"1616665158",
+    "url"=>"http://example.com/ws/rest/files/12345678/foo.csv",
+    "title"=>"foo.csv",
+    "license"=>{
+      "name"=>"CC BY-NC",
+      "url"=>"http://creativecommons.org/licenses/by-nc/4.0/"
+    }
+  },
+]
+```
+
+### person
+Contains an array of internal persons and an array of external persons.
+
+```ruby
+{
+  "internal"=>[
+    {
+      "name"=>{
+        "first"=>"Stan",
+        "last"=>"Laurel"
+       },
+       "role"=>"Creator",
+       "uuid"=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
+    },
+  ],
+  "external"=>[
+  ]
+}
+```
+
+### publication
+An array of related publications.
+
+```ruby
+[
+  {
+    "type"=>"Journal article",
+    "title"=>"An interesting title",
+    "uuid"=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
+  },
+]
+```
+
+### temporal
+Date range. If year is present, month and day will have data or an empty string.
+
+```ruby
+{
+  "start"=>{
+    "year"=>"2005",
+    "month"=>"5",
+    "day"=>"10"
+  },
+  "end"=>{
+    "year"=>"2011",
+    "month"=>"9",
+    "day"=>"18"
+  }
+}
+```
+
+
+## Utilities
+
+### Convert date to ISO 8601 format.
+
+```ruby
+Puree::Date.iso d.available
+```
+```ruby
+{
+  "year"=>"2016",
+  "month"=>"4",
+  "day"=>"18"
+}
+```
+becomes
+
+```ruby
+"2016-04-18"
+```
+
+
+## API coverage
+Version
+
+```ruby
+5.5.1
+```
+
+Resource metadata
+
+```ruby
+:dataset
+```
+
+Resource metadata (single hash only)
+
+```ruby
+:journal
+:organisation
+:person
+:project
+:publication
+:publisher
+```
+
+Collections (for obtaining identifiers)
+
+```ruby
+:dataset
+:journal
+:organisation
+:person
+:project
+:publication
+:publisher
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/puree.rb

@@ -0,0 +1,12 @@
+require 'httparty'
+require 'puree/date'
+require 'puree/map'
+require 'puree/resource'
+require 'puree/dataset'
+require 'puree/journal'
+require 'puree/organisation'
+require 'puree/person'
+require 'puree/project'
+require 'puree/publication'
+require 'puree/publisher'
+require 'puree/collection'

data/lib/puree/collection.rb

@@ -0,0 +1,80 @@
+module Puree
+
+  # Collection resource
+  #
+  class Collection < Resource
+
+    def initialize(resource_type: nil)
+      super(resource_type)
+      @uuids = []
+    end
+
+    # Get
+    #
+    # @param endpoint [String]
+    # @param username [String]
+    # @param password [String]
+    # @param qty [Integer]
+    # @return [HTTParty::Response]
+    def get(endpoint:nil, username:nil, password:nil, qty:nil)
+      # strip any trailing slash
+      @endpoint = endpoint.sub(/(\/)+$/, '')
+      @auth = Base64::strict_encode64(username + ':' + password)
+
+      @options = {
+          latest_api: true,
+          resource_type: @resource_type.to_sym,
+          rendering: :system,
+          qty: qty
+      }
+      headers = {
+          'Accept' => 'application/xml',
+          'Authorization' => 'Basic ' + @auth
+      }
+      query = {}
+      query['rendering'] = @options[:rendering]
+      if @options[:qty]
+        query['window.size'] = @options[:qty]
+      end
+
+      @response = HTTParty.get(url, query: query, headers: headers)
+    end
+
+
+    # Array of UUIDs
+    #
+    # @return [Array<String>]
+    def uuid
+      collect_uuid
+      @uuids
+    end
+
+
+
+    private
+
+
+    def collect_uuid
+      response_name = service_response_name
+      resp = @response[response_name]['result']['renderedItem']
+      arr = []
+      if resp.is_a?(Array)
+        arr = resp
+      else
+        arr << resp
+      end
+      arr.each do |a|
+        tableRows = a['div']['table']['tbody']['tr']
+        tableRows.each do |row|
+          if row['th'] === 'UUID'
+            uuid = row['td']
+            @uuids << uuid
+          end
+        end
+      end
+    end
+
+
+  end
+
+end

data/lib/puree/dataset.rb

@@ -0,0 +1,273 @@
+module Puree
+
+  # Dataset resource
+  #
+  class Dataset < Resource
+
+    def initialize
+      super(:dataset)
+    end
+
+    # Title
+    #
+    # @return [Array<String>]
+    def title
+      data = node 'title'
+      if !data.nil? && !data.empty?
+        data = data['localizedString']["__content__"]
+        data.is_a?(Array) ? data : data.split(',')
+      else
+        []
+      end
+    end
+
+    # Keyword
+    #
+    # @return [Array<String>]
+    def keyword
+      data = node 'keywordGroups'
+      if !data.nil? && !data.empty?
+        data = data['keywordGroup']['keyword']['userDefinedKeyword']['freeKeyword']
+        data.is_a?(Array) ? data : data.split(',')
+      else
+        []
+      end
+    end
+
+    # Description
+    #
+    # @return [Array<String>]
+    def description
+      data = node 'descriptions'
+      if !data.nil? && !data.empty?
+        data = data['classificationDefinedField']['value']['localizedString']['__content__'].tr("\n", '')
+        data.is_a?(Array) ? data : data.split(',')
+      else
+        []
+      end
+    end
+
+    # Person, internal and external
+    #
+    # @return [Hash<Array, Array>]
+    def person
+      data = node('persons')
+      persons = {}
+      if !data.nil? && !data.empty?
+        data = data['dataSetPersonAssociation']
+      else
+        return persons
+      end
+      internal_persons = []
+      external_persons = []
+      case data
+        when Array
+          data.each do |d|
+            person = generic_person d
+            if d.key? 'person'
+              person['uuid'] = d['person']['uuid']
+              internal_persons << person
+            end
+            if d.key? 'externalPerson'
+              person['uuid'] = d['externalPerson']['uuid']
+              external_persons << person
+            end
+          end
+        when Hash
+          person = generic_person data
+          if data.key? 'person'
+            person['uuid'] = data['person']['uuid']
+            internal_persons << person
+          end
+          if data.key? 'externalPerson'
+            person['uuid'] = data['externalPerson']['uuid']
+            external_persons << person
+          end
+      end
+      persons['internal'] = internal_persons
+      persons['external'] = external_persons
+      persons
+    end
+
+    # Publication
+    #
+    # @return [Array<Hash>]
+    def publication
+      data = node('relatedPublications')
+      publications = []
+      if !data.nil? && !data.empty?
+        # convert to array
+        data_arr = []
+        if data['relatedContent'].is_a?(Array)
+          data_arr = data['relatedContent']
+        else
+          data_arr[0] = data['relatedContent']
+        end
+        data_arr.each do |d|
+          o = {}
+          o['type'] = d['typeClassification']
+          o['title'] = d['title']
+          o['uuid'] = d['uuid']
+          publications << o
+        end
+      end
+      publications
+    end
+
+    # Date made available
+    #
+    # @return [Hash]
+    def available
+      data = node('dateMadeAvailable')
+      Puree::Date.normalise(data)
+    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 : data.split(',')
+      else
+        []
+      end
+    end
+
+    # Temporal coverage
+    #
+    # @return [Hash]
+    def temporal
+      data = {}
+      data['start'] = {}
+      data['end'] = {}
+      start_date = temporal_coverage_start_date
+      if !start_date.nil? && !start_date.empty?
+        data['start'] = start_date
+      end
+      end_date = temporal_coverage_end_date
+      if !end_date.nil? && !end_date.empty?
+        data['end'] = end_date
+      end
+      data
+    end
+
+    # Open access permission
+    #
+    # @return [String]
+    def access
+      data = node 'openAccessPermission'
+      !data.nil? && !data.empty? ? data['term']['localizedString']["__content__"] : ''
+    end
+
+
+    # Supporting file
+    #
+    # @return [Array<Hash>]
+    def file
+      data = node 'documents'
+
+      docs = []
+      if !data.nil? && !data.empty?
+        # convert to array
+        data_arr = []
+        if data['document'].is_a?(Array)
+          data_arr = data['document']
+        else
+          data_arr << data['document']
+        end
+
+        data_arr.each do |d|
+          doc = {}
+          # doc['id'] = d['id']
+          doc['name'] = d['fileName']
+          doc['mime'] = d['mimeType']
+          doc['size'] = d['size']
+          doc['url'] = d['url']
+          doc['title'] = d['title']
+          # doc['createdDate'] = doc['createdDate']
+          # doc['visibleOnPortalDate'] = doc['visibleOnPortalDate']
+          # doc['limitedVisibility'] = doc['limitedVisibility']
+
+          license = {}
+          if d['documentLicense']
+            license_name = d['documentLicense']['term']['localizedString']['__content__']
+            license['name'] = license_name
+            license_url = d['documentLicense']['description']['localizedString']['__content__']
+            license['url'] = license_url
+            doc['license'] = license
+          end
+          docs << doc
+
+        end
+      end
+      docs
+    end
+
+    # Digital Object Identifier
+    #
+    # @return [String]
+    def doi
+      data = node 'doi'
+      !data.nil? && !data.empty? ? data['doi'] : ''
+    end
+
+    # def state
+    #   # useful?
+    #   data = node 'startedWorkflows'
+    #    !data.empty? ? data['startedWorkflow']['state'] : ''
+    # end
+
+    # All metadata
+    #
+    # @return [Hash]
+    def metadata
+      o = {}
+      o['title'] = title
+      o['description'] = description
+      o['keyword'] = keyword
+      o['person'] = person
+      o['temporal'] = temporal
+      o['geographical'] = geographical
+      o['file'] = file
+      o['publication'] = publication
+      o['available'] = available
+      o['access'] = access
+      o['doi'] = doi
+      o
+    end
+
+    private
+
+    # Assembles basic information about a person
+    #
+    # @param generic_data [Hash]
+    # @return [Hash]
+    def generic_person(generic_data)
+      person = {}
+      name = {}
+      name['first'] = generic_data['name']['firstName']
+      name['last'] = generic_data['name']['lastName']
+      person['name'] = name
+      person['role'] = generic_data['personRole']['term']['localizedString']["__content__"]
+      person
+    end
+
+    # Temporal coverage start date
+    #
+    # @return [Hash]
+    def temporal_coverage_start_date
+      data = node('temporalCoverageStartDate')
+      !data.nil? && !data.empty? ? Puree::Date.normalise(data) : {}
+    end
+
+    # Temporal coverage end date
+    #
+    # @return [Hash]
+    def temporal_coverage_end_date
+      data = node('temporalCoverageEndDate')
+      !data.nil? && !data.empty? ? Puree::Date.normalise(data) : {}
+    end
+  end
+end

data/lib/puree/date.rb

@@ -0,0 +1,61 @@
+module Puree
+
+  module Date
+
+    # Converts a date with three components (year, month, day) to ISO8601 format
+    #
+    # @param data [Hash]
+    # @return [String]
+    def self.iso(data)
+      iso_date = ''
+      year =  data['year']
+      month = data['month']
+      day = data['day']
+      if !year.empty?
+        iso_date << year
+      else
+        iso_date
+      end
+      if !month.empty?
+        # Add leading zero to convert to ISO 8601
+        if month.length < 2
+          month.insert(0, '0')
+        end
+        iso_date << '-' + month
+      else
+        iso_date
+      end
+      if !day.empty?
+        # Add leading zero to convert to ISO 8601
+        if day.length < 2
+          day.insert(0, '0')
+        end
+        iso_date << '-' + day
+      end
+      iso_date
+    end
+
+    private
+
+    # Forces a date to have three components (year, month, day)
+    #
+    # @param data [Hash]
+    # @return [Hash]
+    def self.normalise(data)
+      if !data.nil? && !data.empty?
+        date = {}
+        year =  data['year']
+        month = data['month']
+        day = data['day']
+        date['year'] = year ? year : ''
+        date['month'] = month ? month : ''
+        date['day'] = day ? day : ''
+        date
+      else
+        {}
+      end
+    end
+
+  end
+
+end

data/lib/puree/journal.rb

@@ -0,0 +1,13 @@
+module Puree
+
+  # Journal resource
+  #
+  class Journal < Resource
+
+    def initialize
+      super(:journal)
+    end
+
+  end
+
+end

data/lib/puree/map.rb

@@ -0,0 +1,48 @@
+module Puree
+
+  class Map
+
+    def initialize
+      @convention = %w(
+        journal
+        organisation
+        person
+        project
+        publication
+        publisher
+      )
+
+      @api_map = {
+        resource_type: {
+          dataset: {
+            service: 'datasets',
+            response: 'GetDataSetsResponse'
+          }
+        }
+      }
+
+      add_convention
+    end
+
+    # Pure API map
+    #
+    # @return [Hash]
+    def get
+      @api_map
+    end
+
+
+    private
+
+    def add_convention
+      @convention.each do |c|
+        resource_type = {}
+        resource_type[:service] = c
+        resource_type[:response] = 'Get' + c.capitalize + 'Response'
+        @api_map[:resource_type][c.to_sym] = resource_type
+      end
+    end
+
+  end
+
+end

data/lib/puree/organisation.rb

@@ -0,0 +1,13 @@
+module Puree
+
+  # Organisation resource
+  #
+  class Organisation < Resource
+
+    def initialize
+      super(:organisation)
+    end
+
+  end
+
+end

data/lib/puree/person.rb

@@ -0,0 +1,13 @@
+module Puree
+
+  # Person resource
+  #
+  class Person < Resource
+
+    def initialize
+      super(:person)
+    end
+
+  end
+
+end

data/lib/puree/project.rb

@@ -0,0 +1,13 @@
+module Puree
+
+  # Project resource
+  #
+  class Project < Resource
+
+    def initialize
+      super(:project)
+    end
+
+  end
+
+end

data/lib/puree/publication.rb

@@ -0,0 +1,13 @@
+module Puree
+
+  # Publication resource
+  #
+  class Publication < Resource
+
+    def initialize
+      super(:publication)
+    end
+
+  end
+
+end

data/lib/puree/publisher.rb

@@ -0,0 +1,13 @@
+module Puree
+
+  # Publisher resource
+  #
+  class Publisher < Resource
+
+    def initialize
+      super(:publisher)
+    end
+
+  end
+
+end

data/lib/puree/resource.rb

@@ -0,0 +1,124 @@
+module Puree
+
+  # Abstract base class for resources.
+  #
+  class Resource
+
+    def initialize(resource_type)
+      @resource_type = resource_type
+      @api_map = Puree::Map.new.get
+    end
+
+    # Get
+    #
+    # @param endpoint [String]
+    # @param username [String]
+    # @param password [String]
+    # @param uuid [String]
+    # @param id [String]
+    # @return [HTTParty::Response]
+    def get(endpoint:nil, username:nil, password:nil, uuid:nil, id:nil)
+      # strip any trailing slash
+      @endpoint = endpoint.sub(/(\/)+$/, '')
+      @auth = Base64::strict_encode64(username + ':' + password)
+
+      @options = {
+          latest_api: true,
+          resource_type: @resource_type.to_sym,
+          rendering: :xml_long,
+          uuid: uuid,
+          id: id,
+      }
+      headers = {
+          'Accept' => 'application/xml',
+          'Authorization' => 'Basic ' + @auth
+      }
+      query = {}
+      query['rendering'] = @options[:rendering]
+      if @options[:uuid]
+        query['uuids.uuid'] = @options[:uuid]
+      else
+        if @options[:id]
+          query['pureInternalIds.id'] = @options[:id]
+        end
+      end
+
+      @response = HTTParty.get(url, query: query, headers: headers)
+
+      if get_data?
+        response_name = service_response_name
+        content = @response.parsed_response[response_name]['result']['content']
+        set_content(content)
+      end
+      @response
+    end
+
+    # Response, if get method has been called
+    #
+    # @return [HTTParty::Response]
+    # @return [Nil]
+    def response
+      @response ? @response : nil
+    end
+
+    # Set content
+    #
+    # @param content [Hash]
+    def set_content(content)
+      if !content.nil? && !content.empty?
+        @content = content
+      else
+        @content = {}
+      end
+    end
+
+    # Content
+    #
+    # @return [Hash]
+    def content
+      @content ? @content : {}
+    end
+
+
+
+    private
+
+
+
+    # Node
+    #
+    # @return [Hash]
+    def node(name)
+      @content ? @content[name] : {}
+    end
+
+    # Is there any data after get?
+    #
+    # @return [Boolean]
+    def get_data?
+      response_name = service_response_name
+      @response.parsed_response[response_name]['count'] != '0' ? 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 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
+
+  end
+end

data/lib/puree/version.rb

@@ -0,0 +1,3 @@
+module Puree
+  VERSION = "0.6.0"
+end

data/puree.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puree"
+  spec.version       = Puree::VERSION
+  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.homepage      = "https://github.com/lulibrary/puree.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'httparty', '~> 0'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'rake', '~> 0'
+end

data/spec/collection.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'Collection' do
+
+  it '#new' do
+    p = Puree::Collection.new(resource_type: :dataset)
+    expect(p).to be_an_instance_of Puree::Collection
+  end
+
+  describe 'data retrieval' do
+    before(:all) do
+      endpoint = ENV['PURE_ENDPOINT']
+      username = ENV['PURE_USERNAME']
+      password = ENV['PURE_PASSWORD']
+      @p = Puree::Collection.new(resource_type: :dataset)
+      @p.get endpoint: endpoint,
+             username: username,
+             password: password
+    end
+
+    it '#UUID' do
+      expect(@p.uuid).to be_an_instance_of(Array)
+    end
+
+  end
+
+end

data/spec/dataset.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'Dataset' do
+
+  it '#new' do
+    p = Puree::Dataset.new
+    expect(p).to be_an_instance_of Puree::Dataset
+  end
+
+  describe 'data retrieval' do
+    before(:all) do
+      endpoint = ENV['PURE_ENDPOINT']
+      username = ENV['PURE_USERNAME']
+      password = ENV['PURE_PASSWORD']
+      uuid = ENV['PURE_DATASET_UUID']
+      @p = Puree::Dataset.new
+      @p.get endpoint: endpoint,
+             username: username,
+             password: password,
+             uuid: uuid
+    end
+
+    it '#title' do
+      expect(@p.title).to be_an_instance_of(Array)
+    end
+
+    it '#keyword' do
+      expect(@p.keyword).to be_an_instance_of(Array)
+    end
+
+    it '#description' do
+      expect(@p.description).to be_an_instance_of(Array)
+    end
+
+    it '#person' do
+      expect(@p.person).to be_an_instance_of(Hash)
+    end
+
+    it '#publication' do
+      expect(@p.publication).to be_an_instance_of(Array)
+    end
+
+    it '#available' do
+      expect(@p.available).to be_an_instance_of(Hash)
+    end
+
+    it '#geographical' do
+      expect(@p.geographical).to be_an_instance_of(Array)
+    end
+
+    it '#temporal' do
+      expect(@p.temporal).to be_an_instance_of(Hash)
+    end
+
+    it '#access' do
+      expect(@p.access).to be_an_instance_of(String)
+    end
+
+    it '#file' do
+      expect(@p.file).to be_an_instance_of(Array)
+    end
+
+    it '#doi' do
+      expect(@p.doi).to be_an_instance_of(String)
+    end
+
+    it '#metadata' do
+      expect(@p.metadata).to be_an_instance_of(Hash)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'httparty'
+require 'puree/date'
+require 'puree/map'
+require 'puree/resource'
+require 'puree/dataset'
+require 'puree/journal'
+require 'puree/organisation'
+require 'puree/person'
+require 'puree/project'
+require 'puree/publication'
+require 'puree/publisher'
+require 'puree/collection'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: puree
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Adrian Albin-Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Consumes the Pure Research Information System API and facilitates post-processing
+  of metadata into simple data structures.
+email:
+- a.albin-clark@lancaster.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puree.rb
+- lib/puree/collection.rb
+- lib/puree/dataset.rb
+- lib/puree/date.rb
+- lib/puree/journal.rb
+- lib/puree/map.rb
+- lib/puree/organisation.rb
+- lib/puree/person.rb
+- lib/puree/project.rb
+- lib/puree/publication.rb
+- lib/puree/publisher.rb
+- lib/puree/resource.rb
+- lib/puree/version.rb
+- puree.gemspec
+- spec/collection.rb
+- spec/dataset.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lulibrary/puree.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A client for the Pure Research Information System API.
+test_files:
+- spec/collection.rb
+- spec/dataset.rb
+- spec/spec_helper.rb
+has_rdoc: