Class: QueryGuard::Uploader::UploadResult

Inherits:
Object
  • Object
show all
Defined in:
lib/query_guard/uploader/interface.rb

Overview

Result of an upload operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success:, uploader_name:, details: {}, error: nil) ⇒ UploadResult

Returns a new instance of UploadResult.



54
55
56
57
58
59
 
# File 'lib/query_guard/uploader/interface.rb', line 54

def initialize(success:, uploader_name:, details: {}, error: nil)
  @success = success
  @uploader_name = uploader_name
  @details = details
  @error = error
end

Instance Attribute Details

#details ⇒ Object (readonly)

Returns the value of attribute details.



52
53
54
 
# File 'lib/query_guard/uploader/interface.rb', line 52

def details
  @details
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



52
53
54
 
# File 'lib/query_guard/uploader/interface.rb', line 52

def error
  @error
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



52
53
54
 
# File 'lib/query_guard/uploader/interface.rb', line 52

def success
  @success
end

#uploader_name ⇒ Object (readonly)

Returns the value of attribute uploader_name.



52
53
54
 
# File 'lib/query_guard/uploader/interface.rb', line 52

def uploader_name
  @uploader_name
end

Instance Method Details

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/query_guard/uploader/interface.rb', line 65

def failed?
  !@success
end

#successful? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/query_guard/uploader/interface.rb', line 61

def successful?
  @success
end

#to_h ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/query_guard/uploader/interface.rb', line 69

def to_h
  {
    success: @success,
    uploader: @uploader_name,
    details: @details,
    error: @error
  }
end