Add Upload() function, update vendored dependencies

Author: justinclift

README.md

@@ -8,20 +8,19 @@ A Go library for accessing and using SQLite databases stored remotely on DBHub.i
 ### What works now
 
 * Run read-only queries (eg SELECT statements) on databases, returning the results as JSON
+* Upload and download your databases
 * List the databases in your account
 * List the tables, views, and indexes present in a database
 * List the columns in a table, view or index, along with their details
 * List the branches, releases, tags, and commits for a database
 * Generate diffs between two databases, or database revisions
-* Download a complete database
 * Download the database metadata (size, branches, commit list, etc.)
-* Retrieve the web page URL of the database
+* Retrieve the web page URL of a database
 
 ### Still to do
 
-* Tests for each function
 * Have the backend server correctly use the incoming branch, release, and tag information
-* Upload a complete database
+* Tests for each function
 * Investigate what would be needed for this to work through the Go SQL API
 * Anything else people suggest and seems like a good idea :smile:
 

dbhub.go

@@ -4,9 +4,11 @@ package dbhub
 
 import (
 	"encoding/base64"
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/url"
+	"time"
 
 	com "github.com/sqlitebrowser/dbhub.io/common"
 )
@@ -142,6 +144,9 @@ func (c Connection) Download(dbOwner, dbName string, ident Identifier) (db io.Re
 	// Fetch the database file
 	queryUrl := c.Server + "/v1/download"
 	db, err = sendRequest(queryUrl, data)
+	if db != nil {
+		defer db.Close()
+	}
 	if err != nil {
 		return
 	}
@@ -287,6 +292,72 @@ func (c Connection) Views(dbOwner, dbName string, ident Identifier) (views []str
 	return
 }
 
+// Upload uploads a new database, or a new revision of a database
+func (c Connection) Upload(dbName string, info UploadInformation, dbBytes *[]byte) (err error) {
+	// Prepare the API parameters
+	data := c.PrepareVals("", dbName, info.Ident)
+	data.Del("dbowner") // The upload function always stores the database in the account of the API key user
+	if info.CommitMsg != "" {
+		data.Set("commitmsg", info.CommitMsg)
+	}
+	if info.SourceURL != "" {
+		data.Set("sourceurl", info.SourceURL)
+	}
+	if !info.LastModified.IsZero() {
+		data.Set("lastmodified", info.LastModified.Format(time.RFC3339))
+	}
+	if info.Licence != "" {
+		data.Set("licence", info.Licence)
+	}
+	if info.Public != "" {
+		data.Set("public", info.Public)
+	}
+	if info.Force {
+		data.Set("force", "true")
+	}
+	if !info.CommitTimestamp.IsZero() {
+		data.Set("committimestamp", info.CommitTimestamp.Format(time.RFC3339))
+	}
+	if info.AuthorName != "" {
+		data.Set("authorname", info.AuthorName)
+	}
+	if info.AuthorEmail != "" {
+		data.Set("authoremail", info.AuthorEmail)
+	}
+	if info.CommitterName != "" {
+		data.Set("committername", info.CommitterName)
+	}
+	if info.CommitterEmail != "" {
+		data.Set("committeremail", info.CommitterEmail)
+	}
+	if info.OtherParents != "" {
+		data.Set("otherparents", info.OtherParents)
+	}
+	if info.ShaSum != "" {
+		data.Set("dbshasum", info.ShaSum)
+	}
+
+	// Upload the database
+	var body io.ReadCloser
+	queryUrl := c.Server + "/v1/upload"
+	body, err = sendUpload(queryUrl, &data, dbBytes)
+	if body != nil {
+		defer body.Close()
+	}
+	if err != nil {
+		if body != nil {
+			// If there's useful error info in the returned JSON, return that as the error message
+			var z JSONError
+			err = json.NewDecoder(body).Decode(&z)
+			if err != nil {
+				return
+			}
+			err = fmt.Errorf("%s", z.Msg)
+		}
+	}
+	return
+}
+
 // Webpage returns the URL of the database file in the webUI.  eg. for web browsers
 func (c Connection) Webpage(dbOwner, dbName string) (webPage com.WebpageResponseContainer, err error) {
 	// Prepare the API parameters
@@ -296,4 +367,4 @@ func (c Connection) Webpage(dbOwner, dbName string) (webPage com.WebpageResponse
 	queryUrl := c.Server + "/v1/webpage"
 	err = sendRequestJSON(queryUrl, data, &webPage)
 	return
-}
+}

examples/upload/example.db

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"log"
+
+	"github.com/sqlitebrowser/go-dbhub"
+)
+
+func main() {
+	// Create a new DBHub.io API object
+	db, err := dbhub.New("YOUR_API_KEY_HERE")
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Read the database file into memory
+	var myDB []byte
+	myDB, err = ioutil.ReadFile("example.db")
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Prepare any information you want to include with the upload (eg a commit message, etc)
+	info := dbhub.UploadInformation{
+		CommitMsg: "An example upload",
+	}
+
+	// Upload the database
+	err = db.Upload("somedb.sqlite", info, &myDB)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Display a success message
+	fmt.Println("Database uploaded")
+}

