Feat/dictation endpoint (#32)

Summary:
Based on this request - #31

1. Add new endpoint method
2. Add test .mp3 file for integration tests

Pull Request resolved: #32

Reviewed By: yuzh174

Differential Revision: D70269191

Pulled By: patapizza

fbshipit-source-id: 1877424010543174a26cdf8976dba779df79abad

Author: plutov

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -2,7 +2,9 @@
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/wit-ai/wit-go)](https://pkg.go.dev/github.com/wit-ai/wit-go)
 
-*This repository is community-maintained. We gladly accept pull requests. Please see the [Wit HTTP Reference](https://wit.ai/docs/http/latest) for all supported endpoints.*
+_This repository is community-maintained. We gladly accept pull requests. Please
+see the [Wit HTTP Reference](https://wit.ai/docs/http/latest) for all supported
+endpoints._
 
 Go client for [wit.ai](https://wit.ai/) HTTP API.
 
@@ -20,26 +22,26 @@ go get -u github.com/wit-ai/wit-go/v2
 package main
 
 import (
-	"os"
-	"fmt"
+    "os"
+    "fmt"
 
-	witai "github.com/wit-ai/wit-go/v2"
+    witai "github.com/wit-ai/wit-go/v2"
 )
 
 func main() {
-	client := witai.NewClient(os.Getenv("WIT_AI_TOKEN"))
-	// Use client.SetHTTPClient() to set custom http.Client
+    client := witai.NewClient(os.Getenv("WIT_AI_TOKEN"))
+    // Use client.SetHTTPClient() to set custom http.Client
 
-	msg, _ := client.Parse(&witai.MessageRequest{
-		Query: "hello",
-	})
-	fmt.Printf("%v", msg)
+    msg, _ := client.Parse(&witai.MessageRequest{
+        Query: "hello",
+    })
+    fmt.Printf("%v", msg)
 }
 ```
 
 ## Testing
 
-Unit tests are executed by Github Actions, but Integration tests have to be executed manually by providing a valid token via `WITAI_INTEGRATION_TOKEN` env var.
+Unit tests are executed by Github Actions.
 
 ### Unit tests
 
@@ -49,21 +51,25 @@ go test -race -v
 
 ### Integration tests
 
-Integration tests are connecting to real Wit.ai API, so you need to provide a valid token:
+Integration tests have to be executed manually by providing a valid token via
+`WITAI_INTEGRATION_TOKEN` env var.
+
+Integration tests are connecting to real Wit.ai API, so you need to provide a
+valid token:
 
 ```
 WITAI_INTEGRATION_TOKEN={SERVER_ACCESS_TOKEN} go test -v -tags=integration
 ```
 
 ## License
 
-The license for wit-go can be found in LICENSE file in the root directory of this source tree.
+The license for wit-go can be found in LICENSE file in the root directory of
+this source tree.
 
 ## Terms of Use
 
 Our terms of use can be found at https://opensource.facebook.com/legal/terms.
 
-
 ## Privacy Policy
 
 Our privacy policy can be found at

dictation.go

@@ -0,0 +1,51 @@
+// Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+
+package witai
+
+import (
+	"encoding/json"
+	"io"
+	"net/http"
+)
+
+type DictationRequest struct {
+	File        io.Reader
+	ContentType string
+}
+
+type DictationToken struct {
+	End   int    `json:"end"`
+	Start int    `json:"start"`
+	Token string `json:"token"`
+}
+
+type DictationSpeech struct {
+	Confidence float64          `json:"confidence"`
+	Tokens     []DictationToken `json:"tokens"`
+}
+
+type DictationResponse struct {
+	Speech DictationSpeech `json:"speech"`
+	Text   string          `json:"text"`
+	Type   string          `json:"type"`
+}
+
+// Dictation - Returns the text transcription from an audio file or stream.
+func (c *Client) Dictation(req DictationRequest) (*DictationResponse, error) {
+	resp, err := c.request(http.MethodPost, "/dictation", req.ContentType, req.File)
+	if err != nil {
+		return nil, err
+	}
+
+	defer resp.Close()
+
+	var msgResp *DictationResponse
+	decoder := json.NewDecoder(resp)
+	for {
+		err := decoder.Decode(&msgResp)
+		if err != nil {
+			break
+		}
+	}
+	return msgResp, err
+}

integration_test.go

@@ -146,3 +146,27 @@ func getIntegrationClient() *Client {
 	})
 	return c
 }
+
+func TestIntegrationDictation(t *testing.T) {
+	c := getIntegrationClient()
+
+	f, err := os.Open("./testdata/test.mp3")
+	if err != nil {
+		t.Fatalf("unable to open test file, err: %v", err)
+	}
+	defer f.Close()
+
+	req := DictationRequest{
+		File:        f,
+		ContentType: "audio/mpeg3",
+	}
+
+	resp, err := c.Dictation(req)
+	if err != nil {
+		t.Fatalf("unexpected err, got %v", err)
+	}
+
+	if resp.Text != "Hi this is a test file" {
+		t.Fatalf("unexpected transcript, got %s", resp.Text)
+	}
+}