generator-aspnet-oauth 6.0.0 → 8.0.0

package/README.md

@@ -1,4 +1,6 @@
-# generator-aspnet-oauth [![Build Status](https://secure.travis-ci.org/aspnet-contrib/generator-aspnet-oauth.png?branch=master)](https://travis-ci.org/aspnet-contrib/generator-aspnet-oauth)
+# generator-aspnet-oauth
+
+[![Build status](https://github.com/aspnet-contrib/generator-aspnet-oauth/workflows/build/badge.svg?branch=dev&event=push)](https://github.com/aspnet-contrib/generator-aspnet-oauth/actions?query=workflow%3Abuild+branch%3Adev+event%3Apush)
 
 > [Yeoman](http://yeoman.io) generator
 

package/generators/app/index.js

@@ -1,19 +1,18 @@
 'use strict';
-var yeoman = require('yeoman-generator');
-var chalk = require('chalk');
-var yosay = require('yosay');
+const fetch = require('cross-fetch');
+const Generator = require('yeoman-generator');
+const queryString = require('query-string');
+const yosay = require('yosay');
 
-module.exports = yeoman.generators.Base.extend({
-  initializing: function() {
-    this.templatedata = {};
+module.exports = class extends Generator {
 
-    this.log(yosay('Welcome to the classy ' + chalk.yellow('ASP.NET OAuth Provider') + ' generator!'));
-  },
-
-  prompting: function () {
-    var done = this.async();
+  initializing() {
+    this.templateData = {};
+    this.log(yosay('Welcome to the classy ASP.NET OAuth Provider generator!'));
+  }
 
-    var prompts = [{
+  async prompting() {
+    const prompts = [{
       type: 'input',
       name: 'name',
       message: 'What is the name of the provider you want to create?',
@@ -44,29 +43,76 @@ module.exports = yeoman.generators.Base.extend({
       store: true
     }];
 
-    this.prompt(prompts, function (props) {
-      this.templatedata.name = props.name;
-      this.templatedata.authorname = props.authorname;
-      this.templatedata.authorizationendpoint = props.authorizationendpoint;
-      this.templatedata.tokenendpoint = props.tokenendpoint;
-      this.templatedata.userinformationendpoint = props.userinformationendpoint;
-
-      this.name = props.name;
-      this.applicationname = 'AspNet.Security.OAuth.' + props.name
-
-      done();
-    }.bind(this));
-  },
-
-  writing: function() {
-    this.fs.copyTpl(this.templatePath('Project.csproj'), this.applicationname + '/' + this.applicationname + '.csproj', this.templatedata)
-    this.fs.copyTpl(this.templatePath('AuthenticationDefaults.cs'), this.applicationname + '/' + this.name + 'AuthenticationDefaults.cs', this.templatedata)
-    this.fs.copyTpl(this.templatePath('AuthenticationExtensions.cs'), this.applicationname + '/' + this.name + 'AuthenticationExtensions.cs', this.templatedata)
-    this.fs.copyTpl(this.templatePath('AuthenticationHandler.cs'), this.applicationname + '/' + this.name + 'AuthenticationHandler.cs', this.templatedata)
-    this.fs.copyTpl(this.templatePath('AuthenticationOptions.cs'), this.applicationname + '/' + this.name + 'AuthenticationOptions.cs', this.templatedata)
-  },
-
-  install: function () {
-    //this.installDependencies();
+    const answers = await this.prompt(prompts);
+
+    this.templateData.name = answers.name;
+    this.templateData.authorname = answers.authorname;
+    this.templateData.authorizationendpoint = answers.authorizationendpoint;
+    this.templateData.tokenendpoint = answers.tokenendpoint;
+    this.templateData.userinformationendpoint = answers.userinformationendpoint;
+
+    this.templateData.currentVersion = await this.getCurrentVersion();
+
+    this.name = answers.name;
+    this.applicationName = 'AspNet.Security.OAuth.' + answers.name;
+  }
+
+  writing() {
+    this.fs.copyTpl(this.templatePath('Project.csproj'), this.applicationName + '/' + this.applicationName + '.csproj', this.templateData)
+    this.fs.copyTpl(this.templatePath('AuthenticationDefaults.cs'), this.applicationName + '/' + this.name + 'AuthenticationDefaults.cs', this.templateData)
+    this.fs.copyTpl(this.templatePath('AuthenticationExtensions.cs'), this.applicationName + '/' + this.name + 'AuthenticationExtensions.cs', this.templateData)
+    this.fs.copyTpl(this.templatePath('AuthenticationHandler.cs'), this.applicationName + '/' + this.name + 'AuthenticationHandler.cs', this.templateData)
+    this.fs.copyTpl(this.templatePath('AuthenticationOptions.cs'), this.applicationName + '/' + this.name + 'AuthenticationOptions.cs', this.templateData)
+  }
+
+  async getCurrentVersion() {
+
+    let response = await fetch('https://api.nuget.org/v3/index.json');
+
+    if (!response.ok) {
+      throw new Error(`Failed to query NuGet service index. HTTP status code: ${response.status}.`);
+    }
+
+    const serviceIndex = await response.json();
+    const baseAddress = serviceIndex.resources.find(resource => resource['@type'] === 'SearchQueryService/3.5.0')['@id'];
+
+    if (!baseAddress) {
+      throw new Error('Failed to determine the base address for the NuGet search query service.');
+    }
+
+    const query = queryString.stringify({
+      prerelease: false,
+      q: 'PackageId:AspNet.Security.OAuth.GitHub',
+      semVerLevel: '2.0.0',
+      take: 1
+    });
+
+    const searchUrl = `${baseAddress}?${query}`;
+    response = await fetch(searchUrl);
+
+    if (!response.ok) {
+      throw new Error(`Failed to search for NuGet package from '${searchUrl}'. HTTP status code: ${response.status}.`);
+    }
+
+    const searchResult = await response.json();
+
+    let latestVersion = null;
+
+    if (searchResult.data && searchResult.data.length > 0) {
+      latestVersion = searchResult.data[0].version;
+    }
+
+    if (!latestVersion) {
+      throw new Error('Failed to determine the latest version of the OAuth providers.');
+    }
+
+    const dot = '.';
+    const versionParts = latestVersion.split(dot);
+
+    // Increment the build number by one for the release that
+    // would be the first one including this new provider.
+    versionParts[2] = parseInt(versionParts[2], 10) + 1;
+
+    return versionParts.join(dot);
   }
-});
+};

package/generators/app/templates/AuthenticationHandler.cs

@@ -18,7 +18,7 @@ namespace AspNet.Security.OAuth.<%= name %>;
 /// <summary>
 /// Defines a handler for authentication using <%= name %>.
 /// </summary>
-public class <%= name %>AuthenticationHandler : OAuthHandler<<%= name %>AuthenticationOptions>
+public partial class <%= name %>AuthenticationHandler : OAuthHandler<<%= name %>AuthenticationOptions>
 {
     /// <summary>
     /// Initializes a new instance of the <see cref="<%= name %>AuthenticationHandler"/> class.
@@ -26,13 +26,11 @@ public class <%= name %>AuthenticationHandler : OAuthHandler<<%= name %>Authenti
     /// <param name="options">The authentication options.</param>
     /// <param name="logger">The logger to use.</param>
     /// <param name="encoder">The URL encoder to use.</param>
-    /// <param name="clock">The system clock to use.</param>
     public <%= name %>AuthenticationHandler(
         [NotNull] IOptionsMonitor<<%= name %>AuthenticationOptions> options,
         [NotNull] ILoggerFactory logger,
-        [NotNull] UrlEncoder encoder,
-        [NotNull] ISystemClock clock)
-        : base(options, logger, encoder, clock)
+        [NotNull] UrlEncoder encoder)
+        : base(options, logger, encoder)
     {
     }
 
@@ -45,23 +43,18 @@ public class <%= name %>AuthenticationHandler : OAuthHandler<<%= name %>Authenti
         var endpoint = Options.UserInformationEndpoint;
 
         // TODO Append any additional query string parameters required
-        //endpoint = QueryHelpers.AddQueryString(endpoint, "token", tokens.AccessToken);
+        ////endpoint = QueryHelpers.AddQueryString(endpoint, "token", tokens.AccessToken);
 
         using var request = new HttpRequestMessage(HttpMethod.Get, endpoint);
         request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
 
         // TODO Add any HTTP request headers required
-        //request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokens.AccessToken);
+        ////request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", tokens.AccessToken);
 
         using var response = await Backchannel.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, Context.RequestAborted);
         if (!response.IsSuccessStatusCode)
         {
-            Logger.LogError("An error occurred while retrieving the user profile: the remote server " +
-                            "returned a {Status} response with the following payload: {Headers} {Body}.",
-                            /* Status: */ response.StatusCode,
-                            /* Headers: */ response.Headers.ToString(),
-                            /* Body: */ await response.Content.ReadAsStringAsync());
-
+            await Log.UserProfileErrorAsync(Logger, response, Context.RequestAborted);
             throw new HttpRequestException("An error occurred while retrieving the user profile from <%= name %>.");
         }
 
@@ -74,4 +67,23 @@ public class <%= name %>AuthenticationHandler : OAuthHandler<<%= name %>Authenti
         await Events.CreatingTicket(context);
         return new AuthenticationTicket(context.Principal!, context.Properties, Scheme.Name);
     }
+
+    private static partial class Log
+    {
+        internal static async Task UserProfileErrorAsync(ILogger logger, HttpResponseMessage response, CancellationToken cancellationToken)
+        {
+            UserProfileError(
+                logger,
+                response.StatusCode,
+                response.Headers.ToString(),
+                await response.Content.ReadAsStringAsync(cancellationToken));
+        }
+
+        [LoggerMessage(1, LogLevel.Error, "An error occurred while retrieving the user profile: the remote server returned a {Status} response with the following payload: {Headers} {Body}.")]
+        private static partial void UserProfileError(
+            ILogger logger,
+            System.Net.HttpStatusCode status,
+            string headers,
+            string body);
+    }
 }

package/generators/app/templates/Project.csproj

@@ -1,9 +1,15 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <PackageValidationBaselineVersion><%= currentVersion %></PackageValidationBaselineVersion>
     <TargetFrameworks>$(DefaultNetCoreTargetFramework)</TargetFrameworks>
   </PropertyGroup>
 
+  <!-- This property group is required until the new provider is first published to NuGet.org -->
+  <PropertyGroup>
+    <DisablePackageBaselineValidation>true</DisablePackageBaselineValidation>
+  </PropertyGroup>
+
   <PropertyGroup>
     <Description>ASP.NET Core security provider enabling <%= name %> authentication.</Description>
     <Authors><%= authorname %></Authors>

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "generator-aspnet-oauth",
-  "version": "6.0.0",
+  "version": "8.0.0",
   "description": "Yeoman generator for OAuth Providers for ASP.NET Core",
   "license": "MIT",
   "main": "app/index.js",
   "repository": "aspnet-contrib/generator-aspnet-oauth",
+  "engines": {
+    "node": ">=14"
+  },
   "author": {
     "name": "Jerrie Pelser",
     "email": "jerrie@jerriepelser.com",
@@ -23,11 +26,15 @@
     "oauth"
   ],
   "dependencies": {
-    "yeoman-generator": "^0.19.0",
-    "chalk": "^1.0.0",
-    "yosay": "^1.0.2"
+    "cross-fetch": "^3.1.5",
+    "query-string": "^7.1.1",
+    "yosay": "^2.0.2",
+    "yeoman-generator": "^5.7.0"
   },
   "devDependencies": {
-    "mocha": "*"
+    "glob": "^8.0.3",
+    "mocha": "^10.1.0",
+    "yeoman-assert": "^3.1.1",
+    "yeoman-test": "^6.3.0"
   }
 }