apps 0.8.2 → 1.0.0-beta.0

package/dist/schema.md

@@ -1,156 +0,0 @@
-`app.json` is a manifest format for describing web apps. It declares environment
-variables, addons, and other information required to run apps on Heroku. This document describes the schema in detail.
-
-## Example app.json
-
-```json
-{
-  "name": "small-sharp-tool",
-  "description": "This app does one little thing, and does it well.",
-  "keywords": [
-    "productivity",
-    "HTML5",
-    "scalpel"
-  ],
-  "website": "https://jane-doe.github.io/small-sharp-tool",
-  "repository": "https://github.com/jane-doe/small-sharp-tool",
-  "logo": "https://jane-doe.github.io/small-sharp-tool/logo.svg",
-  "success_url": "/welcome",
-  "scripts": {
-    "postdeploy": "bundle exec rake bootstrap"
-  },
-  "env": {
-    "BUILDPACK_URL": "https://github.com/stomita/heroku-buildpack-phantomjs",
-    "SECRET_TOKEN": {
-      "description": "A secret key for verifying the integrity of signed cookies.",
-      "generator": "secret"
-    },
-    "WEB_CONCURRENCY": {
-      "description": "The number of processes to run.",
-      "default": "5"
-    }
-  },
-  "addons": [
-    "openredis",
-    "mongolab:shared-single-small"
-  ]
-}
-```
-
-## The Schema
-
-### name
-
-A URL-friendly string that uniquely identifies the template app. *required string*
-
-```json
-{
-  "name": "small-sharp-tool"
-}
-```
-### description
-
-A brief summary of the app: what it does, who it's for, why it exists, etc. *optional string*
-
-```json
-{
-  "description": "This app does one little thing, and does it well."
-}
-```
-### keywords
-
-An array of strings describing the app. *optional array*
-
-```json
-{
-  "keywords": [
-    "productivity",
-    "HTML5",
-    "scalpel"
-  ]
-}
-```
-### website
-
-The project's website, if there is one. *optional string*
-
-```json
-{
-  "website": "https://jane-doe.github.io/small-sharp-tool"
-}
-```
-### repository
-
-The location of the application's source code. Can be a git URL, a GitHub URL, or a tarball URL. *optional string*
-
-```json
-{
-  "repository": "https://github.com/jane-doe/small-sharp-tool"
-}
-```
-### logo
-
-The URL of the application's logo image. It's dimensions should be square. Format can be SVG or PNG. *optional string*
-
-```json
-{
-  "logo": "https://jane-doe.github.io/small-sharp-tool/logo.svg"
-}
-```
-### success_url
-
-A URL specifying where to redirect the user once their new app is deployed. If value is a fully-qualified URL, the user should be redirected to that URL. If value is begins with a slash `/`, the user should be redirected to that path in their newly deployed app. *optional string*
-
-```json
-{
-  "success_url": "/welcome"
-}
-```
-### scripts
-
-A key-value object specifying scripts or shell commands to execute at different stages in the build/release process. *optional object*
-
-```json
-{
-  "scripts": {
-    "postdeploy": "bundle exec rake bootstrap"
-  }
-}
-```
-### env
-
-A key-value object for environment variables, or config vars in Heroku parlance. Keys are the names of the environment variables.
-
-Values can be strings or objects. If the value is a string, it will be used and the user will not be prompted to specify a different value. If the value is an object, it defines specific requirements for that variable:
-
-description - a human-friendly blurb about what the value is for and how to determine what it should be
-value - a default value to use
-generator - a string representing a function to call to generate the value, such as cookie secret *optional object*
-
-```json
-{
-  "env": {
-    "BUILDPACK_URL": "https://github.com/stomita/heroku-buildpack-phantomjs",
-    "SECRET_TOKEN": {
-      "description": "A secret key for verifying the integrity of signed cookies.",
-      "generator": "secret"
-    },
-    "WEB_CONCURRENCY": {
-      "description": "The number of processes to run.",
-      "default": "5"
-    }
-  }
-}
-```
-### addons
-
-An array of strings specifying Heroku addons to provision on the app before deploying. Each addon should be in the format `addon:plan`. If plan is omitted, that addon's default plan will be provisioned. *optional array*
-
-```json
-{
-  "addons": [
-    "openredis",
-    "mongolab:shared-single-small"
-  ]
-}
-```

package/index.html

@@ -1,6 +0,0 @@
-<html>
-  <head>
-    <script type="text/javascript" charset="utf-8" src="web-post.js"></script>
-  </head>
-  <body></body>
-</html>

