Merge pull request #170 from notion-dotnet/bfix/165-create-page-fails

KoditkarVedant · web-flow · commit 279f65a8401d · 2021-10-05T23:29:54.000+05:30
Fix: Create page fails 🐛
diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml
@@ -34,4 +34,4 @@ jobs:
         run: dotnet build --no-restore
 
       - name: Test
-        run: dotnet test --no-build --verbosity normal
+        run: dotnet test --filter "FullyQualifiedName~Notion.UnitTests" --no-build --verbosity normal
diff --git a/.github/workflows/publish-code.yml b/.github/workflows/publish-code.yml
@@ -27,7 +27,7 @@ jobs:
         run: dotnet build --no-restore -c Release
 
       - name: Test
-        run: dotnet test -c Release --no-build --verbosity normal
+        run: dotnet test -c Release --filter "FullyQualifiedName~Notion.UnitTests" --no-build --verbosity normal
 
       - name: Pack solution [Release]
         run: |
diff --git a/.github/workflows/test-publish-code.yml b/.github/workflows/test-publish-code.yml
@@ -30,7 +30,7 @@ jobs:
         run: dotnet build --no-restore -c Release
 
       - name: Test
-        run: dotnet test -c Release --no-build --verbosity normal
+        run: dotnet test --filter "FullyQualifiedName~Notion.UnitTests" -c Release --no-build --verbosity normal
 
       - name: Pack solution [Release]
         run: |
