vets_json_schema 1.0.0

data/src/generate-schemas.js

@@ -0,0 +1,5 @@
+import eduBenefitsSchema from './edu-benefits/schema';
+import jsonfile from 'jsonfile';
+
+jsonfile.writeFileSync('dist/edu-benefits-schema.json', eduBenefitsSchema, { spaces: 2 });
+console.log('json built');

data/src/start.js

@@ -0,0 +1,10 @@
+require('babel-register');
+
+switch(process.argv[2]) {
+  case 'build':
+    require('./generate-schemas');
+    break;
+  case 'watch':
+    require('./watch');
+    break;
+}

data/src/watch.js

@@ -0,0 +1,16 @@
+import watch from 'node-watch';
+import { execSync } from 'child_process';
+
+const build = () => {
+  try {
+    execSync('npm run build', { stdio:[0,1,2] });
+  } catch (e) {
+    console.log(e.message);
+  }
+};
+
+build();
+
+console.log('watching for changes in src dir..');
+
+watch('src', { recursive: true }, build);

data/test/edu-benefits/schema.spec.js

@@ -0,0 +1,330 @@
+import { expect } from 'chai';
+import schema from '../../dist/edu-benefits-schema.json';
+import Ajv from 'ajv';
+import _ from 'lodash';
+
+describe('education benefits json schema', () => {
+  let ajv = new Ajv();
+  let currentSchema;
+  const validateSchema = (data) => {
+    return ajv.validate(currentSchema, data);
+  };
+  const validators = {
+    valid: (data) => {
+      expect(validateSchema(data)).to.equal(true);
+    },
+    invalid: (data) => {
+      expect(validateSchema(data)).to.equal(false);
+      expect(ajv.errors[0].dataPath).to.contain(`.${Object.keys(data)[0]}`);
+    }
+  };
+  const objectBuilder = (keys, value) => {
+    let object = {};
+
+    keys.split('.').reverse().forEach((key, i) => {
+      if (i === 0) {
+        object = {
+          [key]: value
+        };
+      } else {
+        object = {
+          [key]: object
+        };
+      }
+    });
+
+    return object;
+  };
+  const testValidAndInvalid = (parentKey, fields) => {
+    ['valid', 'invalid'].forEach((fieldType) => {
+      fields[fieldType].forEach((values) => {
+        it(`should${fieldType === 'valid' ? '' : 'nt'} allow ${parentKey} with ${JSON.stringify(values)}`, () => {
+          validators[fieldType](objectBuilder(parentKey, values));
+        });
+      });
+    });
+  };
+  const validDateRange = {
+    from: '2000-01-01',
+    to: '2000-01-02'
+  };
+
+  beforeEach(() => {
+    currentSchema = schema;
+  });
+
+  context('ssn validations', () => {
+    testValidAndInvalid('veteranSocialSecurityNumber', {
+      valid: ['123456789'],
+      invalid: ['123-45-6789', '12345678']
+    });
+  });
+
+  context('name validations', () => {
+    ['veteranFullName'].forEach((parentKey) => {
+      testValidAndInvalid(parentKey, {
+        valid: [{
+          first: 'john',
+          last: 'doe'
+        }],
+        invalid: [{
+          first: 'john'
+        }]
+      });
+    });
+  });
+
+  context('gender validations', () => {
+    testValidAndInvalid('gender', {
+      valid: ['M', 'F'],
+      invalid: ['Z']
+    });
+  });
+
+  context('address validations', () => {
+    beforeEach(() => {
+      let modifiedSchema = _.cloneDeep(schema);
+      delete(modifiedSchema.properties.school.required);
+      currentSchema = modifiedSchema;
+    });
+
+    ['veteranAddress', 'secondaryContact.address', 'school.address'].forEach((parentKey) => {
+      testValidAndInvalid(parentKey, {
+        valid: [{
+          street: '123 a rd',
+          city: 'abc',
+          country: 'USA'
+        }],
+        invalid: [{
+          city: 'foo',
+          country: 'USA'
+        }]
+      });
+    });
+  });
+
+  context('phone # validations', () => {
+    ['homePhone', 'mobilePhone', 'secondaryContact.phone'].forEach((parentKey) => {
+      testValidAndInvalid(parentKey, {
+        valid: ['5555555555'],
+        invalid: ['1a']
+      });
+    });
+  });
+
+  context('bank account validations', () => {
+    testValidAndInvalid('bankAccount.accountType', {
+      valid: ['checking', 'savings'],
+      invalid: ['bitcoin']
+    });
+
+    testValidAndInvalid('bankAccount.routingNumber', {
+      valid: ['123456789'],
+      invalid: ['12345678']
+    });
+  });
+
+  context('serviceAcademyGraduationYear validations', () => {
+    testValidAndInvalid('serviceAcademyGraduationYear', {
+      valid: [2004],
+      invalid: [1899]
+    });
+  });
+
+  context('dateRange validations', () => {
+    testValidAndInvalid('activeDutyRepayingPeriod', {
+      valid: [
+        validDateRange,
+        {
+          from: '2000-01-01',
+          to: 'present'
+        }
+      ],
+      invalid: [
+        {
+          from: 'foo',
+          to: 'bar'
+        },
+        {
+          from: '2000-01-01',
+          to: 'future'
+        },
+        {
+          from: '2000-01-01'
+        }
+      ]
+    });
+  });
+
+  context('date validations', () => {
+    testValidAndInvalid('veteranDateOfBirth', {
+      valid: ['2000-01-02'],
+      invalid: ['4/6/1998', 'Fri Aug 19 2016 15:09:46 GMT-0400 (EDT)']
+    });
+  });
+
+  context('tours of duty validation', () => {
+    testValidAndInvalid('toursOfDuty', {
+      valid: [[{
+        dateRange: validDateRange,
+        serviceBranch: 'navy',
+        serviceStatus: 'active',
+        involuntarilyCalledToDuty: 'yes',
+        benefitsToApplyTo: 'chapter30'
+      }]],
+      invalid: [
+        [{
+          serviceBranch: 'navy',
+          serviceStatus: 'active',
+          involuntarilyCalledToDuty: 'yes'
+        }],
+        [{
+          dateRange: validDateRange,
+          serviceBranch: 1,
+          serviceStatus: 'active',
+          involuntarilyCalledToDuty: 'yes'
+        }],
+        [{
+          dateRange: validDateRange,
+          serviceBranch: 'navy',
+          serviceStatus: 'active',
+          involuntarilyCalledToDuty: 'yes',
+          benefitsToApplyTo: ['chapter85968568']
+        }]
+      ],
+    });
+  });
+
+  context('post high school trainings validation', () => {
+    testValidAndInvalid('postHighSchoolTrainings', {
+      valid: [[{
+        name: 'college',
+        dateRange: validDateRange,
+        city: 'new york',
+        hoursType: 'semester',
+        state: 'NY'
+      }]],
+      invalid: [
+        [{
+          name: 'college'
+        }],
+        [{
+          name: 'college',
+          dateRange: validDateRange,
+          city: 'new york',
+          hoursType: 'semestar',
+          state: 'NY'
+        }],
+        [{
+          name: 'college',
+          dateRange: validDateRange,
+          city: 'new york',
+          hoursType: 'semester',
+          state: 'ABC'
+        }]
+      ]
+    });
+  });
+
+  context('non military jobs validation', () => {
+    testValidAndInvalid('nonMilitaryJobs', {
+      valid: [[{
+        name: 'president',
+        months: 9999,
+        postMilitaryJob: true
+      }]],
+      invalid: [[{
+        postMilitaryJob: true,
+        months: 1
+      }]]
+    });
+  });
+
+  context('senior rotc validation', () => {
+    testValidAndInvalid('seniorRotc', {
+      valid: [{
+        commissionYear: 1981,
+        rotcScholarshipAmounts: [{
+          year: 1999,
+          amount: 99.99
+        }]
+      }],
+      invalid: [{
+        commissionYear: 1981,
+      }]
+    });
+  });
+
+  context('email validation', () => {
+    testValidAndInvalid('email', {
+      valid: [
+        'foo@foo.com',
+        'foo+1@foo.com'
+      ],
+      invalid: ['foo']
+    });
+  });
+
+  context('preferredContactMethod validation', () => {
+    testValidAndInvalid('preferredContactMethod', {
+      valid: [
+        'mail',
+        'email'
+      ],
+      invalid: ['foo']
+    });
+  });
+
+  context('benefitsRelinquished validation', () => {
+    testValidAndInvalid('benefitsRelinquished', {
+      valid: ['chapter30', 'unknown', 'chapter1607', 'chapter1606'],
+      invalid: ['chapter33']
+    });
+  });
+
+  context('serviceBefore1977 validation', () => {
+    testValidAndInvalid('serviceBefore1977', {
+      valid: [{
+        married: true,
+        haveDependents: true,
+        parentDependent: false
+      }],
+      invalid: [{
+        married: true
+      }]
+    });
+  });
+
+  context('school validation', () => {
+    testValidAndInvalid('school', {
+      valid: [{
+        name: 'harvard'
+      }],
+      invalid: [{
+        name: true
+      }]
+    });
+  });
+
+  context('previous va claims validation', () => {
+    testValidAndInvalid('previousVaClaims', {
+      valid: [
+        [{
+          claimType: 'vocationalRehab'
+        }],
+        [{
+          claimType: 'vocationalRehab',
+          fileNumber: 'blah',
+          sponsorVeteran: {
+            fileNumber: 'number'
+          }
+        }]
+      ],
+      invalid: [
+        [{
+          fileNumber: 'blah',
+        }]
+      ]
+    });
+  });
+});

data/test/mocha.opts

@@ -0,0 +1 @@
+--compilers js:babel-register

data/vets_json_schema.gemspec

@@ -0,0 +1,13 @@
+require 'json'
+
+Gem::Specification.new do |gem|
+  gem.name = 'vets_json_schema'
+
+  gem.version = JSON.parse(File.read('package.json'))['version']
+  gem.summary = 'JSON Schemas for all Vets.gov projects'
+  gem.author = 'VA devs'
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: vets_json_schema
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- VA devs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".babelrc"
+- ".gitattributes"
+- ".gitignore"
+- ".nvmrc"
+- ".travis.yml"
+- README.md
+- dist/edu-benefits-schema.json
+- lib/vets_json_schema.rb
+- package.json
+- src/common/constants.js
+- src/edu-benefits/schema.js
+- src/generate-schemas.js
+- src/start.js
+- src/watch.js
+- test/edu-benefits/schema.spec.js
+- test/mocha.opts
+- vets_json_schema.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: JSON Schemas for all Vets.gov projects
+test_files: []