Method: CrateAPI::Crate#rename

Defined in:
lib/crate_api/crate.rb

#rename(name) ⇒ CrateRenameError?

Renamed the given crate object.

Returns:

  • (CrateRenameError, nil) —

    if there is an issue with renaming the crate, an error will be raised with the message explaining why.

Raises:



33
34
35
36
 
# File 'lib/crate_api/crate.rb', line 33

def rename(name)
  response = JSON.parse(CrateAPI::Base.call("#{CrateAPI::Base::CRATES_URL}/#{CrateAPI::Crates::CRATE_ACTIONS[:rename] % ["#{self.id}"]}", :post, {:body => {:name => name}}))
  raise CrateRenameError, response["message"] unless response["status"] != "failure"
end