From 16583095dd61778f73edc9130e26838bc41afd10 Mon Sep 17 00:00:00 2001
From: Carlos Lalimarmo <clalimarmo@gmail.com>
Date: Wed, 10 Dec 2014 11:13:13 -0500
Subject: [PATCH] Add infrastructure to allow for testing, and a build step

The build step allows us to have external dependencies, and selectively
compile them into the distribution source for consumption by other
software.

Add unit tests, and inject http (jquery ajax method provider) dependency

Since we inject jquery (or some substitute) in the constructor, we no
longer depend on "real" jquery. Thus, we remove it from our bower deps,
and other configuration.
---
 .bowerrc                 |   3 +
 .gitignore               |   3 +
 Gruntfile.js             | 147 +++++++++++++++++++++++++++++++++++++++
 README.md                |  30 +++++---
 bower.json               |   5 +-
 dist/json-gcs.js         |  69 +-----------------
 karma.conf.js            |  86 +++++++++++++++++++++++
 lib/json-gcs.js          |  66 ++++++++++++++++++
 package.json             |  31 +++++++++
 spec/example_spec.coffee |  69 ++++++++++++++++++
 spec/main.js             |  23 ++++++
 11 files changed, 450 insertions(+), 82 deletions(-)
 create mode 100644 .bowerrc
 create mode 100644 .gitignore
 create mode 100644 Gruntfile.js
 create mode 100644 karma.conf.js
 create mode 100644 lib/json-gcs.js
 create mode 100644 package.json
 create mode 100644 spec/example_spec.coffee
 create mode 100644 spec/main.js

diff --git a/.bowerrc b/.bowerrc
new file mode 100644
index 0000000..8ed7fd0
--- /dev/null
+++ b/.bowerrc
@@ -0,0 +1,3 @@
+{
+"directory": "build/bower_components"
+}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1d2a37f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+build
+coverage
diff --git a/Gruntfile.js b/Gruntfile.js
new file mode 100644
index 0000000..63ad755
--- /dev/null
+++ b/Gruntfile.js
@@ -0,0 +1,147 @@
+/*global module:false*/
+module.exports = function(grunt) {
+
+  // Project configuration.
+  grunt.initConfig({
+    // Metadata.
+    pkg: grunt.file.readJSON('package.json'),
+
+    jshint: {
+      options: {
+        curly: true,
+        eqeqeq: true,
+        immed: true,
+        latedef: true,
+        newcap: true,
+        noarg: true,
+        sub: true,
+        undef: true,
+        unused: true,
+        boss: true,
+        eqnull: true,
+        browser: true,
+        expr: true,
+        trailing: true,
+      },
+      gruntfile: {
+        src: 'Gruntfile.js',
+        options: {
+          globals: {
+            require: false,
+          },
+        },
+      },
+      lib: {
+        src: ['lib/**/*.js'],
+        options: {
+          globals: {
+            requirejs: false,
+            define: false,
+            window: false,
+          },
+        },
+      },
+      spec: {
+        src: ['spec/**/*.js'],
+        options: {
+          globals: {
+            requirejs: false,
+            describe: false,
+            it: false,
+            xit: false,
+            context: false,
+            before: false,
+            beforeEach: false,
+            after: false,
+            afterEach: false,
+            define: false,
+            expect: false,
+          },
+        },
+      },
+    },
+
+    karma: {
+      options: {
+        configFile: 'karma.conf.js'
+      },
+      unit: {
+        coverageReporter: {
+          type: 'text-summary'
+        }
+      },
+      coverage: {
+        coverageReporter: {
+          type: 'html'
+        }
+      },
+    },
+
+    watch: {
+      gruntfile: {
+        files: '<%= jshint.gruntfile.src %>',
+        tasks: ['jshint:gruntfile']
+      },
+      dev: {
+        files: ['lib/**/*.js', 'spec/**/*.js', 'lib/**/*.html'],
+        tasks: ['build', 'karma:unit', 'jshint']
+      },
+      copy: {
+        files: [
+          'app/lib',
+        ],
+        tasks: ['copy:dev'],
+      },
+      bower: {
+        files: ['bower.json'],
+        tasks: ['build:full', 'karma:unit', 'jshint'],
+      },
+    },
+
+    copy: {
+      dev: {
+        files: [
+          {expand: true, cwd: 'lib', src: ['**/*.js'], dest: 'build'},
+          {expand: true, cwd: 'lib', src: ['**/*.json'], dest: 'build'},
+        ],
+      },
+      dist: {
+        files: [
+        ],
+      },
+    },
+
+    requirejs: {
+      compile: {
+        options: {
+          baseUrl: 'build',
+          name: 'json-gcs',
+          mainConfigFile: 'build/json-gcs.js',
+          out: 'dist/json-gcs.js',
+          optimize: 'uglify2',
+        },
+      },
+    },
+
+    bower: {
+      install: {
+      }
+    },
+
+    clean: ['.tmp', 'build', 'coverage'],
+  });
+
+  // These plugins provide necessary tasks.
+  // load all grunt tasks matching the `grunt-*` pattern
+  require('load-grunt-tasks')(grunt);
+
+  // Build tasks.
+  grunt.registerTask('build', ['copy:dev']);
+  grunt.registerTask('build:full', ['clean', 'build', 'bower:install']);
+  grunt.registerTask('build:dist', ['clean', 'copy:dev', 'bower:install', 'requirejs']);
+
+  // Default task.
+  grunt.registerTask('default', ['build:full', 'karma:unit', 'jshint']);
+  grunt.registerTask('coverage', 'Detailed test coverage information', ['build:full', 'karma:coverage']);
+
+};
diff --git a/README.md b/README.md
index fc0f7ad..a65faf1 100644
--- a/README.md
+++ b/README.md
@@ -12,12 +12,14 @@ Google OAuth2 token, which grants the necessary permissions to the named
 bucket.
 
     JsonGCS = require('json-gcs');
