proposal: public API and CLI

[changkun]

Thanks for writing this package. I just wrote a quick demo for trying this out, and here are some of my thoughts and proposals, and open for discussion especially the customization possibilities of the TGStore struct.

APIs

I think for most of the user only need this set of APIs:

package tgstore

// DefaultEndpoint is the default tgstore endpoint.
const DefaultEndpoint = "https://api.telegram.org"

// Storage is a storage with unlimited space.
type Storage interface {
	// Upload consumes the given reader and returns an associated ID that
	// represents the corresponding content.
	Upload(context.Context, io.Reader) (string, error)
	// Download returns a reader of the content associated with the given ID.
	Download(context.Context, string) (io.Reader, error)
}

// New returns a Storage.
func New(token, chatid, endpoint, passphrase string) (Storage, error) { ... }

A minimum example:

func main() {
	var (
		token = "xxx"
		chatid = -123
		passphrase = "mykeyisaslongas32bytesdoyouagree?" // needs to be length of 32
		ctx = context.Background()
	)
	s, err := tgstore.New(token, chatid, tgstore.DefaultEndpoint, passphrase)
	if err != nil { ... }

	fid, err := s.Upload(ctx, bytes.NewReader([]byte("hello")))
	if err != nil { ... }

	r, err := s.Download(ctx, fid)
	if err != nil { ... }

	fo, err := os.Create("output")
	if err != nil {
		panic(err)
	}
	buf := make([]byte, 1024)
	for {
		n, err := r.Read(buf)
		if (err != nil && err != io.EOF) || n == 0 { ... }

		var m int
		for {
			l, err := fo.Write(buf[m:n])
			if (err != nil && err != io.EOF) || l == 0 { ... }
			m += l
		}
	}
}

CLI

CLI might want to store a configuration file at ~/.tgstore_conf, and record all uploaded records in ~/.tgstore_db.

$ go get golang.design/x/tgstore/cmd/tgstore
$ tgstore init
please input your telegram api endpoint (keep it empty to use the default: https://...):
>
please input your bot id:
>
here are the chats associated with your bot:
1 chat1
2 chatb
3 chatC
...
which chat you would like to use for storing your content? input the chat id:
>
DONE.

$ tgstore upload /path/to/what/ever/we/want/to/upload1.ext
9f82h3nf984j
$ tgstore upload /path/to/what/ever/we/want/to/upload2.ext
9r73hjf873h2
$ tgstore upload /path/to/what/ever/we/want/to/upload1.ext
489rfj481je9

$ tgstore list
9f82h3nf984j upload1.ext
9r73hjf873h2 upload2.ext
489rfj481je9 upload1.1.ext      # handle name duplication

$ tgstore download 9r73hjf873h2 # store file into $(pwd)
DONE.

$ tgstore download 489rfj481je9 /path/to/where/ever/we/want/to/store/down.ext
DONE.

[changkun]

After seeing the landing of a5199bc, the proposed design changes to the APIs are in a good shape in my current opinion.

The remaining question is if there is a need to provide a CLI, which is always a design on the application side, and cloud end up with an infinite number of designs.

Based on the clarification above, the discussion can be resolved for now.

[aofei]

Yes, I agree that providing a CLI would be great. But I'm now investigating not using Bot API but using MTProto to reimplement this project, which might speed up uploading and downloading in non-concurrent scenarios. So after this work, I'll start to design the CLI.