initial commit

Author: Lee Richmond

.gitignore

@@ -0,0 +1,53 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+*.swp
+*.swn
+*.swo
+
+tmp/*
+!tmp/.keepme

gulpfile.js

@@ -0,0 +1,27 @@
+const gulp    = require('gulp');
+const mocha   = require('gulp-mocha');
+const clean   = require('gulp-clean');
+const webpack = require('webpack-stream');
+const ts      = require('gulp-typescript');
+
+var tsProject = ts.createProject('tsconfig.json');
+
+gulp.task('test_clean', function () {
+  //return gulp.src('./tmp/test/**/*', { read: false })
+    //.pipe(clean());
+});
+
+gulp.task('test', ['test_clean'], () =>
+  gulp
+    .src(['./index.d.ts.', './src/**/*.ts', './test/test-helper.ts', './test/**/*-test.ts'], { base: '.' })
+    .pipe(tsProject())
+    .pipe(gulp.dest('tmp/test'))
+    .pipe(mocha())
+);
+
+// Use webpack, not tsProject, for browserification
+gulp.task('build', function () {
+  return gulp.src("src/main.ts")
+    .pipe(webpack(require('./webpack.config.js') ))
+    .pipe(gulp.dest('dist/'))
+});

index.d.ts

@@ -0,0 +1,17 @@
+declare var expect: any;
+declare var asyncAssert: any;
+
+// todo deglobalize?, split test
+
+interface japiDocArray {
+  data: Array<japiResource>;
+}
+
+interface japiDoc {
+  data: japiResource;
+}
+
+interface japiResource {
+  id: string;
+  type: string;
+}

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "jsorm",
+  "version": "1.0.0",
+  "description": "Javascript ORM",
+  "main": "./dist/main.js",
+  "types": "./main.d.ts",
+  "scripts": {
+    "test": "gulp test"
+  },
+  "author": "Lee Richmond",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/chai": "^3.4.34",
+    "@types/chai-as-promised": "0.0.29",
+    "@types/es6-promise": "0.0.32",
+    "@types/isomorphic-fetch": "0.0.31",
+    "@types/mocha": "^2.2.33",
+    "@types/node": "^6.0.52",
+    "chai": "^3.5.0",
+    "chai-as-promised": "^6.0.0",
+    "chai-things": "^0.2.0",
+    "fetch-mock": "^5.6.2",
+    "gulp": "^3.9.1",
+    "gulp-clean": "^0.3.2",
+    "gulp-mocha": "^3.0.1",
+    "gulp-typescript": "^3.1.3",
+    "mocha": "^3.2.0",
+    "sinon": "^1.17.6",
+    "typescript": "^2.1.4",
+    "webpack-stream": "^3.2.0"
+  },
+  "dependencies": {
+    "es6-promise": "^4.0.5",
+    "isomorphic-fetch": "^2.2.1",
+    "ts-loader": "^1.3.2"
+  }
+}

src/main.ts

@@ -0,0 +1,9 @@
+/// <reference path="../index.d.ts" />
+
+import * as es6Promise from 'es6-promise';
+import 'isomorphic-fetch';
+es6Promise.polyfill();
+
+import Model from "./model";
+
+export { Model };

src/model.ts

@@ -0,0 +1,54 @@
+/// <reference path="../index.d.ts" />
+
+import Scope from './scope';
+
+export default class Model {
+  static baseUrl = process.env.BROWSER? '': 'http://localhost:9999'
+  static endpoint = 'define-in-subclass';
+  static apiNamespace = '/';
+
+  id: string;
+
+  private static _scope: Scope;
+
+  static scope(): Scope {
+    return this._scope || new Scope(this);
+  }
+
+  constructor(attributes?: Object) {
+    for(var key in attributes) {
+      this[key] = attributes[key];
+    }
+  }
+
+  static all() : Promise<Array<Model>> {
+    return this.scope().all();
+  }
+
+  static find(id) : Promise<Model> {
+    return this.scope().find(id);
+  }
+
+  // private
+
+  private static _url(id?: string) : string {
+    let base = `${this.baseUrl}${this.apiNamespace}${this.endpoint}`;
+
+    if (id) {
+      base = `${base}/${id}`;
+    }
+
+    return base;
+  }
+
+  private static _fetch(url) : Promise<Object> {
+    return new Promise((resolve, reject) => {
+      fetch(url).then((response) => {
+        response.json().then((json) => {
+          resolve(json);
+        });
+      });
+    });
+  }
+
+}

