go/go-notion
1
0
Fork 0
mirror of https://github.com/dstotijn/go-notion.git synced 2025-06-06 23:36:14 +02:00
Code Issues Releases Activity

Add "Update database" endpoint

Browse Source
This commit is contained in:
David Stotijn 2021-12-20 11:11:03 +01:00
parent 2ebac2e1b2
commit f62677ef09
3 changed files with 282 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
client.go
View File

@ -162,6 +162,43 @@ func (c *Client) CreateDatabase(ctx context.Context, params CreateDatabaseParams
return db, nil
}
// UpdateDatabase updates a database.
// See: https://developers.notion.com/reference/update-a-database
func (c *Client) UpdateDatabase(ctx context.Context, databaseID string, params UpdateDatabaseParams) (updatedDB Database, err error) {
if err := params.Validate(); err != nil {
return Database{}, fmt.Errorf("notion: invalid database params: %w", err)
}
body := &bytes.Buffer{}
err = json.NewEncoder(body).Encode(params)
if err != nil {
return Database{}, fmt.Errorf("notion: failed to encode body params to JSON: %w", err)
}
req, err := c.newRequest(ctx, http.MethodPatch, "/databases/"+databaseID, body)
if err != nil {
return Database{}, fmt.Errorf("notion: invalid request: %w", err)
}
res, err := c.httpClient.Do(req)
if err != nil {
return Database{}, fmt.Errorf("notion: failed to make HTTP request: %w", err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return Database{}, fmt.Errorf("notion: failed to update database: %w", parseErrorResponse(res))
}
err = json.NewDecoder(res.Body).Decode(&updatedDB)
if err != nil {
return Database{}, fmt.Errorf("notion: failed to parse HTTP response: %w", err)
}
return updatedDB, nil
}
// FindPageByID fetches a page by ID.
// See: https://developers.notion.com/reference/get-page
func (c *Client) FindPageByID(ctx context.Context, id string) (page Page, err error) {

231
client_test.go
View File

@ -1206,6 +1206,237 @@ func TestCreateDatabase(t *testing.T) {
}
}
func TestUpdateDatabase(t *testing.T) {
t.Parallel()
tests := []struct {
name string
params notion.UpdateDatabaseParams
respBody func(r *http.Request) io.Reader
respStatusCode int
expPostBody map[string]interface{}
expResponse notion.Database
expError error
}{
{
name: "successful response",
params: notion.UpdateDatabaseParams{
Title: []notion.RichText{
{
Text: &notion.Text{
Content: "Updated title",
},
},
},
Properties: map[string]*notion.DatabaseProperty{
"New": {
Type: notion.DBPropTypeRichText,
RichText: &notion.EmptyMetadata{},
},
"Removed": nil,
},
},
respBody: func(_ *http.Request) io.Reader {
return strings.NewReader(
`{
"object": "database",
"id": "668d797c-76fa-4934-9b05-ad288df2d136",
"created_time": "2020-03-17T19:10:04.968Z",
"last_edited_time": "2020-03-17T21:49:37.913Z",
"title": [
{
"type": "text",
"text": {
"content": "Grocery List",
"link": null
},
"annotations": {
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"code": false,
"color": "default"
},
"plain_text": "Grocery List",
"href": null
}
],
"properties": {
"Name": {
"id": "title",
"type": "title",
"title": {}
},
"New": {
"id": "J@cS",
"type": "rich_text",
"text": {}
}
},
"parent": {
"type": "page_id",
"page_id": "b8595b75-abd1-4cad-8dfe-f935a8ef57cb"
}
}`,
)
},
respStatusCode: http.StatusOK,
expPostBody: map[string]interface{}{
"title": []interface{}{
map[string]interface{}{
"text": map[string]interface{}{
"content": "Updated title",
},
},
},
"properties": map[string]interface{}{
"New": map[string]interface{}{
"type": "rich_text",
"rich_text": map[string]interface{}{},
},
"Removed": nil,
},
},
expResponse: notion.Database{
ID: "668d797c-76fa-4934-9b05-ad288df2d136",
CreatedTime: mustParseTime(time.RFC3339, "2020-03-17T19:10:04.968Z"),
LastEditedTime: mustParseTime(time.RFC3339, "2020-03-17T21:49:37.913Z"),
Title: []notion.RichText{
{
Type: notion.RichTextTypeText,
Text: &notion.Text{
Content: "Grocery List",
},
Annotations: &notion.Annotations{
Color: notion.ColorDefault,
},
PlainText: "Grocery List",
},
},
Properties: notion.DatabaseProperties{
"Name": notion.DatabaseProperty{
ID: "title",
Type: notion.DBPropTypeTitle,
Title: &notion.EmptyMetadata{},
},
"New": notion.DatabaseProperty{
ID: "J@cS",
Type: notion.DBPropTypeRichText,
},
},
Parent: notion.Parent{
Type: notion.ParentTypePage,
PageID: "b8595b75-abd1-4cad-8dfe-f935a8ef57cb",
},
},
expError: nil,
},
{
name: "error response",
params: notion.UpdateDatabaseParams{
Title: []notion.RichText{
{
Text: &notion.Text{
Content: "Updated title",
},
},
},
Properties: map[string]*notion.DatabaseProperty{
"New": {
Type: notion.DBPropTypeRichText,
RichText: &notion.EmptyMetadata{},
},
"Removed": nil,
},
},
respBody: func(_ *http.Request) io.Reader {
return strings.NewReader(
`{
"object": "error",
"status": 400,
"code": "validation_error",
"message": "foobar"
}`,
)
},
respStatusCode: http.StatusBadRequest,
expPostBody: map[string]interface{}{
"title": []interface{}{
map[string]interface{}{
"text": map[string]interface{}{
"content": "Updated title",
},
},
},
"properties": map[string]interface{}{
"New": map[string]interface{}{
"type": "rich_text",
"rich_text": map[string]interface{}{},
},
"Removed": nil,
},
},
expResponse: notion.Database{},
expError: errors.New("notion: failed to update database: foobar (code: validation_error, status: 400)"),
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
httpClient := &http.Client{
Transport: &mockRoundtripper{fn: func(r *http.Request) (*http.Response, error) {
postBody := make(map[string]interface{})
err := json.NewDecoder(r.Body).Decode(&postBody)
if err != nil && err != io.EOF {
t.Fatal(err)
}
if len(tt.expPostBody) == 0 && len(postBody) != 0 {
t.Errorf("unexpected post body: %#v", postBody)
}
if len(tt.expPostBody) != 0 && len(postBody) == 0 {
t.Errorf("post body not equal (expected %+v, got: nil)", tt.expPostBody)
}
if len(tt.expPostBody) != 0 && len(postBody) != 0 {
if diff := cmp.Diff(tt.expPostBody, postBody); diff != "" {
t.Errorf("post body not equal (-exp, +got):\n%v", diff)
}
}
return &http.Response{
StatusCode: tt.respStatusCode,
Status: http.StatusText(tt.respStatusCode),
Body: ioutil.NopCloser(tt.respBody(r)),
}, nil
}},
}
client := notion.NewClient("secret-api-key", notion.WithHTTPClient(httpClient))
updatedDB, err := client.UpdateDatabase(context.Background(), "00000000-0000-0000-0000-000000000000", tt.params)
if tt.expError == nil && err != nil {
t.Fatalf("unexpected error: %v", err)
}
if tt.expError != nil && err == nil {
t.Fatalf("error not equal (expected: %v, got: nil)", tt.expError)
}
if tt.expError != nil && err != nil && tt.expError.Error() != err.Error() {
t.Fatalf("error not equal (expected: %v, got: %v)", tt.expError, err)
}
if diff := cmp.Diff(tt.expResponse, updatedDB); diff != "" {
t.Fatalf("response not equal (-exp, +got):\n%v", diff)
}
})
}
}
func TestFindPageByID(t *testing.T) {
t.Parallel()

14
database.go
View File

@ -436,3 +436,17 @@ func (p CreateDatabaseParams) MarshalJSON() ([]byte, error) {
return json.Marshal(dto)
}
// UpdateDatabaseParams are the params used for updating a database.
type UpdateDatabaseParams struct {
Title []RichText `json:"title,omitempty"`
Properties map[string]*DatabaseProperty `json:"properties,omitempty"`
}
// Validate validates params for updating a database.
func (p UpdateDatabaseParams) Validate() error {
if len(p.Title) == 0 && len(p.Properties) == 0 {
return errors.New("either title or properties are required")
}
return nil
}