command

Documentation

Index

• Constants
• Variables
• func Build(c *cli.Context, cmdBuilder runner.Builder, items []*VideoData, ...) error
• func CmdChannel(cmdBuilder runner.Builder) func(c *cli.Context) error
• func CmdPlaylist(cmdBuilder runner.Builder) func(c *cli.Context) error
• func Completion(c *cli.Context)
• func ContainsString(needle string, haystack []string) bool
• func RootCompletion(c *cli.Context)
• type ChannelInfo
• type ChannelScraper
  • func NewChannelScraper(apiKey string) *ChannelScraper
  • func (scraper ChannelScraper) GetVideosForChannel(channelName, after string) ([]*VideoData, *ChannelInfo, error)
• type DirectoryCleaner
  • func NewDirectoryCleaner(outputFolder string) *DirectoryCleaner
  • func (cleaner DirectoryCleaner) CleanupUnrelatedFiles(relatedFiles []string, writer io.Writer) error
• type Downloader
  • func NewDownloader(cmdBuilder runner.Builder, outputFolder string, quality string) *Downloader
  • func (downloader Downloader) DownloadVideos(items []*VideoData) error
• type PlaylistScraper
  • func NewPlaylistScraper(apiKey string) *PlaylistScraper
  • func (scraper PlaylistScraper) GetVideosForPlaylist(playlistID string) ([]*VideoData, *ChannelInfo, error)
• type VideoData
• type XMLBuilder
  • func NewXMLBuilder(cmdBuilder runner.Builder, ...) *XMLBuilder
  • func (xmlBuilder XMLBuilder) BuildRss(items []*VideoData) error

Constants

const Name string = "feedTube"

Name is the name of this program

const Version string = "0.3.1"

Version is the current version

Variables

var Commands = []cli.Command{
	{
		Name:         "channel",
		Aliases:      []string{"c"},
		Usage:        "Builds your rss file from a youtube channel",
		Action:       CmdChannel(runner.Real{}),
		BashComplete: Completion,
		Flags: append(
			flags,
			cli.StringFlag{
				Name:  "after, a",
				Usage: "Only process videos after a given date",
			},
		),
	},
	{
		Name:         "playlist",
		Aliases:      []string{"p"},
		Usage:        "Builds your rss file from a youtube playlist",
		Action:       CmdPlaylist(runner.Real{}),
		BashComplete: Completion,
		Flags:        flags,
	},
}

Commands defines the commands that can be called on hostBuilder

var YoutubeAPIURLBase = "https://www.googleapis.com/youtube/v3/"

YoutubeAPIURLBase is the base url to use for the youtube API. This should only be changed for tests.

Functions

func Build

func Build(c *cli.Context, cmdBuilder runner.Builder, items []*VideoData, info *ChannelInfo) error

Build downloads the videos and builds the feed XML

func CmdChannel

func CmdChannel(cmdBuilder runner.Builder) func(c *cli.Context) error

CmdChannel builds an rss feed from a youtube channel

func CmdPlaylist

func CmdPlaylist(cmdBuilder runner.Builder) func(c *cli.Context) error

CmdPlaylist builds an rss feed from a youtube playlist

func Completion

func Completion(c *cli.Context)

Completion handles bash completion for the commands

func ContainsString

func ContainsString(needle string, haystack []string) bool

ContainsString searches a string slice to see if it contains a given string

func RootCompletion

func RootCompletion(c *cli.Context)

RootCompletion prints the list of root commands as the root completion method This is similar to the default method, but it excludes aliases

Types

type ChannelInfo

type ChannelInfo struct {
	Title       string
	Description string
	Link        string
	Thumbnail   string
}

ChannelInfo contains the metadata for a channel

type ChannelScraper

type ChannelScraper struct {
	// contains filtered or unexported fields
}

ChannelScraper retrieves data about youtube videos

func NewChannelScraper

func NewChannelScraper(apiKey string) *ChannelScraper

NewChannelScraper returns a YoutubeScraper

func (ChannelScraper) GetVideosForChannel

func (scraper ChannelScraper) GetVideosForChannel(channelName, after string) ([]*VideoData, *ChannelInfo, error)

GetVideosForChannel returns an array of all the youtube video ids on a channel

type DirectoryCleaner

type DirectoryCleaner struct {
	// contains filtered or unexported fields
}

DirectoryCleaner cleans up unrelated files

func NewDirectoryCleaner

func NewDirectoryCleaner(outputFolder string) *DirectoryCleaner

NewDirectoryCleaner returns a new directoryCleaner

func (DirectoryCleaner) CleanupUnrelatedFiles

func (cleaner DirectoryCleaner) CleanupUnrelatedFiles(relatedFiles []string, writer io.Writer) error

CleanupUnrelatedFiles searches the outputFolder for files that are not in relatedFiles and deletes them

type Downloader

type Downloader struct {
	// contains filtered or unexported fields
}

Downloader downloads youtube videos

func NewDownloader

func NewDownloader(cmdBuilder runner.Builder, outputFolder string, quality string) *Downloader

NewDownloader returns a new Downloader

func (Downloader) DownloadVideos

func (downloader Downloader) DownloadVideos(items []*VideoData) error

DownloadVideos downloads any items that are not already in outputfolder

type PlaylistScraper

type PlaylistScraper struct {
	// contains filtered or unexported fields
}

PlaylistScraper retrieves data about youtube videos

func NewPlaylistScraper

func NewPlaylistScraper(apiKey string) *PlaylistScraper

NewPlaylistScraper returns a YoutubeScraper

func (PlaylistScraper) GetVideosForPlaylist

func (scraper PlaylistScraper) GetVideosForPlaylist(playlistID string) ([]*VideoData, *ChannelInfo, error)

GetVideosForPlaylist returns an array of all the youtube video ids in a playlist

type VideoData

type VideoData struct {
	GUID        string
	Link        string
	Title       string
	Description string
	FileName    string
	Image       string
	PubDate     time.Time
}

VideoData holds all the data that we scrape from YouTube

type XMLBuilder

type XMLBuilder struct {
	// contains filtered or unexported fields
}

XMLBuilder handles building RSS XML

func NewXMLBuilder

func NewXMLBuilder(cmdBuilder runner.Builder, xmlFileName, outputFolder, baseURL, generator string, channelInfo *ChannelInfo) *XMLBuilder

NewXMLBuilder returns a new XMLBuilder

func (XMLBuilder) BuildRss

func (xmlBuilder XMLBuilder) BuildRss(items []*VideoData) error

BuildRss builds an RSS XML feed from an list of VideoData