History

Christine Dodrill 045f69d53a Update Go API client		2015-08-17 14:36:24 -07:00
..
README.md	Add go documentation	2015-08-12 19:07:29 -07:00
doc.go	Add Go client	2015-08-12 18:07:20 -07:00
episode.go	Add Go client	2015-08-12 18:07:20 -07:00
get.go	Update Go API client	2015-08-17 14:36:24 -07:00
get_test.go	Update Go API client	2015-08-17 14:36:24 -07:00
test.sh	Tests: be less verbose	2015-08-13 21:18:36 -07:00

README.md

ponyapi

import "github.com/Xe/PonyAPI/client/go"

Package ponyapi provides glue for applications written in Go that want to use PonyAPI for getting information.

Usage

type Episode

type Episode struct {
	AirDate int    `json:"air_date"`
	Episode int    `json:"episode"`
	IsMovie bool   `json:"is_movie"`
	Name    string `json:"name"`
	Season  int    `json:"season"`
}

Episode is an episode of My Little Pony: Friendship is Magic.

func GetEpisode

func GetEpisode(season, episode int) (*Episode, error)

GetEpisode gets information about season x episode y or an error.

func Newest

func Newest() (*Episode, error)

Newest returns information on the newest episode or an error.

func Random

func Random() (*Episode, error)

Random returns information on a random episode.

func AllEpisodes

func AllEpisodes() ([]*Episode, error)

AllEpisodes gets all information on all episodes or returns an error.

func GetSeason

func GetSeason(season int) ([]*Episode, error)

GetSeason returns all information on season x or returns an error.

func Search

func Search(query string) ([]*Episode, error)

Search takes the give search terms and uses that to search the list of episodes.