Improvements for Moodle Provider (#533)

FerdinandSu · web-flow · commit b2f3dcc72524 · 2021-03-28T11:07:21.000+01:00
* Add Claims for auth, country and description

* Fixed wrong code style

* Moved doc references from [projectestac/moodle-local_oauth] to [HIT-ReFreSH/moodle-local_oauth]

* Added Tests for new Claims
diff --git a/README.md b/README.md
@@ -150,7 +150,7 @@ If a provider you're looking for does not exist, consider making a PR to add one
 | LinkedIn | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.LinkedIn?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.LinkedIn/ "Download AspNet.Security.OAuth.LinkedIn from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.LinkedIn?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.LinkedIn "Download AspNet.Security.OAuth.LinkedIn from MyGet.org") | [Documentation](https://docs.microsoft.com/en-us/linkedin/shared/authentication/authentication "LinkedIn developer documentation") |
 | MailChimp | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.MailChimp?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.MailChimp/ "Download AspNet.Security.OAuth.MailChimp from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.MailChimp?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.MailChimp "Download AspNet.Security.OAuth.MailChimp from MyGet.org") | [Documentation](https://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/ "MailChimp developer documentation") |
 | MailRu | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.MailRu?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.MailRu/ "Download AspNet.Security.OAuth.MailRu from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.MailRu?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.MailRu "Download AspNet.Security.OAuth.MailRu from MyGet.org") | [Documentation](https://o2.mail.ru/docs#web "MailRu developer documentation") |
-| Moodle | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.Moodle?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.Moodle/ "Download AspNet.Security.OAuth.Moodle from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.Moodle?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.Moodle "Download AspNet.Security.OAuth.Moodle from MyGet.org") | [Documentation](https://github.com/projectestac/moodle-local_oauth "Moodle OAuth2 plugin developer documentation") |
+| Moodle | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.Moodle?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.Moodle/ "Download AspNet.Security.OAuth.Moodle from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.Moodle?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.Moodle "Download AspNet.Security.OAuth.Moodle from MyGet.org") | [Documentation](https://github.com/HIT-ReFreSH/moodle-local_oauth "Moodle OAuth2 plugin developer documentation") |
 | Myob | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.Myob?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.Myob/ "Download AspNet.Security.OAuth.Myob from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.Myob?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.Myob "Download AspNet.Security.OAuth.Myob from MyGet.org") | [Documentation](https://developer.myob.com/api/accountright/api-overview/authentication/ "Myob developer documentation") |
 | NetEase  | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.NetEase?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.NetEase/ "Download AspNet.Security.OAuth.NetEase from NuGet.org") |  [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.NetEase?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.NetEase "Download AspNet.Security.OAuth.NetEase from MyGet.org") |  [Documentation](https://reg.163.com/help/help_oauth2.html "NetEase developer documentation") |
 | Nextcloud | [![NuGet](https://buildstats.info/nuget/AspNet.Security.OAuth.Nextcloud?includePreReleases=false)](https://www.nuget.org/packages/AspNet.Security.OAuth.Nextcloud/ "Download AspNet.Security.OAuth.Nextcloud from NuGet.org") | [![MyGet](https://buildstats.info/myget/aspnet-contrib/AspNet.Security.OAuth.Nextcloud?includePreReleases=true)](https://www.myget.org/feed/aspnet-contrib/package/nuget/AspNet.Security.OAuth.Nextcloud "Download AspNet.Security.OAuth.Nextcloud from MyGet.org") | [Documentation](https://docs.nextcloud.com/server/14/admin_manual/configuration_server/oauth2.html "Nextcloud developer documentation")  [User EndPoint Documentation](https://docs.nextcloud.com/server/15/developer_manual/client_apis/OCS/index.html#user-metadata "Nextcloud developer documentation") |
diff --git a/docs/moodle.md b/docs/moodle.md
@@ -1,6 +1,6 @@
 # Integrating the Moodle Provider
 
-Applies to the Moodle plugin [projectestac/moodle-local_oauth](https://github.com/projectestac/moodle-local_oauth).
+Applies to the Moodle plugin [HIT-ReFreSH/moodle-local_oauth](https://github.com/HIT-ReFreSH/moodle-local_oauth).
 
 ## Example
 
diff --git a/src/AspNet.Security.OAuth.Moodle/MoodleAuthenticationConstants.cs b/src/AspNet.Security.OAuth.Moodle/MoodleAuthenticationConstants.cs
@@ -16,6 +16,7 @@ public static class Claims
             public const string IdNumber = "urn:moodle:idnumber";
             public const string MoodleId = "urn:moodle:id";
             public const string Language = "urn:moodle:lang";
+            public const string Description = "urn:moodle:desc";
         }
     }
 }
diff --git a/src/AspNet.Security.OAuth.Moodle/MoodleAuthenticationOptions.cs b/src/AspNet.Security.OAuth.Moodle/MoodleAuthenticationOptions.cs
@@ -37,9 +37,12 @@ public MoodleAuthenticationOptions()
             ClaimActions.MapJsonKey(ClaimTypes.MobilePhone, "phone1");
             ClaimActions.MapJsonKey(ClaimTypes.GivenName, "firstname");
             ClaimActions.MapJsonKey(ClaimTypes.Surname, "lastname");
+            ClaimActions.MapJsonKey(ClaimTypes.AuthenticationMethod, "auth");
+            ClaimActions.MapJsonKey(ClaimTypes.Country, "country");
             ClaimActions.MapJsonKey(Claims.IdNumber, "idnumber");
             ClaimActions.MapJsonKey(Claims.MoodleId, "id");
             ClaimActions.MapJsonKey(Claims.Language, "lang");
+            ClaimActions.MapJsonKey(Claims.Description, "description");
         }
 
         /// <summary>
diff --git a/test/AspNet.Security.OAuth.Providers.Tests/Moodle/MoodleTests.cs b/test/AspNet.Security.OAuth.Providers.Tests/Moodle/MoodleTests.cs
@@ -39,9 +39,12 @@ protected internal override void RegisterAuthentication(AuthenticationBuilder bu
         [InlineData(ClaimTypes.Surname, "Doe")]
         [InlineData(ClaimTypes.GivenName, "John")]
         [InlineData(ClaimTypes.MobilePhone, "7654321")]
+        [InlineData(ClaimTypes.Country, "avalon")]
+        [InlineData(ClaimTypes.AuthenticationMethod, "manual")]
         [InlineData(Claims.IdNumber, "1234567")]
         [InlineData(Claims.MoodleId, "22")]
         [InlineData(Claims.Language, "en")]
+        [InlineData(Claims.Description, "John Doe's Moodle account")]
         public async Task Can_Sign_In_Using_Moodle(string claimType, string claimValue)
         {
             // Arrange
@@ -64,6 +67,9 @@ public async Task Can_Sign_In_Using_Moodle(string claimType, string claimValue)
         [InlineData(Claims.IdNumber, "ZH1234567")]
         [InlineData(Claims.MoodleId, "22")]
         [InlineData(Claims.Language, "zh_CN")]
+        [InlineData(ClaimTypes.Country, "秦")]
+        [InlineData(ClaimTypes.AuthenticationMethod, "casattras")]
+        [InlineData(Claims.Description, "张三的 Moodle 账号")]
         public async Task Can_Sign_In_Using_Moodle_In_Chinese(string claimType, string claimValue)
         {
             // Arrange
diff --git a/test/AspNet.Security.OAuth.Providers.Tests/Moodle/bundle.json b/test/AspNet.Security.OAuth.Providers.Tests/Moodle/bundle.json
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/justeat/httpclient-interception/master/src/HttpClientInterception/Bundles/http-request-bundle-schema.json",
   "items": [
     {
-      "comment": "https://github.com/projectestac/moodle-local_oauth",
+      "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",
       "uri": "https://moodle.local/local/oauth/token.php",
       "method": "POST",
       "contentFormat": "json",
@@ -15,7 +15,7 @@
       }
     },
     {
-      "comment": "https://github.com/projectestac/moodle-local_oauth",
+      "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",
       "uri": "https://moodle.local/local/oauth/user_info.php",
       "contentFormat": "json",
       "contentJson": {
@@ -26,11 +26,14 @@
         "lastname": "Doe",
         "email": "john.doe@example.com",
         "lang": "en",
-        "phone1": "7654321"
+        "phone1": "7654321",
+        "auth": "manual",
+        "country": "avalon",
+        "description": "John Doe's Moodle account" 
       }
     },
     {
-      "comment": "https://github.com/projectestac/moodle-local_oauth",
+      "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",
       "uri": "https://zh.moodle.local/local/oauth/token.php",
       "method": "POST",
       "contentFormat": "json",
@@ -43,7 +46,7 @@
       }
     },
     {
-      "comment": "https://github.com/projectestac/moodle-local_oauth",
+      "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",
       "uri": "https://zh.moodle.local/local/oauth/user_info.php",
       "contentFormat": "json",
       "contentJson": {
@@ -54,7 +57,10 @@
         "lastname": "张",
         "email": "zhangsan@example.com",
         "lang": "zh_CN",
-        "phone1": "7654321"
+        "phone1": "7654321",
+        "auth": "casattras",
+        "country": "秦",
+        "description": "张三的 Moodle 账号"
       }
     }
   ]

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public static class Claims`
`16`	`16`	`public const string IdNumber = "urn:moodle:idnumber";`
`17`	`17`	`public const string MoodleId = "urn:moodle:id";`
`18`	`18`	`public const string Language = "urn:moodle:lang";`
	`19`	`+ public const string Description = "urn:moodle:desc";`
`19`	`20`	`}`
`20`	`21`	`}`
`21`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"$schema": "https://raw.githubusercontent.com/justeat/httpclient-interception/master/src/HttpClientInterception/Bundles/http-request-bundle-schema.json",`
`3`	`3`	`"items": [`
`4`	`4`	`{`
`5`		`- "comment": "https://github.com/projectestac/moodle-local_oauth",`
	`5`	`+ "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",`
