Module: Zenodo::DSL::Depositions

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

Instance Method Summary collapse

Instance Method Details

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

POST /Deposit/Depositions Creates a deposition.

Parameters:

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

    The options to create a deposition with.

Options Hash (options):

  • :deposition (Hash) —

    The deposition to create.

Returns:

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

    .

Raises:

  • (ArgumentError) —

    If the :deposition arguments are blank.



29
30
31
32
 
# File 'lib/zenodo/dsl/depositions.rb', line 29

def create_deposition(options={})
  deposition = options[:deposition] || raise(ArgumentError, "Must supply :deposition")
  Resources::Deposition.parse(request(:post, "deposit/depositions/", deposition))
end

#delete_deposition(options = {}) ⇒ Faraday::Response

DELETE /Deposit/Depositions/id Deletes a deposition.

Parameters:

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

    The options to delete a deposition with.

  • optoins (Hash) —

    a customizable set of options

Returns:

  • (Faraday::Response) —

    .

Raises:

  • (ArgumentError) —

    If the :id argument is blank.



53
54
55
56
 
# File 'lib/zenodo/dsl/depositions.rb', line 53

def delete_deposition(options={})
  id = options[:id] || raise(ArgumentError, "Must supply :id")
  request(:delete, "deposit/depositions/#{id}")
end

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

GET /Deposit/Deposition/id Get a deposition.

Parameters:

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

    The options to get a deposition with.

Options Hash (options):

  • :id (String, Fixnum) —

    A deposition’s ID.

Returns:

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

    .

Raises:

  • (ArgumentError) —

    If the :id is blank



18
19
20
21
 
# File 'lib/zenodo/dsl/depositions.rb', line 18

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

#get_depositions ⇒ Array?

GET /Deposit/Depositions Get depositions.

Returns:

  • (Array, nil) —

    .



8
9
10
 
# File 'lib/zenodo/dsl/depositions.rb', line 8

def get_depositions
  Resources::Deposition.parse(request(:get, "deposit/depositions/", nil, nil))
end

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

PUT /Deposit/Depositions Updates a deposition.

Parameters:

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

    The options to update a deposition with.

Options Hash (options):

  • :id (String, Fixnum) —

    A deposition’s ID.

  • :deposition (Hash) —

    The deposition to update.

Returns:

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

    .

Raises:

  • (ArgumentError) —

    If the :id or :deposition arguments are blank.



41
42
43
44
45
 
# File 'lib/zenodo/dsl/depositions.rb', line 41

def update_deposition(options={})
  id = options[:id] || raise(ArgumentError, "Must supply :id")
  deposition = options[:deposition] || raise(ArgumentError, "Must supply :deposition")
  Resources::Deposition.parse(request(:put, "deposit/depositions/#{id}", deposition))
end