Merge pull request #64 from chris-steele/develop

Added unregister and rename commands

Author: chris-steele

README.md

@@ -80,8 +80,35 @@ From within a plugin directory
 
 The package will be registered with the registry on a first come first serve basis.
 
+##### Unregister a plugin
+
+From within a plugin directory
+
+    adapt unregister
+
+`name` will be read from `bower.json` in the current directory
+
+Alternatively, from any directory
+
+    adapt unregister <plugin name>
+
+You will be prompted to authenticate with GitHub.
+
+The package will be unregistered with the registry if the authenticated user is a collaborator on the given endpoint or a collaborator on the Adapt framework.
+
+##### Rename a plugin
+
+From any directory
+
+    adapt rename <plugin name> <new plugin name>
+
+You will be prompted to authenticate with GitHub.
+
+The package will be renamed if the authenticated user is a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework.
+
 Release History
 ===============
+- 2.0.5 - Added rename and unregister commands and corrected some typos
 - 2.0.4 - Corrected version numbers
 - 2.0.3 - Fixed issue#53 - npm dependency is git url
 - 2.0.2 - Fixed issue#32 - Error: Cannot find module 'Q' on case sensitive file systems

VERSION

@@ -1 +1 @@
-2.0.4
+2.0.5

json/help-register.json

@@ -1,6 +1,6 @@
 {
     "command": "register",
-    "description": "Register a plugin to adapt's remote registory by reading bower.json file. Check folowing URL for more detail - https://github.com/adaptlearning/adapt_framework/wiki/Registering-a-plugin",
+    "description": "Register a plugin to adapt's remote registry by reading bower.json file. Check folowing URL for more detail - https://github.com/adaptlearning/adapt_framework/wiki/Registering-a-plugin",
     "usage": [
         "register"
     ]

json/help-rename.json

@@ -0,0 +1,7 @@
+{
+    "command": "rename",
+    "description": "Unregister a plugin at Adapt's remote registry. Specify as two arguments the current name of the plugin to be renamed and a new name. Please note that you must authenticate with GitHub to unregister and must be a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework. Access to GitHub is for authentication only.",
+    "usage": [
+        "rename <plugin name> <new plugin name>"
+    ]
+}

json/help-search.json

@@ -1,6 +1,6 @@
 {
     "command": "search",
-    "description": "List out all the plugin(s) in adapt's remote registory or could also search a plugin with supplied partial name.",
+    "description": "List out all the plugin(s) in adapt's remote registry or could also search a plugin with supplied partial name.",
     "usage": [
         "search",
         "search <plugin-name>"

json/help-unregister.json

@@ -0,0 +1,8 @@
+{
+    "command": "unregister",
+    "description": "Unregister a plugin at Adapt's remote registry. This command can be run without arguments in a directory which contains the bower.json file for the plugin to be unregistered. Alternatively, specify the name of the plugin as a single argument. Please note that you must authenticate with GitHub to unregister and must be a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework. Access to GitHub is for authentication only.",
+    "usage": [
+        "unregister",
+        "unregister <plugin name>"
+    ]
+}

json/help.json

@@ -3,14 +3,16 @@
         "<command>"
     ],
     "commands": {
-        "create":          "Create a new adapt course or plugin",
-        "devinstall":      "Get the framework and plugins as git repository",
+        "create":          "Create a new Adapt course or plugin",
+        "devinstall":      "Get the framework and plugins as Git repository",
         "help":            "List out the commands available with adapt-cli",
-        "install":         "Install plugin(s) within the adapt course directory",
-        "ls":              "List all the plugins name mentioned in adapt.json",
-        "register":        "Register a plugins to adapt remote registory",
-        "search":          "List/Search for plugin(s) from remote registory",
+        "install":         "Install plugin(s) within the Adapt course directory",
+        "ls":              "List all the plugin names mentioned in adapt.json",
+        "rename":          "Rename a plugin at the Adapt remote registry",
+        "register":        "Register a plugin with the Adapt remote registry",
+        "search":          "List/Search for plugin(s) at the Adapt remote registry",
         "uninstall":       "Remove a local plugin",
+        "unregister":      "Unregister a plugin from the Adapt remote registry",
         "version":         "Display version of adapt-cli"
     }
 }

lib/commands/register.js

@@ -27,6 +27,10 @@ module.exports = {
             return properties;
         })
         .then(function (properties) {
+            // given a package name, create two Plugin representations
+            // if supplied name is adapt-contrib-myPackageName do a check against this name only
+            // if suppled name is adapt-myPackageName check against this name and adapt-contrib-myPackageName
+            // becase we don't want to allow adapt-myPackageName if adapt-contrib-myPackageName exists
             var plugin = new Plugin(properties.name),
                 contribPlugin = new Plugin(properties.name, true),
                 searches = [exists(contribPlugin)];
@@ -49,11 +53,13 @@ module.exports = {
         .then(function (registered) {
             if(!registered.result) throw new Error('The plugin was unable to register.');
             renderer.log(chalk.green(registered.plugin.packageName), 'has been registered successfully.');
+            done();
         })
         .fail(function (err) {
             renderer.log(chalk.red(err));
             done(err);
-        });
+        })
+        .done();
     }
 };
 
