Module: BucketClient::BlobMethods

Included in:
Client
Defined in:
lib/bucket_client/client.rb

Instance Method Summary collapse

Instance Method Details

#delete_blob(uri) ⇒ OperationResult

Deletes the blob in the provided URI Fails if the blob does not exist. Use delete_blob_if_exist if you do not want this behaviour

uri = “” result = client.delete_blob uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> nil

Parameters:

  • uri (String) —

    the URL of the blob

Returns:



355
356
357
 
# File 'lib/bucket_client/client.rb', line 355

def delete_blob(uri)
	raise NotImplementedError uri
end

#delete_blob!(uri) ⇒ Object

Deletes the blob in the provided URI Fails if the blob does not exist. Use delete_blob_if_exist if you do not want this behaviour

Raises exception if the operation fails

uri = “” client.delete_blob! uri

Parameters:

  • uri (String) —

    URL of the blob

Raises:



369
370
371
372
 
# File 'lib/bucket_client/client.rb', line 369

def delete_blob!(uri)
	result = delete_blob uri
	raise BucketOperationException.new(result) unless result.success
end

#delete_blob_if_exist(uri) ⇒ OperationResult

Deletes the blob if it exist, else does nothing

uri = “” result = client.delete_blob uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> nil

Parameters:

  • uri (String) —

    the URL of the blob

Returns:



385
386
387
 
# File 'lib/bucket_client/client.rb', line 385

def delete_blob_if_exist(uri)
	raise NotImplementedError uri
end

#delete_blob_if_exist!(uri) ⇒ Object

Deletes the blob if it exist, else does nothing

Raises exception if the operation fails

uri = “” client.delete_blob! uri

Parameters:

  • uri (String) —

    the URL of the blob

Raises:



397
398
399
400
 
# File 'lib/bucket_client/client.rb', line 397

def delete_blob_if_exist!(uri)
	result = delete_blob_if_exist uri
	raise BucketOperationException.new(result) unless result.success
end

#exist_blob(uri) ⇒ Boolean

Check if blob with URI exist#

Raises exception when the operation fails

exist = exist_blob “host.com/folder/blob.ext” exist #=> true if exist, false if does not exist

Parameters:

  • uri (String) —

    the URL of the blob

Returns:

  • (Boolean) 


267
268
269
 
# File 'lib/bucket_client/client.rb', line 267

def exist_blob(uri)
	raise NotImplementedError uri
end

#get_blob(uri) ⇒ OperationResult

Gets the blob in the target URL as byte array.

blob = client.get_blob “host.com/bucket” result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> Byte array (payload of blob)

Parameters:

  • uri (String) —

    the endpoint of the blob you want to get

Returns:



240
241
242
 
# File 'lib/bucket_client/client.rb', line 240

def get_blob(uri)
	raise NotImplementedError uri
end

#get_blob!(uri) ⇒ Array<Byte>

Gets the blob in the target URL as byte array

Raises exception if operation fails

blob = client.get_blob! “host.com/bucket” #=> [12,65,127,33] (some byte array)

Parameters:

  • uri (String) —

    the endpoint of the blob you want to get

Returns:

  • (Array<Byte>)

Raises:



252
253
254
255
256
 
# File 'lib/bucket_client/client.rb', line 252

def get_blob!(uri)
	result = get_blob(uri)
	raise BucketOperationException.new(result) unless result.success
	result.value
end

#put_blob(payload, uri) ⇒ OperationResult

Creates the blob with the payload if it does not exist, Updates the blob with the new payload if it exist

img = IO.binread “pic.png” uri = “” result = client.put_blob img, uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> Uri of blob

Parameters:

  • payload (Array<Byte>) —

    the payload to put

  • uri (String) —

    the URL of the blob

Returns:



320
321
322
 
# File 'lib/bucket_client/client.rb', line 320

def put_blob(payload, uri)
	raise NotImplementedError payload.to_s + uri
end

#put_blob!(payload, uri) ⇒ String

Creates the blob with the payload if it does not exist, Updates the blob with the new payload if it exist

Raises exception if the operation fails

img = IO.binread “pic.png” uri = “” result = client.put_blob!(img,uri) #=> returns URI of updated blob

Parameters:

  • payload (Array<Byte>) —

    the payload to put

  • uri (String) —

    the URL of the blob

Returns:

  • (String) 


336
337
338
339
340
 
# File 'lib/bucket_client/client.rb', line 336

def put_blob!(payload, uri)
	result = put_blob payload, uri
	raise NotImplementedError result unless result.success
	result.value
end

#update_blob(payload, uri) ⇒ OperationResult

Updates a blob with new payload in byte array Fails if blob with the URI doesn’t exist

img = IO.binread “pic.png” uri = “” result = client.update_blob img, uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> Uri of update blob

Parameters:

  • payload (Array<Byte>) —

    the payload to update the blob

  • uri (String) —

    the URL of the blob

Returns:



285
286
287
 
# File 'lib/bucket_client/client.rb', line 285

def update_blob(payload, uri)
	raise NotImplementedError payload.to_s + uri
end

#update_blob!(payload, uri) ⇒ Object

Updates a blob with new payload in byte array Fails if blob doesnt exist

Raises exception if operation fails

img = IO.binread “pic.png” uri = “” result = client.update_blob! img, uri #=> URI of update blob

Parameters:

  • payload (Array<Byte>) —

    the payload to update the blob

  • uri (String) —

    the URL of the blob

Raises:



300
301
302
303
304
 
# File 'lib/bucket_client/client.rb', line 300

def update_blob!(payload, uri)
	result = update_blob payload, uri
	raise BucketOperationException.new(result) unless result.success
	result.value
end