yifysubs

README

YIFY Subtitles client

Example

package main

import (
    "io"
    "log"
    "os"

    "github.com/odwrtw/yifysubs"
)

func main() {
    // Create a client.
    client := yifysubs.NewDefault()

    imdbID := "tt3758542"

    // Search subtitles.
    subtitles, err := client.SearchByLang(imdbID, "English")
    if err != nil {
        log.Fatalf("Failed to get subtitles: %s", err)
        return
    }

    log.Printf("Found %d subtitles for movie with IMDB ID %s", len(subtitles), imdbID)

    // There will always be a first subtitles, if no subtitles where to be
    // found, the search function would return an error.
    firstSub := subtitles[0]

    path := "/tmp/" + imdbID + ".srt"
    file, err := os.Create(path)
    if err != nil {
        log.Fatalf("Failed to create file: %s", err)
        return
    }
    defer file.Close()

    if _, err := io.Copy(file, firstSub); err != nil {
        log.Fatalf("Failed to copy file: %s", err)
        return
    }

    log.Printf("Subtitle written to %s", path)
}

Documentation

Index

• Variables
• type Client
  • func New(endpoint string) *Client
  • func NewDefault() *Client
  • func (c *Client) Search(imdbID string) ([]*Subtitle, error)
  • func (c *Client) SearchByLang(imdbID, lang string) ([]*Subtitle, error)
• type Subtitle
  • func FilterByLang(subtitles []*Subtitle, language string) ([]*Subtitle, error)
  • func (s Subtitle) Close() error
  • func (s *Subtitle) Read(p []byte) (n int, err error)

Variables

var (
	ErrNoSubtitleFound = errors.New("yify: no subtitles found")
	ErrNoSubtitleData  = errors.New("yify: no subtitles data")
)

Custom errors

Types

type Client

type Client struct {
	Endpoint string
}

Client represent a Client used to make Search

func New

func New(endpoint string) *Client

New return a new client

func NewDefault

func NewDefault() *Client

NewDefault return a new client with a default endpoint

func (*Client) Search

func (c *Client) Search(imdbID string) ([]*Subtitle, error)

Search will search Subtitles

func (*Client) SearchByLang

func (c *Client) SearchByLang(imdbID, lang string) ([]*Subtitle, error)

SearchByLang searches Subtitles with given language

type Subtitle

type Subtitle struct {
	Lang string

	Releases []string
	// contains filtered or unexported fields
}

Subtitle represents a Subtitle

func FilterByLang

func FilterByLang(subtitles []*Subtitle, language string) ([]*Subtitle, error)

FilterByLang will filter the subtitles by language

func (Subtitle) Close

func (s Subtitle) Close() error

Close implement the closer interface

func (*Subtitle) Read

func (s *Subtitle) Read(p []byte) (n int, err error)

Read implement the reader interface