strava 0.1.0

data/lib/strava/base.rb

@@ -0,0 +1,86 @@
+module Strava
+  # Base class for Strava objects.
+  # Handles setting up the object, mainly data and a client.
+  # 
+  # @abstract
+  class Base
+    attr_reader :response, :client, :id
+
+    def initialize(data, client: nil, token: nil, **opts)
+      raise 'missing client or access token' unless (client || token)
+      @client   = client || Client.new(token)
+      if data.is_a?(Hash)
+        @id       = data['id']
+        set_ivars
+        update(data, **opts)
+      else
+        @id = data
+        set_ivars
+      end
+    end
+
+    # Parse incoming data.
+    # Should be defined by subclasses.
+    #
+    # @abstract
+    def update(data, **opts)
+      @response       = data
+      @resource_state = data['resource_state']
+      self
+    end
+
+    # Set up instance variables upon instantiation.
+    # Should be defined by subclasses.
+    # May not always be necessary.
+    #
+    # @abstract
+    # @return [void]
+    private def set_ivars
+      # this should be defined by subclasses
+    end
+
+    private def parse_data(existing, data, klass: nil, **opts)
+      existing ||= {}
+      case data
+      when [], {}
+        []
+      when Array
+        data.map do |hash|
+          current = existing[hash['id']]
+          if current
+            current.send(:update, hash, **opts)
+          else
+            current = klass.new(hash, **opts)
+            existing[current.id] = current
+          end
+          existing[current.id]
+        end
+      when Hash
+        existing[data['id']] = klass.new(data, **opts)
+      else
+        # raise
+      end
+    end
+
+    def resource_state
+      self.class.resource_states[@resource_state]
+    end
+
+    def summary?
+      @resource_state == 2
+    end
+
+    def detailed?
+      @resource_state == 3
+    end
+
+    def self.resource_states
+      @resource_states ||= {
+        1 => 'meta',
+        2 => 'summary',
+        3 => 'detailed',
+      }
+    end
+
+  end
+end

data/lib/strava/client.rb

@@ -0,0 +1,65 @@
+require 'httparty'
+module Strava
+  class Client
+    attr_reader :token
+    # @return [Usage] Information on API quota usage
+    attr_reader :usage
+    BASE_URL = 'https://www.strava.com/api/v3/' # can be overridden for individual requests
+
+    def initialize(token)
+      @token = token
+    end
+
+    def get(path, **params)
+      make_request(:get, path, **params)
+    end
+
+    def post(path, **params)
+      make_request(:post, path, **params)
+    end
+
+    def put(path, **params)
+      make_request(:put, path, **params)
+    end
+
+    def delete(path, **params)
+      make_request(:delete, path, **params)
+    end
+
+    def make_request(verb, path, **params)
+      puts (params[:host] || BASE_URL) + path
+      handle_params(params)
+      res = HTTParty.send(verb, (params.delete(:host) || BASE_URL) + path, query: params)
+      check_for_error(res)
+      res
+    end
+
+    def handle_params(params)
+      if @token
+        params.merge!(access_token: @token)
+      else
+        params.merge!(client_id: Strava.client_id, client_secret: Strava.secret)
+      end
+      params.reverse_each { |k, v| params.delete(k) if v.nil? }
+    end
+
+    def check_for_error(response)
+      @usage = Usage.new(response.headers['X-Ratelimit-Limit'], response.headers['X-Ratelimit-Usage'])
+      case response.code
+      when 401, 403
+        raise Strava::AccessError.new(response.to_h)
+      end
+    end
+
+
+    ## non athlete calls
+    def list_races(year = Time.now.year)
+      RunningRace.list_races(self, year)
+    end
+
+    def segment_explorer(bounds = '37.821362,-122.505373,37.842038,-122.465977')
+      Segment.explorer(self, bounds)
+    end
+
+  end
+end

data/lib/strava/club.rb

