Start defining basic layers

Author: emmenko

Gruntfile.coffee

@@ -7,109 +7,111 @@ module.exports = (grunt)->
     pkg: grunt.file.readJSON 'package.json'
 
     meta:
-      banner: "/* ===========================================================\n" +
-        "# <%= pkg.title || pkg.name %> - v<%= pkg.version %>\n" +
-        "# ==============================================================\n" +
-        "# Copyright (c) <%= grunt.template.today(\"yyyy\") %> <%= pkg.author.name %>\n" +
-        "# Licensed <%= _.pluck(pkg.licenses, \"type\").join(\", \") %>.\n" +
-        "*/\n"
+      banner: '/* ===========================================================\n' +
+        '# <%= pkg.title || pkg.name %> - v<%= pkg.version %>\n' +
+        '# ==============================================================\n' +
+        '# Copyright (c) <%= grunt.template.today(\"yyyy\") %> <%= pkg.author.name %>\n' +
+        '# Licensed <%= _.pluck(pkg.licenses, \"type\").join(\", \") %>.\n' +
+        '*/\n'
 
     coffeelint:
       options:
         indentation:
           value: 2
-          level: "error"
+          level: 'error'
         no_trailing_semicolons:
-          level: "error"
+          level: 'error'
         no_trailing_whitespace:
-          level: "error"
+          level: 'error'
         max_line_length:
-          level: "ignore"
-      default: ["Gruntfile.coffee", "src/**/*.coffee"]
+          level: 'ignore'
+      default: ['Gruntfile.coffee', 'src/**/*.coffee']
 
     clean:
-      default: "lib"
-      test: "test"
+      default: 'lib'
+      test: 'test'
 
     coffee:
       options:
         bare: true
       default:
-        expand: true
-        flatten: true
-        cwd: "src/coffee"
-        src: ["*.coffee"]
-        dest: "lib"
-        ext: ".js"
+        files: grunt.file.expandMapping(['**/*.coffee'], 'lib/',
+          flatten: false
+          cwd: 'src/coffee'
+          ext: '.js'
+          rename: (dest, matchedSrcPath)->
+            dest + matchedSrcPath
+          )
       test:
-        expand: true
-        flatten: true
-        cwd: "src/spec"
-        src: ["*.spec.coffee"]
-        dest: "test"
-        ext: ".spec.js"
+        files: grunt.file.expandMapping(['**/*.spec.coffee'], 'test/',
+          flatten: false
+          cwd: 'src/spec'
+          ext: '.spec.js'
+          rename: (dest, matchedSrcPath)->
+            dest + matchedSrcPath
+          )
 
     concat:
       options:
-        banner: "<%= meta.banner %>"
+        banner: '<%= meta.banner %>'
         stripBanners: true
       default:
         expand: true
         flatten: true
-        cwd: "lib"
-        src: ["*.js"]
-        dest: "lib"
-        ext: ".js"
+        cwd: 'lib'
+        src: ['*.js']
+        dest: 'lib'
+        ext: '.js'
 
     # watching for changes
     watch:
       default:
-        files: ["src/coffee/*.coffee"]
-        tasks: ["build"]
+        files: ['src/coffee/*.coffee']
+        tasks: ['build']
       test:
-        files: ["src/**/*.coffee"]
-        tasks: ["test"]
+        files: ['src/**/*.coffee']
+        tasks: ['test']
 
     shell:
       options:
         stdout: true
         stderr: true
         failOnError: true
       coverage:
-        command: "istanbul cover jasmine-node --captureExceptions test && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"
+        command: 'istanbul cover jasmine-node --captureExceptions test && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage'
       jasmine:
-        command: "jasmine-node --captureExceptions test"
+        command: 'jasmine-node --captureExceptions test'
       publish:
-        command: "npm publish"
+        command: 'npm publish'
 
     bump:
       options:
-        files: ["package.json"]
-        updateConfigs: ["pkg"]
+        files: ['package.json']
+        updateConfigs: ['pkg']
         commit: true