`6`	`6`	`"uri": "https://moodle.local/local/oauth/token.php",`
`7`	`7`	`"method": "POST",`
`8`	`8`	`"contentFormat": "json",`
`@@ -15,7 +15,7 @@`
`15`	`15`	`}`
`16`	`16`	`},`
`17`	`17`	`{`
`18`		`- "comment": "https://github.com/projectestac/moodle-local_oauth",`
	`18`	`+ "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",`
`19`	`19`	`"uri": "https://moodle.local/local/oauth/user_info.php",`
`20`	`20`	`"contentFormat": "json",`
`21`	`21`	`"contentJson": {`
`@@ -26,11 +26,14 @@`
`26`	`26`	`"lastname": "Doe",`
`27`	`27`	`"email": "[email protected]",`
`28`	`28`	`"lang": "en",`
`29`		`- "phone1": "7654321"`
	`29`	`+ "phone1": "7654321",`
	`30`	`+ "auth": "manual",`
	`31`	`+ "country": "avalon",`
	`32`	`+ "description": "John Doe's Moodle account"`
`30`	`33`	`}`
`31`	`34`	`},`
`32`	`35`	`{`
`33`		`- "comment": "https://github.com/projectestac/moodle-local_oauth",`
	`36`	`+ "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",`
`34`	`37`	`"uri": "https://zh.moodle.local/local/oauth/token.php",`
`35`	`38`	`"method": "POST",`
`36`	`39`	`"contentFormat": "json",`
`@@ -43,7 +46,7 @@`
`43`	`46`	`}`
`44`	`47`	`},`
`45`	`48`	`{`
`46`		`- "comment": "https://github.com/projectestac/moodle-local_oauth",`
	`49`	`+ "comment": "https://github.com/HIT-ReFreSH/moodle-local_oauth",`
`47`	`50`	`"uri": "https://zh.moodle.local/local/oauth/user_info.php",`
`48`	`51`	`"contentFormat": "json",`
`49`	`52`	`"contentJson": {`
`@@ -54,7 +57,10 @@`
`54`	`57`	`"lastname": "张",`
`55`	`58`	`"email": "[email protected]",`
`56`	`59`	`"lang": "zh_CN",`
`57`		`- "phone1": "7654321"`
	`60`	`+ "phone1": "7654321",`
	`61`	`+ "auth": "casattras",`
	`62`	`+ "country": "秦",`
	`63`	`+ "description": "张三的 Moodle 账号"`
`58`	`64`	`}`
`59`	`65`	`}`
`60`	`66`	`]`