puree 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b99230d8fee3aa6a259149b6b0fcf1beb258f43
-  data.tar.gz: 3c6e08559c575caa1edb25c986d91f670f157384
+  metadata.gz: b99d2257bc1a5acc9a02e0518d722e741f75953d
+  data.tar.gz: f29a0057bcd27d84c01b90c2a1316986765442a4
 SHA512:
-  metadata.gz: 083843de876a7502201a2cea2180c39e0c0b9b7ea67d2dce14ad577e47f30243bd798a085d4a6fe48a0ec42a4be0ea901e945b0452bfe269206d4decf40fcea3
-  data.tar.gz: 48c0c50c3a3c1d9cddaed24ad7f9bc8ed90e750721ff244a7eed6150fbca37424827c304145b295259b44107cb9eeb5466289ebe56a6631e91f97a262cfa0031
+  metadata.gz: 8a043447e965f65c4ef360cd2cb8eaf7eff0043bf252c232207f2d55428573c915e8989150053e4a2cb0640e4d1976c0a73041fbcd9a711819853c0ec9b4d0d3
+  data.tar.gz: 09cde7525b2d29e54529b4a1710ff02fa8774aca8e051ebf5fefa3e223dc75324c8ffae2e5c68d46e9695a0b2aba52c6691aae053f82109ee5b7c641d16fa90f

data/CHANGELOG.md

@@ -3,7 +3,31 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
-- Download stats.
+Metadata :journal, publisher
+Factory to make resource objects?
+
+## 0.15.0 - 2016-06-22
+### Added
+- Person (email).
+- Server metadata (version).
+- Download statistics.
+- Collection - metadata fetch.
+- Collection - returns uuids or metadata, depending upon parameter.
+- Project metadata (acronym, description, owner, status, temporal, title, type, url).
+- Collection and resource types - optional basic authentication.
+- Replaced request library.
+- Publication - category, event, organisation, page, person, status, type.
+- Project - organisation, person.
+- Dataset - organisation, person.
+- Server and download - optional basic authentication.
+
+
+### Changed
+- Dataset - organisation becomes owner.
+- Global configuration namespace simplified.
+- Person (affiliation - uuid added to name in a hash).
+- Collection - parameter renamed to resource, in keeping with class structure.
+- Resource types return metadata rather than HTTP response object.
 
 ## 0.14.0 - 2016-06-10
 ### Added

data/README.md

@@ -1,6 +1,5 @@
 # Purée [![Gem Version](https://badge.fury.io/rb/puree.svg)](https://badge.fury.io/rb/puree)
-A Ruby client for the Pure Research Information System API.
-
+Purée consumes the Pure Research Information System API and puts the metadata into simple data structures.
 
 ## Installation
 
@@ -16,359 +15,37 @@ Or install it yourself as:
 
     $ gem install puree
 
-## Usage
- Authentication
-
-```ruby
-
-# Global settings together
-Puree::Configuration.configure do |c|
-  c.endpoint = ENV['PURE_ENDPOINT']
-  c.username = ENV['PURE_USERNAME']
-  c.password = ENV['PURE_PASSWORD']
-end
-
-# Global settings individually
-Puree::Configuration.endpoint = ENV['PURE_ENDPOINT']
-Puree::Configuration.username = ENV['PURE_USERNAME']
-Puree::Configuration.password = ENV['PURE_PASSWORD']
-
-# Use global settings
-d = Puree::Dataset.new
-
-# Override one or more global settings in an instance
-d = Puree::Dataset.new endpoint: 'http://example.com/ws/rest',
-                       username: 'another_username',
-                       password: 'another_password'
-```
 
+## Usage
+The following examples are for the Dataset resource type.
 
