README.md in puree-0.13.0 vs README.md in puree-0.14.0
- old
+ new
@@ -1,7 +1,6 @@
-# Purée
-
+# Purée [](https://badge.fury.io/rb/puree)
A Ruby client for the Pure Research Information System API.
## Installation
@@ -16,30 +15,50 @@
Or install it yourself as:
$ gem install puree
## Usage
+ Authentication
+
```ruby
-endpoint = 'http://example.com/ws/rest'
+
+# 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'
```
-Dataset.
+Dataset
+
```ruby
+
d = Puree::Dataset.new
# Get metadata using ID
-d.get id: 12345678,
- endpoint: endpoint,
- username: username,
- password: password
+d.find id: 12345678
+# Reuse instance
+d.find id: 87654321
+
# Get metadata using UUID
-d.get uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx',
- endpoint: endpoint,
- username: username,
- password: password
+d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
# Filter metadata into simple data structures
d.access
d.associated
d.available
@@ -49,10 +68,11 @@
d.file
d.geographical
d.keyword
d.link
d.modified
+d.organisation
d.person
d.production
d.project
d.publication
d.publisher
@@ -68,37 +88,31 @@
d.response.code
d.response.message
d.response.headers # hash
```
-Collection.
+Collection
```ruby
-c = Puree::Collection.new(resource_type: :dataset)
+c = Puree::Collection.new api: :dataset
# Get three minimal datasets, starting at record ten, created and modified in January 2016.
-c.get endpoint: endpoint,
- username: username,
- password: password,
- 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
+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.get endpoint: endpoint,
- username: username,
- password: password,
- uuid: uuid
+ d.find uuid: uuid
datasets << d.metadata
end
```
## Data structures
@@ -108,30 +122,30 @@
#### 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"
+ "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/"
+ "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/"
}
},
]
```
@@ -139,41 +153,52 @@
An array of links.
```ruby
[
{
- "url": "http://www.example.com/~abc1234/xyz/",
- "description": "An interesting description"
+ "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"
+}
+```
+
#### person
Contains an array of internal persons, an array of external persons and an array of other persons.
```ruby
{
- "internal"=>[
+ "internal" => [
{
- "name"=>{
- "first"=>"Stan",
- "last"=>"Laurel"
+ "name" => {
+ "first" => "Stan",
+ "last" => "Laurel"
},
- "role"=>"Creator",
- "uuid"=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
+ "role" => "Creator",
+ "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
},
],
- "external"=>[
+ "external" => [
],
- "other"=>[
+ "other" => [
{
- "name"=>{
- "first"=>"Hal",
- "last"=>"Roach"
+ "name" => {
+ "first" => "Hal",
+ "last" => "Roach"
},
- "role"=>"Contributor",
- "uuid"=>""
+ "role" => "Contributor",
+ "uuid" => ""
},
]
}
```
@@ -181,68 +206,68 @@
An array of projects associated with the dataset.
```ruby
[
{
- "title": "An interesting project title",
- "uuid": "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
+ "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" => "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" => "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" => "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" => "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" => "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"
+ "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.
```ruby
{
- "start"=>{
- "year"=>"2005",
- "month"=>"5",
- "day"=>"10"
+ "start" => {
+ "year" => "2005",
+ "month" => "5",
+ "day" => "10"
},
- "end"=>{
- "year"=>"2011",
- "month"=>"9",
- "day"=>"18"
+ "end" => {
+ "year" => "2011",
+ "month" => "9",
+ "day" => "18"
}
}
```
### Organisation
@@ -251,31 +276,42 @@
An array of addresses.
```ruby
[
{
- "street"=>"Lancaster University",
- "building"=>"Bowland North",
- "postcode"=>"LA1 4YN",
- "city"=>"Lancaster",
- "country"=>"United Kingdom"
+ "street" => "Lancaster University",
+ "building" => "Bowland North",
+ "postcode" => "LA1 4YN",
+ "city" => "Lancaster",
+ "country" => "United Kingdom"
},
]
```
+#### parent
+Parent organisation.
+
+```ruby
+{
+ "uuid" => "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
+ "name" => "Institute for the Arts",
+ "type" => "Department"
+}
+```
+
### 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",
+ "name" => "foo.csv",
+ "mime" => "application/octet-stream",
+ "size" => "1616665158",
+ "url" => "http://example.com/ws/rest/files/12345678/foo.csv",
},
]
```
## Utilities
@@ -285,12 +321,12 @@
```ruby
Puree::Date.iso d.available
```
```ruby
{
- "year"=>"2016",
- "month"=>"4",
- "day"=>"18"
+ "year" => "2016",
+ "month" => "4",
+ "day" => "18"
}
```
becomes
```ruby
\ No newline at end of file