Strava\API\Client

Complexity

Total Complexity

81

Size/Duplication

Total Lines	779
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

97.55%

Importance

Changes

0

41 Methods

Rating	Name	Duplication	Size	Complexity
A	getAthleteStarredSegments()	0	8	2
A	updateAthlete()	0	8	2
A	__construct()	0	4	1
A	getAthlete()	0	8	2
A	getAthleteStats()	0	8	2
A	getAthleteRoutes()	0	8	2
A	getAthleteClubs()	0	8	2
A	getAthleteActivities()	0	8	2
A	getAthleteFriends()	0	8	2
A	getAthleteFollowers()	0	8	2
A	getAthleteBothFollowing()	0	8	2
A	getAthleteKom()	0	8	2
A	getAthleteZones()	0	8	2
A	getActivity()	0	8	2
A	getActivityComments()	0	8	2
A	getActivityKudos()	0	8	2
A	getActivityPhotos()	0	8	2
A	getActivityZones()	0	8	2
A	getActivityLaps()	0	8	2
A	getActivityUploadStatus()	0	8	2
A	createActivity()	0	8	2
A	uploadActivity()	0	8	2
A	updateActivity()	0	8	2
A	deleteActivity()	0	8	2
A	getGear()	0	8	2
A	getClub()	0	8	2
A	getClubMembers()	0	8	2
A	getClubActivities()	0	8	2
A	getClubAnnouncements()	0	8	2
A	getClubGroupEvents()	0	8	2
A	joinClub()	0	8	2
A	leaveClub()	0	8	2
A	getRoute()	0	8	2
A	getSegment()	0	8	2
A	getSegmentLeaderboard()	0	8	2
A	getSegmentExplorer()	0	8	2
A	getSegmentEffort()	0	8	2
A	getStreamsActivity()	0	8	2
A	getStreamsEffort()	0	8	2
A	getStreamsSegment()	0	8	2
A	getStreamsRoute()	0	8	2

<?php

namespace Strava\API;

use Strava\API\Service\ServiceInterface;
use Strava\API\Exception as ClientException;
use Strava\API\Service\Exception as ServiceException;

/**
 * Strava API Client
 *
 * @author Bas van Dorst
 * @package StravaPHP
 */
class Client
{
    /**
     * @var ServiceInterface $service
     */
    protected $service;

    /**
     * Initiate this class with a subclass of ServiceInterface. There are two
     * service subclasses available:
     * - Service\REST: Service which makes calls to the live Strava API
     * - Service\Stub: Service stub for test purposes (unit tests)
     *
     * @param ServiceInterface $service
     */
    public function __construct(ServiceInterface $service)
    {
        $this->service = $service;
    }

