Module: Strava::Api::Endpoints::Activities

Included in:
Client
Defined in:
lib/strava/api/endpoints/activities.rb

Instance Method Summary collapse

Instance Method Details

#activity(id_or_options, options = {}) ⇒ Object

Get activity.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.



20
21
22
23
 
# File 'lib/strava/api/endpoints/activities.rb', line 20

def activity(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  Strava::Models::DetailedActivity.new(get("activities/#{id}", options))
end

#activity_comments(id_or_options, options = {}, &block) ⇒ Object

List activity comments.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.

  • :page (Integer) —

    Page number.

  • :page_size (Integer) —

    Number of items per page. Defaults to 30.

  • :per_page (Integer) —

    Number of items per page. Defaults to 30. @deprecated use page_size



38
39
40
41
 
# File 'lib/strava/api/endpoints/activities.rb', line 38

def activity_comments(id_or_options, options = {}, &block)
  id, options = parse_args(id_or_options, options)
  paginate_with_cursor "activities/#{id}/comments", options, Strava::Models::Comment, &block
end

#activity_kudos(id_or_options, options = {}, &block) ⇒ Object

List activity kudoers.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.

  • :page (Integer) —

    Page number.

  • :per_page (Integer) —

    Number of items per page. Defaults to 30.



69
70
71
72
 
# File 'lib/strava/api/endpoints/activities.rb', line 69

def activity_kudos(id_or_options, options = {}, &block)
  id, options = parse_args(id_or_options, options)
  paginate "activities/#{id}/kudos", options, Strava::Models::SummaryAthlete, &block
end

#activity_laps(id_or_options, options = {}) ⇒ Object

Get activity laps.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.



80
81
82
83
84
85
 
# File 'lib/strava/api/endpoints/activities.rb', line 80

def activity_laps(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  get("activities/#{id}/laps", options).map do |row|
    Strava::Models::Lap.new(row)
  end
end

#activity_photos(id_or_options, options = {}, &block) ⇒ Object

List activity photos.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.

  • :page (Integer) —

    Page number.

  • :per_page (Integer) —

    Number of items per page. Defaults to 30.



53
54
55
56
57
 
# File 'lib/strava/api/endpoints/activities.rb', line 53

def activity_photos(id_or_options, options = {}, &block)
  id, options = parse_args(id_or_options, options)
  options[:size] = 5000 unless options[:size] # to retrieve full size photos
  paginate "activities/#{id}/photos", options, Strava::Models::DetailedPhoto, &block
end

#activity_zones(id_or_options, options = {}) ⇒ Object

Get activity zones.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.



112
113
114
115
116
117
 
# File 'lib/strava/api/endpoints/activities.rb', line 112

def activity_zones(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  get("activities/#{id}/zones", options).map do |row|
    Strava::Models::ActivityZone.new(row)
  end
end

#athlete_activities(options = {}, &block) ⇒ Object

List logged-in athlete activities.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :before (Integer) —

    An epoch timestamp to use for filtering activities that have taken place before a certain time.

  • :after (Integer) —

    An epoch timestamp to use for filtering activities that have taken place after a certain time.

  • :page (Integer) —

    Page number.

  • :per_page (Integer) —

    Number of items per page. Defaults to 30.



99
100
101
102
103
104
 
# File 'lib/strava/api/endpoints/activities.rb', line 99

def athlete_activities(options = {}, &block)
  options = options.dup if options.key?(:after) || options.key?(:before)
  options[:after] = options[:after].to_i if options[:after]
  options[:before] = options[:before].to_i if options[:before]
  paginate 'athlete/activities', options, Strava::Models::SummaryActivity, &block
end

#create_activity(options = {}) ⇒ Object

Create an activity.



10
11
12
 
# File 'lib/strava/api/endpoints/activities.rb', line 10

def create_activity(options = {})
  Strava::Models::DetailedActivity.new(post('activities', options))
end

#update_activity(id_or_options, options = {}) ⇒ Object

Update an activity.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :id (String) —

    Activity id.

  • :commute (Boolean) —

    Whether this activity is a commute.

  • :trainer (Boolean) —

    Whether this activity was recorded on a training machine.

  • :description (String) —

    The description of the activity.

  • :name (String) —

    The name of the activity.

  • :sport_type (String) —

    Activity type.

  • :gear_id (String) —

    Identifier for the gear associated with the activity. Specifying “none” clears gear from activity.



137
138
139
140
 
# File 'lib/strava/api/endpoints/activities.rb', line 137

def update_activity(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  Strava::Models::DetailedActivity.new(put("activities/#{id}", options))
end