Skip to content

Commit

Permalink
Merge pull request #2 from rcompton78/refactorForVersionedApis
Browse files Browse the repository at this point in the history 
Refactored API to allow easier versioning
  • Loading branch information
@bradbarkhouse
bradbarkhouse committed Oct 27, 2017
2 parents 0ebd09e + a0e6d16 commit fbffa15
Show file tree
Hide file tree
Showing 5 changed files with 290 additions and 232 deletions.
218 changes: 2 additions & 216 deletions src/API_v1_0.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,12 @@

namespace MySportsFeeds;

class API_v1_0 {

private $auth;

private $baseUrl;
private $verbose;
private $storeType;
private $storeLocation;
private $validFeeds;
private $storeOutput;

class API_v1_0 extends BaseApi {
# Constructor
public function __construct($verbose, $storeType = null, $storeLocation = null) {

$this->auth = null;

$this->baseUrl = "https://www.mysportsfeeds.com/api/feed/pull";

$this->verbose = $verbose;
$this->storeType = $storeType;
$this->storeLocation = $storeLocation;

$this->validFeeds = [
'current_season',
'cumulative_player_stats',
Expand All @@ -42,205 +26,7 @@ public function __construct($verbose, $storeType = null, $storeLocation = null)
'latest_updates',
'daily_dfs'
];
}

# Verify a feed
private function __verifyFeedName($feed) {
$isValid = false;

foreach ( $this->validFeeds as $value ) {
if ( $value == $feed ) {
$isValid = true;
break;
}
}

return $isValid;
}

# Verify output format
private function __verifyFormat($format) {
$isValid = true;

if ( $format != "json" and $format != "xml" and $format != "csv" ) {
$isValid = false;
}

return $isValid;
}

# Feed URL (with only a league specified)
private function __leagueOnlyUrl($league, $feed, $outputFormat, ...$params) {
return $this->baseUrl . "/" . $league . "/" . $feed . "." . $outputFormat;
}

# Feed URL (with league + season specified)
private function __leagueAndSeasonUrl($league, $season, $feed, $outputFormat, ...$params) {
return $this->baseUrl . "/" . $league . "/" . $season . "/" . $feed . "." . $outputFormat;
}

# Generate the appropriate filename for a feed request
private function __makeOutputFilename($league, $season, $feed, $outputFormat, ...$params) {
$filename = $feed . "-" . $league . "-" . $season;

if ( array_key_exists("gameid", $params[0]) ) {
$filename .= "-" + $params[0]["gameid"];
}

if ( array_key_exists("fordate", $params[0]) ) {
$filename .= "-" + $params[0]["fordate"];
}

$filename .= "." . $outputFormat;

return $filename;
}

# Save a feed response based on the store_type
private function __saveFeed($response, $league, $season, $feed, $outputFormat, ...$params) {
# Save to memory regardless of selected method
if ( $outputFormat == "json" ) {
$this->storeOutput = (array) json_decode($response);
} elseif ( $outputFormat == "xml" ) {
$this->storeOutput = simplexml_load_string($response);
} elseif ( $outputFormat == "csv" ) {
$this->storeOutput = $response;
}

if ( $this->storeType == "file" ) {
if ( ! is_dir($this->storeLocation) ) {
mkdir($this->storeLocation, 0, true);
}

$filename = $this->__makeOutputFilename($league, $season, $feed, $outputFormat, $params);

file_put_contents($this->storeLocation . $filename, $response);
}
}

# Indicate this version does support BASIC auth
public function supportsBasicAuth() {
return true;
parent::__construct($verbose, $storeType, $storeLocation);
}

# Establish BASIC auth credentials
public function setAuthCredentials($username, $password) {
$this->auth = ['username' => $username, 'password' => $password];
}

# Request data (and store it if applicable)
public function getData($league = "", $season = "", $feed = "", $format = "", ...$kvParams) {
if ( !$this->auth ) {
throw new ErrorException("You must authenticate() before making requests.");
}

$params = [];

# iterate over args and assign vars
foreach ( $kvParams[0] as $kvPair ) {
$pieces = explode("=", $kvPair);

$key = trim($pieces[0]);
$value = trim($pieces[1]);

if ( $key == 'league' ) {
$league = $value;
} elseif ( $key == 'season' ) {
$season = $value;
} elseif ( $key == 'feed' ) {
$feed = $value;
} elseif ( $key == 'format' ) {
$format = $value;
} else {
$params[$key] = $value;
}
}

# add force=false parameter (helps prevent unnecessary bandwidth use)
if ( ! array_key_exists("force", $params) ) {
$params['force'] = 'false';
}

if ( !$this->__verifyFeedName($feed) ) {
throw new ErrorException("Unknown feed '" + $feed + "'.");
}

if ( !$this->__verifyFormat($format) ) {
throw new ErrorException("Unsupported format '" + $format + "'.");
}

if ( $feed == 'current_season' ) {
$url = $this->__leagueOnlyUrl($league, $feed, $format, $params);
} else {
$url = $this->__leagueAndSeasonUrl($league, $season, $feed, $format, $params);
}

$delim = "?";
if ( strpos($url, '?') !== false ) {
$delim = "&";
}

foreach ( $params as $key => $value ) {
$url .= $delim . $key . "=" . $value;
$delim = "&";
}

if ( $this->verbose ) {
print("Making API request to '" . $url . "' ... \n");
}

// Establish a curl handle for the request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_ENCODING, "gzip"); // Enable compression
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // If you have issues with SSL verification
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Basic " . base64_encode($this->auth['username'] . ":" . $this->auth['password'])
]); // Authenticate using HTTP Basic with account credentials

// Send the request & retrieve response
$resp = curl_exec($ch);

// Uncomment the following if you're having trouble:
// print(curl_error($ch));

// Get the response code and then close the curl handle
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$data = "";

if ( $httpCode == 200 ) {
if ( $this->storeType != null ) {
$this->__saveFeed($resp, $league, $season, $feed, $format, $params);
}

$data = $this->storeOutput;
} elseif ( $httpCode == 304 ) {
if ( $this->verbose ) {
print("Data hasn't changed since last call.\n");
}

$filename = $this->__makeOutputFilename($league, $season, $feed, $format, $params);

$data = file_get_contents($this->storeLocation . $filename);

if ( $format == "json" ) {
$this->storeOutput = (array) json_decode($data);
} elseif ( $format == "xml" ) {
$this->storeOutput = simplexml_load_string($data);
} elseif ( $format == "csv" ) {
$this->storeOutput = $data;
}

$data = $this->storeOutput;
} else {
throw new ErrorException("API call failed with response code: " . $httpCode);
}

return $data;
}

}
37 changes: 37 additions & 0 deletions src/API_v1_1.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace MySportsFeeds;

