-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add endpoint for getting data about a given document (#81)
* First pass at #75 * doc: add openapi spec for doc metadata endpoint * test: add tests for HandleDocMetadata
- Loading branch information
Showing
5 changed files
with
203 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package handlers | ||
|
|
||
| import ( | ||
| "errors" | ||
| "log" | ||
| "net/http" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/kevinanielsen/go-fast-cdn/util" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| func HandleDocMetadata(c *gin.Context) { | ||
| fileName := c.Param("filename") | ||
| if fileName == "" { | ||
| c.JSON(http.StatusBadRequest, gin.H{ | ||
| "error": "Doc name is required", | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| filePath := filepath.Join(util.ExPath, "uploads", "docs", fileName) | ||
| stat, err := os.Stat(filePath) | ||
| if err != nil { | ||
| if errors.Is(err, os.ErrNotExist) { | ||
| c.JSON(http.StatusNotFound, gin.H{ | ||
| "error": "Doc does not exist", | ||
| }) | ||
| } else { | ||
| log.Printf("Failed to get document %s: %s\n", fileName, err.Error()) | ||
| c.JSON(http.StatusInternalServerError, gin.H{ | ||
| "error": "Internal error", | ||
| }) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| c.JSON(http.StatusOK, gin.H{ | ||
| "filename": fileName, | ||
| "download_url": c.Request.Host + "/api/cdn/download/docs/" + fileName, | ||
| "file_size": stat.Size(), | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| package handlers | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/kevinanielsen/go-fast-cdn/util" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestHandleDocMetadata_NoError(t *testing.T) { | ||
| // Arrange | ||
| testFileName := uuid.NewString() | ||
| testFileDir := filepath.Join(util.ExPath, "uploads", "docs") | ||
| defer os.RemoveAll(filepath.Join(util.ExPath, "uploads")) | ||
| err := os.MkdirAll(testFileDir, 0766) | ||
| require.NoError(t, err) | ||
| testFilePath := filepath.Join(testFileDir, testFileName) | ||
| testFileContents := uuid.NewString() | ||
| err = os.WriteFile(testFilePath, []byte(testFileContents), 0666) | ||
| require.NoError(t, err) | ||
| w := httptest.NewRecorder() | ||
| c, _ := gin.CreateTestContext(w) | ||
| c.Request = httptest.NewRequest(http.MethodGet, "/test", nil) | ||
| c.Params = []gin.Param{{ | ||
| Key: "filename", | ||
| Value: testFileName, | ||
| }} | ||
|
|
||
| // Act | ||
| HandleDocMetadata(c) | ||
|
|
||
| // Assert | ||
| require.Equal(t, http.StatusOK, w.Result().StatusCode) | ||
| result := map[string]interface{}{} | ||
| err = json.NewDecoder(w.Body).Decode(&result) | ||
| require.NoError(t, err) | ||
| require.Contains(t, result, "filename") | ||
| require.Equal(t, result["filename"], testFileName) | ||
| require.Contains(t, result, "download_url") | ||
| require.NotEmpty(t, result["download_url"]) | ||
| require.Contains(t, result, "file_size") | ||
| require.Equal(t, float64(len(testFileContents)), result["file_size"]) | ||
| } | ||
|
|
||
| func TestHandleDocMetadata_NotFound(t *testing.T) { | ||
| // Arrange | ||
| testFileName := uuid.NewString() | ||
| w := httptest.NewRecorder() | ||
| c, _ := gin.CreateTestContext(w) | ||
| c.Request = httptest.NewRequest(http.MethodGet, "/test", nil) | ||
| c.Params = []gin.Param{{ | ||
| Key: "filename", | ||
| Value: testFileName, | ||
| }} | ||
|
|
||
| // Act | ||
| HandleDocMetadata(c) | ||
|
|
||
| // Assert | ||
| require.Equal(t, http.StatusNotFound, w.Result().StatusCode) | ||
| result := map[string]interface{}{} | ||
| err := json.NewDecoder(w.Body).Decode(&result) | ||
| require.NoError(t, err) | ||
| require.Contains(t, result, "error") | ||
| require.Equal(t, result["error"], "Doc does not exist") | ||
| } | ||
|
|
||
| func TestHandleDocMetadata_NameNotProvided(t *testing.T) { | ||
| // Arrange | ||
| w := httptest.NewRecorder() | ||
| c, _ := gin.CreateTestContext(w) | ||
| c.Request = httptest.NewRequest(http.MethodGet, "/test", nil) | ||
|
|
||
| // Act | ||
| HandleDocMetadata(c) | ||
|
|
||
| // Assert | ||
| require.Equal(t, http.StatusBadRequest, w.Result().StatusCode) | ||
| result := map[string]interface{}{} | ||
| err := json.NewDecoder(w.Body).Decode(&result) | ||
| require.NoError(t, err) | ||
| require.Contains(t, result, "error") | ||
| require.Equal(t, result["error"], "Doc name is required") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters