rapgenius

README

RapGenius client for Golang

This is a RapGenius client for Golang which can be used to retrieve artists, retrieve songs, and search using the "public" API.

Install

go get github.com/mondok/rapgenius

Searching

rapgenius := rapgenius.New()
results, err := rapgenius.Search("notorious")
fmt.Printf("%s, %s", results[0].Title, results[0].Artist.Name)

Retrieving Artists

rapgenius := rapgenius.New()
artist, err := rapgenius.Artist(22)
fmt.Printf("Artist is %s", artist.Name)

Retrieving Songs

rapgenius := rapgenius.New()
song, err := rapgenius.Song(22)
fmt.Printf("Song is %s", song.Title)

Documentation

Index

• type Artist
• type RapGenius
  • func New() *RapGenius
  • func (h *RapGenius) Artist(id int) (result *Artist, err error)
  • func (h *RapGenius) Search(query string) (result []*SearchItem, err error)
  • func (h *RapGenius) Song(id int) (result *Song, err error)
• type SearchItem
• type Song

Types

type Artist

type Artist struct {
	ID    int    `json:"id"`
	Image string `json:"image_url"`
	Name  string `json:"name"`
	URL   string `json:"url"`
}

Artist is a musician

type RapGenius

type RapGenius struct {
	BaseURL string
	Client  *http.Client
}

RapGenius is a new instance of RapGenius HTTP client

func New

func New() *RapGenius

New creates new instance of RapGenius

func (*RapGenius) Artist

func (h *RapGenius) Artist(id int) (result *Artist, err error)

Artist retrieves artist by ID

func (*RapGenius) Search

func (h *RapGenius) Search(query string) (result []*SearchItem, err error)

Search searches RapGenius for the specified query

func (*RapGenius) Song

func (h *RapGenius) Song(id int) (result *Song, err error)

Song retrieves song by ID

type SearchItem

type SearchItem struct {
	AnnotationCount int     `json:"annotation_count"`
	ID              int     `json:"id"`
	Title           string  `json:"title"`
	Artist          *Artist `json:"primary_artist"`
}

SearchItem is a single search item from API

type Song

type Song struct {
	AnnotationCount float64 `json:"annotation_count"`
	APIPath         string  `json:"api_path"`
	BopURL          string  `json:"bop_url"`

	DescriptionAnnotation struct {
		Annotatable struct {
			ID    float64 `json:"id"`
			Title string  `json:"title"`
			Type  string  `json:"type"`
			URL   string  `json:"url"`
		} `json:"annotatable"`
		Annotations []struct {
			Authors []struct {
				Attribution float64 `json:"attribution"`
				User        struct {
					Avatar struct {
						Thumb struct {
							BoundingBox struct {
								Height float64 `json:"height"`
								Width  float64 `json:"width"`
							} `json:"bounding_box"`
							URL string `json:"url"`
						} `json:"thumb"`
						Tiny struct {
							BoundingBox struct {
								Height float64 `json:"height"`
								Width  float64 `json:"width"`
							} `json:"bounding_box"`
							URL string `json:"url"`
						} `json:"tiny"`
					} `json:"avatar"`
					ID             float64     `json:"id"`
					Iq             float64     `json:"iq"`
					Name           string      `json:"name"`
					RoleForDisplay interface{} `json:"role_for_display"`
				} `json:"user"`
			} `json:"authors"`
			Body struct {
				Dom struct {
					Children []interface{} `json:"children"`
					Tag      string        `json:"tag"`
				} `json:"dom"`
			} `json:"body"`
			CosignedBy          []interface{} `json:"cosigned_by"`
			CurrentUserMetadata struct {
				Interactions struct {
					Cosign bool        `json:"cosign"`
					Vote   interface{} `json:"vote"`
				} `json:"interactions"`
				Permissions []interface{} `json:"permissions"`
			} `json:"current_user_metadata"`
			ID         float64     `json:"id"`
			Pinned     bool        `json:"pinned"`
			ShareURL   string      `json:"share_url"`
			State      string      `json:"state"`
			URL        string      `json:"url"`
			VerifiedBy interface{} `json:"verified_by"`
			VotesTotal float64     `json:"votes_total"`
		} `json:"annotations"`
		APIPath        string      `json:"api_path"`
		Classification string      `json:"classification"`
		EmbedURL       string      `json:"embed_url"`
		Featured       bool        `json:"featured"`
		Fragment       string      `json:"fragment"`
		ID             float64     `json:"id"`
		Path           string      `json:"path"`
		Range          interface{} `json:"range"`
		SongID         float64     `json:"song_id"`
		TrackingPaths  struct {
			Aggregate  string `json:"aggregate"`
			Concurrent string `json:"concurrent"`
		} `json:"tracking_paths"`
		TwitterShareMessage string `json:"twitter_share_message"`
		URL                 string `json:"url"`
	} `json:"description_annotation"`
	FeaturedArtists []interface{} `json:"featured_artists"`
	ID              float64       `json:"id"`
	Lyrics          struct {
		Dom struct {
			Children []struct {
				Children []interface{} `json:"children"`
				Tag      string        `json:"tag"`
			} `json:"children"`
			Tag string `json:"tag"`
		} `json:"dom"`
	} `json:"lyrics"`
	LyricsUpdatedAt float64 `json:"lyrics_updated_at"`
	Media           []struct {
		Provider string `json:"provider"`
		Type     string `json:"type"`
		URL      string `json:"url"`
	} `json:"media"`
	PrimaryArtist struct {
		ID       float64 `json:"id"`
		ImageURL string  `json:"image_url"`
		Name     string  `json:"name"`
		URL      string  `json:"url"`
	} `json:"primary_artist"`
	ProducerArtists []struct {
		ID       float64 `json:"id"`
		ImageURL string  `json:"image_url"`
		Name     string  `json:"name"`
		URL      string  `json:"url"`
	} `json:"producer_artists"`
	Stats struct {
		Hot       bool    `json:"hot"`
		Pageviews float64 `json:"pageviews"`
	} `json:"stats"`
	Title         string `json:"title"`
	TrackingPaths struct {
		Aggregate  string `json:"aggregate"`
		Concurrent string `json:"concurrent"`
	} `json:"tracking_paths"`
	URL                   string        `json:"url"`
	VerifiedAnnotationsBy []interface{} `json:"verified_annotations_by"`
}

Song is a song result