├── index.js ├── .gitignore ├── test ├── fixtures │ ├── default-error-schema.json │ └── blueprint.md ├── instantiation.js ├── validation.js └── schema-selection.js ├── package.json ├── README.md ├── lib ├── helpers.js └── bluth.js └── LICENSE /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require( './lib/bluth' ); 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # nyc test coverage 18 | .nyc_output 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules 31 | jspm_packages 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | -------------------------------------------------------------------------------- /test/fixtures/default-error-schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-04/schema#", 3 | "title": "Error", 4 | "type": "object", 5 | "required": [ 6 | "code", 7 | "message", 8 | "errors" 9 | ], 10 | "properties": { 11 | "code": { 12 | "description": "Error code reference.", 13 | "type": "string" 14 | }, 15 | "message": { 16 | "description": "Error description", 17 | "type": "string" 18 | }, 19 | "errors": { 20 | "description": "Errors related to request data.", 21 | "type": "array", 22 | "items": { 23 | "type": "object", 24 | "required": [ 25 | "property", 26 | "message" 27 | ], 28 | "properties": { 29 | "property": { 30 | "description": "Property name.", 31 | "type": "string" 32 | }, 33 | "message": { 34 | "description": "Error message relating to a property.", 35 | "type": "string" 36 | } 37 | } 38 | } 39 | } 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /test/instantiation.js: -------------------------------------------------------------------------------- 1 | // External dependencies 2 | var fs = require( 'fs' ), 3 | should = require( 'should' ); 4 | 5 | 6 | // Dependencies 7 | var Bluth = require( '../' ); 8 | 9 | 10 | var blueprintMd = fs.readFileSync( __dirname + '/./fixtures/blueprint.md' ).toString(); 11 | 12 | 13 | describe( 'Instantiation', function() { 14 | 15 | it( 'should create an instance of Bluth', function( done ) { 16 | var bluth = new Bluth( blueprintMd ); 17 | 18 | bluth.get() 19 | .then( function( blueprint ) { 20 | done(); 21 | } ); 22 | 23 | } ); 24 | 25 | it( 'should return an error if Blueprint is not a string', function() { 26 | 27 | try { 28 | var bluth = new Bluth( {}, {} ); 29 | } catch ( error ) { 30 | should.exist( error ); 31 | } 32 | 33 | } ); 34 | 35 | it( 'should have config properties set on the instance', function() { 36 | var bluth = new Bluth( blueprintMd, { 37 | bees: 'BEADS?!' 38 | } ); 39 | 40 | bluth.config.should.have.property( 'bees' ).and.equal( 'BEADS?!' ); 41 | 42 | } ); 43 | 44 | } ); 45 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "bluth", 3 | "version": "0.0.3", 4 | "description": "Lightweight library to validate requests and responses, according to your API blueprint.", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "node_modules/.bin/mocha" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "https://github.com/ribot/bluth.git" 12 | }, 13 | "keywords": [ 14 | "api", 15 | "blueprint", 16 | "json", 17 | "schema", 18 | "validation", 19 | "promise" 20 | ], 21 | "author": "ribot", 22 | "contributors": [ 23 | { 24 | "name": "Stefan Pearson", 25 | "email": "stefan@ribot.co.uk" 26 | } 27 | ], 28 | "license": "Apache-2.0", 29 | "bugs": { 30 | "url": "https://github.com/ribot/bluth/issues" 31 | }, 32 | "homepage": "https://github.com/ribot/bluth", 33 | "dependencies": { 34 | "bluebird": "^3.3.5", 35 | "jsonschema": "^1.0.0", 36 | "lodash": "^4.17.10", 37 | "protagonist": "^1.0.0" 38 | }, 39 | "devDependencies": { 40 | "mocha": "^2.4.5", 41 | "should": "^8.3.1" 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /test/validation.js: -------------------------------------------------------------------------------- 1 | // External dependencies 2 | var fs = require( 'fs' ), 3 | should = require( 'should' ); 4 | 5 | 6 | // Dependencies 7 | var Bluth = require( '../' ), 8 | defaultErrorSchema = require( './fixtures/default-error-schema' ); 9 | 10 | 11 | var blueprintMd = fs.readFileSync( __dirname + '/./fixtures/blueprint.md' ).toString(); 12 | 13 | 14 | describe( 'Validation', function() { 15 | 16 | before( function () { 17 | 18 | this.bluth = new Bluth( blueprintMd, { 19 | defaultErrorSchema: defaultErrorSchema 20 | } ); 21 | 22 | } ); 23 | 24 | it( 'should pass validation when valid data is provided', function( done ) { 25 | 26 | this.bluth.validate( { 27 | name: 'G.O.B.', 28 | noiseAChickenMakes: 'Caw! Ca-caw!' 29 | }, { 30 | route: '/test/:id/something', 31 | method: 'POST', 32 | type: 'request' 33 | } ) 34 | .then( function() { 35 | done(); 36 | } ); 37 | 38 | } ); 39 | 40 | it( 'should return a list of errors when invalid data is provided', function( done ) { 41 | 42 | this.bluth.validate( { 43 | name: 'G.O.B.', 44 | noiseAChickenMakes: 'Cluck', 45 | invalidProperty: 'BEES?!' 46 | }, { 47 | route: '/test/:id/something', 48 | method: 'POST', 49 | type: 'request' 50 | } ) 51 | .catch( function( error ) { 52 | done(); 53 | } ); 54 | 55 | } ); 56 | 57 | } ); 58 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bluth 2 | 3 | A lightweight promise-based library to validate payloads against a specified JSON Schema within your API Blueprint. 4 | 5 | ### Why? 6 | 7 | It encourages developers to utilise their API blueprint as a 'source of truth', creating synergy between documentation and source code. This ultimately improves quality and developer-experience for those using the API. 8 | 9 | For example: 10 | 11 | * Validate request bodies in your routing middleware 12 | * Validate response bodies within tests 13 | 14 | ## Installation 15 | 16 | ```sh 17 | npm install bluth --save 18 | ``` 19 | 20 | ## Usage 21 | 22 | ###### Instantiation 23 | 24 | ```javascript 25 | var Bluth = require( 'bluth' ); 26 | 27 | /* 28 | * A default error schema can be provided to catch any 29 | * response status codes that aren't listed in the Blueprint 30 | */ 31 | var bluth = new Bluth( myBlueprintMarkdown, { 32 | defaultErrorSchema: myDefaultErrorSchema 33 | } ); 34 | ``` 35 | 36 | ###### Finding a schema 37 | 38 | ```javascript 39 | bluth.find( { 40 | 41 | // 'request' or 'response' 42 | type: 'reponse', 43 | 44 | // URL path 45 | route: '/my/route', 46 | 47 | // HTTP method 48 | method: 'GET', 49 | 50 | // HTTP status code (required if type is 'response') 51 | statusCode: 200 52 | 53 | } ) 54 | .then( function( schema ) { 55 | // hooray! 56 | } ); 57 | ``` 58 | 59 | ###### Validating a payload 60 | 61 | Uses `jsonschema`'s built in validation method. 62 | 63 | ```javascript 64 | bluth.validate( myRequestData, { 65 | type: 'request', 66 | route: '/my/resource/:resourceId', 67 | method: 'GET' 68 | } ) 69 | .then( function() { 70 | // Success! 71 | } ) 72 | .catch( function( error ) { 73 | // Error thrown from jsonschema, with validation errors listed 74 | } ); 75 | ``` 76 | 77 | ###### Retrieving the Blueprint object 78 | 79 | ```javascript 80 | bluth.get() 81 | .then( function( blueprint ) { 82 | // hooray! 83 | } ); 84 | ``` 85 | 86 | ### Why the name? 87 | 88 | A pun on 'Blueprint' and 'source of truth', with Arrested Development references. I thought it was funny at the time. 89 | -------------------------------------------------------------------------------- /lib/helpers.js: -------------------------------------------------------------------------------- 1 | // External dependencies 2 | var _ = require( 'lodash' ), 3 | Promise = require( 'bluebird' ); 4 | 5 | 6 | /** 7 | * Find endpoint in blueprint object 8 | */ 9 | var findEndpointInBlueprint = function findEndpointInBlueprint( blueprint, params ) { 10 | var blueprintizedRoute = params.route.replace( /:([\w_-]+)[\s]*/g, '{$1}' ), 11 | endpoint; 12 | 13 | _.find( blueprint.ast.resourceGroups, function( resourceGroup ) { 14 | 15 | endpoint = _.find( resourceGroup.resources, function( resource ) { 16 | return resource.uriTemplate.split( '?' )[ 0 ] === blueprintizedRoute; 17 | } ); 18 | 19 | return endpoint; 20 | } ); 21 | 22 | if ( !endpoint ) { 23 | return Promise.reject( new Error( 'Bluth: Couldn\'t find endpoint' ) ); 24 | } 25 | 26 | return Promise.resolve( endpoint ); 27 | }; 28 | 29 | 30 | /** 31 | * Find action in blueprint endpoint 32 | */ 33 | var findActionInEndpoint = function findActionInEndpoint( endpoint, params ) { 34 | var action; 35 | 36 | action = _.find( endpoint.actions, function( action ) { 37 | return action.method.toUpperCase() == params.method.toUpperCase(); 38 | } ); 39 | 40 | if ( !action ) { 41 | return Promise.reject( new Error( 'Blueprint: Couldn\'t find action' ) ); 42 | } 43 | 44 | return Promise.resolve( action ); 45 | }; 46 | 47 | 48 | /** 49 | * Find schema in blueprint action 50 | */ 51 | var findSchemaInAction = function findSchemaInAction( action, params ) { 52 | var schema, 53 | targetSchema; 54 | 55 | // Find schema 56 | switch ( params.type ) { 57 | case 'request': 58 | targetSchema = action.examples[ 0 ].requests[ 0 ].schema; 59 | break; 60 | 61 | case 'response': 62 | targetSchema = _.find( action.examples[ 0 ].responses, { name: params.statusCode.toString() } ); 63 | if ( targetSchema ) { 64 | targetSchema = targetSchema.schema; 65 | } 66 | break; 67 | } 68 | 69 | if ( !targetSchema && params.type == 'response' ) { 70 | 71 | if ( this.config.defaultErrorSchema ) { 72 | return Promise.resolve( this.config.defaultErrorSchema ); 73 | } else { 74 | return Promise.reject( new Error( 'Bluth: Could not find JSON Schema' ) ) 75 | } 76 | 77 | } else { 78 | 79 | try { 80 | schema = JSON.parse( targetSchema ); 81 | } catch( error ) { 82 | return Promise.reject( new Error( 'Bluth: Could not parse JSON Schema' ) ); 83 | } 84 | 85 | return Promise.resolve( schema ); 86 | 87 | } 88 | 89 | }; 90 | 91 | 92 | // Exports 93 | module.exports = { 94 | findEndpointInBlueprint: findEndpointInBlueprint, 95 | findActionInEndpoint: findActionInEndpoint, 96 | findSchemaInAction: findSchemaInAction 97 | }; 98 | -------------------------------------------------------------------------------- /test/schema-selection.js: -------------------------------------------------------------------------------- 1 | // External dependencies 2 | var fs = require( 'fs' ), 3 | should = require( 'should' ); 4 | 5 | 6 | // Dependencies 7 | var Bluth = require( '../' ), 8 | defaultErrorSchema = require( './fixtures/default-error-schema' ); 9 | 10 | 11 | var blueprintMd = fs.readFileSync( __dirname + '/./fixtures/blueprint.md' ).toString(); 12 | 13 | 14 | describe( 'Schema selection', function() { 15 | 16 | before( function () { 17 | 18 | this.bluth = new Bluth( blueprintMd, { 19 | defaultErrorSchema: defaultErrorSchema 20 | } ); 21 | 22 | } ); 23 | 24 | it( 'should return a request schema', function( done ) { 25 | var params = { 26 | route: '/test/:id/something', 27 | method: 'POST', 28 | type: 'request' 29 | }; 30 | 31 | this.bluth.find( params ) 32 | .then( function( schema ) { 33 | 34 | schema.should.be.type( 'object' ); 35 | schema.title.should.containEql( params.method.replace( /\{([\w-_]+)\}/, ':$1' ) ); 36 | 37 | done(); 38 | 39 | } ); 40 | 41 | } ); 42 | 43 | it( 'should error if the request schema wasn\'t found', function( done ) { 44 | var params = { 45 | route: '/invalid-route/:id', 46 | method: 'POST', 47 | type: 'request' 48 | }; 49 | 50 | this.bluth.find( params ) 51 | .catch( function( error ) { 52 | done(); 53 | } ); 54 | 55 | } ); 56 | 57 | it( 'should error if parameters are invalid', function( done ) { 58 | var params = { 59 | route: '/test/:id' 60 | }; 61 | 62 | this.bluth.find( params ) 63 | .catch( function( error ) { 64 | done(); 65 | } ); 66 | 67 | } ); 68 | 69 | it( 'should return a response schema', function( done ) { 70 | var params = { 71 | route: '/test/:id/something', 72 | method: 'POST', 73 | type: 'response', 74 | statusCode: 201 75 | }; 76 | 77 | this.bluth.find( params ) 78 | .then( function( schema ) { 79 | 80 | schema.should.be.type( 'object' ); 81 | schema.title.should.containEql( params.method.replace( /\{([\w-_]+)\}/, ':$1' ) ); 82 | schema.title.should.containEql( params.statusCode ); 83 | 84 | done(); 85 | 86 | } ); 87 | 88 | } ); 89 | 90 | it( 'should return a default response error schema if one is not present', function( done ) { 91 | var params = { 92 | route: '/test/:id/something', 93 | method: 'POST', 94 | type: 'response', 95 | statusCode: 418 96 | }; 97 | 98 | this.bluth.find( params ) 99 | .then( function( schema ) { 100 | 101 | schema.should.be.type( 'object' ); 102 | schema.title.should.equal( defaultErrorSchema.title ); 103 | 104 | done(); 105 | 106 | } ); 107 | 108 | } ); 109 | 110 | } ); 111 | -------------------------------------------------------------------------------- /test/fixtures/blueprint.md: -------------------------------------------------------------------------------- 1 | FORMAT: 1A 2 | 3 | # Test API Blueprint 4 | 5 | Test API Blueprint for ```Bluth```. 6 | 7 | Request and response payloads include data schemas, to the [JSON schema spec](http://json-schema.org/). 8 | 9 | # Group Test resource 10 | 11 | Authentication operations. 12 | 13 | ## Test [/test/{id}/something?niceParameter={niceParameter}] 14 | 15 | + Parameters 16 | 17 | + id (required, string) ... Test ```id``` 18 | 19 | ### Retrieve [POST] 20 | 21 | Retrieve test data. 22 | 23 | + Request 24 | 25 | + Body 26 | 27 | { 28 | "name": "G.O.B.", 29 | "noiseAChickenMakes": "Caw! Ca-caw!" 30 | } 31 | 32 | + Schema 33 | 34 | { 35 | "$schema": "http://json-schema.org/draft-04/schema#", 36 | "title": "/test/{id}/something POST request", 37 | "type": "object", 38 | "required": [ 39 | "name", 40 | "noiseAChickenMakes" 41 | ], 42 | "properties": { 43 | "name": { 44 | "description": "Name.", 45 | "type": "string" 46 | }, 47 | "noiseAChickenMakes": { 48 | "description": "Valid chicken noise.", 49 | "type": "string", 50 | "enum": [ "Caw! Ca-caw!", "A-coodle-doodle-do!", "Chee-chaw!", "Coo-coo-ca-chaw!" ] 51 | } 52 | }, 53 | "additionalProperties": false 54 | } 55 | 56 | + Response 201 57 | 58 | + Body 59 | 60 | { 61 | "name": "G.O.B.", 62 | "noiseAChickenMakes": "Caw! Ca-caw!" 63 | } 64 | 65 | + Schema 66 | 67 | { 68 | "$schema": "http://json-schema.org/draft-04/schema#", 69 | "title": "/test/{id}/something POST 201 response", 70 | "type": "object", 71 | "required": [ 72 | "name", 73 | "noiseAChickenMakes" 74 | ], 75 | "properties": { 76 | "name": { 77 | "description": "Name.", 78 | "type": "string" 79 | }, 80 | "noiseAChickenMakes": { 81 | "description": "Valid chicken noise.", 82 | "type": "string" 83 | } 84 | } 85 | } 86 | 87 | + Response 400 88 | 89 | + Response 500 90 | 91 | + Schema 92 | 93 | { 94 | "$schema": "http://json-schema.org/draft-04/schema#", 95 | "title": "/test/{id} POST 500 response", 96 | "type": "object", 97 | "required": [ 98 | "stackTrace" 99 | ], 100 | "properties": { 101 | "stackTrace": { 102 | "description": "Server stack trace.", 103 | "type": "string" 104 | } 105 | } 106 | } 107 | -------------------------------------------------------------------------------- /lib/bluth.js: -------------------------------------------------------------------------------- 1 | // External dependencies 2 | var protagonist = require( 'protagonist' ), 3 | _ = require( 'lodash' ), 4 | jsonSchema = require( 'jsonschema' ), 5 | Promise = require( 'bluebird' ); 6 | 7 | 8 | // Dependencies 9 | var helpers = require( './helpers' ); 10 | 11 | 12 | // Promisify libraries 13 | protagonist = Promise.promisifyAll( protagonist, { suffix: 'Promise' } ); 14 | 15 | 16 | /** 17 | * Bluth Constructor 18 | * 19 | * @param blueprintString {String} API Blueprint string 20 | * @param options {Object} Options 21 | * @param options.defaultErrorSchema {Object} JSON Schema for default error responses (400+) 22 | */ 23 | var Bluth = function Bluth( blueprintString, options ) { 24 | 25 | if ( typeof blueprintString !== 'string' ) { 26 | throw new Error( 'Bluth: Blueprint must be a parseable Markdown string' ); 27 | } 28 | 29 | this.config = _.extend( {}, options || {} ); 30 | this.blueprintString = blueprintString; 31 | 32 | return this; 33 | }; 34 | 35 | 36 | /** 37 | * Get Blueprint object 38 | * Parses Blueprint on first invocation, otherwise resolves with cached result 39 | */ 40 | Bluth.prototype.get = function get() { 41 | 42 | if ( this.blueprint ) { 43 | return Promise.resolve( this.blueprint ); 44 | } else { 45 | return protagonist.parsePromise( this.blueprintString, { type: 'ast' } ) 46 | .bind( this ) 47 | .tap( function( result ) { 48 | this.blueprint = result; 49 | } ); 50 | } 51 | 52 | }; 53 | 54 | 55 | /** 56 | * Find schema within Blueprint 57 | * 58 | * @param params {Object} Options 59 | * @param params.type {String} Payload type, 'request' or 'response' 60 | * @param params.route {String} Route path 61 | * @param params.method {String} Route method 62 | * @param params.statusCode {String, Number} Status code, required if params.type = 'response' 63 | */ 64 | Bluth.prototype.find = function find( params ) { 65 | return this.get() 66 | .bind( this ) 67 | .then( function( blueprint ) { 68 | return helpers.findEndpointInBlueprint.apply( this, [ blueprint, params ] ); 69 | } ) 70 | .then( function( endpoint ) { 71 | return helpers.findActionInEndpoint.apply( this, [ endpoint, params ] ); 72 | } ) 73 | .then( function( action ) { 74 | return helpers.findSchemaInAction.apply( this, [ action, params ] ); 75 | } ); 76 | }; 77 | 78 | 79 | /** 80 | * Validate payload against given schema 81 | * 82 | * @param data {Object} Data to validate 83 | * @param params {Object} Options 84 | * @param params.type {String} Payload type, 'request' or 'response' 85 | * @param params.route {String} Route path 86 | * @param params.method {String} Route method 87 | * @param params.statusCode {String, Number} Status code, required if params.type = 'response' 88 | */ 89 | Bluth.prototype.validate = function validate( data, params ) { 90 | return this.find( params ) 91 | .then( function( schema ) { 92 | var validationResult = jsonSchema.validate( data, schema ), 93 | validationError; 94 | 95 | if ( validationResult.errors.length ) { 96 | validationError = new Error( 'Bluth: Validation errors' ); 97 | validationError.errors = validationResult.errors; 98 | throw validationError; 99 | } 100 | 101 | return validationResult; 102 | } ); 103 | }; 104 | 105 | 106 | // Exports 107 | module.exports = Bluth; 108 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 Ribot Ltd. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------