dataverse 0.1.0

data/lib/dataverse/dataverse.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'dataset'
+
+module Dataverse
+  class Dataverse < Base
+
+    attr_reader :id
+
+    def self.id(id)
+      new(id)
+    rescue RestClient::NotFound
+      nil
+    end
+
+    def self.root
+      id(':root')
+    end
+
+    SAMPLE_DATA= {
+      name: 'new dataverse',
+      alias: 'new_dv',
+      dataverseContacts: [
+        { contactEmail: 'abc@def.org'}
+      ],
+      affiliation: 'My organization',
+      description: 'My new dataverse',
+      dataverseType: 'ORGANIZATIONS_INSTITUTIONS'
+    }
+
+    TYPES = %w'DEPARTMENT JOURNALS LABORATORY ORGANIZATIONS_INSTITUTIONS RESEARCHERS RESEARCH_GROUP RESEARCH_PROJECTS TEACHING_COURSES UNCATEGORIZED'
+
+    def create(data)
+      data = StringIO.new(data.to_json) if data.is_a?(Hash)
+      if data.is_a?(String)
+        begin
+          if File.exist?(data)
+            data = File.open(data, 'r')
+          elsif JSON::parse(data)
+            data = StringIO.new(data)
+          end
+        rescue JSON::ParserError, File
+          data = nil
+        end
+      end
+      
+      unless data.is_a?(File) || data.is_a?(StringIO)
+        raise Error.new("Data could not be parsed. Should be a Hash, filename or JSON string.")
+      end
+
+      result = call('', method: :post, body: data)
+      
+      dv = Dataverse.new(nil)
+      dv.init(result)
+      dv.instance_variable_set('@id', result['id'])
+      return dv
+
+    ensure
+      data.close if data.is_a?(File)
+
+    end
+
+    def publish
+      call("actions/:publish", method: :post)
+      return "Dataverse #{id} published"
+    end
+
+    def delete
+      call('', method: :delete)['message']
+    end
+
+    def call(url, **args)
+      api_call("dataverses/#{id}/#{url}", **args)
+    end
+
+    def children
+      @children ||= begin
+        result = []
+        data = call("contents")
+        data.each do |x|
+          case x['type']
+          when 'dataverse'
+            result << Dataverse.id(x['id'])
+          when 'dataset'
+            result << Dataset.id(x['id'])
+          else
+            raise Error.new("Unsupported type: #{x['type']} (#{x['name']})")
+          end
+        end
+        result
+      end
+    end
+
+    def each_dataverse(&block)
+      data = []
+      children.each do |child|
+        if child.is_a?(Dataverse)
+          data << (block_given? ? yield(child) : child)
+          data += child.each_dataverse(&block)
+        end
+      end
+      data
+    end
+
+    def each_dataset(&block)
+      data = []
+      children.each do |child|
+        if child.is_a?(Dataverse)
+          data += child.each_dataset(&block)
+        elsif child.is_a?(Dataset)
+          data << (block_given? ? yield(child) : child)
+        end
+      end
+      data
+    end
+
+    def size
+      @size ||= begin
+        data = api_call("dataverses/#{id}/storagesize")
+        data['message'][/[,\d]+/].delete(',').to_i
+      end
+    end
+
+    def rdm_data
+      api_data
+    end
+
+    def export_metadata(md_type)
+      format = case md_type.to_s
+      when 'rdm'
+        return rdm_data
+      else
+        raise Error.new("Unknown metadata format: '#{md_type}'")
+      end
+    end
+
+    protected
+
+    def initialize(id)
+      @id = id
+      init(get_data)
+    end
+
+    def init(data)
+      @size = nil
+      @children = nil
+      super(data)
+    end
+
+    def get_data
+      return unless id
+      api_call("dataverses/#{id}")
+    end
+
+  end
+end

data/lib/dataverse/errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dataverse
+
+  class Error < StandardError
+    def initialize(msg, backtrace: nil)
+      @backtrace = backtrace
+      super(msg)
+    end
+
+    def backtrace
+      return @backtrace if @backtrace
+      super
+    end
+
+    def cause
+      nil
+    end
+  end
+
+  class VersionError < Error
+    def initialize(version)
+      super "Version #{version} does not exist"
+    end
+  end
+
+end

data/lib/dataverse/version.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: dataverse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kris Dekeyser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Dataverse.org API wrapper.
+email:
+- kris.dekeyser@libis.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dataverse.gemspec
+- lib/dataverse.rb
+- lib/dataverse/base.rb
+- lib/dataverse/dataset.rb
+- lib/dataverse/dataverse.rb
+- lib/dataverse/errors.rb
+- lib/dataverse/version.rb
+homepage: https://rubygems.org/gems/dataverse
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/dataverse
+  source_code_uri: https://github.com/libis/dataverse_api
+  changelog_uri: https://github.com/libis/dataverse_api/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Dataverse API.
+test_files: []