dropy

README

Dropy

High level Dropbox v2 client for Go built on top of go-dropbox.

Example

token := os.Getenv("DROPBOX_ACCESS_TOKEN")
client := dropy.New(dropbox.New(dropbox.NewConfig(token)))

client.Upload("/demo.txt", strings.NewReader("Hello World"))
io.Copy(os.Stdout, client.Open("/demo.txt"))

Testing

To manually run tests use the test account access token:

$ export DROPBOX_ACCESS_TOKEN=oENFkq_oIVAAAAAAAAAABqI2Nor2e9_ORA3oAZDQexMgJocCQX4aOFXZuDc1t-Sx
$ go test -v

License

MIT

Documentation

Overview

Package dropy implements a higher-level Dropbox API on top of go-dropbox.

Example

Upload and read a file.

token := env.MustGet("DROPBOX_ACCESS_TOKEN")
client := dropy.New(dropbox.New(dropbox.NewConfig(token)))

client.Upload("/demo.txt", strings.NewReader("Hello World"))
io.Copy(os.Stdout, client.Open("/demo.txt"))

Output:

Hello World

Index

• type Client
  • func New(d *dropbox.Client) *Client
  • func (c *Client) Copy(src, dst string) error
  • func (c *Client) Delete(name string) error
  • func (c *Client) Download(name string) (io.ReadCloser, error)
  • func (c *Client) List(name string) ([]os.FileInfo, error)
  • func (c *Client) ListFiles(name string) ([]os.FileInfo, error)
  • func (c *Client) ListFilter(name string, filter func(info os.FileInfo) bool) (ret []os.FileInfo, err error)
  • func (c *Client) ListFolders(name string) ([]os.FileInfo, error)
  • func (c *Client) ListN(name string, n int) (list []os.FileInfo, err error)
  • func (c *Client) Mkdir(name string) error
  • func (c *Client) Move(src, dst string) error
  • func (c *Client) Open(name string) *File
  • func (c *Client) Preview(name string) (io.ReadCloser, error)
  • func (c *Client) Read(name string) ([]byte, error)
  • func (c *Client) Search(path, query string) (list []os.FileInfo, err error)
  • func (c *Client) Stat(name string) (os.FileInfo, error)
  • func (c *Client) Upload(path string, r io.Reader) error
• type File
  • func (f *File) Close() error
  • func (f *File) Read(b []byte) (int, error)
  • func (f *File) Write(b []byte) (int, error)
• type FileInfo
  • func (f *FileInfo) IsDir() bool
  • func (f *FileInfo) ModTime() time.Time
  • func (f *FileInfo) Mode() os.FileMode
  • func (f *FileInfo) Name() string
  • func (f *FileInfo) Size() int64
  • func (f *FileInfo) Sys() interface{}

Examples

• Package

Types

type Client

type Client struct {
	*dropbox.Client
}

Client wraps dropbox.Client to provide higher level sugar.

func New

func New(d *dropbox.Client) *Client

New client.

func (*Client) Copy

func (c *Client) Copy(src, dst string) error

Copy file from `src` to `dst`.

func (*Client) Delete

func (c *Client) Delete(name string) error

Delete file `name`.

func (*Client) Download

func (c *Client) Download(name string) (io.ReadCloser, error)

Download returns the contents of `name`.

func (*Client) List

func (c *Client) List(name string) ([]os.FileInfo, error)

List returns all entries in dir `name`.

func (*Client) ListFiles

func (c *Client) ListFiles(name string) ([]os.FileInfo, error)

ListFiles returns all files in dir `name`.

func (*Client) ListFilter

func (c *Client) ListFilter(name string, filter func(info os.FileInfo) bool) (ret []os.FileInfo, err error)

ListFilter returns all entries in dir `name` filtered by `filter`.

func (*Client) ListFolders

func (c *Client) ListFolders(name string) ([]os.FileInfo, error)

ListFolders returns all folders in dir `name`.

func (*Client) ListN

func (c *Client) ListN(name string, n int) (list []os.FileInfo, err error)

ListN returns entries in dir `name`. Up to `n` entries, or all when `n` <= 0.

func (*Client) Mkdir

func (c *Client) Mkdir(name string) error

Mkdir creates folder `name`.

func (*Client) Move

func (c *Client) Move(src, dst string) error

Move file from `src` to `dst`.

func (*Client) Open

func (c *Client) Open(name string) *File

Open returns a File for reading and writing.

func (*Client) Preview

func (c *Client) Preview(name string) (io.ReadCloser, error)

Preview returns the PDF preview of `name`.

func (*Client) Read

func (c *Client) Read(name string) ([]byte, error)

Read returns the contents of `name`.

func (*Client) Search

func (c *Client) Search(path, query string) (list []os.FileInfo, err error)

Search return results for a search against `path` with the given `query`.

func (*Client) Stat

func (c *Client) Stat(name string) (os.FileInfo, error)

Stat returns file and directory meta-data for `name`.

func (*Client) Upload

func (c *Client) Upload(path string, r io.Reader) error

Upload reader to path.

type File

type File struct {
	Name string
	// contains filtered or unexported fields
}

File implements an io.ReadWriteCloser for Dropbox files.

func (*File) Close

func (f *File) Close() error

Close implements io.Closer.

func (*File) Read

func (f *File) Read(b []byte) (int, error)

Read implements io.Reader

func (*File) Write

func (f *File) Write(b []byte) (int, error)

Write implements io.Writer.

type FileInfo

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

FileInfo wraps Dropbox file MetaData to implement os.FileInfo.

func (*FileInfo) IsDir

func (f *FileInfo) IsDir() bool

IsDir returns true if the file is a directory.

func (*FileInfo) ModTime

func (f *FileInfo) ModTime() time.Time

ModTime returns the modification time.

func (*FileInfo) Mode

func (f *FileInfo) Mode() os.FileMode

Mode returns the file mode flags.

func (*FileInfo) Name

func (f *FileInfo) Name() string

Name of the file.

func (*FileInfo) Size

func (f *FileInfo) Size() int64

Size of the file.

func (*FileInfo) Sys

func (f *FileInfo) Sys() interface{}

Sys is not implemented.