Module: BucketClient::UriMethod

Included in:
Bucket
Defined in:
lib/bucket_client/bucket.rb

Instance Method Summary collapse

Instance Method Details

#delete_blob_if_exist_with_uri(uri) ⇒ OperationResult

Deletes the blob if it exist, else does nothing

uri = “” result = bucket.delete_blob_with_uri uri result.success #=> whether the operation succeeded result.code #=> Status code of the operation result.message #=> Error message if the operation failed result.value #=> nil

Parameters:

  • uri (String) —

    the URL of the blob

Returns:



356
357
358
 
# File 'lib/bucket_client/bucket.rb', line 356

def delete_blob_if_exist_with_uri(uri)
  raise NotImplementedError uri
end

#delete_blob_if_exist_with_uri!(uri) ⇒ Object

Deletes the blob if it exist, else does nothing Raises exception if the operation fails

uri = “” bucket.delete_blob_with_uri! uri

Parameters:

  • uri (String) —

    the URL of the blob

Raises:



367
368
369
370
 
# File 'lib/bucket_client/bucket.rb', line 367

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

#delete_blob_with_uri(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 = bucket.delete_blob_with_uri uri result.success #=> whether the operation succeeded result.code #=> Status code of the operation result.message #=> Error message if the operation failed result.value #=> nil

Parameters:

  • uri (String) —

    the URL of the blob

Returns:



326
327
328
 
# File 'lib/bucket_client/bucket.rb', line 326

def delete_blob_with_uri(uri)
  raise NotImplementedError uri
end

#delete_blob_with_uri!(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 = “” bucket.delete_blob_with_uri! uri

Parameters:

  • uri (String) —

    URL of the blob

Raises:



340
341
342
343
 
# File 'lib/bucket_client/bucket.rb', line 340

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

#exist_blob_with_uri(uri) ⇒ Boolean

Check if blob exist

Raises exception if the operation fails

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

Parameters:

  • uri (String) —

    the URL of the blob

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/bucket_client/bucket.rb', line 239

def exist_blob_with_uri(uri)
  raise NotImplementedError uri
end

#get_blob_with_uri(uri) ⇒ OperationResult

Gets the blob in the target URL as byte array.

blob = bucket.get_blob_with_uri “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 #=> payload of the blob as byte array

Parameters:

  • uri (String) —

    the endpoint of the blob you want to get

Returns:



212
213
214
 
# File 'lib/bucket_client/bucket.rb', line 212

def get_blob_with_uri(uri)
  raise NotImplementedError uri
end

#get_blob_with_uri!(uri) ⇒ Array<Byte>

Gets the blob in the target URL as byte array

Raises exception if operation fails

blob = bucket.get_blob_with_uri! “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:



224
225
226
227
228
 
# File 'lib/bucket_client/bucket.rb', line 224

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

#put_blob_with_uri(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 = bucket.put_blob_with_uri img, uri result.success #=> whether the operation succeeded result.code #=> Status code of the operation result.message #=> Error message if the operation failed result.value #=> Uri of blob

Parameters:

  • payload (Array<Byte>) —

    the payload to put

  • uri (String) —

    the URL of the blob

Returns:



291
292
293
 
# File 'lib/bucket_client/bucket.rb', line 291

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

#put_blob_with_uri!(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 = bucket.put_blob_with_uri!(img,uri) #=> returns URI of updated blob

Parameters:

  • payload (Array<Byte>) —

    the payload to put

  • uri (String) —

    the URL of the blob

Returns:

  • (String)

Raises:



307
308
309
310
311
 
# File 'lib/bucket_client/bucket.rb', line 307

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

#update_blob_with_uri(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 = bucket.update_blob_with_uri 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:



257
258
259
 
# File 'lib/bucket_client/bucket.rb', line 257

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

#update_blob_with_uri!(payload, uri) ⇒ Object

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

img = IO.binread “pic.png” uri = “” result = bucket.update_blob_with_uri!(img, uri) #=> URI of update blob

Parameters:

  • payload (Array<Byte>) —

    the payload to update the blob

  • uri (String) —

    the URL of the blob

Raises:



271
272
273
274
275
 
# File 'lib/bucket_client/bucket.rb', line 271

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