package/index.js

@@ -1,115 +0,0 @@
-'use strict'
-var fs = require("fs")
-var hogan = require("hogan.js")
-var http = require('http')
-var superagent = require('superagent')
-var revalidator = require('revalidator')
-var parseGithubURL = require("github-url-to-object")
-var addons = require("./lib/addons")
-var schema = require("./schema")
-
-var App = module.exports = (function() {
-
-  function App(raw) {
-    var key
-
-    if (typeof(raw) === 'string' && raw.match(/\.json$/i)) {
-      raw = JSON.parse(fs.readFileSync(raw))
-    } else if (typeof(raw) === 'string') {
-      raw = JSON.parse(raw)
-    }
-
-    for (key in raw) {
-      if (raw.hasOwnProperty(key)) {
-        this[key] = raw[key]
-      }
-    }
-
-    this.__defineGetter__("valid", function(){
-      return this.validate().valid
-    })
-
-    this.__defineGetter__("errors", function(){
-      return this.validate().errors
-    })
-
-    return this
-  }
-
-  App.prototype.validate = function() {
-    return revalidator.validate(this, schema)
-  }
-
-  App.prototype.toJSON = function() {
-    var key
-    var out = {}
-    var validProps = Object.keys(schema.properties)
-    for (key in this) {
-      if (this.hasOwnProperty(key) && validProps.indexOf(key) > -1) {
-        out[key] = this[key]
-      }
-    }
-    return JSON.stringify(out, null, 2)
-  }
-
-  App.prototype.getAddonPrices = function(cb) {
-    var _this = this
-    App.addons.getPrices(this.addons, function(err, prices){
-      if (err) return cb(err)
-      _this.prices = prices
-      cb(null, prices)
-    })
-  }
-
-  App.new = function(raw) {
-    return new App(raw)
-  }
-
-  App.fetch = function(url, cb) {
-    if (!parseGithubURL(url))
-      return cb("Not a valid github URL: " + url)
-
-    var user = parseGithubURL(url).user
-    var repo = parseGithubURL(url).repo
-    var proxy_url = "https://github-raw-cors-proxy.herokuapp.com/" + user + "/" + repo + "/blob/master/app.json"
-
-    superagent.get(proxy_url, function(res){
-      cb(null, App.new(res.body))
-    })
-  }
-
-  // Hogan Templates FTW
-  App.templates = {}
-  // // fs.readdirSync('./templates').forEach(function(filename){
-  // var list = ['app.mustache', 'build.mustache', 'schema.mustache']
-  // list.forEach(function(filename){
-  //   var name = filename.replace(/\.\w+$/, '')
-  //
-  //   // Server vs Browser
-  //   if (module.parent) {
-  //     console.log('server')
-  //     App.templates[name] = hogan.compile(fs.readFileSync('./templates/' + filename).toString())
-  //   } else {
-  //     console.log('browser')
-  //     App.templates[name] = require('.templates/'+filename)
-  //   }
-  // })
-
-  if (module.parent) {
-    App.templates.app = hogan.compile(fs.readFileSync(__dirname + '/templates/app.mustache.html').toString())
-    App.templates.build = hogan.compile(fs.readFileSync(__dirname + '/templates/build.mustache.html').toString())
-    App.templates.schema = hogan.compile(fs.readFileSync(__dirname + '/templates/schema.mustache.html').toString())
-  } else {
-    App.templates.app = require('./templates/app.mustache.html')
-    App.templates.build = require('./templates/build.mustache.html')
-    App.templates.schema = require('./templates/schema.mustache.html')
-  }
-
-  App.example = new App(schema.example)
-
-  App.addons = addons
-  App.schema = schema
-
-  return App
-
-})()

package/lib/addons.js

