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(id:) ⇒ Zenodo::Resources::deposition?

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

Parameters:

  • id (String, Fixnum) —

    A deposition’s ID.

Returns:

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

    .

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



31
32
33
34
 
# File 'lib/zenodo/dsl/deposition_actions.rb', line 31

def discard_deposition(id:)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/discard", nil, nil))
end

#edit_deposition(id:) ⇒ Zenodo::Resources::deposition?

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

Parameters:

  • id (String, Fixnum) —

    A deposition’s ID.

Returns:

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

    .

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



21
22
23
24
 
# File 'lib/zenodo/dsl/deposition_actions.rb', line 21

def edit_deposition(id:)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/edit", nil, nil))
end

#publish_deposition(id:) ⇒ 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:

  • id (String, Fixnum) —

    A deposition’s ID.

Returns:

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

    .

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



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

def publish_deposition(id:)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/publish", nil, nil))
end