dataverse 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 218801f555a41f3c5a6b5f780903c8558c5df6d1b149470e649a763bf2f7fd39
-  data.tar.gz: 498a782ecc5c745fa4b23c2bae2cd599b73a855dec072e91a1f96a254db9c8be
+  metadata.gz: 8a378998e229002001b0b68f0c9d2cb90244106ef05720aed7a6d9899fc7b599
+  data.tar.gz: 1e60cab628d4b6e5b1307ed3aa8631b2c2d99efb268a887729c33713caaf8543
 SHA512:
-  metadata.gz: 6cd333801c73346653ca2a9780f9cf99d22bb2d2e343d424dff73e48a6789dd87487309a8d7ae72b905bc6c9512de2f84d12f08e188c8a2d0cf1f18add2344c2
-  data.tar.gz: 65ad0e6cf95d2a557195414226da5fa751dde28e3111370beb46c5f24b00b65781ba40183d8b3dbee3fe568eab3520bf355920aa975e215326d20af5695978af
+  metadata.gz: e6f8171213b9de61b5b5854e594f1e125e4c6e6ecd03c16461f022dde1e2e56bddf8ad3d219f352a8e37f2fe1ddd7427757c6c921746806ae476cdcc64aa0193
+  data.tar.gz: fde1a04400885bb74e5164ee49b0f4f645a3ec2253ece76f345ab3cd95c0d9af86e1201b2655f2855fc7c475abb48099bfa130f642baab3cc53744f9d1f471e9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dataverse (0.1.0)
+    dataverse (0.1.1)
       rest-client (~> 2.0)
 
 GEM
@@ -48,6 +48,7 @@ GEM
     unf_ext (0.0.7.7)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -1,8 +1,6 @@
-# Dataverse
+# Dataverse API gem
 
-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
+This gem wraps the Dataverse 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. For more information about Dataverse and the API, see https://dataverse.org/ and https://guides.dataverse.org/en/latest/api/index.html
 
 ## Installation
 
@@ -14,15 +12,23 @@ gem 'dataverse'
 
 And then execute:
 
-    $ bundle install
+```
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install dataverse
+```
+$ 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.
+First load the library with
+
+```ruby
+require 'dataverse'
+```
 
 In order to configure the API calls, you need to define at least two environment variables:
 
@@ -30,29 +36,31 @@ In order to configure the API calls, you need to define at least two environment
  - 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.
 
+You can set these environment variables in a .env file and use the dotenv gem to load the variables. The file .env.template is provided as a starting point for you.
+
 ## Dataverse::Dataverse
 
-The class that captures the api dealing with dataverses.
+The class that captures the api dealing with Dataverse collections.
 
-### Accessing an existing dataverse
+### Accessing an existing Dataverse collection
 
-You can create a new instance by supplying the id or alias of an existing dataverse to the constructor:
+You can create a new instance by supplying the id or alias of an existing Dataverse collection 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.
+You can pass the value ':root' or use the #root class method if you want to access the Dataverse root collection.
 
 ```ruby
 Dataverse::Dataverse.id(':root') == Dataverse::Dataverse.root
 # => true
 ```
 
-### Creating a new dataverse
+### Creating a new Dataverse collection
 
-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.
+To create a new Dataverse collection, you should first open an instance for the parent Dataverse collection, 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')
@@ -77,14 +85,14 @@ Dataverse::Dataverse::TYPES
 #     "UNCATEGORIZED"]
 ```
 
-All the metadata of an existing dataverse can be retrieved as a Hash with the #rdm_data method:
+All the metadata of an existing Dataverse collection 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:
+The resulting Hash can be saved to a file and used to create a new Dataverse collection:
 
 ```ruby
 data = parent_dv.rdm_data.dup
@@ -95,14 +103,14 @@ new_dv = parent_dv.create(filename)
 # => #<Dataverse::Dataverse:0x0...>
 ```
 
-### Deleting a dataverse
+### Deleting a Dataverse collection
 
 ```ruby
 new_dv.delete
 # => {"message" => "Dataverse 15 deleted"}
 ```
 
-### Publishing a dataverse
+### Publishing a Dataverse collection
 
 ```ruby
 new_dv.publish