@@ -0,0 +1,164 @@
+module Strava
+  # Clubs represent groups of athletes on Strava. They can be public or private.
+  # Clubs have both summary and detailed representations.
+  # 
+  # @see https://strava.github.io/api/v3/clubs/ Strava Docs - Clubs
+  class Club < Base
+
+    # Set up instance variables upon instantiation.
+    #
+    # @abstract
+    # @return [void]
+    private def set_ivars
+      @activities       = {}
+      @group_events     = {}
+      @announcements    = []
+      @members          = {}
+      @admins           = []
+      @segment_efforts  = {}
+    end
+
+    # Update an existing club. 
+    # Used by other methods in the gem.
+    # Should not be used directly.
+    # 
+    # @param data [Hash] data to update the club with
+    # @return [self]
+    def update(data, **opts)
+      @response       = data
+      @id             = data["id"]
+      @resource_state = data['resource_state']
+
+      self
+    end
+
+    def activities(per_page: nil, page: nil, before: nil)
+      if page || per_page || before
+        get_activities(per_page: per_page, page: page, before: before)
+      else
+        get_activities if @activities.empty?
+        @activities.values
+      end
+    end
+
+    def group_events(per_page: nil, page: nil, before: nil)
+      if page || per_page || before
+        get_group_events(per_page: per_page, page: page, before: before)
+      else
+        get_group_events if @group_events.empty?
+        @group_events.values
+      end
+    end
+
+    def announcements
+      get_announcements if @announcements.empty?
+      @announcements
+    end
+
+    def members(per_page: nil, page: nil)
+      if page || per_page
+        get_members(per_page: per_page, page: page)
+      else
+        get_members if @members.empty? || !@members_fetched
+        @members_fetched = true
+        @members.values
+      end
+    end
+
+    def admins(per_page: nil, page: nil)
+      if page || per_page
+        get_admins(per_page: per_page, page: page)
+      else
+        get_admins if @admins.empty?
+        @admins
+      end
+    end
+
+    # {"success"=>true, "active"=>false}
+    def join
+      res = client.post(path_join).to_h
+    end
+
+    # {"success"=>true, "active"=>true, "membership"=>"member"}
+    def leave
+      res = client.post(path_leave).to_h
+    end
+
+    def get_details
+      return self if detailed?
+      res = client.get(path_base).to_h
+      update(res)
+    end
+
+    private def get_activities(per_page: nil, page: nil, before: nil)
+      res = client.get(path_activities, per_page: per_page, page: page, before: before).to_a
+      parse_data(@activities, res, klass: Activity, client: @client)
+    end
+
+    private def get_group_events(per_page: nil, page: nil, before: nil)
+      res = client.get(path_group_events, per_page: per_page, page: page, before: before).to_a
+      parse_data(@group_events, res, klass: Activity, client: @client)
+    end
+
+    private def get_announcements
+      res = client.get(path_announcements).to_a
+      @announcements = parse_data({}, res, klass: ClubAnnouncement, client: @client)
+    end
+
+    private def get_members
+      res = client.get(path_members).to_a
+      parse_data(@members, res, klass: Athlete, client: @client)
+    end
+
+    private def get_admins
+      res = client.get(path_admins).to_a
+      @admins = parse_data(@members, res, klass: Athlete, client: @client)
+    end
+
+    private def path_base
+      "clubs/#{id}"
+    end
+
+    private def path_activities
+      "#{path_base}/activities"
+    end
+
+    private def path_group_events
+      "#{path_base}/group_events"
+    end
+
+    private def path_announcements
+      "#{path_base}/announcements"
+    end
+
+    private def path_members
+      "#{path_base}/members"
+    end
+
+    private def path_admins
+      "#{path_base}/admins"
+    end
+
+    private def path_join
+      "#{path_base}/join"
+    end
+
+    private def path_leave
+      "#{path_base}/leave"
+    end
+
+  end
+end
+
+__END__
+
+ca = Strava::Athlete.current_athlete;
+club = ca.clubs.last
+club.admins
+club.members
+club.get_details
+club.activities
+club.group_events
+club.announcements
+club.leave
+club.join

data/lib/strava/club_announcement.rb

@@ -0,0 +1,28 @@
+module Strava
+  # Class to represent Strava Club Announcement
+  # https://strava.github.io/api/v3/activities/
+  class ClubAnnouncement < Base
+
+    def update(data, **opts)
+      @response = data
+      @id             = data['id']
+      @resource_state = data['resource_state']
+
+      @message        = data['message']
+      @created_at     = data['created_at']
+      @club_id        = data['club_id']
+      @athlete        = Athlete.new(data['athlete'], client: @client)
+    end
+
+  end
+end
+
+__END__
+
+ca = Strava::Athlete.current_athlete;
+ca.activities;
+ca.activities(page: 2);
+ca.activities(page: 3);
+ca.activities(page: 4);
+act = ca.activities.detect{|act| act.response['comment_count'] > 0 && act.response['kudos_count'] > 0 }
+act.comments