    /**
     * Retrieve current athlete
     *
     * @link    https://strava.github.io/api/v3/athlete/#get-details,
     *          https://strava.github.io/api/v3/athlete/#get-another-details
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getAthlete($id = null)
    {
        try {
            return $this->service->getAthlete($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve athlete stats
     *
     * Only available for the authenticated athlete.
     *
     * @link    https://strava.github.io/api/v3/athlete/#stats
     * @param int $id
     * @return  array
     * @throws  ClientException
     */
    public function getAthleteStats($id)
    {
        try {
            return $this->service->getAthleteStats($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve athlete routes
     *
     * @link    https://strava.github.io/api/v3/routes/#list
     * @param int $id
     * @return  array
     * @throws  ClientException
     */
    public function getAthleteRoutes($id, $type = null, $after = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteRoutes($id, $type, $after, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List athlete clubs
     *
     * @link    https://strava.github.io/api/v3/clubs/#get-athletes
     * @return  array
     * @throws  Exception
     */
    public function getAthleteClubs()
    {
        try {
            return $this->service->getAthleteClubs();
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List athlete activities
     *
     * @link    https://strava.github.io/api/v3/activities/#get-activities
     * @param string $before
     * @param string $after
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getAthleteActivities($before = null, $after = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteActivities($before, $after, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List athlete friends
     *
     * @link    https://strava.github.io/api/v3/follow/#friends
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getAthleteFriends($id = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteFriends($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List athlete followers
     *
     * @link    https://strava.github.io/api/v3/follow/#followers
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getAthleteFollowers($id = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteFollowers($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List both following
     *
     * @link    https://strava.github.io/api/v3/follow/#both
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getAthleteBothFollowing($id, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteBothFollowing($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List athlete K/QOMs/CRs
     *
     * @link    https://strava.github.io/api/v3/athlete/#koms
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getAthleteKom($id, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteKom($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List athlete zones
     *
     * @link    https://strava.github.io/api/v3/athlete/#zones
     * @return  array
     * @throws  Exception
     */
    public function getAthleteZones()
    {
        try {
            return $this->service->getAthleteZones();
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }


    /**
     * List starred segment
     *
     * @link    https://strava.github.io/api/v3/segments/#starred
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getAthleteStarredSegments($id = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getAthleteStarredSegments($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Update current athlete
     *
     * @link    https://strava.github.io/api/v3/athlete/#update
     * @param string $city
     * @param string $state
     * @param string $country
     * @param string $sex
     * @param float $weight
     * @return  array
     * @throws  Exception
     */
    public function updateAthlete($city, $state, $country, $sex, $weight)
    {
        try {
            return $this->service->updateAthlete($city, $state, $country, $sex, $weight);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve an activity
     *
     * @link    https://strava.github.io/api/v3/athlete/#get-details,
     *          https://strava.github.io/api/v3/athlete/#get-another-details
     * @param int $id
     * @param boolean $include_all_efforts
     * @return  array
     * @throws  Exception
     */
    public function getActivity($id, $include_all_efforts = null)
    {
        try {
            return $this->service->getActivity($id, $include_all_efforts);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List activity comments
     *
     * @link    https://strava.github.io/api/v3/comments/#list
     * @param int $id
     * @param boolean $markdown
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getActivityComments($id, $markdown = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getActivityComments($id, $markdown, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List activity kudoers
     *
     * @link    https://strava.github.io/api/v3/kudos/#list
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getActivityKudos($id, $page = null, $per_page = null)
    {
        try {
            return $this->service->getActivityKudos($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List activity photos
     *
     * @link    https://strava.github.io/api/v3/photos/#list
     * @param int $id
     * @param int $size In pixels.
     * @param string $photo_sources Must be "true".
     * @return  array
     * @throws  Exception
     */
    public function getActivityPhotos($id, $size = 2048, $photo_sources = 'true')
    {
        try {
            return $this->service->getActivityPhotos($id, $size, $photo_sources);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List activity zones
     *
     * @link    https://strava.github.io/api/v3/activities/#zones
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getActivityZones($id)
    {
        try {
            return $this->service->getActivityZones($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List activity laps
     *
     * @link    https://strava.github.io/api/v3/activities/#laps
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getActivityLaps($id)
    {
        try {
            return $this->service->getActivityLaps($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Check upload status
     *
     * @link    https://strava.github.io/api/v3/uploads/#get-status
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getActivityUploadStatus($id)
    {
        try {
            return $this->service->getActivityUploadStatus($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Create an activity
     *
     * @link    https://strava.github.io/api/v3/activities/#create
     * @param string $name
     * @param string $type
     * @param string $start_date_local
     * @param int $elapsed_time
     * @param string $description
     * @param float $distance
     * @param int $private
     * @param int $trainer
     * @return  array
     * @throws  Exception
     */
    public function createActivity($name, $type, $start_date_local, $elapsed_time, $description = null, $distance = null, $private = null, $trainer = null)
    {
        try {
            return $this->service->createActivity($name, $type, $start_date_local, $elapsed_time, $description, $distance, $private, $trainer);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Upload an activity
     *
     * @link    https://strava.github.io/api/v3/uploads/#post-file
     * @param mixed $file
     * @param string $activity_type
     * @param string $name
     * @param string $description
     * @param int $private
     * @param int $trainer
     * @param int $commute
     * @param string $data_type
     * @param string $external_id
     * @return  array
     * @throws  Exception
     */
    public function uploadActivity($file, $activity_type = null, $name = null, $description = null, $private = null, $trainer = null, $commute = null, $data_type = null, $external_id = null)
    {
        try {
            return $this->service->uploadActivity($file, $activity_type, $name, $description, $private, $trainer, $commute, $data_type, $external_id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Update an activity
     *
     * @link    https://strava.github.io/api/v3/activities/#put-updates
     * @param int $id
     * @param string $name
     * @param string $type
     * @param boolean $private
     * @param boolean $commute
     * @param boolean $trainer
     * @param string $gear_id
     * @param string $description
     * @return  array
     * @throws  Exception
     */
    public function updateActivity($id, $name = null, $type = null, $private = false, $commute = false, $trainer = false, $gear_id = null, $description = null)
    {
        try {
            return $this->service->updateActivity($id, $name, $type, $private, $commute, $trainer, $gear_id, $description);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Delete an activity
     *
     * @link    https://strava.github.io/api/v3/activities/#delete
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function deleteActivity($id)
    {
        try {
            return $this->service->deleteActivity($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve gear
     *
     * @link    https://strava.github.io/api/v3/gear/
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getGear($id)
    {
        try {
            return $this->service->getGear($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve a club
     *
     * @link    https://strava.github.io/api/v3/clubs/#get-details
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getClub($id)
    {
        try {
            return $this->service->getClub($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List club members
     *
     * @link    https://strava.github.io/api/v3/clubs/#get-members
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getClubMembers($id, $page = null, $per_page = null)
    {
        try {
            return $this->service->getClubMembers($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List club activities
     *
     * @link    https://strava.github.io/api/v3/clubs/#get-activities
     * @param int $id
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getClubActivities($id, $page = null, $per_page = null)
    {
        try {
            return $this->service->getClubActivities($id, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List club announcements
     *
     * @link    https://strava.github.io/api/v3/clubs/#get-announcements
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getClubAnnouncements($id)
    {
        try {
            return $this->service->getClubAnnouncements($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List club group events
     *
     * @link    https://strava.github.io/api/v3/clubs/#get-group-events
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getClubGroupEvents($id)
    {
        try {
            return $this->service->getClubGroupEvents($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Join a club
     *
     * @link    https://strava.github.io/api/v3/clubs/#join
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function joinClub($id)
    {
        try {
            return $this->service->joinClub($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Leave a club
     *
     * @link    https://strava.github.io/api/v3/clubs/#leave
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function leaveClub($id)
    {
        try {
            return $this->service->leaveClub($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Get route details
     *
     * @link    https://strava.github.io/api/v3/routes/#list
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getRoute($id)
    {
        try {
            return $this->service->getRoute($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve a segment
     *
     * @link    https://strava.github.io/api/v3/segments/#retrieve
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getSegment($id)
    {
        try {
            return $this->service->getSegment($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Segment leaderboards
     *
     * @link    https://strava.github.io/api/v3/segments/#leaderboard
     * @param int $id
     * @param string $gender
     * @param string $age_group
     * @param string $weight_class
     * @param boolean $following
     * @param int $club_id
     * @param string $date_range
     * @param int $context_entries
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getSegmentLeaderboard($id, $gender = null, $age_group = null, $weight_class = null, $following = null, $club_id = null, $date_range = null, $context_entries = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getSegmentLeaderboard($id, $gender, $age_group, $weight_class, $following, $club_id, $date_range, $context_entries, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Segment explorer
     *
     * @link    https://strava.github.io/api/v3/segments/#explore
     * @param string $bounds
     * @param string $activity_type
     * @param int $min_cat
     * @param int $max_cat
     * @return  array
     * @throws  Exception
     */
    public function getSegmentExplorer($bounds, $activity_type = 'riding', $min_cat = null, $max_cat = null)
    {
        try {
            return $this->service->getSegmentExplorer($bounds, $activity_type, $min_cat, $max_cat);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * List efforts filtered by athlete and/or a date range
     *
     * @link    https://strava.github.io/api/v3/segments/#efforts
     * @param int $id
     * @param int $athlete_id
     * @param string $start_date_local
     * @param string $end_date_local
     * @param int $page
     * @param int $per_page
     * @return  array
     * @throws  Exception
     */
    public function getSegmentEffort($id, $athlete_id = null, $start_date_local = null, $end_date_local = null, $page = null, $per_page = null)
    {
        try {
            return $this->service->getSegmentEffort($id, $athlete_id, $start_date_local, $end_date_local, $page, $per_page);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve activity streams
     *
     * @link    https://strava.github.io/api/v3/streams/#activity
     * @param int $id
     * @param string $types
     * @param string $resolution
     * @param string $series_type
     * @return  array
     * @throws  Exception
     */
    public function getStreamsActivity($id, $types, $resolution = null, $series_type = 'distance')
    {
        try {
            return $this->service->getStreamsActivity($id, $types, $resolution, $series_type);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve effort streams
     *
     * @link    https://strava.github.io/api/v3/streams/#effort
     * @param int $id
     * @param string $types
     * @param string $resolution
     * @param string $series_type
     * @return  array
     * @throws  Exception
     */
    public function getStreamsEffort($id, $types, $resolution = null, $series_type = 'distance')
    {
        try {
            return $this->service->getStreamsEffort($id, $types, $resolution, $series_type);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve segment streams
     * @link    https://strava.github.io/api/v3/streams/#segment
     * @param int $id
     * @param string $types
     * @param string $resolution
     * @param string $series_type
     * @return  array
     * @throws  Exception
     */
    public function getStreamsSegment($id, $types, $resolution = null, $series_type = 'distance')
    {
        try {
            return $this->service->getStreamsSegment($id, $types, $resolution, $series_type);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }

    /**
     * Retrieve route streams
     *
     * @link    https://strava.github.io/api/v3/streams/#routes
     * @param int $id
     * @return  array
     * @throws  Exception
     */
    public function getStreamsRoute($id)
    {
        try {
            return $this->service->getStreamsRoute($id);
        } catch (ServiceException $e) {
            throw new ClientException('[SERVICE] ' . $e->getMessage());
        }
    }
}