src/scope.ts

@@ -0,0 +1,57 @@
+import Model from './model';
+
+export default class Scope {
+  model: typeof Model;
+
+  constructor(model : typeof Model) {
+    this.model = model;
+  }
+
+  all() : Promise<Array<Model>> {
+    return new Promise((resolve, reject) => {
+      this._fetch(this._url()).then((json : japiDocArray) => {
+        let records = json.data.map((datum : japiResource) => {
+          return this._newFromJSON(datum);
+        });
+        resolve(records);
+      });
+    });
+  }
+
+  find(id) : Promise<Model> {
+    return new Promise((resolve, reject) => {
+      this._fetch(this._url(id)).then((json : japiDoc) => {
+        resolve(this._newFromJSON(json.data));
+      });
+    });
+  }
+
+  // private
+
+  private _newFromJSON(resource : japiResource) : Model {
+    let instance = new this.model({ id: resource.id });
+    return instance;
+  }
+
+  private _url(id?: string) : string {
+    let base = this.model.baseUrl;
+    base = base + this.model.apiNamespace;
+    base = base + this.model.endpoint;
+
+    if (id) {
+      base = `${base}/${id}`;
+    }
+
+    return base;
+  }
+
+  private _fetch(url) : Promise<Object> {
+    return new Promise((resolve, reject) => {
+      fetch(url).then((response) => {
+        response.json().then((json) => {
+          resolve(json);
+        });
+      });
+    });
+  }
+}

test/model-test.ts

@@ -0,0 +1,62 @@
+import '../test/test-helper';
+import { Model } from '../src/main';
+
+class Person extends Model {
+  static baseUrl = 'http://example.com';
+  static apiNamespace = '/api';
+  static endpoint = '/v1/people';
+}
+
+let fetchMock = require('fetch-mock');
+let mockResponse = {};
+
+before(function() {
+  fetchMock.get('http://example.com/api/v1/people/1', {
+    data: {
+      id: '1'
+    }
+  });
+});
+
+after(function () {
+  fetchMock.restore();
+});
+
+describe('Model', function() {
+  describe('#find()', function() {
+    before(function () {
+      fetchMock.get('http://example.com/api/v1/people/1', {
+        data: {
+          id: '1'
+        }
+      });
+    });
+
+    it('returns a promise that resolves the correct instance', function() {
+      return expect(Person.find(1)).to.eventually
+        .be.instanceof(Person).and
+        .have.property('id', '1');
+    });
+
+    describe('when API response returns a different type than the caller', function() {
+      it('resolves to the correct class', function() {
+      });
+    });
+  });
+
+  describe('#all()', function() {
+    before(function () {
+      fetchMock.get('http://example.com/api/v1/people', {
+        data: [
+          { id: '1' }
+        ]
+      });
+    });
+
+    it('returns a promise that resolves the correct instances', function() {
+      return expect(Person.all()).to.eventually
+        .all.be.instanceof(Person)
+        .all.have.property('id', '1').and
+    });
+  });
+});

test/test-helper.ts

@@ -0,0 +1,29 @@
+/// <reference path="../index.d.ts" />
+
+import * as es6Promise from 'es6-promise';
+import 'isomorphic-fetch';
+import * as sinon from 'sinon';
+es6Promise.polyfill();
+
+import * as chai from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+import * as chaiThings from 'chai-things';
+
+// MUST be in this order
+chai.use(chaiThings);
+chai.use(chaiAsPromised);
+
+global['expect'] = chai.expect;
+global['sinon'] = sinon;
+
+global['asyncAssert'] = function(done, callback) {
+  try {
+    if (callback() === false) {
+      done('Failed!');
+    } else {
+      done();
+    }
+  } catch(e) {
+    done(e);
+  }
+}