adding ability to test deploy process / upload process via dry run arg

README.md

@@ -15,20 +15,26 @@ Setup your aws.json file
 {
   "key": "AKIAI3Z7CUAFHG53DMJA",
   "secret": "acYxWRu5RRa6CwzQuhdXEfTpbQA+1XQJ7Z1bGTCx",
-  "bucket": "dev.example.com",
-  "region": "eu-west-1"
+  "bucket": "dev.example.com"
 }
 ```
 
 Then, use it in your `gulpfile.js`:
 ```javascript
 var s3 = require("gulp-s3");
 
-aws = JSON.parse(fs.readFileSync('./aws.json'));
+aws = require('./aws.json');
 gulp.src('./dist/**')
     .pipe(s3(aws));
 ```
 
+## Testing
+To test your paths before uploading add the 'dry' flag to your gulp command.
+
+```
+gulp deploy --dry
+```
+
 ## API
 
 
@@ -59,9 +65,8 @@ var gzip = require("gulp-gzip");
 var options = { gzippedOnly: true };
 
 gulp.src('./dist/**')
-.pipe(gzip())
-.pipe(s3(aws, options));
-
+  .pipe(gzip())
+  .pipe(s3(aws, options));
 });
 ```
 

index.js

@@ -4,15 +4,15 @@ var es = require('event-stream');
 var knox = require('knox');
 var gutil = require('gulp-util');
 var mime = require('mime');
+var yargs = require('yargs').argv;
 mime.default_type = 'text/plain';
 
 module.exports = function (aws, options) {
   options = options || {};
 
   if (!options.delay) { options.delay = 0; }
 
-  var client = knox.createClient(aws);
-  var waitTime = 0;
+  var dry = (yargs.dry) ? true : false;
   var regexGzip = /\.([a-z]{2,})\.gz$/i;
   var regexGeneral = /\.([a-z]{2,})$/i;
 
@@ -49,13 +49,20 @@ module.exports = function (aws, options) {
 
       headers['Content-Length'] = file.stat.size;
 
-      client.putBuffer(file.contents, uploadPath, headers, function(err, res) {
-        if (err || res.statusCode !== 200) {
-          gutil.log(gutil.colors.red('[FAILED]', file.path + " -> " + uploadPath));
-        } else {
-          gutil.log(gutil.colors.green('[SUCCESS]', file.path + " -> " + uploadPath));
-          res.resume();
-        }
+      if (dry) {
+        gutil.log(gutil.colors.yellow('[DRY RUN]', file.path + ' -> ' + uploadPath));
+        return file;
+      }
+
+      knox
+        .createClient(aws)
+        .putBuffer(file.contents, uploadPath, headers, function(err, res) {
+          if (err || res.statusCode !== 200) {
+            gutil.log(gutil.colors.red('[FAILED]', file.path + ' -> ' + uploadPath));
+          } else {
+            gutil.log(gutil.colors.green('[SUCCESS]', file.path + ' -> ' + uploadPath));
+            res.resume();
+          }
       });
 
       return file;

package.json

@@ -27,7 +27,8 @@
     "event-stream": "*",
     "gulp-util": "~2.2.6",
     "knox": "",
-    "mime": "~1.2.11"
+    "mime": "~1.2.11",
+    "yargs": "^3.6.0"
   },
   "devDependencies": {
     "mocha": "~1.14.0",