Module: Strava::Api::Endpoints::Streams

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

Instance Method Summary collapse

Instance Method Details

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

Returns the given activity’s streams.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :id (String) —

    The identifier of the activity.

  • :keys (Array[String]) —

    Desired stream types.

  • :key_by_type (Boolean) —

    Must be true.



17
18
19
20
21
22
23
 
# File 'lib/strava/api/endpoints/streams.rb', line 17

def activity_streams(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  query = options.dup
  query[:key_by_type] = true unless options.key?(:key_by_type)
  query[:keys] = options[:keys].join(',') if options[:keys].is_a?(Array)
  Strava::Models::StreamSet.new(get("activities/#{id}/streams", query))
end

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

Returns a set of streams for a segment effort completed by the authenticated athlete.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :id (String) —

    The identifier of the segment effort.

  • :keys (Array[String]) —

    The types of streams to return.

  • :key_by_type (Boolean) —

    Must be true.



35
36
37
38
39
40
41
 
# File 'lib/strava/api/endpoints/streams.rb', line 35

def segment_effort_streams(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  query = options.dup
  query[:key_by_type] = true unless options.key?(:key_by_type)
  query[:keys] = options[:keys].join(',') if options[:keys].is_a?(Array)
  Strava::Models::StreamSet.new(get("segment_efforts/#{id}/streams", query))
end

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

Returns the given segment’s streams.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :id (String) —

    The identifier of the segment.

  • :keys (Array[String]) —

    The types of streams to return.

  • :key_by_type (Boolean) —

    Must be true.



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

def segment_streams(id_or_options, options = {})
  id, options = parse_args(id_or_options, options)
  query = options.dup
  query[:key_by_type] = true unless options.key?(:key_by_type)
  query[:keys] = options[:keys].join(',') if options[:keys].is_a?(Array)
  Strava::Models::StreamSet.new(get("segments/#{id}/streams", query))
end