dataverse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 218801f555a41f3c5a6b5f780903c8558c5df6d1b149470e649a763bf2f7fd39
+  data.tar.gz: 498a782ecc5c745fa4b23c2bae2cd599b73a855dec072e91a1f96a254db9c8be
+SHA512:
+  metadata.gz: 6cd333801c73346653ca2a9780f9cf99d22bb2d2e343d424dff73e48a6789dd87487309a8d7ae72b905bc6c9512de2f84d12f08e188c8a2d0cf1f18add2344c2
+  data.tar.gz: 65ad0e6cf95d2a557195414226da5fa751dde28e3111370beb46c5f24b00b65781ba40183d8b3dbee3fe568eab3520bf355920aa975e215326d20af5695978af

data/.env.template

@@ -0,0 +1,3 @@
+API_URL=""
+API_TOKEN=""
+#RESTCLIENT_LOG=stdout

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env
+
+/*.json
+/*.xml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.2.15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kris.dekeyser@libis.be. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dataverse.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem 'pry'
+gem 'dotenv'
+gem 'awesome_print'

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    dataverse (0.1.0)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.9.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    netrc (0.11.0)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  awesome_print
+  dataverse!
+  dotenv
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kris Dekeyser
+
+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,598 @@
+# Dataverse
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dataverse`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dataverse'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dataverse
+
+## Usage
+
+This gem wraps the Dataverse.org API in a set of Ruby classes. You can use the classes to perform the API calls and process the result on the Ruby objects. It builds upon the rest-client gem to perform the low-level REST API calls.
+
+In order to configure the API calls, you need to define at least two environment variables:
+
+ - API_URL: the full url of the Dataverse repository you want to access. This URL should be give up to and including the '/api' path. Optionally, a version portion can be added to the path.
+ - API_TOKEN: a token to identify and authorize the user. Note that for some API calls a superuser token may be required.
+ - RESTCLIENT_LOG: if defined, will log the REST API calls to the given file. Set to 'stdout' if you want to log to screen.
+
+## Dataverse::Dataverse
+
+The class that captures the api dealing with dataverses.
+
+### Accessing an existing dataverse
+
+You can create a new instance by supplying the id or alias of an existing dataverse to the constructor:
+
+```ruby
+Dataverse::Dataverse.id('my_dataverse')
+# => #<Dataverse::Dataverse:0x0...>
+```
+
+You can pass the value ':root' or use the #root class method if you want to access the root dataverse.
+
+```ruby
+Dataverse::Dataverse.id(':root') == Dataverse::Dataverse.root
+# => true
+```
+
+### Creating a new dataverse
+
+To create a new dataverse, you should first open an instance for the parent dataverse, then call the #create method on it, supplying either a Hash, a file name or a JSON string.
+
+```ruby
+parent_dv = Dataverse::Dataverse.id('parent_dv')
+# => #<Dataverse::Dataverse:0x0...>
+
+new_dv = parent_dv.create(name: 'My new dataverse', alias: 'new_dv', ...)
+# => #<Dataverse::Dataverse:0x0...>
+```
+
+A sample data hash for a new dataset is provided in
+```ruby
+Dataverse::Dataverse::SAMPLE_DATA
+# => {:name=>"new dataverse", :alias=>"new_dv", :dataverseContacts=>[
+#    {:contactEmail=>"abc@def.org"}], :affiliation=>"My organization",
+#     :description=>"My new dataverse", :dataverseType=>"ORGANIZATIONS_INSTITUTIONS"}
+```
+and the list of valid values for the field 'dataverseType' can be found at:
+```ruby
+Dataverse::Dataverse::TYPES
+# => ["DEPARTMENT", "JOURNALS", "LABORATORY", "ORGANIZATIONS_INSTITUTIONS", 
+#     "RESEARCHERS", "RESEARCH_GROUP", "RESEARCH_PROJECTS", "TEACHING_COURSES", 
+#     "UNCATEGORIZED"]
+```
+
+All the metadata of an existing dataverse can be retrieved as a Hash with the #rdm_data method:
+
+```ruby
+parent_dv.rdm_data
+# => {"id"=>5, "alias"=>"parent_dv", ...}
+```
+
+The resulting Hash can be saved to a file and used to create a new dataverse:
+
+```ruby
+data = parent_dv.rdm_data.dup
+data['alias'] = 'new_dv'
+filename = 'dataverse.json'
+File.open(filename, 'wt') { |f| f.write JSON.pretty_generate(data) }
+new_dv = parent_dv.create(filename)
+# => #<Dataverse::Dataverse:0x0...>
+```
+
+### Deleting a dataverse
+
+```ruby
+new_dv.delete
+# => {"message" => "Dataverse 15 deleted"}
+```
+
+### Publishing a dataverse
+
+```ruby
+new_dv.publish
+# => "Dataverse 15 published"
+
+new_dv.publish
+# => Dataverse::Error: Dataverse new_dv has already been published
+```
+
+Note that if a dataverse was already published, the call will raise a Dataverse::Error exception.
+
+### Access dataverse properties
+
+The Dataverse properties can be accessed similar to a Hash:
+
+```ruby
+parent_dv.keys
+# => ["id", "alias", "name", "affiliation", "dataverseContacts", "permissionRoot",
+#     "description", "dataverseType", "ownerId", "creationDate"]
+
+parent_dv['alias']
+# => "parent_dv"
+
+parent_dv.fetch('alias')
+# => "parent_dv"
+```
+
+Only the above Hash methods are implemented on the Dataverse class. For other Hash operations, you can access the data Hash directly:
+
+```ruby
+parent_dv.api_data.select {|k,v| k =~ /^a/ }
+# => {"alias" = "parent_dv", "affiliation" => "My organization"}
+
+parent_dv.api_data.values
+# => [5, "parent_dv", ...]
+```
+
+Note that the data Hash is frozen and using methods on the data Hash that change the contents of the Hash (e.g. #reject! and #delete) will throw a FrozenError exception. If you want to manipulate the Hash, you should create a copy of the Hash:
+
+```ruby
+parent_dv.api_data['id'] = 123456
+# => FrozenError: can't modify a frozen Hash: ...
+
+data = parent_dv.api_data.dup
+# => {"id" => 5, "alias" => "parent_dv", ...}
+
+data.delete('id')
+# => 123456
+
+data['alias'] = 'new_dv'
+# => "new_dv"
+
+data
+# => {"alias" => "new_dv", ...}
+```
+
+The id or alias that was used to instantiate the Dataverse:
+
+```ruby
+parent_dv.id
+# => "parent_dv"
+
+new_dv.id
+# => 15
+```
+
+To get the id or alias explicitly, use the Hash methods:
+
+```ruby
+parent_dv['id']
+# => 5
+
+parent_dv['alias']
+# => "parent_dv"
+```
+
+### Report the data file size of a Dataverse (in bytes)
+
+```ruby
+parent_dv.size
+# => 123456789
+```
+
+### Browsing
+
+Get an array of child dataverses and datasets:
+
+```ruby
+parent_dv.children
+# => [#<Dataverse::Dataverse:0x0...>, #<Dataverse::Dataset:0x0...>]
+```
+
+Iterate over all child dataverses recursively:
+
+```ruby
+parent_dv.each_dataverse do |dv|
+    puts dv.id
+end
+# => 10
+# => 15
+# ...
+```
+
+Iterate over all child datasets recursively:
+
+```ruby
+parent_dv.each_dataverse do |dv|
+    puts dv.size
+end
+# => 123456
+# => 456123
+# ...
+```
+
+## Dataverse::Dataset
+
+The class that encapsulates the dataset related API.
+
+### Accessing an existing dataset
+
+A new Dataset instance can be obtained from the parent Dataverse's #children call or can be directly instantiated if you know the dataset's id or persistent identifier:
+
+```ruby
+ds = parent_dv.children[1]
+# => #<Dataverse::Dataset:0x0...>
+
+Dataverse::Dataset.new(25)
+# => #<Dataverse::Dataset:0x0...>
+
+Dataverse::Dataset.pid('doi:10.5072/FK2/J8SJZB')
+# => #<Dataverse::Dataset:0x0...>
+```
+
+### Creating a new dataset
+
+A new dataset can only be created on an existing dataverse. You should supply either a Hash, a file name or a JSON string to the #create_dataset method.
+
+```ruby
+ds = parent_dv.create_dataset(
+    'datasetVersion' => {
+        'metadataBlocks' => {
+            'citation' => {
+                ...
+            }
+        }
+)
+# => #<Dataverse::Dataset: 0x0...>
+```
+
+All the metadata of an existing dataset required to create a new dataset can be retrieved as a Hash with the #raw_data method:
+
+```ruby
+data = ds.raw_data
+# => {"datasetVersion" => {"metadataBlocks" => {"citation" => {...}}}}
+```
+
+The resulting Hash can be used to create a new dataverse, either directly or by saving it to a file.
+
+```ruby
+data = ds.raw_data
+new_ds = parent_dv.create_dataset(data)
+# => #<Dataverse::Dataset:0x0...>
+
+filename = 'dataset.json'
+File.open(filename, 'wt') { |f| f.write JSON.pretty_generate(data) }
+new_ds = parent_dv.create_dataset(filename)
+# => #<Dataverse::Dataset:0x0...>
+```
+
+### Importing a dataset
+
+The #import_dataset method on a dataverse allows to import an existing dataset. The dataset should be registred and its persisten identifier should be supplied in the pid argument. The data argument is similar to the #create_dataset method.
+
+```ruby
+data = 'dataset.json'
+pid = 'doi:ZZ7/MOSEISLEYDB94'
+ds = parent_dv.import_dataset(data, pid: pid)
+# => #<Dataverse::Dataset:0x0...>
+```
+
+Optionally, upon importing, you can immediately publish the imported dataset.
+
+```ruby
+data = 'dataset.json'
+pid = 'doi:ZZ7/MOSEISLEYDB94'
+ds = parent_dv.import_dataset(data, pid: pid, publish: true)
+ds.versions
+# => [:latest, :published, 1.0]
+```
+
+If you have DDI data instead of Dataverse JSON, you can import as well:
+
+```ruby
+data = 'dataset_ddi.xml'
+pid = 'doi:ZZ7/MOSEISLEYDB94'
+ds = parent_dv.import_dataset(data, pid: pid, ddi: true)
+# => #<Dataverse::Dataset:0x0...>
+```
+
+### Deleting a dataset
+
+```ruby
+ds.delete
+# => 'Draft version of dataset 53 deleted'
+```
+
+Only the draft version of a dataset can be deleted. If there is only a draft version in the repository, the entire dataset will be deleted. Note that the Ruby Dataverse::Dataset object will still exist and it will still hold the cached data for any version other than the draft version.
+
+### Access dataset properties
+
+The Dataset properties can be accessed just like with the Dataverse class:
+
+```ruby
+ds.keys
+# => ["id", "identifier", "persistentUrl", "protocol", "authority", "publisher",
+#     "publicationDate", "storageIdentifier", "latestVersion"]
+
+ds['identifier']
+# => "FK2/J8SJZB"
+
+ds.fetch('identifier')
+# => "FK2/J8SJZB"
+
+ds.api_data.keys
+# => ["id", "identifier", "persistentUrl", "protocol", "authority", "publisher",
+#     "publicationDate", "storageIdentifier", "latestVersion"]
+
+ds.api_data['identifier']
+# => "FK2/J8SJZB"
+```
+
+The id or pid of the Dataset:
+
+```ruby
+ds.id
+# => "25"
+
+ds.pid
+# => "doi:10.5072/FK2/J8SJZB"
+```
+
+The title and author in the metadata of the latest version:
+
+```ruby
+ds.title
+# => "My new dataset"
+
+ds.author
+# => "Lastname, Firstname"
+```
+
+Some timestamps:
+
+```ruby
+ds.created
+# => 2021-02-11 18:05:46 +0100
+
+ds.updated
+# => 2021-02-11 18:34:47 +0100
+
+ds.published
+# => 2021-02-11 18:34:47 +0100
+```
+
+### Accessing metadata
+
+```ruby
+ds.metadata_fields
+# => ["title", "alternativeTitle", "alternativeURL", "otherId", "author", ...]
+
+ds.metadata
+# => { "title" => "My new dataset",
+#      "author" => [
+#        {
+#          "authorName" => "Lastname, Firstname",
+#          "authorIdentifierScheme" => "ORCID",
+#          "authorIdentifier" => "0000-0001-2345-6789"
+#        }
+#      ],
+#      ...
+#    }
+```
+
+### Exporting metadata
+
+```ruby
+md_type = 'dataverse_json'
+ds.export_metadata(md_type)
+# => { ... }
+
+md_type = 'raw'
+ds.export_metadata(md_type) == ds.raw_data
+# => true
+
+Dataverse::Dataset::MD_TYPES
+# => ["rdm", "raw", "schema.org", "OAI_ORE", "dataverse_json", 
+#     "ddi", "oai_ddi", "dcterms", "oai_dc", "Datacite", "oai_datacite"]
+
+# Note: format types 'ddi' and after that are XML formats; anything else is JSON.
+
+Dataverse::Dataset::MD_TYPES_XML
+# => ["ddi", "oai_ddi", "dcterms", "oai_dc", "Datacite", "oai_datacite"]
+
+Dataverse::Dataset::MD_TYPES_JSON
+# => ["schema.org", "OAI_ORE", "dataverse_json"]
+
+# Note: JSON metadata will be converted into a Hash and returned as a Hash, 
+#       to improve parsing and manipulation of the metadata:
+data = ds.export_metadata('schema.org')
+# => {"@context"=>"http://schema.org", "@type"=>"Dataset", ...}
+```
+
+The resulting Hash can be used to create a new dataverse, either directly or by saving it to a file.
+
+```ruby
+data = ds.raw_data
+new_ds = parent_dv.create_dataset(data)
+# => #<Dataverse::Dataset:0x0...>
+
+filename = 'dataset.json'
+File.open(filename, 'wt') { |f| f.write JSON.pretty_generate(data) }
+new_ds = parent_dv.create_dataset(filename)
+# => #<Dataverse::Dataset:0x0...>
+```
+
+If the metadata type is a XML format, the data will be a REXML::Document instance:
+
+```ruby
+data = ds.export_metadata('dcterms')
+# => <UNDEFINED> ...</>
+
+data.write(indent: 2)
+# <?xml version='1.0' encoding='UTF-8'?>
+#   <metadata xmlns:dcterms='http://purl.org/dc/elements/1.1/' ...>
+#   <dcterms:title>My new dataset</dcterms:title>
+#   ...
+# </metadata>
+
+File.open('dataset_dcterms.xml') 'wt') do |f|
+  f.write data
+end
+```
+
+The 'rdm' metadata format is not one of the officially supported metadata output formats, but a slightly more compact version of the 'dataverse_json' format. It can be accessed directly using the #rdm_data method:
+
+```ruby
+ds.rdm_data
+# => {"id"=>5, "versionId"=>8, ...,
+#     "metadata"=> {"title"=>"My new dataset", ....}}
+
+md_type = 'rdm'
+ds.export_metadata(md_type) == ds.rdm_data
+# => true
+```
+
+The 'raw' metadata format is the format that is required for the creation and import of datasets.
+
+```ruby
+data = ds.export_metadata('raw')
+#=> {"datasetVersion"=>{"id"=>25, ...}}
+
+data == ds.raw_data
+# => true
+
+data.dig('datasetVersion', 'files')
+# => nil
+
+ds.raw_data(with_files: true).dig('datasetVersion', 'files')
+# => [{"description"=>"data file", "label"=>"file.pdf", ...}]
+```
+
+### Report the data file size of a Dataset (in bytes)
+
+```ruby
+ds.size
+# => 123456789
+```
+
+### Accessing dataset files
+```ruby
+ds.files
+# => [ { "description"=>"File descripion",
+#        "label"=>"file.pdf", 
+#        "id"=>16,
+#        "persistentId"=>"doi:10.5072/FK2/J8SJZB/2QPLAC",
+#        ...
+#      }
+#    ]
+```
+
+To download datafiles, you can:
+
+1. Download all files:
+
+```ruby
+ds.download
+# => downloads all files as 'dataset_files.zip' for the latest version
+
+ds.download 'files.zip'
+# => use 'files.zip' as target file
+
+ds.download version: '1.0'
+# => downloads all files for the version '1.0'
+```
+
+2. Download a specific file
+
+```ruby
+# TODO
+```
+
+### Accessing dataset versions
+
+```ruby
+ds.versions
+# => [:latest, :published, :draft, 3.0, 2.0, 1.0]
+
+ds.published_versions
+# => [1.0, 2.0, 3.0]
+
+ds.draft_version
+# => :draft
+# will return nil if there is no draft version
+
+ds.version(:published)
+# => 3.0
+
+ds.version(:latest)
+# => :draft
+
+ds.version(2)
+# => 2.0
+
+ds.version(4)
+# => nil
+```
+
+Use the #versions to get a list of valid versions and the #version method resolves the given version name to the version number or the special version :draft. Valid version names are:
+
+- :draft, ':draft' or 'draft' => the draft version, if it exists
+- :latest, ':latest', or 'latest' => the latest version: draft if it exists, the last published version otherwise
+- :published, ':published', 'published', ':latest-published', 'latest-published' => the last published version if it exists
+- a number => a specific published version; integer numbers n will be interpreted as n.0
+
+The following methods take an optional version: argument that allows to retrieve the data specific for that version: #pid, #title, #author, #updated, #created, #published, #metadata_fields, #rdm_data, #metadata, #files, #download. Most of these methods default to using :latest version if omitted. Exceptions to this rule are #rdm (:published) and #download (nil, uses the download api on dataset level by default).
+
+```ruby
+ds.title
+# => "My new dataset"
+
+ds.title(version: 1)
+# => "Preliminary title"
+
+ds.updated
+# => 2021-02-11 18:34:47 +0100
+
+ds.updated(version: 1)
+# => 2021-02-03 12:05:13 +0100
+
+ds.published
+# => 2021-02-11 18:34:47 +0100
+
+ds.published(version: :draft)
+# => nil
+# (:draft version does not have a publication date)
+```
+
+Note that in most cases, entering a non-existent version will throw a Dataverse::VersionError exception. If you want to prevent having to catch the exception in your code, you can use the #version method first to check if the version is valid.
+
+```ruby
+ds.title(version: 8.2)
+# => Dataverse::VersionError: Version 8.2 does not exist
+
+ds.title(version: 8.2) if ds.version(8.2)
+# => nil
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/libis/dataverse_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/libis/dataverse_api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dataverse project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/libis/dataverse_api/blob/master/CODE_OF_CONDUCT.md).