Merge branch 'master' of github.com:/jquery/plugins.jquery.com

Author: rdworth

.gitignore

@@ -1,2 +1,3 @@
 config.json
+plugins.db
 node_modules

README.md

@@ -18,7 +18,7 @@ Simply add a [post-receive hook](http://help.github.com/post-receive-hooks/) to
 * jQuery's [web-base-template](https://github.com/jquery/web-base-template)
 * Web server (such as Apache)
 * PHP
-* MySql
+* MySQL
 * WordPress
 * node
 * git
@@ -27,13 +27,15 @@ Simply add a [post-receive hook](http://help.github.com/post-receive-hooks/) to
 
 ### web-base-template
 
-Download or clone web-base-template
+1. Download or clone web-base-template
 
-`git clone git://github.com/jquery/web-base-template.git`
+    * `git clone git://github.com/jquery/web-base-template.git`
 
 #### HOSTS
 
-Add a `plugins.jquery.com.local` entry in /etc/hosts
+1. Add a `plugins.jquery.com.local` entry in /etc/hosts
+
+    * `127.0.0.1 plugins.jquery.com.local`
 
 #### WordPress
 
@@ -78,16 +80,12 @@ From http://plugins.jquery.com.local/wp-admin/
 
 3. `npm install`
 
-4. `mkdir -p tmp/plugin-repos`
-
-5. `cp src/config-sample.json src/config.json`
+4. `cp src/config-sample.json src/config.json`
 
-6. Edit src/config.json
-    * Set `dbHost` to the hostname of your WordPress MySQL server
-    * Set `dbPort` to your MySQL port (usually 3306)
-    * Set `dbName` to the MySQL user name
-    * Set `dbUser` to the MySQL password
+5. Edit src/config.json
+    * Set `dbName` to your WordPress MySQL database name
+    * Set `dbUser` to your WordPress MySQL database user
+    * Set `dbPassword` to your WordPress MySQL database password
     * Leave `siteId` null (unless you happen to be using a Wordpress multi-site installation locally, in which case supply the site's ID in the multi-site install)
 
-7. `node src/main.js` 
-
+6. `node src/main.js` 

docs/package.md

@@ -22,6 +22,7 @@ file. It must be actual JSON, not just a JavaScript object literal.
 * <a href="#field-description">description</a>
 * <a href="#field-keywords">keywords</a>
 * <a href="#field-homepage">homepage</a>
+* <a href="#field-contributors">contributors</a>
 * <a href="#field-files">files</a>
 
 ## <a name="field-name">name</a>
@@ -125,7 +126,7 @@ discover your plugin as it's listed on the jQuery Plugins Site.
 
 The url to the plugin homepage.
 
-## <a name="field-conbtributors">people fields: author, contributors</a>
+## <a name="field-contributors">contributors</a>
 
 An array of people.
 
@@ -216,3 +217,47 @@ The following are equivalent:
 
 You may not supply a comparator with a version containing an x. Any
 digits after the first "x" are ignored.
+
+## <a href="sample">Sample package.json</a>
+
+```json
+{
+    "name": "color",
+    "version": "2.0.0b1",
+    "title": "jQuery.Color()",
+    "author": {
+        "name": "John Resig",
+        "url": "https://github.com/jeresig"
+    },
+    "licenses": [
+        {
+            "type": "MIT",
+            "url": "MIT-LICENSE.txt"
+        },
+        {
+            "type": "GPL",
+            "url": "GPL-LICENSE.txt"
+        }
+    ],
+    "dependencies": {
+        "jquery": "1"
+    },
+    "description": "The main purpose of this plugin to animate color properties on elements using jQuery's .animate()",
+    "keywords": [
+        "color",
+        "animate",
+        "rgba",
+        "hsla"
+    ],
+    "homepage": "https://github.com/jquery/jquery-color",
+    "contributors": [
+        {
+            "name": "Corey Frang",
+            "url": "https://github.com/gnarf37"
+        }
+    ],
+    "files": [
+        "jquery.color.js"
+    ]
+}
+```

package.json

@@ -12,7 +12,8 @@
   "dependencies": {
     "mkdirp": "0.2.1",
     "mysql": "0.9.5",
-    "semver": "1.0.12"
+    "semver": "1.0.12",
+    "sqlite3": "2.1.1"
   },
   "engines": {
     "node": "0.6.5"

src/config-sample.json

@@ -1,6 +1,6 @@
 {
 	"repoDir": "/tmp/plugin-repos",
-	"pluginsDir": "/tmp/plugin-data",
+	"pluginsDb": "plugins.db",
 	"dbHost": "localhost",
 	"dbPort": 3306,
 	"dbName": "mysql",

src/main.js

@@ -1,9 +1,10 @@
 var exec = require( "child_process" ).exec,
 	fs = require( "fs" ),
 	mkdirp = require( "mkdirp" ),
-	template = require( "./template" ),
 	semver = require( "semver" ),
-	wordpress = require( "./wordpress" )
+	template = require( "./template" ),
+	wordpress = require( "./wordpress" ),
+	pluginsDb = require( "./pluginsdb" ),
 	config = require( "./config" );
 
 
@@ -234,8 +235,6 @@ function validatePackageJson( package, version ) {
 		errors.push( "Missing required dependency: jquery." );
 	}
 
-	// TODO: validate repo (must match actual GitHub repo)
-
 	return errors;
 }
 
@@ -284,11 +283,11 @@ function processPlugin( repo, fn ) {
 		}
 
 		if ( !versions.length ) {
-			return fn( createError( "No semver tags.", "NO_SEMVER_TAGS" ) );
+			return fn( null );
 		}
 
-		// TODO: add plugin to database
-		var allErrors = [],
+		// TODO: track our actions so we can process metadata in done()
+		var plugins = {},
 			waiting = versions.length;
 
 		function progress() {
@@ -299,6 +298,7 @@ function processPlugin( repo, fn ) {
 		}
 
 		function done() {
+			// TODO: track invalid versions (user error, not system error)
 			// TODO: update versionless post to have latest version
 			// TODO: update metadata in WP
 			// - don't list pre-release versions that are older than latest stable
@@ -315,25 +315,77 @@ function processPlugin( repo, fn ) {
 				}
 
 				if ( data.errors.length ) {
-					allErrors.concat( data.errors );
+					// TODO: report errors to user
 					return progress();
 				}
 
-				// TODO: verify user is owner of plugin
-
-				data.package._downloadUrl = repoDetails.downloadUrl( version );
-				_generatePage( data.package, function( error, data ) {
+				wordpress.getVersions( data.package.name, function( error, versions ) {
 					if ( error ) {
 						// TODO: log failure for retry
 						return progress();
 					}
 
+					// this version has already been processed
+					// TODO: when should we start passing around the clean version?
+					if ( versions.indexOf( semver.clean( version ) ) !== -1 ) {
+						return progress();
+					}
+
+					_addPluginVersion( version, data.package, function( error ) {
+						if ( error ) {
+							return progress();
+						}
+
+						var name = data.package.name;
+						if ( !plugins[ name ] ) {
+							plugins[ name ] = [];
+						}
+						plugins[ name ].push( semver.clean( version ) );
+						progress();
+					});
+				});
+			});
+		});
+	}
+
+	function _addPluginVersion( version, package, fn ) {
+		// find out who owns this plugin
+		// if there is no owner, then set the user as the owner
+		pluginsDb.getOrSetOwner( package.name, repoDetails.userName, function( error, owner ) {
+			if ( error ) {
+				// TODO: log failure for retry
+				return fn( error );
+			}
+
+			// the plugin is owned by someone else
+			if ( owner !== repoDetails.userName ) {
+				// TODO: report error to user
+				return fn( createError( "Plugin owned by someone else.", "NOT_OWNER", {
+					owner: owner
+				}));
+			}
+
+			pluginsDb.addVersion( repoDetails, package, function( error ) {
+				if ( error ) {
+					// TODO: log failure for retry
+					return fn( error );
+				}
+
+				// add additional metadata and generate the plugin page
+				package._downloadUrl = repoDetails.downloadUrl( version );
+				_generatePage( package, function( error, data ) {
+					if ( error ) {
+						// TODO: log failure for retry
+						return fn( error );
+					}
+
 					wordpress.addVersionedPlugin( data, function( error ) {
 						if ( error ) {
 							// TODO: log failure for retry
+							return fn( error );
 						}
 						console.log( "Added " + data.pluginName + " " + data.version );
-						progress();
+						fn();
 					});
 				});
 			});

src/pluginsdb.js

@@ -0,0 +1,92 @@
+var sqlite = require( "sqlite3" ),
+	config = require( "./config" );
+
+var db;
+
+function connect( fn ) {
+	db = new sqlite.Database( config.pluginsDb, fn );
+}
+
+function auto( fn ) {
+	return function() {
+		var that = this,
+			args = arguments;
+
+		if ( db ) {
+			return fn.apply( that, args );
+		}
+
+		connect(function( error ) {
+			if ( error ) {
+				return fn( error );
+			}
+
+			fn.apply( that, args );
+		});
+	};
+}
+
+var pluginsDb = module.exports = {
+	getOwner: auto(function( plugin, fn ) {
+		db.get( "SELECT owner FROM owners WHERE plugin = ?",
+			[ plugin ], function( error, row ) {
+				if ( error ) {
+					return fn( error );
+				}
+
+				if ( !row ) {
+					return fn( null, null );
+				}
+
+				return fn( null, row.owner );
+			});
+	}),
+
+	setOwner: auto(function( plugin, owner, fn ) {
+		db.run( "INSERT INTO owners( plugin, owner ) VALUES( ?, ? )",
+			[ plugin, owner ], function( error ) {
+				if ( error ) {
+					return fn( error );
+				}
+
+				fn( null );
+			});
+	}),
+
+	getOrSetOwner: auto(function( plugin, owner, fn ) {
+		pluginsDb.setOwner( plugin, owner, function( error ) {
+			// successfully set owner (new plugin)
+			if ( !error ) {
+				return fn( null, owner );
+			}
+
+			// there is already an owner
+			if ( error.code === "SQLITE_CONSTRAINT" ) {
+				return pluginsDb.getOwner( plugin, fn );
+			}
+
+			fn( error );
+		});
+	}),
+
+	addVersion: auto(function( repoDetails, package, fn ) {
+		// TODO: verify what data we need to store (build restore functionality to confirm)
+		var data = JSON.stringify({
+			git: repoDetails.git,
+			package: package
+		});
+		// TODO: should we track timestamps so we can replay actions since a specific date?
+		db.run( "INSERT INTO actions( action, data ) VALUES( ?, ? )",
+			[ "addVersion", data ], function( error ) {
+				if ( error ) {
+					return fn( error );
+				}
+
+				fn( null );
+			});
+	}),
+
+	getAllActions: auto(function( fn ) {
+		db.all( "SELECT * FROM actions", fn );
+	})
+};