[rename-resource-owner-password-grant] Rename resource owner password grant public API

Author: jonathansamines

API.md

@@ -60,7 +60,7 @@ Additional options will be automatically serialized as params for the token requ
 
 * `httpOptions` All [wreck](https://github.com/hapijs/wreck) options can be overriden as documented by the module `http` options.
 
-### new PasswordOwner(options)
+### new ResourceOwnerPassword(options)
 This submodule provides support for the OAuth2 [Resource Owner Password Credentials](https://oauth.net/2/grant-types/password/) grant type.
 
 #### .getToken(params, [httpOptions]) => Promise<AccessToken>

README.md

@@ -59,7 +59,7 @@ const config = {
   }
 };
 
-const { ClientCredentials, PasswordOwner, AuthorizationCode } = require('simple-oauth2');
+const { ClientCredentials, ResourceOwnerPassword, AuthorizationCode } = require('simple-oauth2');
 ```
 
 For a complete reference of configuration options, see the [API Options](./API.md#options)
@@ -109,7 +109,7 @@ The [Resource Owner Password Credentials](https://oauth.net/2/grant-types/passwo
 
 ```javascript
 async function run() {
-  const client = new PasswordOwner(config);
+  const client = new ResourceOwnerPassword(config);
 
   const tokenParams = {
     username: 'username',
@@ -127,7 +127,7 @@ async function run() {
 run();
 ```
 
-See the [API reference](./API.md#new-passwordowneroptions) for a complete reference of available options.
+See the [API reference](./API.md#new-resourceownerpasswordoptions) for a complete reference of available options.
 
 #### Client Credentials Grant
 

index.js

@@ -3,7 +3,7 @@
 const Client = require('./lib/client');
 const Config = require('./lib/config');
 const AuthorizationCodeGrant = require('./lib/grants/authorization-code');
-const PasswordOwnerGrant = require('./lib/grants/password-owner');
+const ResourceOwnerPasswordGrant = require('./lib/grants/resource-owner-password');
 const ClientCredentialsGrant = require('./lib/grants/client-credentials');
 
 class AuthorizationCode extends AuthorizationCodeGrant {
@@ -24,7 +24,7 @@ class ClientCredentials extends ClientCredentialsGrant {
   }
 }
 
-class PasswordOwner extends PasswordOwnerGrant {
+class ResourceOwnerPassword extends ResourceOwnerPasswordGrant {
   constructor(options) {
     const config = Config.apply(options);
     const client = new Client(config);
@@ -34,7 +34,7 @@ class PasswordOwner extends PasswordOwnerGrant {
 }
 
 module.exports = {
-  PasswordOwner,
+  ResourceOwnerPassword,
   ClientCredentials,
   AuthorizationCode,
 };

lib/grants/password-owner.js renamed to lib/grants/resource-owner-password.js

@@ -3,7 +3,7 @@
 const GrantParams = require('../grant-params');
 const AccessToken = require('../access-token');
 
-module.exports = class PasswordOwner {
+module.exports = class ResourceOwnerPassword {
   #config = null;
   #client = null;
 

test/index.js

@@ -2,19 +2,19 @@
 
 const test = require('ava');
 
-const { PasswordOwner, ClientCredentials, AuthorizationCode } = require('../index');
+const { ResourceOwnerPassword, ClientCredentials, AuthorizationCode } = require('../index');
 const { createModuleConfig } = require('./_module-config');
 
 test('@create => throws a validation error when no configuration is provided', (t) => {
-  t.throws(() => new PasswordOwner());
+  t.throws(() => new ResourceOwnerPassword());
   t.throws(() => new ClientCredentials());
   t.throws(() => new AuthorizationCode());
 });
 
 test('@create => creates a new instance with the minimal required configuration', (t) => {
   const config = createModuleConfig();
 
-  t.notThrows(() => new PasswordOwner(config));
+  t.notThrows(() => new ResourceOwnerPassword(config));
   t.notThrows(() => new ClientCredentials(config));
   t.notThrows(() => new AuthorizationCode(config));
 });
@@ -27,7 +27,7 @@ test('@create => creates a new instance with empty credentials', (t) => {
     },
   });
 
-  t.notThrows(() => new PasswordOwner(config));
+  t.notThrows(() => new ResourceOwnerPassword(config));
   t.notThrows(() => new ClientCredentials(config));
   t.notThrows(() => new AuthorizationCode(config));
 });
@@ -40,7 +40,7 @@ test('@create => creates a new instance with visual non-control characters', (t)
     },
   });
 
-  t.notThrows(() => new PasswordOwner(config));
+  t.notThrows(() => new ResourceOwnerPassword(config));
   t.notThrows(() => new ClientCredentials(config));
   t.notThrows(() => new AuthorizationCode(config));
 });

test/password-owner.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const test = require('ava');
-const { PasswordOwner } = require('../index');
+const { ResourceOwnerPassword } = require('../index');
 const AccessToken = require('../lib/access-token');
 const { createModuleConfig } = require('./_module-config');
 const {
@@ -36,7 +36,7 @@ test.serial('@getToken => resolves to an access token (body credentials and JSON
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -68,7 +68,7 @@ test.serial('@getToken => resolves to an access token (body credentials and form
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -97,7 +97,7 @@ test.serial('@getToken => resolves to an access token (header credentials)', asy
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -136,7 +136,7 @@ test.serial('@getToken => resolves to an access token with custom module configu
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -175,7 +175,7 @@ test.serial('@getToken => resolves to an access token with custom module configu
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -205,7 +205,7 @@ test.serial('@getToken => resolves to an access token with custom module configu
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -243,7 +243,7 @@ test.serial('@getToken => resolves to an access token with custom module configu
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const accessToken = await oauth2.getToken(tokenParams);
 
   scope.done();
@@ -274,7 +274,7 @@ test.serial('@getToken => resolves to an access token with custom module configu
     },
   });
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const accessToken = await oauth2.getToken(tokenParams);
 
@@ -301,7 +301,7 @@ test.serial('@getToken => resolves to an access token while following redirectio
   };
 
   const config = createModuleConfig();
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const accessToken = await oauth2.getToken(tokenParams);
 
@@ -330,7 +330,7 @@ test.serial('@getToken => resolves to an access token while requesting multiple
   };
 
   const config = createModuleConfig();
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const accessToken = await oauth2.getToken(tokenParams);
 
@@ -356,7 +356,7 @@ test.serial('@getToken => resolves to an access token with a custom grant type',
   };
 
   const config = createModuleConfig();
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const accessToken = await oauth2.getToken(tokenParams);
 
@@ -374,7 +374,7 @@ test.serial('@getToken => resolves to an access token with no params', async (t)
   const scope = server.tokenSuccess(scopeOptions, tokenRequestParams);
 
   const config = createModuleConfig();
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const accessToken = await oauth2.getToken();
 
@@ -397,7 +397,7 @@ test.serial('@getToken => resolves to an access token with custom (inline) http
   const scope = server.tokenSuccess(scopeOptions, tokenRequestParams);
 
   const config = createModuleConfig();
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const httpOptions = {
     headers: {
@@ -421,7 +421,7 @@ test.serial('@getToken => resolves to an access token with custom (inline) http
   const scope = server.tokenSuccess(scopeOptions, tokenRequestParams);
 
   const config = createModuleConfig();
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
 
   const httpOptions = {
     headers: {
@@ -460,7 +460,7 @@ test.serial('@getToken => rejects the operation when a non json response is rece
     password: 'secret',
   };
 
-  const oauth2 = new PasswordOwner(config);
+  const oauth2 = new ResourceOwnerPassword(config);
   const error = await t.throwsAsync(() => oauth2.getToken(tokenParams));
 
   scope.done();