+    $ = require('jquery');
 
     var cloudStore = JsonGCS({
       authenticator: {
         token: function() { return userOAuth2Token; },
-      }
-      bucketName: "myBucket"
+      },
+      bucketName: "myBucket",
+      http: $
     });
 
     cloudStore.put(objectName, jsonDocument);
@@ -26,15 +28,23 @@ bucket.
       //do something with retrieved json document
     });
 
-## Dependencies
-
-The only dependency at the moment is jQuery, whose `ajax` method is used to
-send request to the Google Cloud Storage JSON API.
-
-At some point this dependency might be removed. Until then, the module
-expects to be able to `require('jquery')`.
-
 ## Notes
 
 The module is provided as an AMD module, with simplified CommonJS wrapping.
 It's compatible with RequireJS, I haven't tried it in other contexts.
+
+So that there isn't a package dependency on jquery, we pass it into the
+initialization function. We only use the `ajax` method of jquery, so if
+you don't already use jquery, and don't want to introduce it to your project
+you can provide your own http adapter, as long as the `ajax` method matches
+jquery's signature and behavior. (This also simplifies testing).
+
+## Development
+
+To run the tests:
+
+    grunt
+
+To build the dist package:
+
+    grunt build:dist
diff --git a/bower.json b/bower.json
index 10a909c..6e9edbf 100644
--- a/bower.json
+++ b/bower.json
@@ -1,15 +1,12 @@
 {
   "name": "json-gcs",
-  "version": "0.0.0",
   "homepage": "https://github.com/clalimarmo/json-gcs",
   "authors": [
     "Carlos Lalimarmo <clalimarmo@gmail.com>"
   ],
   "description": "Store JSON documents to Google Cloud Storage",
   "main": "dist/json-gcs.js",
-  "dependencies": {
-    "jquery": "~2.1.1"
-  },
+  "dependencies": {},
   "moduleType": [
     "amd"
   ],
diff --git a/dist/json-gcs.js b/dist/json-gcs.js
index 18de260..1b58bf0 100644
--- a/dist/json-gcs.js
+++ b/dist/json-gcs.js
@@ -1,68 +1 @@
-define(function(require) {
-  var $ = require('jquery');
-
-  //constructor dependency injection helper
-  var ensure = function(dependencyNames, dependencies) {
-    var onlyDependencies = {};
-    for (var i = 0; i < dependencyNames.length; i++) {
-      var expectedDependency = dependencyNames[i];
-      var injectedDependency = dependencies[expectedDependency];
-      if (injectedDependency === undefined || injectedDependency === null) {
-        throw new Error('missing dependency:' + expectedDependency);
-      } else {
-        onlyDependencies[expectedDependency] = injectedDependency;
-      }
-    }
-    return onlyDependencies;
-  };
-
-  var JsonGCS = function(deps) {
-    deps = ensure(['authenticator', 'bucketName'], deps);
-    deps.authenticator = ensure(['token'], deps.authenticator);
-
-    //helpers
-    var authHeader = function() {
-      return 'Bearer ' + deps.authenticator.token();
-    };
-
-    var objectCreateURL = function(name) {
-      return 'https://www.googleapis.com/upload/storage/v1/b/' +
-        deps.bucketName + '/o?uploadType=media&name=' + name;
-    };
-
-    var objectGetURL = function(name) {
-      return 'https://storage.googleapis.com/' + deps.bucketName + '/' + name;
-    };
-
-    //instance methods
-    var instance = {};
-
-    instance.put = function(name, doc) {
-      $.ajax(
-        objectCreateURL(name),
-        {
-          method: 'POST',
-          headers: { 'Authorization': authHeader() },
-          data: JSON.stringify(doc)
-        }
-      );
-    };
-
-    instance.get = function(name, handleJson) {
-      $.ajax(
-        objectGetURL(name),
-        {
-          headers: { 'Authorization': authHeader() },
-          success: function(doc) {
-            var json = JSON.parse(doc);
-            handleJson(json);
-          }
-        }
-      );
-    };
-
-    return instance;
-  };
-
-  return JsonGCS;
-});
+define("json-gcs",[],function(){var t=function(t,e){for(var n={},o=0;o<t.length;o++){var r=t[o],a=e[r];if(void 0===a||null===a)throw new Error("missing dependency:"+r);n[r]=a}return n},e=function(e){t(["authenticator","http","bucketName"],e),t(["token"],e.authenticator);var n=function(){return"Bearer "+e.authenticator.token()},o=function(t){return"https://www.googleapis.com/upload/storage/v1/b/"+e.bucketName+"/o?uploadType=media&name="+t},r=function(t){return"https://storage.googleapis.com/"+e.bucketName+"/"+t},a={};return a.put=function(t,r){e.http.ajax(o(t),{method:"POST",headers:{Authorization:n()},data:JSON.stringify(r)})},a.get=function(t,o){e.http.ajax(r(t),{headers:{Authorization:n()},success:function(t){var e=JSON.parse(t);o(e)}})},a};return e});
\ No newline at end of file
diff --git a/karma.conf.js b/karma.conf.js
new file mode 100644
index 0000000..ec50cc6
--- /dev/null
+++ b/karma.conf.js
@@ -0,0 +1,86 @@
+// Karma configuration
+// Generated on Thu Feb 06 2014 09:46:59 GMT-0500 (EST)
+
+module.exports = function(config) {
+  config.set({
+
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: '',
+
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: [
+      // NB: requirejs should come before chai in the list below, to avoid a
+      // known issue: https://github.com/xdissent/karma-chai/issues/5
+      'requirejs',
+      'mocha',
+      'chai',
+    ],
+
+
+    // list of files / patterns to load in the browser
+    files: [
+      //our code
+      {pattern: 'build/**/*.js', included: false},
+      {pattern: 'spec/**/*_spec.js', included: false},
+      {pattern: 'spec/**/*_spec.coffee', included: false},
+
+      'spec/main.js',
+    ],
+
+
+    // list of files to exclude
+    exclude: [
+      '**/*.swp',
+      'build/bower_components/**/test/**/*js', //DO NOT run tests for third party libraries
+    ],
+
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      'spec/**/*.coffee': ['coffee'],
+    },
+
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ['dots', 'coverage'],
+
+    coverageReporter: {
+      reporters:[
+        {type: 'html', dir:'coverage/'},
+        {type: 'text-summary'},
+      ],
+    },
+
+
+    // web server port
+    port: 9876,
+
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: true,
+
+
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: ['PhantomJS'],
+
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: true
+  });
+};
diff --git a/lib/json-gcs.js b/lib/json-gcs.js
new file mode 100644
index 0000000..69e2aec
--- /dev/null
+++ b/lib/json-gcs.js
@@ -0,0 +1,66 @@
+define(function() {
+  //constructor dependency injection helper
+  var ensure = function(dependencyNames, dependencies) {
+    var onlyDependencies = {};
+    for (var i = 0; i < dependencyNames.length; i++) {
+      var expectedDependency = dependencyNames[i];
+      var injectedDependency = dependencies[expectedDependency];
+      if (injectedDependency === undefined || injectedDependency === null) {
+        throw new Error('missing dependency:' + expectedDependency);
+      } else {
+        onlyDependencies[expectedDependency] = injectedDependency;
+      }
+    }
+    return onlyDependencies;
+  };
+
+  var JsonGCS = function(deps) {
+    ensure(['authenticator', 'http', 'bucketName'], deps);
+    ensure(['token'], deps.authenticator);
+
+    //helpers
+    var authHeader = function() {
+      return 'Bearer ' + deps.authenticator.token();
+    };
+
+    var objectCreateURL = function(name) {
+      return 'https://www.googleapis.com/upload/storage/v1/b/' +
+        deps.bucketName + '/o?uploadType=media&name=' + name;
+    };
+
+    var objectGetURL = function(name) {
+      return 'https://storage.googleapis.com/' + deps.bucketName + '/' + name;
+    };
+
+    //instance methods
+    var instance = {};
+
+    instance.put = function(name, doc) {
+      deps.http.ajax(
+        objectCreateURL(name),
+        {
+          method: 'POST',
+          headers: { 'Authorization': authHeader() },
+          data: JSON.stringify(doc)
+        }
+      );
+    };
+
+    instance.get = function(name, handleJson) {
+      deps.http.ajax(
+        objectGetURL(name),
+        {
+          headers: { 'Authorization': authHeader() },
+          success: function(doc) {
+            var json = JSON.parse(doc);
+            handleJson(json);
+          }
+        }
+      );
+    };
+
+    return instance;
+  };
+
+  return JsonGCS;
+});
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..0e3c666
--- /dev/null
+++ b/package.json
@@ -0,0 +1,31 @@
+{
+  "version": "0.0.4",
+  "description": "Store JSON documents to Google Cloud Storage",
+  "repository": "git@github.com:clalimarmo/json-gcs",
+  "devDependencies": {
+    "bower": "~1.2.8",
+    "grunt": "~0.4.4",
+    "grunt-cli": "0.1.13",
+    "grunt-bower-task": "~0.3.4",
+    "grunt-contrib-clean": "~0.5.0",
+    "grunt-contrib-copy": "~0.5.0",
+    "grunt-contrib-jshint": "~0.8.0",
+    "grunt-contrib-jst": "~0.5.1",
+    "grunt-contrib-watch": "~0.5.3",
+    "grunt-contrib-uglify": "~0.6.0",
+    "grunt-karma": "~0.7.3",
+    "karma": "~0.12.0",
+    "karma-chai": "0.0.2",
+    "karma-chrome-launcher": "~0.1.2",
+    "karma-coverage": "~0.1.5",
+    "karma-mocha": "~0.1.1",
+    "karma-osx-reporter": "0.0.4",
+    "karma-phantomjs-launcher": "~0.1.2",
+    "karma-requirejs": "~0.2.1",
+    "mocha": "~1.17.1",
+    "requirejs": "~2.1.10",
+    "grunt-contrib-requirejs": "~0.4.4",
+    "load-grunt-tasks": "^0.4.0",
+    "karma-coffee-preprocessor": "~0.2.1"
+  }
+}
diff --git a/spec/example_spec.coffee b/spec/example_spec.coffee
new file mode 100644
index 0000000..d187731
--- /dev/null
+++ b/spec/example_spec.coffee
@@ -0,0 +1,69 @@
+define (require) ->
+  JsonGCS = require('json-gcs')
+
+  describe 'JsonGCS', ->
+    mocks = {}
+    instance = null
+
+    beforeEach ->
+      mocks.http = {}
+      mocks.authenticator = {
+        token: -> 'stub'
+      }
+      mocks.http = {}
+
+      instance = JsonGCS(
+        http: mocks.http
+        authenticator: mocks.authenticator
+        bucketName: 'my-bucket'
+      )
+
+    context 'get', ->
+
+      it 'makes an ajax http get request', ->
+        requestURL = 'request url'
+        requestOptions = 'request options'
+        requestResponse = 'response'
+
+        mocks.authenticator.token = -> '1234-oauth-token'
+
+        mocks.response = '{"very-important":"data"}'
+
+        mocks.http.ajax = (url, opts) ->
+          requestURL = url
+          requestOptions = opts
+          opts.success(mocks.response)
+
+        mocks.httpSuccessHandler = (json) ->
+          requestResponse = json
+
+        instance.get('my-object-name', mocks.httpSuccessHandler)
+
+        expect(requestURL).to.eq('https://storage.googleapis.com/my-bucket/my-object-name')
+        expect(requestOptions.headers['Authorization']).to.eq('Bearer 1234-oauth-token')
+        expect(requestResponse).to.deep.eq(JSON.parse(mocks.response))
+
+    context 'put', ->
+
+      it 'makes an ajax http post request with the data to be saved', ->
+        requestURL = 'request url'
+        requestOptions = 'request options'
+        requestResponse = 'response'
+
+        mocks.authenticator.token = -> '4321-oauth-token'
+
+        mocks.userData = {
+          name: 'Carlos'
+          points: 12
+        }
+
+        mocks.http.ajax = (url, opts) ->
+          requestURL = url
+          requestOptions = opts
+
+        instance.put('my-profile', mocks.userData)
+
+        expect(requestURL).to.eq('https://www.googleapis.com/upload/storage/v1/b/my-bucket/o?uploadType=media&name=my-profile')
+        expect(requestOptions.method).to.eq('POST')
+        expect(requestOptions.headers['Authorization']).to.eq('Bearer 4321-oauth-token')
+        expect(requestOptions.data).to.eq(JSON.stringify(mocks.userData))
diff --git a/spec/main.js b/spec/main.js
new file mode 100644
index 0000000..db504c9
--- /dev/null
+++ b/spec/main.js
@@ -0,0 +1,23 @@
+// based on https://github.com/kjbekkelund/karma-requirejs
+var tests = [];
+for (var file in window.__karma__.files) {
+  if (window.__karma__.files.hasOwnProperty(file)) {
+    if (/spec\.js$/.test(file)) {
+      tests.push(file);
+    }
+    if (/spec\.coffee$/.test(file)) {
+      tests.push(file);
+    }
+  }
+}
+
+requirejs.config({
+  // Karma serves files from '/base'
+  baseUrl: '/base/build',
+  paths: {},
+  shim: {},
+  deps: tests,
+
+  // start test run, only after Require.js is done
+  callback: window.__karma__.start,
+});