getRole renamed to fetchRole, getProfile renamed to fetchProfile

Author: xbill82

src/security/kuzzleSecurity.js

@@ -47,13 +47,13 @@ function Security(kuzzle) {
  * @param {object|responseCallback} [options] - Optional parameters
  * @param {responseCallback} [cb] - returns Kuzzle's response
  */
-Security.prototype.getRole = function (id, options, cb) {
+Security.prototype.fetchRole = function (id, options, cb) {
   var
     data,
     self = this;
 
   if (!id) {
-    throw new Error('Id parameter is mandatory for getRole function');
+    throw new Error('Id parameter is mandatory for fetchRole function');
   }
 
   if (!cb && typeof options === 'function') {
@@ -63,9 +63,9 @@ Security.prototype.getRole = function (id, options, cb) {
 
   data = {_id: id};
 
-  self.kuzzle.callbackRequired('Security.getRole', cb);
+  self.kuzzle.callbackRequired('Security.fetchRole', cb);
 
-  self.kuzzle.query(this.buildQueryArgs('getRole'), data, options, function (err, response) {
+  self.kuzzle.query(this.buildQueryArgs('fetchRole'), data, options, function (err, response) {
     cb(err, err ? undefined : new Role(self, response.result._id, response.result._source));
   });
 };
@@ -229,7 +229,7 @@ Security.prototype.role = function(id, content) {
  * @param {object|responseCallback} [options] - (optional) arguments
  * @param {responseCallback} cb - returns Kuzzle's response
  */
-Security.prototype.getProfile = function (id, options, cb) {
+Security.prototype.fetchProfile = function (id, options, cb) {
   var
     data,
     self = this;
@@ -240,15 +240,15 @@ Security.prototype.getProfile = function (id, options, cb) {
   }
 
   if (!id || typeof id !== 'string') {
-    throw new Error('Id parameter is mandatory for getProfile function');
+    throw new Error('Id parameter is mandatory for fetchProfile function');
   }
 
 
   data = {_id: id};
 
-  self.kuzzle.callbackRequired('Security.getProfile', cb);
+  self.kuzzle.callbackRequired('Security.fetchProfile', cb);
 
-  self.kuzzle.query(this.buildQueryArgs('getProfile'), data, options, function (error, response) {
+  self.kuzzle.query(this.buildQueryArgs('fetchProfile'), data, options, function (error, response) {
     cb(error, error ? undefined : new Profile(self, response.result._id, response.result._source));
   });
 };

test/security/kuzzleSecurity/constructor.test.js

@@ -24,11 +24,11 @@ describe('kuzzleSecurity constructor', function () {
     kuzzle = new Kuzzle('foo');
 
     should.exist(kuzzle.security.createRolePromise);
-    should.exist(kuzzle.security.getRolePromise);
+    should.exist(kuzzle.security.fetchRolePromise);
     should.exist(kuzzle.security.searchRolesPromise);
     should.exist(kuzzle.security.deleteRolePromise);
     should.exist(kuzzle.security.createProfilePromise);
-    should.exist(kuzzle.security.getProfilePromise);
+    should.exist(kuzzle.security.fetchProfilePromise);
     should.exist(kuzzle.security.searchProfilesPromise);
     should.exist(kuzzle.security.deleteProfilePromise);
     should.exist(kuzzle.security.createUserPromise);

test/security/kuzzleSecurity/profilesMethods.test.js

@@ -40,7 +40,7 @@ describe('Security profiles methods', function () {
       }
     };
 
-  describe('#getProfile', function () {
+  describe('#fetchProfile', function () {
     beforeEach(function () {
       kuzzle = new Kuzzle('foo', {defaultIndex: 'bar'});
       kuzzle.query = queryStub;
@@ -60,14 +60,14 @@ describe('Security profiles methods', function () {
         }
       };
       expectedQuery = {
-        action: 'getProfile',
+        action: 'fetchProfile',
         controller: 'security',
         _id: 'foobar'
       };
     });
 
     it('should send the right query to Kuzzle', function (done) {
-      should(kuzzle.security.getProfile(result.result._id, function (err, res) {
+      should(kuzzle.security.fetchProfile(result.result._id, function (err, res) {
         should(err).be.null();
         should(res).be.instanceof(Profile);
 
@@ -83,7 +83,7 @@ describe('Security profiles methods', function () {
     });
 
     it('should send the right query to Kuzzle with id as roles when hydrate is false', function (done) {
-      should(kuzzle.security.getProfile(result.result._id, function (err, res) {
+      should(kuzzle.security.fetchProfile(result.result._id, function (err, res) {
         should(err).be.null();
         should(res).be.instanceof(Profile);
 
@@ -103,18 +103,18 @@ describe('Security profiles methods', function () {
     });
 
     it('should raise an error if no callback is provided', function () {
-      should(function () { kuzzle.security.getProfile('test'); }).throw(Error);
+      should(function () { kuzzle.security.fetchProfile('test'); }).throw(Error);
     });
 
     it('should throw an error when no id is provided', function () {
-      should(function () { kuzzle.security.getProfile(null, function () {}); }).throw(Error);
+      should(function () { kuzzle.security.fetchProfile(null, function () {}); }).throw(Error);
     });
 
     it('should call the callback with an error if one occurs', function (done) {
       error = 'error';
       this.timeout(50);
 
-      kuzzle.security.getProfile('foobar', function (err, res) {
+      kuzzle.security.fetchProfile('foobar', function (err, res) {
         should(err).be.exactly('error');
         should(res).be.undefined();
         done();

test/security/kuzzleSecurity/rolesMethods.test.js

@@ -40,40 +40,40 @@ describe('Security roles methods', function () {
       }
     };
 
-  describe('#getRole', function () {
+  describe('#fetchRole', function () {
     beforeEach(function () {
       kuzzle = new Kuzzle('foo', {defaultIndex: 'bar'});
       kuzzle.query = queryStub;
       error = null;
       result = { result: {_id: 'foobar', _source: {} }};
       expectedQuery = {
-        action: 'getRole',
+        action: 'fetchRole',
         controller: 'security',
         _id: 'foobar'
       };
     });
 
     it('should send the right query to Kuzzle', function (done) {
-      should(kuzzle.security.getRole(result.result._id, function (err, res) {
+      should(kuzzle.security.fetchRole(result.result._id, function (err, res) {
         should(err).be.null();
         should(res).be.instanceof(Role);
         done();
       }));
     });
 
     it('should raise an error if no callback is provided', function () {
-      should(function () { kuzzle.security.getRole('test'); }).throw(Error);
+      should(function () { kuzzle.security.fetchRole('test'); }).throw(Error);
     });
 
     it('should throw an error when no id is provided', function () {
-      should(function () { kuzzle.security.getRole(null, function () {}); }).throw(Error);
+      should(function () { kuzzle.security.fetchRole(null, function () {}); }).throw(Error);
     });
 
     it('should call the callback with an error if one occurs', function (done) {
       error = 'error';
       this.timeout(50);
 
-      kuzzle.security.getRole('foobar', function (err, res) {
+      kuzzle.security.fetchRole('foobar', function (err, res) {
         should(err).be.exactly('error');
         should(res).be.undefined();
         done();