class API_v1_1 extends BaseApi
{
# Constructor
public function __construct($verbose, $storeType = null, $storeLocation = null) {

$this->baseUrl = "https://api.mysportsfeeds.com/v1.1/pull";

/**
* I am not sure if these changed for v1.1
*/
$this->validFeeds = [
'current_season',
'cumulative_player_stats',
'full_game_schedule',
'daily_game_schedule',
'daily_player_stats',
'game_playbyplay',
'game_boxscore',
'scoreboard',
'player_gamelogs',
'team_gamelogs',
'roster_players',
'game_startinglineup',
'active_players',
'player_injuries',
'latest_updates',
'daily_dfs'
];

parent::__construct($verbose, $storeType, $storeLocation);
}

}
23 changes: 23 additions & 0 deletions src/ApiFactory.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

namespace MySportsFeeds;

class ApiFactory
{
public static function create($version, $verbose, $storeType, $storeLocation)
{
$apiVersion = null;
switch($version) {
case '1.0':
$apiVersion = new API_v1_0($verbose, $storeType, $storeLocation);
break;
case '1.1':
$apiVersion = new API_v1_1($verbose, $storeType, $storeLocation);
break;
default:
throw new \ErrorException("Unrecognized version specified. Supported versions are: '1.0, 1.1'");
}

return $apiVersion;
}
}
Loading

0 comments on commit fbffa15

Please sign in to comment.