rrickgauer / api.mlb-data

Restful API for MLB data

my name's ryan and I hate programming...

api.mlb-data's Issues

create filter URL parser

/pitching?filter=HR:>:50,GS:=:100

Translates to

WHERE HR > 50 AND GS = 100

DB-Functions: use constants for default function paramters

Aggregate ERA is wrong

ERA = (9 * ER) / IP

Make an SQL Query builder class

• Separate out the logic that creates the sql statements and executes them in DB-Functions.php
• Use the values in the constants class to generate the select statements
• Remove unused columns from sql queries

---

• possibly make the class non-static
• pass in the variables for the initialization
  • then I don't have to use the same exact static function parameters for every function
  • I can just call the individual functions themselves

Add complete api url to query links in search

Create search module

• links to all the other submodules of the player
• debut game
• death date
• list of teams the player played for
• first name
• last name

Add option to sum records

Instead of returning the seasonal stats for each module, add the option to sum all stats

batting?aggregate=true

Update the submodule classes return data

Instead of calling each function, I can use the call_user_func().

See the People.setDataSetSize() for a reference.

add HOF status to people module

Add a column in people that shows whether or not they are in the hall of fame

Add people search module

• /search/people?q='jon'
• /search/players?q='jon'
• /search/managers?q='jon'
• /search/teams?q='Cubs'

Release timeline

• finish 1.0 requirements
• then create a demo page
  • any bugs that are found, make an issue for them
• wait till demo page is completed to begin work on 2.0
• once 1.0 is completed, assign all closed issues a label of 1.0
  • or link them to a release

create a sorting url parser

the sort parameter should be /module?sort=+HR,-GS,+R

Update default page display

Should include per page and pagination

Add option to sum all fields for a player

For pitching, batting, and appearances modules add option to sum all data using people/playerID/batting?total=true

Add pagination to search module

• perPage
• page

Return all results for /people

• If a user only loads /people, then return all rows using pagination.
• Input parameters (?) will be:
  • page
• To determine the required variables:
  • the constant per_page will be 1,000
  • total = count(DataSet)
  • numPages = floor(total / per_page)
• the response body will contain a pagination section that gives:
  • first - the first page in the dataset: /people?page=1
  • next - the next page in the dataset: /people?page=13
  • last - the last page in the dataset: /people?page=19

Consolidate all Module subclasses into one file

sub classes include:

• batting
• pitching

Update the default api page to show the endpoints/resources

like api.github.com

Return a single element, not an array with 1 element for aggregates

Fix the DB-Functions count statements

• Need to account for filters.
• Use the same sql query as its related one, without the limit and offset. Then do a fetch all and return the number of records.
• use the filters

Remove page and per page from module classes

I can just use the parser calls to get the data

move examples into different md file

Finish creating rest of the submodules

• Batting
• Pitching
• Appearances
• Fielding
• People
• FieldingOF
• FieldingOFSplit
• Salaries

DB-Functions: need to make count functions for aggregate functions

I am using the same function for aggregates and non aggregates. Because of this, the pagination is wrong for aggregate modules.

Code cleanup

• add comments to each function
• reindent all files
  • 2 spaces
  • no tabs

Add images module

• Make a new table in the database called images
• table columns should be:
  • ID
  • playerID
  • source
• add images module
• if playerID is specified, return only the image links for that player

Add all fields to each constant module field array

• Batting
• Pitching
• Appearances
• Fielding
• Images
• People
• FieldingOF
• FieldingOFSplit
• Salaries
• Search
• BattingPost
• PitchingPost
• FieldingPost
• Colleges
• BattingAggregate
• PitchingAggregate
• AppearancesAggregate
• FieldingAggregate
• FieldingOFAggregate
• FieldingOFSplitAggregate
• SalariesAggregate
• BattingPostAggregate
• PitchingPostAggregate
• FieldingPostAggregate

add /playerID submodule

Returns the module stats for only that player.

Filter, sort, and aggregate parameters still work the same here.

Example: /batting/playerID

set default display

Display the modules/endpoints for the default display api.mlb-data.php

Add post season modules

• battingpost
• fieldingpost
• pitchingpost

Add aggregates to each one

Create people modules

• people/playerID - biographical
• people/playerID/salaries - salary info
• people/playerID/batting - batting stats
• people/playerID/pitching - pitching stats
• people/playerID/appearances - appearances
• people/playerID/schools - schools attended

Make a demo/documentation web page

Update readme

Re-order the parameters for DB-Functions

1. playerID
2. sort
3. filter
4. limit
5. offset

Rename files

• all file names start with a capital letter
• functions.php renamed to DB-Functions.php
• api-functions.php renamed to API-Functions.php`

add documentation to the README

Add new MySQL user in db-info.php on the server

Create a new user that has only read/select statement privileges

Keep the main user for local testing

standardize all column names

For instance, sometimes it returns yearID, other times it returns year.

Also, for team names, return teamName

add pagination

• First page: ?page=1
• last page = ceil(count(dataSet) / perPage)
• next page = page + 1
  • if page = lastPage, then next page = null

Some modules are not sorting

• Batting
• Pitching
• Appearances
• Fielding
• People
• FieldingOF
• FieldingOFSplit
• Salaries
• Search

add more info to people module

• make baseball-reference id be an actual link to the site and not just an ID
  • Add links to constants

Do not return G_batting in aggregate batting

They are all null

Release 1.0 remaining requirements

These are the requirements I want to include before releasing the first version.

Add integrity constraints to the parser

Check if requested sort/filter parameters are included in the related module's constants array.

If not, return 400 header response

Make documentation

sort=HR:desc&filter=HR:>:47,SO:=:215

• sort=columnName:[asc,desc]
• filter=columnName:conditional:qualifier, columnName:conditional:qualifier

Code cleanup, add comment blocks

• Make a comment block for all functions and add to each class function
  • Use DocBlockr
  • Add function prototype types https://www.php.net/manual/en/functions.arguments.php
  • add function return types
• code clean up

Add colleges submodule to people

people/playerID should give a list of that player's colleges

Return list of teams a player has played for in people module

Add sorting

• people
• batting
• pitching
• fielding
• fieldingOF
• fieldingOFSplit
• salaries
• appearances

DB-Functions: use having instead of where

https://www.java67.com/2019/06/difference-between-where-and-having-in-sql.html