examples/upload/main.go

@@ -10,4 +10,4 @@ replace (
 	github.com/Sirupsen/logrus v1.6.0 => github.com/sirupsen/logrus v1.6.0
 )
 
-require github.com/sqlitebrowser/dbhub.io v0.0.12
+require github.com/sqlitebrowser/dbhub.io v0.0.13

go.mod

@@ -123,8 +123,8 @@ github.com/sourcegraph/syntaxhighlight v0.0.0-20170531221838-bd320f5d308e h1:qpG
 github.com/sourcegraph/syntaxhighlight v0.0.0-20170531221838-bd320f5d308e/go.mod h1:HuIsMU8RRBOtsCgI77wP899iHVBQpCmg4ErYMZB+2IA=
 github.com/sqlitebrowser/blackfriday v9.0.0+incompatible h1:ddH/UyzasooYgGIblVU4R8DdmBuJ7QXLvSqX/0chZv4=
 github.com/sqlitebrowser/blackfriday v9.0.0+incompatible/go.mod h1:/zga9sqpWzcewuI83AO5JZwe9+6F9GgPDdqqdNNEL/0=
-github.com/sqlitebrowser/dbhub.io v0.0.12 h1:G5qd4qQGCVB8/Seh0e+cBvaYkpnoGnWQuxPEr4B09ZE=
-github.com/sqlitebrowser/dbhub.io v0.0.12/go.mod h1:GgZi8wkjdRGkkUVgYNuZp5i+Yps3jGt/jjRuLKRi6Po=
+github.com/sqlitebrowser/dbhub.io v0.0.13 h1:R29VyPD6LZmtsDicbK4ICnW4RnhiqN3c8+vvKS8RzHM=
+github.com/sqlitebrowser/dbhub.io v0.0.13/go.mod h1:GgZi8wkjdRGkkUVgYNuZp5i+Yps3jGt/jjRuLKRi6Po=
 github.com/sqlitebrowser/github_flavored_markdown v0.0.0-20190120045821-b8cf8f054e47 h1:s0+Ea95n1LrsKh6rtclU/9Qb2/5ofvnfnR7gDDiFTw8=
 github.com/sqlitebrowser/github_flavored_markdown v0.0.0-20190120045821-b8cf8f054e47/go.mod h1:8vPIKi5FslxCXEgfQxrFtWfdclGy6VWAc9NA1ZTYCJg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

go.sum

