Module: Zenodo::DSL::DepositionActions

Included in:
Zenodo::DSL
Defined in:
lib/zenodo/dsl/deposition_actions.rb

Instance Method Summary collapse

Instance Method Details

#discard_deposition(options = {}) ⇒ Zenodo::Resources::deposition?

Discard POST deposit/depositions/:id/actions/discard Discard changes in the current editing session.

Parameters:

  • options (Hash) (defaults to: {}) —

    The options to discard a deposition with.

Options Hash (options):

  • :id (String, Fixnum) —

    A deposition’s ID.

Returns:

  • (Zenodo::Resources::deposition, nil) —

    .

Raises:

  • (ArgumentError) —

    If the given :id is blank.



34
35
36
37
 
# File 'lib/zenodo/dsl/deposition_actions.rb', line 34

def discard_deposition(options={})
  id = options[:id] || raise(ArgumentError, "Must supply :id")
  Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/discard", nil, nil))
end

#edit_deposition(options = {}) ⇒ Zenodo::Resources::deposition?

Edit POST deposit/depositions/:id/actions/edit Unlock already submitted deposition for editing.

Parameters:

  • options (Hash) (defaults to: {}) —

    The options to edit a deposition with.

Options Hash (options):

  • :id (String, Fixnum) —

    A deposition’s ID.

Returns:

  • (Zenodo::Resources::deposition, nil) —

    .

Raises:

  • (ArgumentError) —

    If the given :id is blank.



23
24
25
26
 
# File 'lib/zenodo/dsl/deposition_actions.rb', line 23

def edit_deposition(options={})
  id = options[:id] || raise(ArgumentError, "Must supply :id")
  Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/edit", nil, nil))
end

#publish_deposition(options = {}) ⇒ Zenodo::Resources::deposition?

Publish POST deposit/depositions/:id/actions/publish Publishes a deposition. Note publishing will fail if no files are associated with the deposition.

Parameters:

  • options (Hash) (defaults to: {}) —

    The options to publish a deposition with.

Options Hash (options):

  • :id (String, Fixnum) —

    A deposition’s ID.

Returns:

  • (Zenodo::Resources::deposition, nil) —

    .

Raises:

  • (ArgumentError) —

    If the given :id is blank.



12
13
14
15
 
# File 'lib/zenodo/dsl/deposition_actions.rb', line 12

def publish_deposition(options={})
  id = options[:id] || raise(ArgumentError, "Must supply :id")
  Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/publish", nil, nil))
end