@@ -1,67 +0,0 @@
-'use strict'
-var async = require('async')
-var superagent = require('superagent')
-var addons = module.exports = {}
-
-addons.getPrices = function(slugs, cb) {
-
-  // Assemble an empty API response
-  if (!slugs || slugs === []) {
-    return cb(null, {
-      plans: [],
-      totalPrice: "Free",
-      totalPriceInCents: 0
-    })
-  }
-
-  async.map(slugs, addons.getPlan, function(err, plans) {
-    if (err) return cb(err)
-    var prices = {}
-    prices.totalPriceInCents = plans.reduce(function(sum, plan) {
-      return plan.price.cents + sum
-    }, 0)
-    prices.totalPrice = formatPrice(prices.totalPriceInCents)
-    prices.plans = plans
-    cb(null, prices)
-  })
-}
-
-addons.getPlan = function(slug, cb) {
-
-  if (slug.match(/:/)) {
-    // format is 'addon:plan'
-    var addon = slug.split(":")[0]
-    var plan = slug.split(":")[1]
-
-    superagent
-      .get('https://api.heroku.com/addon-services/'+addon+'/plans/'+plan)
-      .set('Accept', 'application/vnd.heroku+json; version=3')
-      .end(function(err, res){
-        if (err) return cb(err)
-        if (res.statusCode == 404) return cb(res.body)
-        var plan = res.body
-        plan.prettyPrice = formatPrice(plan.price.cents)
-        plan.logo = "https://addons.heroku.com/addons/" + addon + "/icons/original.png"
-        cb(null, plan)
-      })
-
-  } else {
-    // plan not specified; find the default plan
-    superagent
-      .get('https://api.heroku.com/addon-services/'+slug+'/plans')
-      .set('Accept', 'application/vnd.heroku+json; version=3')
-      .end(function(err, res){
-        if (err) return cb(err)
-        if (res.statusCode == 404) return cb(res.body)
-        var plan = res.body.filter(function(plan) { return plan.default })[0]
-        plan.prettyPrice = formatPrice(plan.price.cents)
-        plan.logo = "https://addons.heroku.com/addons/" + slug + "/icons/original.png"
-        cb(null, plan)
-      })
-  }
-
-}
-
-function formatPrice(price) {
-  return (price == 0) ? "Free" : "$" + price/100 + "/mo"
-}

package/schema.js

@@ -1,100 +0,0 @@
-'use strict'
-var schema = {
-  "properties": {
-    "name": {
-      "description": "A URL-friendly string that uniquely identifies the template app.",
-      "type": "string",
-      "required": true,
-      "allowEmpty": false,
-      "example": "small-sharp-tool"
-    },
-    "description": {
-      "description": "A brief summary of the app: what it does, who it's for, why it exists, etc.",
-      "type": "string",
-      "example": "This app does one little thing, and does it well."
-    },
-    "keywords": {
-      "description": "An array of strings describing the app.",
-      "type": "array",
-      "example": ["productivity", "HTML5", "scalpel"]
-    },
-    "website": {
-      "description": "The project's website, if there is one.",
-      "type": "string",
-      "format": "url",
-      "allowEmpty": false,
-      "example": "https://jane-doe.github.io/small-sharp-tool"
-    },
-    "repository": {
-      "description": "The location of the application's source code. Can be a git URL, a GitHub URL, or a tarball URL.",
-      "type": "string",
-      "format": "url",
-      "allowEmpty": false,
-      "example": "https://github.com/jane-doe/small-sharp-tool"
-    },
-    "logo": {
-      "description": "The URL of the application's logo image. It's dimensions should be square. Format can be SVG or PNG.",
-      "type": "string",
-      "format": "url",
-      "allowEmpty": false,
-      "example": "https://jane-doe.github.io/small-sharp-tool/logo.svg"
-    },
-    "success_url": {
-      "description": "A URL specifying where to redirect the user once their new app is deployed. If value is a fully-qualified URL, the user should be redirected to that URL. If value is begins with a slash `/`, the user should be redirected to that path in their newly deployed app.",
-      "type": "string",
-      "allowEmpty": false,
-      "example": "/welcome"
-    },
-    "scripts": {
-      "description": "A key-value object specifying scripts or shell commands to execute at different stages in the build/release process.",
-      "type": "object",
-      "example": {"postdeploy": "bundle exec rake bootstrap"}
-    },
-    "env": {
-      "description": "A key-value object for environment variables, or config vars in Heroku parlance. Keys are the names of the environment variables.\n\nValues can be strings or objects. If the value is a string, it will be used and the user will not be prompted to specify a different value. If the value is an object, it defines specific requirements for that variable:\n\ndescription - a human-friendly blurb about what the value is for and how to determine what it should be\nvalue - a default value to use\ngenerator - a string representing a function to call to generate the value, such as cookie secret",
-      "type": "object",
-      "example": {
-        "BUILDPACK_URL": "https://github.com/stomita/heroku-buildpack-phantomjs",
-        "SECRET_TOKEN": {
-          "description": "A secret key for verifying the integrity of signed cookies.",
-          "generator": "secret"
-        },
-        "WEB_CONCURRENCY": {
-          "description": "The number of processes to run.",
-          "default": "5"
-        }
-      }
-    },
-    "addons": {
-      "description": "An array of strings specifying Heroku addons to provision on the app before deploying. Each addon should be in the format `addon:plan`. If plan is omitted, that addon's default plan will be provisioned.",
-      "type": "array",
-      "example": [
-        "openredis",
-        "mongolab:shared-single-small"
-      ]
-    }
-  }
-}
-
-// Assemble an example schema
-schema.example = {}
-Object.keys(schema.properties).map(function(key){
-  schema.example[key] = schema.properties[key].example
-})
-
-// Assemble a template-ready stringified version of the schema
-schema.exampleJSON = JSON.stringify(schema.example, null, 2)
-
-// Coerce schema properties into a template-friendly format
-schema.propertiesArray = Object.keys(schema.properties).map(function(name) {
-  var prop = schema.properties[name]
-  prop.name = name
-  prop.requiredOrOptional = prop.required ? "required" : "optional"
-
-  var jsonDoc = {}
-  jsonDoc[prop.name] = prop.example
-  prop.exampleJSON = JSON.stringify(jsonDoc, null, 2)
-  return prop
-})
-
-module.exports = schema