@@ -93,29 +99,29 @@ function confirm(properties) {
         schema = {
             properties: {
                 name: {
-                    description: 'name',
+                    description: chalk.cyan('name'),
                     pattern: /^adapt-[\w|-]+?$/,
                     message: "Name must prefixed with 'adapt' and each word separated with a hyphen(-)",
                     type: 'string',
                     default: plugin.toString() || 'not specified',
                     required: true
                 },
                 repository: {
-                    description: 'repository',
+                    description: chalk.cyan('repository'),
                     pattern: /([A-Za-z0-9]+@|http(|s)|git\:\/\/)([A-Za-z0-9.]+)(:|\/)([A-Za-z0-9\-\.\/]+)(\.git)?/,
                     type: 'string',
                     default: properties.repository || 'not specified',
                     required: true
                 },
                 framework: {
-                    description: 'framework',
+                    description: chalk.cyan('framework'),
                     pattern: /\bv?(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)(?:-[\da-z\-]+(?:\.[\da-z\-]+)*)?(?:\+[\da-z\-]+(?:\.[\da-z\-]+)*)?\b/ig,
                     type: 'string',
                     default: properties.framework || '~2.0.0',
                     required: false
                 },
                 ready: {
-                    description: 'Register now?',
+                    description: chalk.cyan('Register now?'),
                     message: 'Please specify (y)es or (n)o',
                     pattern: /^y$|^n$/i,
                     type: 'string',

lib/commands/rename.js

@@ -0,0 +1,138 @@
+var bower = require('bower'),
+    chalk = require('chalk'),
+    _ = require('lodash'),
+    prompt = require('prompt'),
+    Q = require('q'),
+    request = require('request'),
+    Constants = require('../Constants'),
+    Plugin = require('../Plugin'),
+    authenticate = require('../promise/authenticate'),
+    log;
+
+module.exports = {
+    rename: function (renderer) {
+        log = renderer.log;
+
+        var done = arguments[arguments.length-1] || function () {};
+        
+        if (arguments.length >= 4) {
+            var params = {
+                oldName:arguments[1],
+                newName:arguments[2]
+            };
+
+            // use Plugin to standardise name
+            params.newName = new Plugin(params.newName).packageName;
+
+            log(chalk.yellow('Using registry at', Constants.Registry));
+            log(chalk.yellow('Plugin will be renamed to', params.newName));
+
+             Q(params)
+            .then(checkPluginNameExists)
+            .then(checkNewPluginNameDoesNotExist)
+            .then(authenticate)
+            .then(confirm)
+            .then(rename)
+            .then(function() {
+                log(chalk.green('The plugin was successfully renamed.'));
+                done();
+            })
+            .catch(function (err) {
+                log(chalk.red(err));
+                log('The plugin was not renamed.');
+                done(err);
+            })
+            .done();
+
+        } else {
+            log(chalk.red('You must call rename with the following arguments: <plugin name> <new plugin name>'));
+            done();
+        }
+    }
+};
+
+function checkPluginNameExists(params) {
+    return exists(params.oldName).then(function(exists) {
+        return exists ? Q.resolve(params) : Q.reject('Plugin "'+params.oldName+'" does not exist');
+    });
+}
+
+function checkNewPluginNameDoesNotExist(params) {
+    return exists(params.newName).then(function(exists) {
+        return exists ? Q.reject('Name "'+params.newName+'" already exists') : Q.resolve(params);
+    });
+}
+
+function confirm(params) {
+    var deferred = Q.defer();
+    var schema = {
+        properties: {
+            ready: {
+                description: chalk.cyan('Confirm rename now?'),
+                message: 'Please specify (y)es or (n)o',
+                pattern: /^y$|^n$/i,
+                type: 'string',
+                default: 'y',
+                required: true,
+                before: function(value) { return /^y$/i.test(value); }
+            }
+        }
+    };
+    prompt.message = '';
+    prompt.delimiter = ' ';
+    prompt.start();
+    prompt.get(schema, function (err, confirmation) {
+        if(err) return deferred.reject(err);
+        if(!confirmation.ready) deferred.reject(new Error('Aborted. Nothing has been renamed.'));
+        deferred.resolve(params);
+    });
+    return deferred.promise;
+}
+
+function rename(params) {
+    var deferred = Q.defer();
+    var path = 'packages/rename/'+params.username+'/'+params.oldName+'/'+params.newName;
+    var query = '?access_token='+params.token;
+
+    request({
+        url: Constants.Registry+'/'+path+query,
+        method:'GET',
+        headers: {'User-Agent':'adapt-cli'},
+        followRedirect:false
+    }, function(err, res, body) {
+        if (err) {
+            deferred.reject(err);
+        } else {
+            res.statusCode==201 ? deferred.resolve(params) : deferred.reject("The server responded with "+res.statusCode);
+        }
+    });
+
+    return deferred.promise;
+}
+
+function exists(plugin) {
+    var deferred = Q.defer();
+
+    bower.commands.search(plugin.toString(),  { registry: Constants.Registry })
+    .on('end', function(result) {
+        var matches = result.filter(exactMatch(plugin.toString()));
+        deferred.resolve(!!matches.length);
+    })
+    .on('error', function (err) {
+        deferred.reject(err);
+    });
+    return deferred.promise;
+}
+
+function exactMatch(pattern) {
+    return function (item) {
+        if (typeof pattern === 'string') {
+            if (pattern.toLowerCase() === item.name.toLowerCase()) {
+                return true;
+            } 
+            return false
+        }
+        var regexp = new RegExp(pattern, 'i');
+        return regexp.test(item.name);
+    };
+}