G5 Sibling Deployer Engine

Build Status Code Climate

Provides models, views, controllers, routes, and rake tasks for deploying Sibling Apps.

Current Version

0.6.2

Requirements

Installation

Add these lines to your application's Gemfile.

gem "g5_sibling_deployer_engine"

Usage

Export environment variables:

export MAIN_APP_UID=http://g5-configurator.herokuapp.com/apps/1

Run migrations:

rake railties:install:migrations
rake db:migrate

Seed database:

rake sibling:consume
rake sibling:instruction:consume

You get these routes and views for free:

         deploy_sibling POST /siblings/:id/deploy(.:format)      siblings#deploy
               siblings GET  /siblings(.:format)                 siblings#index
  siblings_instructions GET  /siblings/instructions(.:format)    siblings/instructions#index
       siblings_deploys GET  /siblings/deploys(.:format)         siblings/deploys#index
g5_configurator_webhook POST /webhooks/g5-configurator(.:format) webhooks#g5_configurator

You get these rake tasks:

rake sibling:consume # seeds siblings
rake sibling:deploy # deploys all siblings
rake sibling:instruction:consume # consumes instruction feed

Authors

Contributing

  1. Get it running
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Write your code and specs
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

If you find bugs, have feature requests or questions, please file an issue.

Specs

Run once.

$ rspec spec

Keep then running.

$ guard

Coverage.

$ rspec spec
$ open coverage/index.html

License

Copyright (c) 2013 G5

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.