-        commitMessage: "Bump version to %VERSION%"
-        commitFiles: ["-a"]
+        commitMessage: 'Bump version to %VERSION%'
+        commitFiles: ['-a']
         createTag: true
-        tagName: "v%VERSION%"
-        tagMessage: "Version %VERSION%"
+        tagName: 'v%VERSION%'
+        tagMessage: 'Version %VERSION%'
         push: true
-        pushTo: "origin"
-        gitDescribeOptions: "--tags --always --abbrev=1 --dirty=-d"
+        pushTo: 'origin'
+        gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d'
 
   # load plugins that provide the tasks defined in the config
-  grunt.loadNpmTasks "grunt-bump"
-  grunt.loadNpmTasks "grunt-coffeelint"
-  grunt.loadNpmTasks "grunt-contrib-clean"
-  grunt.loadNpmTasks "grunt-contrib-coffee"
-  grunt.loadNpmTasks "grunt-contrib-concat"
-  grunt.loadNpmTasks "grunt-contrib-watch"
-  grunt.loadNpmTasks "grunt-shell"
+  grunt.loadNpmTasks 'grunt-bump'
+  grunt.loadNpmTasks 'grunt-coffeelint'
+  grunt.loadNpmTasks 'grunt-contrib-clean'
+  grunt.loadNpmTasks 'grunt-contrib-coffee'
+  grunt.loadNpmTasks 'grunt-contrib-concat'
+  grunt.loadNpmTasks 'grunt-contrib-watch'
+  grunt.loadNpmTasks 'grunt-shell'
 
   # register tasks
-  grunt.registerTask "default", ["build"]
-  grunt.registerTask "build", ["clean", "coffeelint", "coffee", "concat"]
-  grunt.registerTask "test", ["build", "shell:jasmine"]
-  grunt.registerTask "coverage", ["build", "shell:coverage"]
-  grunt.registerTask "release", "Release a new version, push it and publish it", (target)->
-    target = "patch" unless target
-    grunt.task.run "bump-only:#{target}", "test", "bump-commit", "shell:publish"
+  grunt.registerTask 'default', ['build']
+  grunt.registerTask 'build', ['clean', 'coffeelint', 'coffee', 'concat']
+  grunt.registerTask 'test', ['build', 'shell:jasmine']
+  grunt.registerTask 'coverage', ['build', 'shell:coverage']
+  grunt.registerTask 'release', 'Release a new version, push it and publish it', (target)->
+    target = 'patch' unless target
+    grunt.task.run 'bump-only:#{target}', 'test', 'bump-commit', 'shell:publish'

lib/client.js

@@ -0,0 +1,34 @@
+/* ===========================================================
+# sphere-node-sdk - v0.0.1
+# ==============================================================
+# Copyright (c) 2014 Nicola Molinari
+# Licensed MIT.
+*/
+var ProductService, Rest, SphereClient;
+
+Rest = require('sphere-node-connect').Rest;
+
+ProductService = require('./services/products');
+
+/**
+ * Defines a SphereClient.
+ * @class SphereClient
+*/
+
+
+SphereClient = (function() {
+  function SphereClient(config) {
+    this._rest = new Rest(config);
+    this.products = new ProductService(this._rest);
+  }
+
+  return SphereClient;
+
+})();
+
+/**
+ * The {@link SphereClient} client.
+*/
+
+
+module.exports = SphereClient;

lib/services/base.js