-Dataset
+### Single resource
+Tell Purée what you are looking for...
 
 ```ruby
-
 d = Puree::Dataset.new
-
-# Get metadata using ID
-d.find id: 12345678
-
-# Reuse instance
-d.find id: 87654321
-
-# Get metadata using UUID
-d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
-
-# Filter metadata into simple data structures
-d.access
-d.associated
-d.available
-d.created
-d.description
-d.doi
-d.file
-d.geographical
-d.keyword
-d.link
-d.modified
-d.organisation
-d.person
-d.production
-d.project
-d.publication
-d.publisher
-d.temporal
-d.title
-
-# 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 api: :dataset
-
-# Get three minimal datasets, starting at record ten, created and modified in January 2016.
-c.find limit:          3,  # optional, default 20
-       offset:         10, # optional, default 0
-       created_start:  '2016-01-01', # optional
-       created_end:    '2016-01-31', # optional
-       modified_start: '2016-01-01', # optional
-       modified_end:   '2016-01-31'  # optional
-
-# Get UUIDs for datasets
-uuids = c.uuid
-
-# Get metadata using UUID
-datasets = []
-uuids.each do |uuid|
-    d = Puree::Dataset.new
-    d.find uuid: uuid
-    datasets << d.metadata
-end
-```
-
-## Data structures
-
-### Dataset
-
-#### 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/"
-    }
-  },
-]
-```
-
-#### link
-An array of links.
-
-```ruby
-[
-  {
-    "url" => "http://www.example.com/~abc1234/xyz/",
-    "description" => "An interesting description"
-  },
-]
-```
-
-#### organisation
-Organisation responsible.
-
-```ruby
-{
-  "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
-  "name" => "Institute for the Arts",
-  "type" => "Department"
-}
+metadata = d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
 ```
-
-#### person
-Contains an array of internal persons, an array of external persons and an array of other persons.
-
-```ruby
-{
-  "internal" => [
-    {
-      "name" => {
-        "first" => "Stan",
-        "last" => "Laurel"
-       },
-       "role" => "Creator",
-       "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-    },
-  ],
-  "external" => [
-  ],
-  "other" => [
-    {
-      "name" => {
-        "first" => "Hal",
-        "last" => "Roach"
-      },
-      "role" => "Contributor",
-      "uuid" => ""
-    },
-  ]
-}
-```
-
-#### project
-An array of projects associated with the dataset.
-
-```ruby
-[
-  {
-    "title" => "An interesting project title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-]
-```
-
-#### publication
-An array of research outputs associated with the dataset.
-
-```ruby
-[
-  {
-    "type" => "Journal article",
-    "title" => "An interesting journal article title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-  {
-    "type" => "Conference paper",
-    "title" => "An interesting conference paper title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-  {
-    "type" => "Working paper",
-    "title" => "An interesting working paper title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-  {
-    "type" => "Paper",
-    "title" => "An interesting paper title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-  {
-    "type" => "Dataset",
-    "title" => "An interesting dataset title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-  {
-    "type" => "Chapter",
-    "title" => "An interesting chapter title",
-    "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  },
-]
-```
-
-#### production, temporal
-Date range. If year is present, month and day will have data or an empty string.
+...and get the data from a hash...
 
 ```ruby
-{
-  "start" => {
-    "year" => "2005",
-    "month" => "5",
-    "day" => "10"
-  },
-  "end" => {
-    "year" => "2011",
-    "month" => "9",
-    "day" => "18"
-  }
-}
+metadata['doi']
 ```
 
-### Organisation
-
-#### address
-An array of addresses.
+### Collection of 50 resources
+Tell Pur&#233;e what you are looking for...
 
 ```ruby
-[
-  {
-    "street" => "Lancaster University",
-    "building" => "Bowland North",
-    "postcode" => "LA1 4YN",
-    "city" => "Lancaster",
-    "country" => "United Kingdom"
-  },
-]
+c = Puree::Collection.new resource: :dataset
+metadata = c.find limit: 50
 ```
+...and get the data from an array of hashes.
 
-#### parent
-Parent organisation.
+## Documentation
+[API in YARD](http://www.rubydoc.info/gems/puree/frames)
 
-```ruby
-{
-  "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
-  "name" => "Institute for the Arts",
-  "type" => "Department"
-}
-```
+[Detailed usage](https://github.com/lulibrary/puree/wiki)
 
-### Publication
 
-#### 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",
-  },
-]
-```
-
-## 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
-:event
-:organisation
-:person
-:publication
-```
-
-Resource metadata (system data and single hash only)
-
-```ruby
-:journal
-:project
-:publisher
-```
-
-Collections (for obtaining identifiers)
-
-```ruby
-:dataset
-:event
-:journal
-:organisation
-:person
-:project
-:publication
-:publisher
-```

data/lib/puree.rb

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