ember-deploy-rest-index
This ember-cli-deploy index adapter uses HTTP REST commands to handle all operations pertaining to the index.html deploy process. The server is, therefore, responsible for managing index.html revisions.
Purpose
This adapter is intended for those who have an existing REST API and would like to leverage it to manage their index.html revisions. It is ideal for internal system environments (not in the cloud) or in the case that adding additional components such as a NoSQL is prohibitive. For such environments, this adapter will enable the usage of the existing infrastructure to accommodate, still, a Lightning Fast Deployments process.
To use
npm install ember-deploy-rest-index
Commands
The adapter implements the following commands as per the ember-cli-deploy interface:
-
deploy- Makes a POST to upload the index.html information:Sample Request:
HTTP POST http://leojh.com/api/ember-revisions"id": 'ember-app:9c0568d'"indexHtml": '<html>...</html>'Sample Response: HTTP 200 OK, 201 CREATED, or 204 NO CONTENT with no content.
-
deploy:list- Makes a GET call to get all uploaded revisionsSample Request:
HTTP GET https://leojh.com/api/ember-revisionsSample Response:
HTTP OK"id":"ember-app:1bdc67a""createdOn":"2015-06-19T09:58:00-04:00""id":"ember-app:2251eda""createdOn":"2015-06-22T10:51:00-04:00"... -
deploy:activate- Makes a PUT call to activate the specified revisionsSample Request:
HTTP PUT https://leojh.com/api/ember-revisions/ember-app:1bdc67aSample Response: HTTP 200 OK, or 204 NO CONTENT with no content.
Config
Sample config in your deploy.js file:
store: type: 'REST' serviceHost: 'http://leojh.com' serviceNamespace: 'api' serviceIndexVersionResource: 'ember-revisions'type- Must be 'REST' to use this adapterserviceHost- the root URL for the serviceserviceNamespace- path to the serviceserviceIndexVersionResource- the name of your resource responsible for handling your revisions
The combination of config settings will help construct the target URLs for calling your service. For example, given the config above, the deploy:list command will result in: GET http://leojh.com/api/ember-revisions
Notes
Always specify the environment flag when running any ember deploy commands. Similarly, when specifying a revision to activate, specify the revision flag.
Example: ember deploy:activate --revision ember-app:1234 --environment qa
TODOs:
- Authentication header
- Cleanup of old revisions
- Tests (I know, they should come first)
- Multipart?
- A REST adapter for assets?