@@ -0,0 +1,52 @@
+var BaseService, Q;
+
+Q = require('q');
+
+/**
+ * Creates a new BaseService, containing base functionalities. It should be extended when defining a Service.
+ * @class BaseService
+*/
+
+
+BaseService = (function() {
+  /**
+   * Initialize the class.
+   * @param  {Rest} [@_rest] an instance of the Rest client (sphere-node-connect)
+   * @return {BaseService}
+  */
+
+  function BaseService(_rest) {
+    this._rest = _rest;
+    this._projectEndpoint = '/';
+    this;
+  }
+
+  /**
+   * Fetch resource defined by [@_projectEndpoint]
+   * @return {Promise} a promise, fulfilled with an Object or rejected with a SphereError
+  */
+
+
+  BaseService.prototype.fetch = function() {
+    var deferred;
+    deferred = Q.defer();
+    this._rest(this._projectEndpoint, function(e, r, b) {
+      if (e) {
+        return deferred.reject(e);
+      } else {
+        return deferred.resolve(JSON.parse(b));
+      }
+    });
+    return deferred.promise;
+  };
+
+  return BaseService;
+
+})();
+
+/**
+ * The {@link BaseService} service.
+*/
+
+
+module.exports = BaseService;

lib/services/products.js

@@ -0,0 +1,38 @@
+var BaseService, ProductService,
+  __hasProp = {}.hasOwnProperty,
+  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
+
+BaseService = require('./base');
+
+/**
+ * Creates a new ProductService.
+ * @class ProductService
+*/
+
+
+ProductService = (function(_super) {
+  __extends(ProductService, _super);
+
+  /**
+   * Initialize the class.
+   * @param  {Rest} [@_rest] an instance of the Rest client (sphere-node-connect)
+   * @return {ProductService}
+  */
+
+
+  function ProductService(rest) {
+    ProductService.__super__.constructor.call(this, rest);
+    this._projectEndpoint = '/';
+    this;
+  }
+
+  return ProductService;
+
+})(BaseService);
+
+/**
+ * The {@link ProductService} service.
+*/
+
+
+module.exports = ProductService;

package.json

@@ -27,6 +27,11 @@
   "scripts": {
     "test": "grunt coverage"
   },
+  "dependencies": {
+    "q": "~1.0.0",
+    "sphere-node-connect": "~0.2.2",
+    "underscore": "~1.5.2"
+  },
   "devDependencies": {
     "coveralls": "~2.6.1",
     "grunt": "~0.4.1",

src/coffee/client.coffee

@@ -1,3 +1,19 @@
-"use strict"
+Rest = require('sphere-node-connect').Rest
+ProductService = require('./services/products')
 
-exports.awesome = -> "awesome"
+###*
+ * Defines a SphereClient.
+ * @class SphereClient
+###
+class SphereClient
+
+  constructor: (config)->
+    @_rest = new Rest config
+
+    # services
+    @products = new ProductService @_rest
+
+###*
+ * The {@link SphereClient} client.
+###
+module.exports = SphereClient

src/coffee/services/base.coffee

@@ -0,0 +1,34 @@
+Q = require('q')
+
+###*
+ * Creates a new BaseService, containing base functionalities. It should be extended when defining a Service.
+ * @class BaseService
+###
+class BaseService
+
+  ###*
+   * Initialize the class.
+   * @param  {Rest} [@_rest] an instance of the Rest client (sphere-node-connect)
+   * @return {BaseService}
+  ###
+  constructor: (@_rest)->
+    @_projectEndpoint = '/'
+    @
+
+  ###*
+   * Fetch resource defined by [@_projectEndpoint]
+   * @return {Promise} a promise, fulfilled with an Object or rejected with a SphereError
+  ###
+  fetch: ->
+    deferred = Q.defer()
+    @_rest @_projectEndpoint, (e, r, b)->
+      if e
+        deferred.reject e
+      else
+        deferred.resolve JSON.parse b
+    deferred.promise
+
+###*
+ * The {@link BaseService} service.
+###
+module.exports = BaseService

src/coffee/services/products.coffee

@@ -0,0 +1,22 @@
+BaseService = require('./base')
+
+###*
+ * Creates a new ProductService.
+ * @class ProductService
+###
+class ProductService extends BaseService
+
+  ###*
+   * Initialize the class.
+   * @param  {Rest} [@_rest] an instance of the Rest client (sphere-node-connect)
+   * @return {ProductService}
+  ###
+  constructor: (rest)->
+    super(rest)
+    @_projectEndpoint = '/'
+    @
+
+###*
+ * The {@link ProductService} service.
+###
+module.exports = ProductService