Merge lp:~benji/juju-gui/reorganize-charmworld-api-part-A into lp:juju-gui/experimental

[Benji York]

Factor out charmworld API helpers and rename

These changes are part of the move to adding v3 of the charmworld API.

https://codereview.appspot.com/13592047/

[Brad Crittenden (bac)]

LGTM

https://codereview.appspot.com/13592047/

[Richard Harding (rharding)]

LGTM on the code. I'm not a huge fan of APIv2 as a name, but I guess we
don't use it much and it's clear.

Did not QA.

https://codereview.appspot.com/13592047/

=== modified file 'app/app.js'
--- app/app.js	2013-09-13 03:49:20 +0000
+++ app/app.js	2013-09-13 20:06:29 +0000
@@ -1356,8 +1356,8 @@
       },
       /**
          @attribute store
-         @default Charmworld2
-         @type {Charmworld2}
+         @default Y.juju.charmworld.APIv2
+         @type {Y.juju.charmworld.APIv2}
        */
       store: {
         /**
@@ -1379,7 +1379,7 @@
           } else {
             cfg.apiHost = window.juju_config.charmworldURL;
           }
-          return new Y.juju.Charmworld2(cfg);
+          return new Y.juju.charmworld.APIv2(cfg);
         }
       },
 

=== modified file 'app/models/charm.js'
--- app/models/charm.js	2013-09-06 14:23:56 +0000
+++ app/models/charm.js	2013-09-13 20:06:29 +0000
@@ -386,7 +386,7 @@
 
 
   /**
-   * Model to represent the Charms from the Charmworld2 Api.
+   * Model to represent the Charms from the Charmworld API.
    *
    * @class BrowserCharm
    * @extends {Y.Model}
@@ -796,8 +796,9 @@
       /**
        * This attr is a mapper to the relations ATTR in the new API. It's
        * provided for backwards compatibility with the original Charm model.
-       * This can be removed when Charmworld2 is the one true model used in
-       * all Juju Gui code.
+       *
+       * This can be removed when juju.charmworld is the one true provider of
+       * models used in all Juju Gui code.
        *
        * @attribute provides
        * @default undefined
@@ -901,8 +902,8 @@
        * This attr is a mapper to the relations ATTR in the new API. It's
        * provided for backwards compatibility with the original Charm model.
        *
-       * This can be removed when Charmworld2 is the one true model used in
-       * all Juju Gui code.
+       * This can be removed when juju.charmworld is the one true provider of
+       * models used in all Juju Gui code.
        *
        * @attribute requires
        * @default undefined

=== modified file 'app/models/model-controller.js'
--- app/models/model-controller.js	2013-09-04 11:19:19 +0000
+++ app/models/model-controller.js	2013-09-13 20:06:29 +0000
@@ -197,7 +197,7 @@
         Reference to the client charm store.
 
         @attribute store
-        @type {Charmworld2}
+        @type {Object}
         @default undefined
       */
       store: {}

=== modified file 'app/store/charm.js'
--- app/store/charm.js	2013-09-12 16:42:21 +0000
+++ app/store/charm.js	2013-09-13 20:06:29 +0000
@@ -26,40 +26,40 @@
  */
 
 YUI.add('juju-charm-store', function(Y) {
-  var ns = Y.namespace('juju'),
+  var juju = Y.namespace('juju'),
+      ns = Y.namespace('juju.charmworld'),
       models = Y.namespace('juju.models');
 
-  /**
-   * Api helper for the updated charmworld api v2.
-   *
-   * @class Charmworld2
-   * @extends {Base}
-   *
-   */
-  ns.Charmworld2 = Y.Base.create('charmworld2', Y.Base, [], {
-    _apiRoot: 'api/2',
-
-    /**
-     * Send the actual request and handle response from the api.
-     *
-     * @method _makeRequest
-     * @param {Object} args any query params and arguments required.
-     * @private
-     *
-     */
-    _makeRequest: function(apiEndpoint, callbacks, args) {
-      // If we're in the noop state, just call the error callback.
-      if (this.get('noop')) {
-        callbacks.failure('noop failure');
-        return;
-      }
-
+  // Make Y.juju.charmworld refernce the "juju.charmworld" namespace.
+  juju.charmworld = ns;
+
+  ns.ApiHelper = Y.Base.create('ApiHelper', Y.Base, [], {
+
+    /**
+      Initializer for the class.
+
+      @method initializer
+      @param {Object} cfg The configuration for the API interface.
+      @return {undefined} Nothing.
+    */
+    initializer: function(cfg) {
+      this.sendRequest = cfg.sendRequest;
+    },
+
+    /**
+      Send a request and handle the response from the API.
+
+      @method makeRequest
+      @param {Object} args any query params and arguments required.
+      @return {undefined} Nothing.
+    */
+    makeRequest: function(apiEndpoint, callbacks, args) {
       // Any query string args need to be put onto the endpoint for calling.
       if (args) {
         apiEndpoint = apiEndpoint + '?' + Y.QueryString.stringify(args);
       }
 
-      this.get('datasource').sendRequest({
+      this.sendRequest({
         request: apiEndpoint,
         callback: {
           success: function(io_request) {
@@ -82,6 +82,74 @@
     },
 
     /**
+      Normalize a charm name so we can request its full data. Charm lookup
+      requires a very specific form of the charm identifier.
+
+      series/charm-revision
+
+      where revision can currently (API v2) be any numeric placeholder.
+
+      @method normalizeCharmId
+      @param {String} charmId to normalize.
+      @param {String} [defaultSeries='precise'] The series to use if none is
+        specified in the charm ID.
+      @return {String} normalized id.
+    */
+    normalizeCharmId: function(charmId, defaultSeries) {
+      var result = charmId;
+      if (/^(cs:|local:)/.exec(result)) {
+        result = result.slice(result.indexOf(':') + 1);
+      }
+
+      if (result.indexOf('/') === -1) {
+        if (!defaultSeries) {
+          console.warn('No default series provided when normalizing charm ' +
+              'ID.  Using "precise".');
+          defaultSeries = 'precise';
+        }
+        result = defaultSeries + '/' + result;
+      }
+      if (/\-(\d+|HEAD)/.exec(result) === null) {
+        // Add in a revision placeholder
+        result = result + '-1';
+      }
+      return result;
+    }
+
+  }, {
+    ATTRS: {
+    }
+  });
+
+  /**
+   * Api helper for the charmworld API v2.
+   *
+   * @class APIv2
+   * @extends {Base}
+   *
+   */
+  ns.APIv2 = Y.Base.create('APIv2', Y.Base, [], {
+    _apiRoot: 'api/2',
+
+    /**
+      * Send the actual request and handle response from the api.
+      *
+      * @method _makeRequest
+      * @param {Object} args any query params and arguments required.
+      * @private
+      *
+      */
+    _makeRequest: function(apiEndpoint, callbacks, args) {
+      // If we're in the noop state, just call the error callback.
+      if (this.get('noop')) {
+        callbacks.failure('noop failure');
+        return;
+      }
+      // Delegate the request making to the helper object.
+      this.apiHelper.makeRequest(apiEndpoint, callbacks, args);
+    },
+
+    /**
      * Api call to fetch autocomplete suggestions based on the current term.
      *
      * @method autocomplete
@@ -103,6 +171,7 @@
       this._makeRequest(endpoint, callbacks, filters);
     },
 
+
     /**
      * Api call to fetch a charm's details.
      *
@@ -161,7 +230,7 @@
           };
         }
       }
-      this._charm(this.normalizeCharmId(charmID, defaultSeries),
+      this._charm(this.apiHelper.normalizeCharmId(charmID, defaultSeries),
                   callbacks, bindScope);
     },
 
@@ -185,41 +254,6 @@
     },
 
     /**
-     Normalize a charm name so we can request its full data. Charm lookup
-     requires a very specific form of the charm identifier.
-
-     series/charm-revision
-
-     where revision can currently (API v2) be any numeric placeholder.
-
-     @method normalizeCharmId
-     @param {String} charmId to normalize.
-     @param {String} [defaultSeries='precise'] The series to use if none is
-       specified in the charm ID.
-     @return {String} normalized id.
-     */
-    normalizeCharmId: function(charmId, defaultSeries) {
-      var result = charmId;
-      if (/^(cs:|local:)/.exec(result)) {
-        result = result.slice(result.indexOf(':') + 1);
-      }
-
-      if (result.indexOf('/') === -1) {
-        if (!defaultSeries) {
-          console.warn('No default series provided when normalizing charm ' +
-              'ID.  Using "precise".');
-          defaultSeries = 'precise';
-        }
-        result = defaultSeries + '/' + result;
-      }
-      if (/\-(\d+|HEAD)/.exec(result) === null) {
-        // Add in a revision placeholder
-        result = result + '-1';
-      }
-      return result;
-    },
-
-    /**
       Promises to return the latest charm ID for a given charm if a newer one
       exists; this also caches the newer charm if one is available.
 
@@ -498,7 +532,15 @@
        * @type {Datasource}
        *
        */
-      datasource: {},
+      datasource: {
+        setter: function(datasource) {
+          // Construct an API helper using the new datasource.
+          this.apiHelper = new ns.ApiHelper({
+            sendRequest: Y.bind(datasource.sendRequest, datasource)
+          });
+          return datasource;
+        }
+      },
 
       /**
         If there's no config we end up setting noop on the store so that tests

=== modified file 'app/subapps/browser/browser.js'
--- app/subapps/browser/browser.js	2013-09-06 16:22:23 +0000
+++ app/subapps/browser/browser.js	2013-09-13 20:06:29 +0000
@@ -1058,8 +1058,8 @@
 
       /**
          @attribute store
-         @default Charmworld2
-         @type {Charmworld2}
+         @default juju.charmworld.APIv2
+         @type {Object}
        */
       store: {},
 

=== modified file 'app/subapps/browser/views/charm.js'
--- app/subapps/browser/views/charm.js	2013-08-15 13:21:21 +0000
+++ app/subapps/browser/views/charm.js	2013-09-13 20:06:29 +0000
@@ -852,7 +852,7 @@
        *
        * @attribute store
        * @default undefined
-       * @type {Charmworld2}
+       * @type {Object}
        *
        */
       store: {},

=== modified file 'app/subapps/browser/views/charmresults.js'
--- app/subapps/browser/views/charmresults.js	2013-08-07 18:19:54 +0000
+++ app/subapps/browser/views/charmresults.js	2013-09-13 20:06:29 +0000
@@ -182,11 +182,11 @@
       renderTo: {},
 
       /**
-       * The Charmworld2 Api store instance for loading content.
+       * The Charmworld API store instance for loading content.
        *
        * @attribute store
        * @default undefined
-       * @type {Charmworld2}
+       * @type {Object}
        */
       store: {}
     }

=== modified file 'app/subapps/browser/views/view.js'
--- app/subapps/browser/views/view.js	2013-08-23 13:21:48 +0000
+++ app/subapps/browser/views/view.js	2013-09-13 20:06:29 +0000
@@ -300,7 +300,7 @@
        *
        * @attribute store
        * @default undefined
-       * @type {Charmworld2}
+       * @type {Object}
        *
        */
       store: {},

=== modified file 'app/views/topology/bundle.js'
--- app/views/topology/bundle.js	2013-09-06 00:26:54 +0000
+++ app/views/topology/bundle.js	2013-09-13 20:06:29 +0000
@@ -288,7 +288,7 @@
     }
     this.store = options.store;
     if (!this.store) {
-      this.store = new juju.Charmworld2({});
+      this.store = new juju.charmworld.APIv2({});
       this._cleanups.push(this.store.destroy);
     }
     this.container = options.container;

=== modified file 'docs/style-guide.rst'
--- docs/style-guide.rst	2013-01-30 12:38:03 +0000
+++ docs/style-guide.rst	2013-09-13 20:06:29 +0000
@@ -189,12 +189,12 @@
 Multi-line YUIDoc comment blocks like this will be needed::
 
     /**
-     * Frob the thingy.
-     *
-     * @param {object} type How the thingy should be frobbed.
-     * @return {undefined} Side-effects only, eturns nothing.
-     * @method frob
-     */
+      Frob the thingy.
+
+      @method frob
+      @param {object} type How the thingy should be frobbed.
+      @return {undefined} Side-effects only, eturns nothing.
+    */
 
 In this case, the type directive is the ``@method`` one. It is placed at
 the end of the comment block, because it is little more than noise

=== modified file 'test/test_app.js'
--- test/test_app.js	2013-09-06 00:26:54 +0000
+++ test/test_app.js	2013-09-13 20:06:29 +0000
@@ -541,7 +541,7 @@
             consoleEnabled: true,
             user: 'admin',
             password: 'admin',
-            store: new Y.juju.Charmworld2({})
+            store: new Y.juju.charmworld.APIv2({})
           });
       app.showView(new Y.View());
       // This simply walks through the hierarchy to show that all the

=== modified file 'test/test_browser_app.js'
--- test/test_browser_app.js	2013-09-06 15:06:53 +0000
+++ test/test_browser_app.js	2013-09-13 20:06:29 +0000
@@ -74,7 +74,7 @@
       it('must correctly render the initial browser ui', function() {
         var container = Y.one('#subapp-browser');
         view = new FullScreen({
-          store: new Y.juju.Charmworld2({
+          store: new Y.juju.charmworld.APIv2({
             apiHost: 'http://localhost'
           })
         });
@@ -107,7 +107,7 @@
 
       it('must show the home icons when withHome is set', function() {
         var container = Y.one('#subapp-browser'),
-            fakeStore = new Y.juju.Charmworld2({});
+            fakeStore = new Y.juju.charmworld.APIv2({});
 
         view = new FullScreen({
           store: fakeStore,
@@ -121,7 +121,7 @@
 
       it('shows the home icons if the withHome is changed', function(done) {
         var container = Y.one('#subapp-browser'),
-            fakeStore = new Y.juju.Charmworld2({});
+            fakeStore = new Y.juju.charmworld.APIv2({});
 
         view = new FullScreen({
           store: fakeStore
@@ -139,7 +139,7 @@
 
       it('routes home when it catches a gohome event', function(done) {
         var container = Y.one('#subapp-browser'),
-            fakeStore = new Y.juju.Charmworld2({});
+            fakeStore = new Y.juju.charmworld.APIv2({});
         view = new FullScreen({
           store: fakeStore
         });
@@ -158,7 +158,7 @@
 
       it('resets charmid and hash on search', function(done) {
         var container = Y.one('#subapp-browser'),
-            fakeStore = new Y.juju.Charmworld2({});
+            fakeStore = new Y.juju.charmworld.APIv2({});
         view = new FullScreen({
           charmID: 'precise/jenkins-13'
         });
@@ -281,7 +281,7 @@
         var container = Y.one('#subapp-browser');
         view = new Sidebar({
           container: container,
-          store: new Y.juju.Charmworld2({
+          store: new Y.juju.charmworld.APIv2({
             apiHost: 'http://localhost'
           })
         });
@@ -324,7 +324,7 @@
       it('shows the home icon when instructed', function() {
         var container = Y.one('#subapp-browser');
         view = new Sidebar({
-          store: new Y.juju.Charmworld2({
+          store: new Y.juju.charmworld.APIv2({
             apiHost: 'http://localhost'
           }),
           withHome: true
@@ -355,7 +355,7 @@
 
       it('routes home when it catches a gohome event', function(done) {
         var container = Y.one('#subapp-browser'),
-            fakeStore = new Y.juju.Charmworld2({});
+            fakeStore = new Y.juju.charmworld.APIv2({});
         view = new Sidebar({
           store: fakeStore
         });
@@ -377,7 +377,7 @@
 
   (function() {
     describe('browser app', function() {
-      var Y, app, browser, Charmworld2, container, next;
+      var Y, app, browser, CharmworldAPI, container, next;
 
       before(function(done) {
         Y = YUI(GlobalConfig).use(
@@ -388,7 +388,7 @@
             'juju-views',
             'subapp-browser', function(Y) {
               browser = Y.namespace('juju.subapps');
-              Charmworld2 = Y.namespace('juju').Charmworld2;
+              CharmworldAPI = Y.namespace('juju').charmworld.APIv2;
               next = function() {};
               done();
             });
@@ -516,7 +516,7 @@
 
       it('/charm/id routes to the default view correctly', function() {
         app = new browser.Browser({
-          store: new Charmworld2({
+          store: new CharmworldAPI({
             'apiHost': 'http://localhost'
           })
         });
@@ -534,7 +534,7 @@
 
       it('/charm/id handles routes for new charms correctly', function() {
         app = new browser.Browser({
-          store: new Charmworld2({
+          store: new CharmworldAPI({
             'apiHost': 'http://localhost'
           })
         });
@@ -613,7 +613,7 @@
 
       it('/charm/id router ignores other urls', function() {
         app = new browser.Browser({
-          store: new Charmworld2({
+          store: new CharmworldAPI({
             'apiHost': 'http://localhost',
             'noop': true
           })
@@ -642,7 +642,7 @@
             editorialCleaned = false;
 
         app = new browser.Browser({
-          store: new Charmworld2({
+          store: new CharmworldAPI({
             'apiHost': 'http://localhost',
             'noop': true
           })

=== modified file 'test/test_browser_charm_details.js'
--- test/test_browser_charm_details.js	2013-09-06 08:57:34 +0000
+++ test/test_browser_charm_details.js	2013-09-13 20:06:29 +0000
@@ -141,7 +141,7 @@
     });
 
     it('has sharing links', function() {
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -255,7 +255,7 @@
     });
 
     it('should be able to display the readme content', function() {
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -315,7 +315,7 @@
 
 
     it('_addCharmEnvironment displays the config panel', function(done) {
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.iconpath = function() {
         return 'charm icon url';
       };
@@ -345,7 +345,7 @@
     });
 
     it('should load a file when a hook is selected', function() {
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -385,7 +385,7 @@
     });
 
     it('should be able to render markdown as html', function() {
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -493,7 +493,7 @@
       data.scores = null;
       var fakedata = Y.JSON.stringify(data);
 
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -841,7 +841,7 @@
       // We don't want any files so we don't have to mock/load them.
       data.files = [];
 
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -887,7 +887,7 @@
       // We don't want any files so we don't have to mock/load them.
       data.files = [];
 
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -922,7 +922,7 @@
       // We don't want any files so we don't have to mock/load them.
       data.files = [];
 
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -973,7 +973,7 @@
       // We don't want any files so we don't have to mock/load them.
       data.files = [];
 
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value

=== modified file 'test/test_browser_editorial.js'
--- test/test_browser_editorial.js	2013-08-23 13:02:58 +0000
+++ test/test_browser_editorial.js	2013-09-13 20:06:29 +0000
@@ -72,7 +72,7 @@
     });
 
     it('renders sidebar with hidden charms', function() {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -93,7 +93,7 @@
 
     it('shows and hides an indicator', function(done) {
       var hit = 0;
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -120,7 +120,7 @@
     });
 
     it('renders fullscreen 14/22 charms hidden', function() {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -141,7 +141,7 @@
     });
 
     it('clicking a charm navigates for fullscreen', function(done) {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -169,7 +169,7 @@
     });
 
     it('clicking a charm navigates for sidebar', function(done) {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -196,7 +196,7 @@
     });
 
     it('setting the activeID marks the div active', function() {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -217,7 +217,7 @@
     });
 
     it('unsetting the activeID will remove the active markings', function() {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value
@@ -255,7 +255,7 @@
     });
 
     it('uses passed in cache data if available', function() {
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value

=== modified file 'test/test_browser_search_view.js'
--- test/test_browser_search_view.js	2013-09-05 20:04:58 +0000
+++ test/test_browser_search_view.js	2013-09-13 20:06:29 +0000
@@ -53,7 +53,7 @@
     //
     // Create monkeypatched store to verify right method is called.
     apiURL = '';
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     var sampleData = {
       result: [{
         charm: {
@@ -161,7 +161,7 @@
         }
       }]
     };
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.set('datasource', {
       sendRequest: function(params) {
         // Stubbing the server callback value
@@ -205,7 +205,7 @@
         }
       }]
     };
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.set('datasource', {
       sendRequest: function(params) {
         // Stubbing the server callback value
@@ -249,7 +249,7 @@
         }
       }]
     };
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.set('datasource', {
       sendRequest: function(params) {
         // Stubbing the server callback value

=== modified file 'test/test_browser_search_widget.js'
--- test/test_browser_search_widget.js	2013-09-06 08:57:34 +0000
+++ test/test_browser_search_widget.js	2013-09-13 20:06:29 +0000
@@ -203,7 +203,7 @@
     cleanIconHelper = utils.stubCharmIconPath();
 
     // We need a valid store instance to send back the data.
-    fakeStore = new Y.juju.Charmworld2({});
+    fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.set('datasource', {
       sendRequest: function(params) {
         // Stubbing the server callback value

=== modified file 'test/test_charm_panel.js'
--- test/test_charm_panel.js	2013-09-06 00:26:54 +0000
+++ test/test_charm_panel.js	2013-09-13 20:06:29 +0000
@@ -129,7 +129,7 @@
         }
       };
       // Mock the charm store.
-      store = new juju.Charmworld2({
+      store = new juju.charmworld.APIv2({
         datasource: {
           sendRequest: function(params) {
             params.callback.success({

=== modified file 'test/test_charm_store.js'
--- test/test_charm_store.js	2013-09-12 17:06:27 +0000
+++ test/test_charm_store.js	2013-09-13 20:06:29 +0000
@@ -21,7 +21,8 @@
 (function() {
 
   describe('Charmworld API v2 interface', function() {
-    var Y, models, conn, env, app, container, data, juju, utils, hostname;
+    var Y, models, conn, env, app, container, data, juju, utils, charmworld,
+        hostname;
 
 
     before(function(done) {
@@ -31,6 +32,7 @@
           'juju-tests-utils',
           function(Y) {
             juju = Y.namespace('juju');
+            charmworld = Y.namespace('juju.charmworld');
             models = Y.namespace('juju.models');
             utils = Y.namespace('juju-tests').utils;
             done();
@@ -42,20 +44,20 @@
     });
 
     it('constructs the api url correctly based on apiHost', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname}),
+      var api = new charmworld.APIv2({apiHost: hostname}),
           ds = api.get('datasource');
 
       ds.get('source').should.eql(hostname + 'api/2/');
 
       // And it should work without a trailing / as well.
       hostname = hostname.slice(0, -1);
-      api = new Y.juju.Charmworld2({apiHost: hostname});
+      api = new charmworld.APIv2({apiHost: hostname});
       ds = api.get('datasource');
       ds.get('source').should.eql(hostname + '/api/2/');
     });
 
     it('handles loading interesting content correctly', function(done) {
-      var api = new Y.juju.Charmworld2({apiHost: hostname}),
+      var api = new charmworld.APIv2({apiHost: hostname}),
           data = [];
 
       data.push({responseText: Y.JSON.stringify({summary: 'wowza'})});
@@ -73,7 +75,7 @@
     });
 
     it('handles searching correctly', function(done) {
-      var api = new Y.juju.Charmworld2({apiHost: hostname}),
+      var api = new charmworld.APIv2({apiHost: hostname}),
           data = [],
           url;
       data.push({responseText: Y.JSON.stringify({name: 'foo'})});
@@ -100,7 +102,7 @@
     });
 
     it('constructs filepaths correctly', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
       var iconPath = api.filepath('precise/mysql-1', 'icon.svg');
       assert.equal(
           iconPath,
@@ -108,7 +110,7 @@
     });
 
     it('constructs cateogry icon paths correctly', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       var iconPath = api.categoryIconPath('app-servers');
       assert.equal(
@@ -117,7 +119,7 @@
     });
 
     it('makes charm requests to correct URL', function(done) {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       api._makeRequest = function(endpoint, callbacks, filters) {
         assert.equal(endpoint, 'charm/CHARM-ID');
@@ -128,7 +130,7 @@
     });
 
     it('can use a cache to avoid requesting charm data', function(done) {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       var should_not_happen = function() {
         assert.isTrue(false, 'Oops, this should not have been called.');
@@ -156,7 +158,7 @@
     });
 
     it('will make a request on a cache miss', function(done) {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       var should_not_happen = function() {
         assert.isTrue(false, 'Oops, this should not have been called.');
@@ -188,7 +190,7 @@
 
     it('makes autocomplete requests to correct URL', function(done) {
       var noop = function() {};
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       api._makeRequest = function(endpoint, callbacks, filters) {
         assert.equal(endpoint, 'charms');
@@ -200,7 +202,7 @@
 
     it('makes autocomplete requests with right query flag', function(done) {
       var noop = function() {};
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       api._makeRequest = function(endpoint, callbacks, filters) {
         assert.equal(filters.autocomplete, 'true');
@@ -211,47 +213,29 @@
     });
 
     it('constructs iconpaths correctly', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       var iconPath = api.iconpath('precise/mysql-1');
       assert.equal(iconPath, hostname + 'api/2/charm/precise/mysql-1/icon.svg');
     });
 
     it('constructs an icon path for local charms', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
 
       var iconPath = api.iconpath('local:precise/mysql-1');
       assert.equal(iconPath, hostname + 'static/img/charm_160.svg');
     });
 
     it('splits the charm id to remove cs: when necessary', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
       var iconPath = api.iconpath('cs:precise/mysql-1');
       assert.equal(iconPath, hostname + 'api/2/charm/precise/mysql-1/icon.svg');
     });
 
-    it('can normalize charm names for lookup', function() {
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
-      assert.equal(api.normalizeCharmId('wordpress', 'precise'),
-          'precise/wordpress-1');
-      assert.equal(api.normalizeCharmId('precise/wordpress', 'precise'),
-          'precise/wordpress-1');
-      assert.equal(api.normalizeCharmId('precise/wordpress'),
-          'precise/wordpress-1');
-      assert.equal(api.normalizeCharmId('precise/wordpress-10'),
-          'precise/wordpress-10');
-      assert.equal(api.normalizeCharmId('cs:precise/wordpress-10'),
-          'precise/wordpress-10');
-      assert.equal(api.normalizeCharmId('precise/wordpress-HEAD'),
-          'precise/wordpress-HEAD');
-      assert.equal(api.normalizeCharmId('cs:precise/wordpress-HEAD'),
-          'precise/wordpress-HEAD');
-    });
-
     it('can fetch a charm via a promise', function(done) {
       // The "promiseCharm" method is just a promise-wrapped version of the
       // "charm" method.
-      var api = new Y.juju.Charmworld2({apiHost: hostname});
+      var api = new charmworld.APIv2({apiHost: hostname});
       var DATA = 'DATA';
       var CHARM = 'CHARM';
       api.charm = function(charmID, callbacks) {
@@ -292,4 +276,47 @@
 
   });
 
+  describe('Charmworld API Helper', function() {
+    var Y, models, conn, env, app, container, data, juju, utils, charmworld,
+        hostname;
+
+
+    before(function(done) {
+      Y = YUI(GlobalConfig).use(
+          'datasource-local', 'json-stringify', 'juju-charm-store',
+          'datasource-io', 'io', 'array-extras', 'juju-charm-models',
+          'juju-tests-utils',
+          function(Y) {
+            juju = Y.namespace('juju');
+            charmworld = Y.namespace('juju.charmworld');
+            models = Y.namespace('juju.models');
+            utils = Y.namespace('juju-tests').utils;
+            done();
+          });
+    });
+
+    beforeEach(function() {
+      hostname = 'http://charmworld.example/';
+    });
+
+    it('can normalize charm names for lookup', function() {
+      var apiHelper = new charmworld.ApiHelper({});
+      assert.equal(apiHelper.normalizeCharmId('wordpress', 'precise'),
+          'precise/wordpress-1');
+      assert.equal(apiHelper.normalizeCharmId('precise/wordpress', 'precise'),
+          'precise/wordpress-1');
+      assert.equal(apiHelper.normalizeCharmId('precise/wordpress'),
+          'precise/wordpress-1');
+      assert.equal(apiHelper.normalizeCharmId('precise/wordpress-10'),
+          'precise/wordpress-10');
+      assert.equal(apiHelper.normalizeCharmId('cs:precise/wordpress-10'),
+          'precise/wordpress-10');
+      assert.equal(apiHelper.normalizeCharmId('precise/wordpress-HEAD'),
+          'precise/wordpress-HEAD');
+      assert.equal(apiHelper.normalizeCharmId('cs:precise/wordpress-HEAD'),
+          'precise/wordpress-HEAD');
+    });
+
+  });
+
 })();

=== modified file 'test/test_charm_view.js'
--- test/test_charm_view.js	2013-09-06 00:26:54 +0000
+++ test/test_charm_view.js	2013-09-13 20:06:29 +0000
@@ -90,7 +90,7 @@
       container = Y.Node.create('<div id="test-container" />');
       Y.one('#main').append(container);
       CharmView = juju.views.charm;
-      fakeStore = new Y.juju.Charmworld2({});
+      fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.set('datasource', {
         sendRequest: function(params) {
           // Stubbing the server callback value

=== modified file 'test/test_conflict_ux.js'
--- test/test_conflict_ux.js	2013-09-13 03:25:47 +0000
+++ test/test_conflict_ux.js	2013-09-13 20:06:29 +0000
@@ -82,7 +82,7 @@
       ['unit', 'add', {id: 'mediawiki/0', agent_state: 'pending'}]
     ]}});
 
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.iconpath = function() {
       return 'charm icon url';
     };

=== modified file 'test/test_environment_view.js'
--- test/test_environment_view.js	2013-09-06 00:26:54 +0000
+++ test/test_environment_view.js	2013-09-13 20:06:29 +0000
@@ -113,7 +113,7 @@
         env = juju.newEnvironment({conn: conn});
         env.connect();
         conn.open();
-        fakeStore = new Y.juju.Charmworld2({});
+        fakeStore = new Y.juju.charmworld.APIv2({});
         fakeStore.iconpath = function() {
           return 'charm icon url';
         };
@@ -1195,7 +1195,7 @@
     });
 
     it('sets the default icon for local charms without an icon', function() {
-      var iconFakeStore = new Y.juju.Charmworld2({
+      var iconFakeStore = new Y.juju.charmworld.APIv2({
         apiHost: 'http://localhost'
       });
       var services = new models.ServiceList();

=== modified file 'test/test_ghost_inspector.js'
--- test/test_ghost_inspector.js	2013-09-12 12:36:25 +0000
+++ test/test_ghost_inspector.js	2013-09-13 20:06:29 +0000
@@ -69,7 +69,7 @@
     // Create a ghost service with the fake charm.
     service = db.services.ghostService(charm);
 
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.iconpath = function(id) {
       return '/icon/' + id;
     };

=== modified file 'test/test_inspector_charm.js'
--- test/test_inspector_charm.js	2013-08-27 18:06:51 +0000
+++ test/test_inspector_charm.js	2013-09-13 20:06:29 +0000
@@ -68,7 +68,7 @@
     testContainer = utils.makeContainer();
     testContainer.setHTML('<div class="left-breakout"></div>');
 
-    fakeStore = new Y.juju.Charmworld2({});
+    fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.set('datasource', {
       sendRequest: function(params) {
         // Stubbing the server callback value
@@ -107,7 +107,7 @@
     testContainer = utils.makeContainer();
     testContainer.setHTML('<div class="left-breakout"></div>');
 
-    fakeStore = new Y.juju.Charmworld2({});
+    fakeStore = new Y.juju.charmworld.APIv2({});
     var cache = new Y.juju.models.BrowserCharmList();
     var charm = new Y.juju.models.BrowserCharm(data.charm);
     charm.set('cached', true);

=== modified file 'test/test_inspector_constraints.js'
--- test/test_inspector_constraints.js	2013-09-11 15:40:06 +0000
+++ test/test_inspector_constraints.js	2013-09-13 20:06:29 +0000
@@ -86,7 +86,7 @@
     var conn = new utils.SocketStub();
     var db = new models.Database();
     var service = makeService(db);
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.iconpath = function() {
       return 'charm icon url';
     };

=== modified file 'test/test_inspector_overview.js'
--- test/test_inspector_overview.js	2013-09-13 18:06:31 +0000
+++ test/test_inspector_overview.js	2013-09-13 20:06:29 +0000
@@ -109,7 +109,7 @@
       ['unit', 'add', {id: 'mediawiki/1', agent_state: 'pending'}],
       ['unit', 'add', {id: 'mediawiki/2', agent_state: 'pending'}]
     ]}});
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.iconpath = function(id) {
       return '/icon/' + id;
     };

=== modified file 'test/test_inspector_settings.js'
--- test/test_inspector_settings.js	2013-09-12 19:56:59 +0000
+++ test/test_inspector_settings.js	2013-09-13 20:06:29 +0000
@@ -93,7 +93,7 @@
         ['unit', 'add', {id: 'mediawiki/2', agent_state: 'pending'}]
       ]}});
     }
-    var fakeStore = new Y.juju.Charmworld2({});
+    var fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.iconpath = function() {
       return 'charm icon url';
     };

=== modified file 'test/test_model.js'
--- test/test_model.js	2013-09-11 20:39:45 +0000
+++ test/test_model.js	2013-09-13 20:06:29 +0000
@@ -488,7 +488,7 @@
     conn.open();
     container = Y.Node.create('<div id="test" class="container"></div>');
     data = [];
-    fakeStore = new Y.juju.Charmworld2({});
+    fakeStore = new Y.juju.charmworld.APIv2({});
     fakeStore.set('datasource', {
       sendRequest: function(params) {
         params.callback.success({

=== modified file 'test/utils.js'
--- test/utils.js	2013-08-21 15:47:36 +0000
+++ test/utils.js	2013-09-13 20:06:29 +0000
@@ -139,9 +139,9 @@
 
     makeFakeStore: function(cache) {
       var modellist = cache;
-      var fakeStore = new Y.juju.Charmworld2({});
+      var fakeStore = new Y.juju.charmworld.APIv2({});
       fakeStore.charm = function(store_id, callbacks, bindscope, cache) {
-        store_id = this.normalizeCharmId(store_id, 'precise');
+        store_id = this.apiHelper.normalizeCharmId(store_id, 'precise');
         var charmName = store_id.split('/')[1];
         charmName = charmName.split('-', 1);
         if (charmName in jujuTests.utils._cached_charms) {