Class: QualtricsAPI::ResponseExport

Inherits:
Object
  • Object
show all
Defined in:
lib/qualtrics_api/response_export.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ResponseExport

Returns a new instance of ResponseExport.



7
8
9
10
 
# File 'lib/qualtrics_api/response_export.rb', line 7

def initialize(options = {})
  @conn = options[:connection]
  @id = options[:id]
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



5
6
7
 
# File 'lib/qualtrics_api/response_export.rb', line 5

def id
  @id
end

Instance Method Details

#completed? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/qualtrics_api/response_export.rb', line 30

def completed?
  @completed == true
end

#file_url ⇒ Object 



34
35
36
37
 
# File 'lib/qualtrics_api/response_export.rb', line 34

def file_url
  update_status unless completed?
  @file_url
end

#percent_completed ⇒ Object 



25
26
27
28
 
# File 'lib/qualtrics_api/response_export.rb', line 25

def percent_completed
  update_status unless completed?
  @export_progress
end

#status ⇒ Object 



20
21
22
23
 
# File 'lib/qualtrics_api/response_export.rb', line 20

def status
  update_status unless completed?
  "#{@export_progress}%"
end

#update_status ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/qualtrics_api/response_export.rb', line 12

def update_status
  res = @conn.get('surveys/responseExports/' + @id).body["result"]
  @export_progress = res["percentComplete"]
  @file_url = res["fileUrl"]
  @completed = true if @export_progress == 100.0
  self
end