gist

Documentation

Index

• type Cache
  • func NewCache(path string) *Cache
  • func (c *Cache) Delete() error
  • func (c *Cache) Open() error
  • func (c *Cache) Save(pages []Page) error
• type Client
  • func NewClient(token string) Client
  • func (c Client) List(user string) ([]Page, error)
• type File
  • func (f File) HasUpdated() (bool, error)
  • func (f File) Update() error
• type Gist
  • func (g *Gist) Checkout() error
  • func (g Gist) Create(page Page) (string, error)
  • func (g Gist) Delete(page Page) error
  • func (g Gist) Files() []File
• type Page

Types

type Cache

type Cache struct {
	Token string `json:"token"`
	Pages []Page `json:"pages"`
	Path  string `json:"-"`
}

func NewCache

func NewCache(path string) *Cache

func (*Cache) Delete

func (c *Cache) Delete() error

func (*Cache) Open

func (c *Cache) Open() error

func (*Cache) Save

func (c *Cache) Save(pages []Page) error

type Client

type Client struct {
	*github.Client
}

func NewClient

func NewClient(token string) Client

func (Client) List

func (c Client) List(user string) ([]Page, error)

List lists gist pages

type File

type File struct {
	Name     string `json:"name"`
	Content  string `json:"content"`
	FullPath string `json:"fullpath"`

	Page `json:"-"`
}

File represents a single file hosted on gist

func (File) HasUpdated

func (f File) HasUpdated() (bool, error)

func (File) Update

func (f File) Update() error

type Gist

type Gist struct {
	User   string
	Token  string
	Editor string

	Client Client

	WorkDir string
	Pages   []Page
}

func (*Gist) Checkout

func (g *Gist) Checkout() error

func (Gist) Create

func (g Gist) Create(page Page) (string, error)

func (Gist) Delete

func (g Gist) Delete(page Page) error

func (Gist) Files

func (g Gist) Files() []File

type Page

type Page struct {
	ID          string    `json:"id"`
	Description string    `json:"description"`
	User        string    `json:"user"`
	URL         string    `json:"url"`
	Public      bool      `json:"public"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`
	Files       []File    `json:"files"`

	Repo *git.Repo `json:"-"`
}

Page represents gist page itself