@@ -1,27 +1,26 @@
 package dbhub
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"io"
+	"mime/multipart"
 	"net/http"
 	"net/url"
 	"strings"
 )
 
 // sendRequestJSON sends a request to DBHub.io, formatting the returned result as JSON
 func sendRequestJSON(queryUrl string, data url.Values, returnStructure interface{}) (err error) {
-	type JSONError struct {
-		Msg string `json:"error"`
-	}
-
 	// Send the request
 	var body io.ReadCloser
 	body, err = sendRequest(queryUrl, data)
+	if body != nil {
+		defer body.Close()
+	}
 	if err != nil {
 		if body != nil {
-			defer body.Close()
-
 			// If there's useful error info in the returned JSON, return that as the error message
 			var z JSONError
 			err = json.NewDecoder(body).Decode(&z)
@@ -32,9 +31,6 @@ func sendRequestJSON(queryUrl string, data url.Values, returnStructure interface
 		}
 		return
 	}
-	if body != nil {
-		defer body.Close()
-	}
 
 	// Unmarshall the JSON response into the structure provided by the caller
 	err = json.NewDecoder(body).Decode(returnStructure)
@@ -61,7 +57,7 @@ func sendRequest(queryUrl string, data url.Values) (body io.ReadCloser, err erro
 		return
 	}
 
-	// Return the response body, even if an error occured.  This lets us return useful error information provided as
+	// Return the response body, even if an error occurred.  This lets us return useful error information provided as
 	// JSON in the body of the message
 	body = resp.Body
 
@@ -73,3 +69,69 @@ func sendRequest(queryUrl string, data url.Values) (body io.ReadCloser, err erro
 	}
 	return
 }
+
+// sendUpload uploads a database to DBHub.io.  It exists because the DBHub.io upload end point requires multi-part data
+func sendUpload(queryUrl string, data *url.Values, dbBytes *[]byte) (body io.ReadCloser, err error) {
+	// Prepare the database file byte stream
+	var buf bytes.Buffer
+	w := multipart.NewWriter(&buf)
+	dbName := data.Get("dbname")
+	var wri io.Writer
+	if dbName != "" {
+		wri, err = w.CreateFormFile("file", dbName)
+	} else {
+		wri, err = w.CreateFormFile("file", "database.db")
+	}
+	if err != nil {
+		return
+	}
+	_, err = wri.Write(*dbBytes)
+	if err != nil {
+		return
+	}
+
+	// Add the headers
+	for i, j := range *data {
+		wri, err = w.CreateFormField(i)
+		if err != nil {
+			return
+		}
+		_, err = wri.Write([]byte(j[0]))
+		if err != nil {
+			return
+		}
+	}
+	err = w.Close()
+	if err != nil {
+		return
+	}
+
+	// Prepare the request
+	var req *http.Request
+	var resp *http.Response
+	var client http.Client
+	req, err = http.NewRequest(http.MethodPost, queryUrl, &buf)
+	if err != nil {
+		return
+	}
+	req.Header.Set("User-Agent", fmt.Sprintf("go-dbhub v%s", version))
+	req.Header.Set("Content-Type", w.FormDataContentType())
+
+	// Upload the database
+	resp, err = client.Do(req)
+	if err != nil {
+		return
+	}
+
+	// Return the response body, even if an error occurred.  This lets us return useful error information provided as
+	// JSON in the body of the message
+	body = resp.Body
+
+	// Basic error handling, based on the status code received from the server
+	if resp.StatusCode != 201 {
+		// The returned status code indicates something went wrong
+		err = fmt.Errorf(resp.Status)
+		return
+	}
+	return
+}

http.go

@@ -1,5 +1,7 @@
 package dbhub
 
+import "time"
+
 // Connection is a simple container holding the API key and address of the DBHub.io server
 type Connection struct {
 	APIKey string `json:"api_key"`
@@ -14,6 +16,11 @@ type Identifier struct {
 	Tag      string `json:"tag"`
 }
 
+// JSONError holds information about an error condition, in a useful JSON format
+type JSONError struct {
+	Msg string `json:"error"`
+}
+
 // MergeStrategy specifies the type of SQL statements included in the diff results.
 // The SQL statements can be used for merging databases and depending on whether and
 // how you want to merge you should choose your merge strategy.
@@ -41,3 +48,21 @@ type ResultRow struct {
 type Results struct {
 	Rows []ResultRow
 }
+
+// UploadInformation holds information used when uploading
+type UploadInformation struct {
+	Ident           Identifier `json:"identifier"`
+	CommitMsg       string     `json:"commitmsg"`
+	SourceURL       string     `json:"sourceurl"`
+	LastModified    time.Time  `json:"lastmodified"`
+	Licence         string     `json:"licence"`
+	Public          string     `json:"public"`
+	Force           bool       `json:"force"`
+	CommitTimestamp time.Time  `json:"committimestamp"`
+	AuthorName      string     `json:"authorname"`
+	AuthorEmail     string     `json:"authoremail"`
+	CommitterName   string     `json:"committername"`
+	CommitterEmail  string     `json:"committeremail"`
+	OtherParents    string     `json:"otherparents"`
+	ShaSum          string     `json:"dbshasum"`
+}