Class: Uploadcare::Client::FileMetadataClient

Inherits:
RestClient
  • Object
show all
Defined in:
lib/uploadcare/client/file_metadata_client.rb

Overview

API client for handling single metadata_files

See Also:

Instance Method Summary collapse

Methods inherited from RestClient

#api_root, #api_struct_delete, #api_struct_get, #api_struct_post, #api_struct_put, #get, #headers, #post, #put, #request

Methods included from Uploadcare::Concerns::ThrottleHandler

#handle_throttling

Methods included from Uploadcare::Concerns::ErrorHandler

#failure, #wrap

Instance Method Details

#delete(uuid, key) ⇒ Object

Delete a file's metadata key.

See Also:



31
32
33
 
# File 'lib/uploadcare/client/file_metadata_client.rb', line 31

def delete(uuid, key)
  request(method: 'DELETE', uri: "/files/#{uuid}/metadata/#{key}/")
end

#index(uuid) ⇒ Object

Get file's metadata keys and values

See Also:



13
14
15
 
# File 'lib/uploadcare/client/file_metadata_client.rb', line 13

def index(uuid)
  get(uri: "/files/#{uuid}/metadata/")
end

#show(uuid, key) ⇒ Object

Get the value of a single metadata key.

See Also:



19
20
21
 
# File 'lib/uploadcare/client/file_metadata_client.rb', line 19

def show(uuid, key)
  get(uri: "/files/#{uuid}/metadata/#{key}/")
end

#update(uuid, key, value) ⇒ Object

Update the value of a single metadata key. If the key does not exist, it will be created.

See Also:



25
26
27
 
# File 'lib/uploadcare/client/file_metadata_client.rb', line 25

def update(uuid, key, value)
  put(uri: "/files/#{uuid}/metadata/#{key}/", content: value.to_json)
end