@@ -112,11 +120,11 @@ 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.
+Note that if a Dataverse collection was already published, the call will raise a Dataverse::Error exception.
 
-### Access dataverse properties
+### Access properties of a Dataverse collection
 
-The Dataverse properties can be accessed similar to a Hash:
+The properties of a Dataverse collection can be accessed similar to a Hash:
 
 ```ruby
 parent_dv.keys
@@ -159,7 +167,7 @@ data
 # => {"alias" => "new_dv", ...}
 ```
 
-The id or alias that was used to instantiate the Dataverse:
+The id or alias that was used to instantiate the Dataverse collection:
 
 ```ruby
 parent_dv.id
@@ -179,7 +187,7 @@ parent_dv['alias']
 # => "parent_dv"
 ```
 
-### Report the data file size of a Dataverse (in bytes)
+### Report the data file size of a Dataverse collection (in bytes)
 
 ```ruby
 parent_dv.size
@@ -188,14 +196,14 @@ parent_dv.size
 
 ### Browsing
 
-Get an array of child dataverses and datasets:
+Get an array of child Dataverse collections and datasets:
 
 ```ruby
 parent_dv.children
 # => [#<Dataverse::Dataverse:0x0...>, #<Dataverse::Dataset:0x0...>]
 ```
 
-Iterate over all child dataverses recursively:
+Iterate over all child Dataverse collections recursively:
 
 ```ruby
 parent_dv.each_dataverse do |dv|
@@ -209,8 +217,8 @@ end
 Iterate over all child datasets recursively:
 
 ```ruby
-parent_dv.each_dataverse do |dv|
-    puts dv.size
+parent_dv.each_dataset do |ds|
+    puts ds.size
 end
 # => 123456
 # => 456123
@@ -223,7 +231,7 @@ 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:
+A new Dataset instance can be obtained from the parent Dataverse collection's #children call or can be directly instantiated if you know the dataset's id or persistent identifier:
 
 ```ruby
 ds = parent_dv.children[1]
@@ -238,7 +246,7 @@ Dataverse::Dataset.pid('doi:10.5072/FK2/J8SJZB')
 
 ### 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.
+A new dataset can only be created on an existing Dataverse collection. You should supply either a Hash, a file name or a JSON string to the #create_dataset method.
 
 ```ruby
 ds = parent_dv.create_dataset(
@@ -259,7 +267,7 @@ 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.
+The resulting Hash can be used to create a new dataset, either directly or by saving it to a file.
 
 ```ruby
 data = ds.raw_data
@@ -274,7 +282,7 @@ new_ds = parent_dv.create_dataset(filename)
 
 ### 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.
+The #import_dataset method on a Dataverse collection 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'
@@ -415,7 +423,7 @@ 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.
+The resulting Hash can be used to create a new dataset, either directly or by saving it to a file.
 
 ```ruby
 data = ds.raw_data
@@ -595,4 +603,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+Everyone interacting in the Dataverse API 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).

data/lib/dataverse/dataset.rb

@@ -25,7 +25,7 @@ module Dataverse
     end
 
     def delete
-      url = raise Error.new 'Can only delete draft version' unless draft_version
+      raise Error.new 'Can only delete draft version' unless draft_version
       versions
       result = call('versions/:draft', method: :delete)
       @version_data.delete(:draft)
@@ -61,7 +61,7 @@ module Dataverse
     end
 
     def size
-      data = call("storagesize". params: {includCached: 'true'})
+      data = call("storagesize", params: {includCached: 'true'})
       data['message'][/[,\d]+/].delete(',').to_i
     end
 
@@ -255,7 +255,7 @@ module Dataverse
     end
 
     def version_data(version)
-      data = @version_data[resolve_version(version)].transform_keys {|k| k == 'id' ? 'versionId' : k}
+      @version_data[resolve_version(version)].transform_keys { |k| k == 'id' ? 'versionId' : k }
     end
 
     private

data/lib/dataverse/dataverse.rb

@@ -127,7 +127,7 @@ module Dataverse
     end
 
     def export_metadata(md_type)
-      format = case md_type.to_s
+      case md_type.to_s
       when 'rdm'
         return rdm_data
       else

data/lib/dataverse/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dataverse
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dataverse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Dataverse API.