Class: Strava::Models::Upload

Inherits:

Response

• Object
• Hashie::Trash
• Strava::Model
• Response
• Strava::Models::Upload

Defined in:

lib/strava/models/upload.rb

Overview

Represents an activity file upload status.

When uploading activity files (GPX, TCX, FIT) to Strava, the upload is processed asynchronously. This model tracks the upload status and provides helper methods to check if processing is complete.

Examples:

Upload and poll for completion

upload = client.create_upload(
  file: Faraday::UploadIO.new('activity.gpx', 'application/gpx+xml'),
  data_type: 'gpx'
)

while upload.processing?
  sleep 2
  upload = client.upload(upload.id)
end

if upload.error
  puts "Upload failed: #{upload.error}"
else
  puts "Activity created: #{upload.activity_id}"
end

See Also:

• Api::Client#create_upload
• Api::Client#upload
• https://developers.strava.com/docs/reference/#api-models-Upload

Instance Method Summary

• #activity_id ⇒ Integer^?

  Activity ID once processing is complete.

• #error ⇒ String^?

  Error message if upload failed.

• #external_id ⇒ String

  External identifier for the upload.

• #id ⇒ Integer

  Upload ID.

• #id_str ⇒ String

  Upload ID as string.

• #processed? ⇒ Boolean

  Checks if the upload has completed processing.

• #processing? ⇒ Boolean

  Checks if the upload is still processing.

• #status ⇒ String

  Status message (e.g., "Your activity is ready.", "Your activity is still being processed.").

Instance Method Details

#activity_id ⇒ Integer^?

Returns Activity ID once processing is complete.

Returns:

• (Integer, nil) —

  Activity ID once processing is complete

# File 'lib/strava/models/upload.rb', line 50

property 'activity_id'

#error ⇒ String^?

Returns Error message if upload failed.

Returns:

• (String, nil) —

  Error message if upload failed

# File 'lib/strava/models/upload.rb', line 44

property 'error'

#external_id ⇒ String

Returns External identifier for the upload.

Returns:

• (String) —

  External identifier for the upload

# File 'lib/strava/models/upload.rb', line 41

property 'external_id'

#id ⇒ Integer

Returns Upload ID.

Returns:

• (Integer) —

  Upload ID

# File 'lib/strava/models/upload.rb', line 35

property 'id'

#id_str ⇒ String

Returns Upload ID as string.

Returns:

• (String) —

  Upload ID as string

# File 'lib/strava/models/upload.rb', line 38

property 'id_str'

#processed? ⇒ Boolean

Checks if the upload has completed processing.

Returns:

• (Boolean) —

  true if upload processing is complete

# File 'lib/strava/models/upload.rb', line 68

def processed?
  !processing?
end

#processing? ⇒ Boolean

Checks if the upload is still processing.

Returns:

• (Boolean) —

  true if upload is still being processed

Raises:

• (Strava::Errors::UploadError) —

  if upload failed with an error

# File 'lib/strava/models/upload.rb', line 58

def processing?
  validate!
  activity_id.nil?
end

#status ⇒ String

Returns Status message (e.g., "Your activity is ready.", "Your activity is still being processed.").

Returns:

• (String) —

  Status message (e.g., "Your activity is ready.", "Your activity is still being processed.")

# File 'lib/strava/models/upload.rb', line 47

property 'status'