data/lib/strava/comment.rb

@@ -0,0 +1,36 @@
+module Strava
+  # Class to represent Strava Activity
+  # https://strava.github.io/api/v3/activities/
+  class Comment < Base
+
+    attr_reader :activity_id
+
+    def update(data, **opts)
+      @response = data
+      @id             = data['id']
+      @resource_state = data['resource_state']
+
+      @text           = data['text']
+      @activity_id    = data['activity_id']
+      @athlete        = Athlete.new(data['athlete'], client: @client)
+    end
+
+    def delete
+      res = client.delete(path_base).to_h
+    end
+
+    def path_base
+      "activities/#{activity_id}/comments/#{id}"
+    end
+  end
+end
+
+__END__
+
+ca = Strava::Athlete.current_athlete;
+ca.activities;
+ca.activities(page: 2);
+ca.activities(page: 3);
+ca.activities(page: 4);
+act = ca.activities.detect{|act| act.response['comment_count'] > 0 && act.response['kudos_count'] > 0 }
+act.comments

data/lib/strava/error.rb

@@ -0,0 +1,15 @@
+{"message"=>"Authorization Error", "errors"=>[{"resource"=>"AccessToken", "field"=>"write_permission", "code"=>"missing"}]}
+
+module Strava
+  class Error < StandardError
+    attr_accessor :response, :strava_errors
+  end
+
+  class AccessError < Error
+    def initialize(response)
+      message = response['message']
+      strava_errors = response['errors']
+      super(message)
+    end
+  end
+end

data/lib/strava/gear.rb

@@ -0,0 +1,41 @@
+module Strava
+  # Gear represents both shoes and bikes.
+  # These are returned as part of the athlete summary.
+  # 
+  # @see https://strava.github.io/api/v3/gear/ Strava Gear API Docs
+  class Gear < Base
+
+    # Updates gear with passed data attributes.
+    # 
+    # @param data [Hash] data hash containing gear data
+    # @return [self]
+    def update(data, **opts)
+      @response = data
+      @id                     = data['id']
+      @resource_state         = data['resource_state']
+      self
+    end
+
+    # Retrieve full details for Gear object.
+    # Sets all data attributes on self.
+    # 
+    # @return [Hash] raw API response
+    def get_details
+      return self if detailed?
+      res = client.get(path_base).to_h
+      update(res)
+      res
+    end
+
+    # URL path for Gear object.
+    # 
+    # @return [String] URL path
+    private def path_base
+      "gear/#{id}"
+    end
+  end
+end
+
+__END__
+
+ca = Strava::Athlete.current_athlete;

data/lib/strava/group_event.rb

@@ -0,0 +1,62 @@
+module Strava
+  # Group events for Strava Clubs
+  # 
+  # @see http://strava.github.io/api/v3/club_group_events/ Strava Docs - Group Events
+  class GroupEvent < Base
+
+    def update(data, **opts)
+      @response = data
+      @id                     = data["id"]
+      @resource_state         = data['resource_state']
+    end
+
+    def get_details
+      return self if detailed?
+      res = client.get(path_base).to_h
+      update(res)
+      res
+    end
+
+    def athletes(per_page: nil, page: nil)
+      if page || per_page
+        get_athletes(per_page: per_page, page: page)
+      else
+        get_athletes if @athletes.empty?
+        @athletes.values
+      end
+    end
+
+    def delete
+      res = client.delete(path_base).to_h
+    end
+
+    # {"success"=>true, "active"=>false}
+    def join
+      res = client.post(path_rsvp).to_h
+    end
+
+    # {"success"=>true, "active"=>true, "membership"=>"member"}
+    def leave
+      res = client.delete(path_rsvp).to_h
+    end
+
+    private def path_base
+      "group_events/#{id}"
+    end
+
+    private def path_rsvp
+      "#{path_base}/rsvps"
+    end
+
+    private def path_athletes
+      "#{path_base}/athletes"
+    end
+
+  end
+end
+
+__END__
+
+ca = Strava::Athlete.current_athlete;
+miz = ca.clubs.last;
+miz.group_events