diff --git a/Notion.sln b/Notion.sln
@@ -16,6 +16,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.editorconfig = .editorconfig
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Notion.IntegrationTests", "Test\Notion.IntegrationTests\Notion.IntegrationTests.csproj", "{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -50,13 +52,26 @@ Global
 		{B3AE07EA-49CC-4A86-A2D4-04E1FF00AB04}.Release|x64.Build.0 = Release|Any CPU
 		{B3AE07EA-49CC-4A86-A2D4-04E1FF00AB04}.Release|x86.ActiveCfg = Release|Any CPU
 		{B3AE07EA-49CC-4A86-A2D4-04E1FF00AB04}.Release|x86.Build.0 = Release|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Debug|x64.Build.0 = Debug|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Debug|x86.Build.0 = Debug|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Release|Any CPU.Build.0 = Release|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Release|x64.ActiveCfg = Release|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Release|x64.Build.0 = Release|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Release|x86.ActiveCfg = Release|Any CPU
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{BF5F85F3-901C-40B0-8357-A1919F89AE2E} = {4A92506A-3CF1-4E86-B9FD-D5F109655D87}
 		{B3AE07EA-49CC-4A86-A2D4-04E1FF00AB04} = {F474CF12-E2AC-4388-B764-BAE891D307B8}
+		{E0E2D7D5-E2AD-4587-AE88-BA5812A90451} = {F474CF12-E2AC-4388-B764-BAE891D307B8}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {3C5C8AC9-88CA-4079-BC0B-C1A81248B0B1}
diff --git a/Src/Notion.Client/Api/Databases/RequestParams/DatabasesCreateParameters/ParentPageInput.cs b/Src/Notion.Client/Api/Databases/RequestParams/DatabasesCreateParameters/ParentPageInput.cs
@@ -2,7 +2,7 @@
 
 namespace Notion.Client
 {
-    public class ParentPageInput
+    public class ParentPageInput : IPageParentInput
     {
         [JsonProperty("page_id")]
         public string PageId { get; set; }
diff --git a/Src/Notion.Client/Api/Pages/IPagesClient.cs b/Src/Notion.Client/Api/Pages/IPagesClient.cs
@@ -5,7 +5,17 @@ namespace Notion.Client
 {
     public interface IPagesClient
     {
-        Task<Page> CreateAsync(NewPage page);
+        /// <summary>
+        /// Creates a new page in the specified database or as a child of an existing page.
+        /// 
+        /// If the parent is a database, the <see href="https://developers.notion.com/reference-link/page#property-value-object">property values</see> of the new page in the properties parameter must conform to the parent <see href="https://developers.notion.com/reference-link/database">database</see>'s property schema.
+        /// 
+        /// If the parent is a page, the only valid property is <strong>title</strong>.
+        /// </summary>
+        /// <param name="pagesCreateParameters">Create page parameters</param>
+        /// <returns>Created page.</returns>
+        Task<Page> CreateAsync(PagesCreateParameters pagesCreateParameters);
+
         Task<Page> RetrieveAsync(string pageId);
 
         Task<Page> UpdatePropertiesAsync(
diff --git a/Src/Notion.Client/Api/Pages/PagesClient.cs b/Src/Notion.Client/Api/Pages/PagesClient.cs
@@ -14,24 +14,35 @@ public PagesClient(IRestClient client)
             _client = client;
         }
 
-        public async Task<Page> CreateAsync(NewPage page)
+        /// <summary>
+        /// Creates a new page in the specified database or as a child of an existing page.
+        /// 
+        /// If the parent is a database, the <see href="https://developers.notion.com/reference-link/page#property-value-object">property values</see> of the new page in the properties parameter must conform to the parent <see href="https://developers.notion.com/reference-link/database">database</see>'s property schema.
+        /// 
+        /// If the parent is a page, the only valid property is <strong>title</strong>.
+        /// </summary>
+        /// <param name="pagesCreateParameters">Create page parameters</param>
+        /// <returns>Created page.</returns>
+        public async Task<Page> CreateAsync(PagesCreateParameters pagesCreateParameters)
         {
-            if (page == null)
+            if (pagesCreateParameters is null)
             {
-                throw new ArgumentNullException(nameof(page));
+                throw new ArgumentNullException(nameof(pagesCreateParameters));
             }
 
-            if (page.Parent == null)
+            var bodyParameters = (IPagesCreateBodyParameters)pagesCreateParameters;
+
+            if (bodyParameters.Parent == null)
             {
-                throw new ArgumentNullException(nameof(page.Parent), "Parent is required!");
+                throw new ArgumentNullException(nameof(bodyParameters.Parent), "Parent is required!");
             }
 
-            if (page.Properties == null)
+            if (bodyParameters.Properties == null)
             {
-                throw new ArgumentNullException(nameof(page.Properties), "Properties are required!");
+                throw new ArgumentNullException(nameof(bodyParameters.Properties), "Properties are required!");
             }
 
-            return await _client.PostAsync<Page>(PagesApiUrls.Create(), page);
+            return await _client.PostAsync<Page>(PagesApiUrls.Create(), bodyParameters);
         }
 
         public async Task<Page> RetrieveAsync(string pageId)
diff --git a/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/DatabaseParentInput.cs b/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/DatabaseParentInput.cs
@@ -0,0 +1,10 @@
+﻿using Newtonsoft.Json;
+
+namespace Notion.Client
+{
+    public class DatabaseParentInput : IPageParentInput
+    {
+        [JsonProperty("database_id")]
+        public string DatabaseId { get; set; }
+    }
+}
diff --git a/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/IPageParentInput.cs b/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/IPageParentInput.cs
@@ -0,0 +1,6 @@
+﻿namespace Notion.Client
+{
+    public interface IPageParentInput
+    {
+    }
+}
diff --git a/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/IPagesCreateBodyParameters.cs b/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/IPagesCreateBodyParameters.cs
@@ -0,0 +1,23 @@
+﻿using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace Notion.Client
+{
+    public interface IPagesCreateBodyParameters
+    {
+        [JsonProperty("parent")]
+        IPageParentInput Parent { get; set; }
+
+        [JsonProperty("properties")]
+        IDictionary<string, PropertyValue> Properties { get; set; }
+
+        [JsonProperty("children")]
+        IList<Block> Children { get; set; }
+
+        [JsonProperty("icon")]
+        IPageIcon Icon { get; set; }
+
+        [JsonProperty("cover")]
+        FileObject Cover { get; set; }
+    }
+}
diff --git a/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/IPagesCreateQueryParameters.cs b/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/IPagesCreateQueryParameters.cs
@@ -0,0 +1,6 @@
+﻿namespace Notion.Client
+{
+    public interface IPagesCreateQueryParameters
+    {
+    }
+}
diff --git a/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/PagesCreateParameters.cs b/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/PagesCreateParameters.cs
@@ -0,0 +1,13 @@
+﻿using System.Collections.Generic;
+
+namespace Notion.Client
+{
+    public class PagesCreateParameters : IPagesCreateBodyParameters, IPagesCreateQueryParameters
+    {
+        public IPageParentInput Parent { get; set; }
+        public IDictionary<string, PropertyValue> Properties { get; set; }
+        public IList<Block> Children { get; set; }
+        public IPageIcon Icon { get; set; }
+        public FileObject Cover { get; set; }
+    }
+}
diff --git a/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/PagesCreateParametersBuilder.cs b/Src/Notion.Client/Api/Pages/RequestParams/PagesCreateParameters/PagesCreateParametersBuilder.cs
@@ -0,0 +1,49 @@
+﻿using System.Collections.Generic;
+
+namespace Notion.Client
+{
+    public class PagesCreateParametersBuilder
+    {
+        private IPageParentInput parent;
+        private Dictionary<string, PropertyValue> properties = new Dictionary<string, PropertyValue>();
+        private IList<Block> children = new List<Block>();
+        private IPageIcon icon;
+        private FileObject cover;
+
+        private PagesCreateParametersBuilder()
+        {
+        }
+
+        public static PagesCreateParametersBuilder Create(IPageParentInput parent)
+        {
+            return new PagesCreateParametersBuilder
+            {
+                parent = parent
+            };
+        }
+
+        public PagesCreateParametersBuilder AddProperty(string nameOrId, PropertyValue value)
+        {
+            properties[nameOrId] = value;
+            return this;
+        }
+
+        public PagesCreateParametersBuilder AddPageContent(Block block)
+        {
+            children.Add(block);
+            return this;
+        }
+
+        public PagesCreateParameters Build()
+        {
+            return new PagesCreateParameters
+            {
+                Parent = parent,
+                Properties = properties,
+                Children = children,
+                Icon = icon,
+                Cover = cover
+            };
+        }
+    }
+}
diff --git a/Src/Notion.Client/Models/Page/NewPage.cs b/Src/Notion.Client/Models/Page/NewPage.cs
diff --git a/Test/Notion.IntegrationTests/IPageClientTests.cs b/Test/Notion.IntegrationTests/IPageClientTests.cs
@@ -0,0 +1,58 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using FluentAssertions;
+using Notion.Client;
+using Xunit;
+
+namespace Notion.IntegrationTests
+{
+    public class IPageClientTests
+    {
+        [Fact]
+        public async Task CreateAsync_CreatesANewPage()
+        {
+            var options = new ClientOptions
+            {
+                AuthToken = Environment.GetEnvironmentVariable("NOTION_AUTH_TOKEN")
+            };
+
+            IPagesClient _client = new PagesClient(new RestClient(options));
+
+            PagesCreateParameters pagesCreateParameters = PagesCreateParametersBuilder.Create(new DatabaseParentInput
+            {
+                DatabaseId = "f86f2262-0751-40f2-8f63-e3f7a3c39fcb"
+            })
+            .AddProperty("Name", new TitlePropertyValue
+            {
+                Title = new List<RichTextBase>
+                {
+                    new RichTextText
+                    {
+                        Text = new Text
+                        {
+                            Content = "Test Page Title"
+                        }
+                    }
+                }
+            })
+            .Build();
+
+            var page = await _client.CreateAsync(pagesCreateParameters);
+
+            page.Should().NotBeNull();
+            page.Parent.Should().BeOfType<DatabaseParent>().Which
+                .DatabaseId.Should().Be("f86f2262-0751-40f2-8f63-e3f7a3c39fcb");
+
+            page.Properties.Should().ContainKey("Name");
+            page.Properties["Name"].Should().BeOfType<TitlePropertyValue>().Which
+                .Title.First().PlainText.Should().Be("Test Page Title");
+
+            await _client.UpdateAsync(page.Id, new PagesUpdateParameters
+            {
+                Archived = true
+            });
+        }
+    }
+}
diff --git a/Test/Notion.IntegrationTests/Notion.IntegrationTests.csproj b/Test/Notion.IntegrationTests/Notion.IntegrationTests.csproj
@@ -0,0 +1,28 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+    <Nullable>enable</Nullable>
+
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\Src\Notion.Client\Notion.Client.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="FluentAssertions" Version="5.10.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="3.0.2">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+</Project>
diff --git a/Test/Notion.UnitTests/PagesClientTests.cs b/Test/Notion.UnitTests/PagesClientTests.cs
diff --git a/Test/Notion.UnitTests/data/pages/CreatePageResponse.json b/Test/Notion.UnitTests/data/pages/CreatePageResponse.json

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Notion.Client`
`4`	`4`	`{`
`5`		`- public class ParentPageInput`
	`5`	`+ public class ParentPageInput : IPageParentInput`
`6`	`6`	`{`
`7`	`7`	`[JsonProperty("page_id")]`
`8`	`8`	`public string PageId { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -14,24 +14,35 @@ public PagesClient(IRestClient client)`
`14`	`14`	`_client = client;`
`15`	`15`	`}`
`16`	`16`
`17`		`- public async Task<Page> CreateAsync(NewPage page)`
	`17`	`+ /// <summary>`
	`18`	`+ /// Creates a new page in the specified database or as a child of an existing page.`
	`19`	`+ ///`
	`20`	`+ /// If the parent is a database, the <see href="https://developers.notion.com/reference-link/page#property-value-object">property values</see> of the new page in the properties parameter must conform to the parent <see href="https://developers.notion.com/reference-link/database">database</see>'s property schema.`
	`21`	`+ ///`
	`22`	`+ /// If the parent is a page, the only valid property is <strong>title</strong>.`
	`23`	`+ /// </summary>`
	`24`	`+ /// <param name="pagesCreateParameters">Create page parameters</param>`
	`25`	`+ /// <returns>Created page.</returns>`
	`26`	`+ public async Task<Page> CreateAsync(PagesCreateParameters pagesCreateParameters)`
`18`	`27`	`{`
`19`		`- if (page == null)`
	`28`	`+ if (pagesCreateParameters is null)`
`20`	`29`	`{`
`21`		`- throw new ArgumentNullException(nameof(page));`
	`30`	`+ throw new ArgumentNullException(nameof(pagesCreateParameters));`
`22`	`31`	`}`
`23`	`32`
`24`		`- if (page.Parent == null)`
	`33`	`+ var bodyParameters = (IPagesCreateBodyParameters)pagesCreateParameters;`
	`34`	`+`
	`35`	`+ if (bodyParameters.Parent == null)`
`25`	`36`	`{`
`26`		`- throw new ArgumentNullException(nameof(page.Parent), "Parent is required!");`
	`37`	`+ throw new ArgumentNullException(nameof(bodyParameters.Parent), "Parent is required!");`
`27`	`38`	`}`
`28`	`39`
`29`		`- if (page.Properties == null)`
	`40`	`+ if (bodyParameters.Properties == null)`
`30`	`41`	`{`
`31`		`- throw new ArgumentNullException(nameof(page.Properties), "Properties are required!");`
	`42`	`+ throw new ArgumentNullException(nameof(bodyParameters.Properties), "Properties are required!");`
`32`	`43`	`}`
`33`	`44`
`34`		`- return await _client.PostAsync<Page>(PagesApiUrls.Create(), page);`
	`45`	`+ return await _client.PostAsync<Page>(PagesApiUrls.Create(), bodyParameters);`
`35`	`46`	`}`
`36`	`47`
`37`	`48`	`public async Task<Page> RetrieveAsync(string pageId)`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +namespace Notion.Client
 +{
 +    public interface IPageParentInput
 +    {
 +    }
 +}