package/templates/app.mustache.html

@@ -1,36 +0,0 @@
-<li class="app">
-
-  <a class="logo activator">
-    <img src="{{logo}}">
-  </a>
-
-  <div class="meta">
-
-    <h2><a class="activator">{{name}}</a></h2>
-
-    <div class="drawer">
-
-      {{#description}}
-        <p>{{description}}</p>
-      {{/description}}
-
-      {{#repository}}
-        <a href="{{repository}}" class="repository">{{repository}}</a>
-      {{/repository}}
-
-      {{#website}}
-        <a href="{{website}}" class="website">{{website}}</a>
-      {{/website}}
-
-      <form class="deploy">
-        <input type="hidden" name="source" value="{{repository}}">
-        <input type="submit" value="Deploy for {{prices.totalPrice}}">
-      </form>
-
-      <div class="output"></div>
-
-    </div>
-
-  </div>
-
-</li>

package/templates/build.mustache.html

@@ -1,13 +0,0 @@
-{{#app}}
-  <p>
-    Your app is deploying to
-    <a href="https://{{app.name}}.herokuapp.com">{{app.name}}.herokuapp.com</a>,
-    and will be ready soon.
-  </p>
-{{/app}}
-
-{{^app}}
-  <p class="error">
-    Build failed. {{message}}
-  </p>
-{{/app}}

package/templates/schema.mustache.html

@@ -1,20 +0,0 @@
-`app.json` is a manifest format for describing web apps. It declares environment
-variables, addons, and other information required to run apps on Heroku. This document describes the schema in detail.
-
-## Example app.json
-
-```json
-{{{exampleJSON}}}
-```
-
-## The Schema
-
-{{#propertiesArray}}
-### {{name}}
-
-{{description}} *{{requiredOrOptional}} {{type}}*
-
-```json
-{{{exampleJSON}}}
-```
-{{/propertiesArray}}

package/test/addons.js

@@ -1,172 +0,0 @@
-var assert = require("assert")
-var util = require("util")
-var addons = require("../lib/addons")
-
-describe('addons.getPlan()', function(){
-
-  it('accepts an addon:plan string', function(done){
-    addons.getPlan('mongohq:ssd_1g_elastic', function(err, plan) {
-      assert.equal(plan.name, 'mongohq:ssd_1g_elastic')
-      assert.equal(plan.description, 'MongoHQ 1 GB SSD')
-      done()
-    })
-  })
-
-  it('accepts an addon string with no plan', function(done){
-    addons.getPlan('mongohq', function(err, plan) {
-      assert.equal(plan.name, 'mongohq:sandbox')
-      done()
-    })
-  })
-
-  it('returns a pretty price', function(done){
-    addons.getPlan('mongohq', function(err, plan) {
-      assert.equal(plan.prettyPrice, 'Free')
-      done()
-    })
-  })
-
-  it('returns a logo URL when given an addon:plan slug', function(done){
-    addons.getPlan('mongohq:sandbox', function(err, plan) {
-      assert.equal(plan.logo, 'https://addons.heroku.com/addons/mongohq/icons/original.png')
-      done()
-    })
-  })
-
-  it('returns a logo URL given a plan-free slug', function(done){
-    addons.getPlan('mongohq', function(err, plan) {
-      assert.equal(plan.logo, 'https://addons.heroku.com/addons/mongohq/icons/original.png')
-      done()
-    })
-  })
-
-})
-
-describe('addons.getPrices()', function(){
-
-  it('accepts an array and returns a prcies object', function(done){
-    addons.getPrices(['mongohq:ssd_1g_elastic'], function(err, prices) {
-      assert(typeof(prices) === "object")
-      assert(!util.isArray(prices))
-      assert(util.isArray(prices.plans))
-      done()
-    })
-  })
-
-  it('returns an array of plans in the prices object', function(done){
-    addons.getPrices(['mongohq:ssd_1g_elastic'], function(err, prices) {
-      assert(util.isArray(prices.plans))
-      done()
-    })
-  })
-
-  it('handles addon:plan formatted slugs', function(done){
-    addons.getPrices(['mongohq:ssd_1g_elastic'], function(err, prices) {
-      assert.equal(prices.plans[0].name, 'mongohq:ssd_1g_elastic')
-      assert.equal(prices.plans[0].price.cents, 1800)
-      assert.equal(prices.plans[0].price.unit, 'month')
-      done()
-    })
-  })
-
-  it('finds the default plan, if unspecified', function(done){
-    addons.getPrices(['mongohq'], function(err, prices) {
-      assert.equal(prices.plans[0].name, 'mongohq:sandbox')
-      assert.equal(prices.plans[0].price.cents, 0)
-      assert.equal(prices.plans[0].price.unit, 'month')
-      done()
-    })
-  })
-
-  it('returns a totalPrice in the prices object', function(done){
-    addons.getPrices(['mongohq:ssd_1g_elastic', 'memcachedcloud:100'], function(err, prices) {
-      assert.equal(prices.plans[0].name, 'mongohq:ssd_1g_elastic')
-      assert.equal(prices.plans[0].price.cents, 1800)
-      assert.equal(prices.plans[1].price.cents, 1400)
-      assert.equal(prices.totalPriceInCents, 3200)
-      done()
-    })
-  })
-
-  it('returns a human-friendly dollar amount total', function(done){
-    addons.getPrices(['mongohq:ssd_1g_elastic', 'memcachedcloud:100'], function(err, prices) {
-      assert.equal(prices.totalPriceInCents, 3200)
-      assert.equal(prices.totalPrice, '$32/mo')
-      done()
-    })
-  })
-
-  it('returns free if total is zero', function(done){
-    addons.getPrices(['heroku-postgresql'], function(err, prices) {
-      assert.equal(prices.totalPriceInCents, 0)
-      assert.equal(prices.totalPrice, 'Free')
-      done()
-    })
-  })
-
-  it('accepts an emtpy array', function(done){
-    addons.getPrices([], function(err, prices) {
-      assert(util.isArray(prices.plans))
-      assert.equal(prices.totalPriceInCents, 0)
-      assert.equal(prices.totalPrice, 'Free')
-      done()
-    })
-  })
-
-  it('propagates errors for nonexistent addons', function(done){
-    addons.getPrices(['nonexistent-addon'], function(err, prices) {
-      assert(err)
-      done()
-    })
-  })
-
-  it('propagates errors for nonexistent plans',function(done){
-    addons.getPrices(['mongohq:bad-plan'], function(err, res) {
-      assert(err)
-      assert.equal(err.id, "not_found")
-      done()
-    })
-  })
-
-  it('handles a long list of addons',function(done){
-    var slugs = [
-      'mongohq:sandbox',
-      'redistogo',
-      'goinstant',
-      'rollbar',
-      'usersnap',
-      'bonsai:staging'
-    ]
-
-    addons.getPrices(slugs, function(err, prices) {
-      assert(!err)
-      assert(prices.plans)
-      assert(prices.totalPrice)
-      assert.equal(typeof(prices.totalPriceInCents), 'number')
-      done()
-    })
-  })
-
-  it("returns a mocked response for a null slugs array", function(done) {
-    addons.getPrices(null, function(err, prices) {
-      assert(prices)
-      assert.equal(prices.totalPrice, "Free")
-      assert.equal(prices.totalPriceInCents, 0)
-      assert(util.isArray(prices.plans))
-      assert.equal(prices.plans.length, 0)
-      done()
-    })
-  })
-
-  it("returns a mocked response for an empty slugs array", function(done) {
-    addons.getPrices([], function(err, prices) {
-      assert(prices)
-      assert.equal(prices.totalPrice, "Free")
-      assert.equal(prices.totalPriceInCents, 0)
-      assert(util.isArray(prices.plans))
-      assert.equal(prices.plans.length, 0)
-      done()
-    })
-  })
-
-})