Implement InsufficientScopeError

Author: maxtruxa

lib/errors/insufficient-scope-error.js

@@ -0,0 +1,38 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+var _ = require('lodash');
+var OAuthError = require('./oauth-error');
+var util = require('util');
+
+/**
+ * Constructor.
+ *
+ * "The request requires higher privileges than provided by the access token.."
+ *
+ * @see https://tools.ietf.org/html/rfc6750.html#section-3.1
+ */
+
+function InsufficientScopeError(message, properties) {
+  properties = _.assign({
+    code: 403,
+    name: 'insufficient_scope'
+  }, properties);
+
+  OAuthError.call(this, message, properties);
+}
+
+/**
+ * Inherit prototype.
+ */
+
+util.inherits(InsufficientScopeError, OAuthError);
+
+/**
+ * Export constructor.
+ */
+
+module.exports = InsufficientScopeError;

lib/handlers/authenticate-handler.js

@@ -6,7 +6,7 @@
 
 var InvalidArgumentError = require('../errors/invalid-argument-error');
 var InvalidRequestError = require('../errors/invalid-request-error');
-var InvalidScopeError = require('../errors/invalid-scope-error');
+var InsufficientScopeError = require('../errors/insufficient-scope-error');
 var InvalidTokenError = require('../errors/invalid-token-error');
 var OAuthError = require('../errors/oauth-error');
 var Promise = require('bluebird');
@@ -232,13 +232,14 @@ AuthenticateHandler.prototype.validateAccessToken = function(accessToken) {
  */
 
 AuthenticateHandler.prototype.verifyScope = function(accessToken) {
-  return promisify(this.model.verifyScope, 2)(accessToken, this.scope).then(function(scope) {
-    if (!scope) {
-      throw new InvalidScopeError('Invalid scope: scope is invalid');
-    }
+  return promisify(this.model.verifyScope, 2)(accessToken, this.scope)
+    .then(function(scope) {
+      if (!scope) {
+        throw new InsufficientScopeError('Insufficient scope: authorized scope is insufficient');
+      }
 
-    return scope;
-  });
+      return scope;
+    });
 };
 
 /**

test/integration/handlers/authenticate-handler_test.js

@@ -8,7 +8,7 @@ var AccessDeniedError = require('../../../lib/errors/access-denied-error');
 var AuthenticateHandler = require('../../../lib/handlers/authenticate-handler');
 var InvalidArgumentError = require('../../../lib/errors/invalid-argument-error');
 var InvalidRequestError = require('../../../lib/errors/invalid-request-error');
-var InvalidScopeError = require('../../../lib/errors/invalid-scope-error');
+var InsufficientScopeError = require('../../../lib/errors/insufficient-scope-error');
 var InvalidTokenError = require('../../../lib/errors/invalid-token-error');
 var Promise = require('bluebird');
 var Request = require('../../../lib/request');
@@ -447,7 +447,7 @@ describe('AuthenticateHandler integration', function() {
   });
 
   describe('verifyScope()', function() {
-    it('should throw an error if `scope` is invalid', function() {
+    it('should throw an error if `scope` is insufficient', function() {
       var model = {
         getAccessToken: function() {},
         verifyScope: function() {
@@ -459,8 +459,8 @@ describe('AuthenticateHandler integration', function() {
       return handler.verifyScope('foo')
         .then(should.fail)
         .catch(function(e) {
-          e.should.be.an.instanceOf(InvalidScopeError);
-          e.message.should.equal('Invalid scope: scope is invalid');
+          e.should.be.an.instanceOf(InsufficientScopeError);
+          e.message.should.equal('Insufficient scope: authorized scope is insufficient');
         });
     });