Class: UploadProgress::Progress

Inherits:
Object
  • Object
show all
Defined in:
lib/upload_progress/lib/progress.rb

Overview

Upload Progress abstracts the progress of an upload. It’s used by the multipart progress IO that keeps track of the upload progress and creating the application depends on. It contians methods to update the progress during an upload and read the statistics such as received_bytes, total_bytes, completed_percent, bitrate, and remaining_seconds

You can get the current Progress object by calling upload_progress instance method in your controller or view.

Constant Summary collapse

MIN_SAMPLE_TIME =

Number of seconds between bitrate samples. Updates that occur more frequently than MIN_SAMPLE_TIME will not be queued until this time passes. This behavior gives a good balance of accuracy and load for both fast and slow transfers.

0.150
MIN_STALL_TIME =

Number of seconds between updates before giving up to try and calculate bitrate anymore

10.0
MAX_SAMPLES =

Number of samples used to calculate bitrate

20

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(total) ⇒ Progress

Create a new Progress object passing the expected number of bytes to receive



44
45
46
47
 
# File 'lib/upload_progress/lib/progress.rb', line 44

def initialize(total)
  @total_bytes = total
  reset!
end

Instance Attribute Details

#last_update_time ⇒ Object (readonly)

The last time the upload history was updated



35
36
37
 
# File 'lib/upload_progress/lib/progress.rb', line 35

def last_update_time
  @last_update_time
end

#message ⇒ Object

A message you can set from your controller or view to be rendered in the upload_status_text helper method. If you set a messagein a controller then call session.update to make that message available to your upload_status action.



41
42
43
 
# File 'lib/upload_progress/lib/progress.rb', line 41

def message
  @message
end

#received_bytes ⇒ Object (readonly)

Number bytes received from the multipart post



29
30
31
 
# File 'lib/upload_progress/lib/progress.rb', line 29

def received_bytes
  @received_bytes
end

#total_bytes ⇒ Object (readonly)

Total number of bytes expected from the mutlipart post



32
33
34
 
# File 'lib/upload_progress/lib/progress.rb', line 32

def total_bytes
  @total_bytes
end

Instance Method Details

#bitrate ⇒ Object

Calculates the bitrate in bytes/second. If the transfer is stalled or just started, the bitrate will be 0



108
109
110
111
 
# File 'lib/upload_progress/lib/progress.rb', line 108

def bitrate
  history_bytes, history_time = @history.transpose.map { |vals| vals.inject { |sum, v| sum + v } } 
  history_bytes / history_time rescue 0
end

#completed_percent ⇒ Object

Completed percent in integer form from 0..100



62
63
64
 
# File 'lib/upload_progress/lib/progress.rb', line 62

def completed_percent
  (@received_bytes * 100 / @total_bytes).to_i rescue 0
end

#elapsed_seconds ⇒ Object

Number of seconds elapsed since the start of the upload



114
115
116
 
# File 'lib/upload_progress/lib/progress.rb', line 114

def elapsed_seconds
  @last_update_time
end

#finished? ⇒ Boolean

Returns true if there are bytes pending otherwise returns false

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/upload_progress/lib/progress.rb', line 125

def finished?
  remaining_bytes <= 0
end

#remaining_bytes ⇒ Object

Number of bytes left for this upload



57
58
59
 
# File 'lib/upload_progress/lib/progress.rb', line 57

def remaining_bytes
  @total_bytes - @received_bytes
end

#remaining_seconds ⇒ Object

Calculate the seconds remaining based on the current bitrate. Returns O seconds if stalled or if no bytes have been received



120
121
122
 
# File 'lib/upload_progress/lib/progress.rb', line 120

def remaining_seconds
  remaining_bytes / bitrate rescue 0
end

#reset! ⇒ Object

Resets the received_bytes, last_update_time, message and bitrate, but but maintains the total expected bytes



51
52
53
54
 
# File 'lib/upload_progress/lib/progress.rb', line 51

def reset!
  @received_bytes, @last_update_time, @stalled, @message = 0, 0, false, ''
  reset_history
end

#stalled? ⇒ Boolean

Returns true if there has been a delay in receiving bytes. The delay is set by the constant MIN_STALL_TIME

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/upload_progress/lib/progress.rb', line 136

def stalled?
  @stalled
end

#started? ⇒ Boolean

Returns true if some bytes have been received

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/upload_progress/lib/progress.rb', line 130

def started?
  @received_bytes > 0
end

#update!(bytes, elapsed_seconds) ⇒ Object

Updates this UploadProgress object with the number of bytes received since last update time and the absolute number of seconds since the beginning of the upload.

This method is used by the MultipartProgress module and should not be called directly.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/upload_progress/lib/progress.rb', line 72

def update!(bytes, elapsed_seconds)#:nodoc:
  if @received_bytes + bytes > @total_bytes
    #warn "Progress#update received bytes exceeds expected bytes"
    bytes = @total_bytes - @received_bytes
  end

  @received_bytes += bytes

  # Age is the duration of time since the last update to the history
  age = elapsed_seconds - @last_update_time

  # Record the bytes received in the first element of the history
  # in case the sample rate is exceeded and we shouldn't record at this
  # time
  @history.first[0] += bytes
  @history.first[1] += age

  history_age = @history.first[1]

  @history.pop while @history.size > MAX_SAMPLES
  @history.unshift([0,0]) if history_age > MIN_SAMPLE_TIME

  if history_age > MIN_STALL_TIME
    @stalled = true
    reset_history 
  else
    @stalled = false
  end

  @last_update_time = elapsed_seconds
  
  self
end