jack-eb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2343df18ed2f47fd445ea515e7316062cd94bb15
+  data.tar.gz: 6e3b15ea572829141595e0725af3ab1caa084fbb
+SHA512:
+  metadata.gz: 7aaf881febb1581159b83bcbb04be0a54340482d5ea7bcc7fcb4f42e627e53687f5abc626204275b2b98afeda8013d2edf87ad230b13f7a25104a823f3863cd6
+  data.tar.gz: 892740d93240d5cf75cbd18fd89f7f87ec16472e345fa9ea2032201790a15841690512a107ab44826e6f7d43c420be9537002fe52eb206b8cf6d1a4a4b718eb5

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures/*/.elasticbeanstalk/saved_configs
+spec/fixtures/fake.cfg.yml
+spec/fixtures/project/.elasticbeanstalk/config.yml
+
+# Elastic Beanstalk Files
+.elasticbeanstalk/*
+!.elasticbeanstalk/*.cfg.yml
+!.elasticbeanstalk/*.global.yml
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jack.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    jack-eb (0.0.1)
+      aws-sdk (~> 2)
+      colorize
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.0.29)
+      aws-sdk-resources (= 2.0.29)
+    aws-sdk-core (2.0.29)
+      builder (~> 3.0)
+      jmespath (~> 1.0)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+    aws-sdk-resources (2.0.29)
+      aws-sdk-core (= 2.0.29)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    colorize (0.7.5)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.12.4)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    jmespath (1.0.2)
+      multi_json (~> 1.0)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    shellany (0.0.1)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  codeclimate-test-reporter
+  guard
+  guard-bundler
+  guard-rspec
+  jack-eb!
+  rake

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})      { "spec/jack_spec.rb" }
+  watch(%r{^lib/jack/(.+)\.rb$})  { "spec/jack_spec.rb" }
+  watch('spec/spec_helper.rb')   { "spec/jack_spec.rb" }
+  watch(%r{^lib/jack/(.+)\.rb$})   { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tung Nguyen
+
+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.

data/README.md

@@ -0,0 +1,135 @@
+# Jack and the Elastic Beanstalk
+
+[![Build Status](https://travis-ci.org/tongueroo/jack.svg?branch=master)](https://travis-ci.org/tongueroo/jack)
+[![Code Climate](https://codeclimate.com/github/tongueroo/jack/badges/gpa.svg)](https://codeclimate.com/github/tongueroo/jack)
+[![Test Coverage](https://codeclimate.com/github/tongueroo/jack/badges/coverage.svg)](https://codeclimate.com/github/tongueroo/jack)
+
+Jack is a wrapper tool around the eb cli tool that can be use to manage AWS Elastic Beanstalk environments.  It allows you to create environments based on a saved template configuration file, located in the jack/cfg folder of your project.  It also provides a helpful config command to manage the template configuration. 
+
+For things that this tool does not do, it is recommended that you use use the underlying eb tool directly.  This tool has been tested with the 3.1.2 version of the eb command, so have at least that version installed.
+
+## Installation
+
+```
+$ gem install jack-eb
+```
+
+Note that the gem is called jack-eb but the command that is installed is called jack.
+
+### Setup
+
+This gem relies on the eb cli tool.  To install follow the instructions on [AWS EB Documentation](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-getting-set-up.html).  Here's the gist of it:
+
+<pre>
+$ sudo pip install awsebcli
+</pre>
+
+You need at least version 3.1.2 of the eb tool.  To check the version `eb --version`.  If you need to upgrade:
+
+<pre>
+$ sudo pip install --upgrade awsebcli
+</pre>
+
+You'll also need to set up your environment with your aws access keys since the tool also uses the aws-sdk.  Add the following to your ~/.profile, replacing xxx with your actually credentials.  Don't forgot to source the ~/.profile or open up a new terminal.
+
+<pre>
+export AWS_ACCESS_KEY_ID=xxx
+export AWS_SECRET_ACCESS_KEY=xxx
+</pre>
+
+You're ready to go.
+
+## Usage
+
+### Overview
+
+In your project folder create a folder call jack/cfg.  It might be useful for your company to create a baseline config that you can use.  If you do not already have a baseline template, you can download the template from an existing environment like so:
+
+<pre>
+$ jack config download [ENVIRONMENT_NAME]
+</pre>
+
+The path of config that is saved is based on a convention.  An example best illustrates the convention.
+
+<pre>
+$ jack config download stag-rails-app-s1
+Downloading config file...
+Running: eb config save --cfg current-2015-03-03_18-40-34 stag-rails-app-s1
+
+Configuration saved at: /Users/tung/src/rails/.elasticbeanstalk/saved_configs/current-2015-03-03_18-40-34.cfg.yml
+Writing to local config file: jack/cfg/stag-rails-app.cfg.yml
+Cleaning up eb remote config and local files
+Config downloaded to jack/cfg/stag-rails-app.cfg.yml
+$ 
+</pre>
+
+Results in a saved jack/cfg/stag-rails-app.cfg.yml template configuration file.  Notice how the last dash separated word has been removed.  The convention is overridable. 
+
+<pre>
+$ jack config download -c myconfig stag-rails-app-s1
+</pre>
+
+Results in a saved jack/cfg/myconfig.cfg.yml template configuration file. 
+
+### Creating Environments
+
+The purpose of the jack/cfg configs is allow us to be able to create environments with a codified configuration file that can be versioned controlled.
+
+<pre>
+$ jack create stag-rails-app-s1 # uses the jack/cfg/stag-rails-app.cfg.yml template
+$ jack create stag-rails-app-s2 # another instance of the environment, but still uses the jack/cfg/stag-rails-app.cfg.yml template
+$ jack create -c myconfig stag-rails-app-s3 # creates environment using a config not based on naming convention
+</pre>
+
+If the project is brand new and has never had `eb init` ran on it before.  For example, a project that has just been git cloned.  Then calling any of the jack commands will automatically call `eb init` in the project.  `eb init` requires the platform flag in order to avoid prompting.  By default, the latest Docker solution stack is used for the platform option.  But you can override that by creating an ~/.jack/create.yml or jack/create.yml within the project folder.  Here's an [example](https://gist.github.com/tongueroo/086e3c11c4d00d5c39b6). The options from each file is merged using the following precedence: project folder, user home, default that is packaged with this gem.  Most of the settings that `jack create` should used should be in the template configuration file though.
+
+### Downloading and Uploading Template Configurations
+
+#### Download
+
+To download a template configuration.
+
+```
+$ jack config download stag-rails-app-s1
+```
+
+This will save the config to jack/cfg/stag-rails-app.cfg.yml.
+
+#### Upload
+
+To upload a template configuration.
+
+```
+$ jack config upload stag-rails-app-s1
+```
+
+This will save the config to jack/cfg/stag-rails-app.cfg.yml.  Here's an example of the [output](http://d.pr/i/14Sfh).
+
+Notice that the `eb config upload` command also prompts you with the diff before uploading and ask for confirmation.  You can bypass the prompt with the force option.
+
+#### Diff - Comparing your local config to the live environment config
+
+You can use the diff command directly to compare your local config to what configs the environment is actually using is useful.  To see the diff.  
+
+```
+$ jack config diff stag-rails-app-s1
+```
+
+A note about the configs.  They are formatted so that the keys are sorted.  This has been done so the diffs are actually useful.  It is also recommended you install colordiff so you can see the diff output colorized.  You can also specify your own diff viewer via the JACK_DIFF environment variable.  Example of [colorized diff](http://d.pr/i/9wrS).
+
+### More Help
+
+You can get help information from the CLI.  Examples:
+
+<pre>
+$ jack help
+$ jack help create
+$ jack config help download
+$ jack config help upload
+$ jack config help upload
+$ jack config help sort
+</pre>
+
+### TODO
+
+* encrypted the jack/cfg files similar to how [shopify/ejson](https://github.com/Shopify/ejson) works, except with yaml - pull requests are welcome

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new

data/bin/jack

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'jack'
+require 'jack/cli'
+
+Jack::CLI.start(ARGV)

data/jack.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jack-eb"
+  spec.version       = Jack::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.description   = %q{Wrapper tool to manage AWS Elastic Beanstalk environments}
+  spec.summary       = %q{Wrapper tool to manage AWS Elastic Beanstalk environments}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = ["jack"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+  spec.add_dependency 'aws-sdk', '~> 2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/jack.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "jack/version"
+require "colorize"
+require "aws-sdk"
+require File.expand_path("../jack/ext/hash", __FILE__)
+
+module Jack
+  autoload :CLI, 'jack/cli'
+  autoload :Create, 'jack/create'
+  autoload :Config, 'jack/config'
+  autoload :UI, 'jack/ui'
+  autoload :Util, 'jack/util'
+  autoload :VersionChecker, 'jack/version_checker'
+end

data/lib/jack/cli.rb

@@ -0,0 +1,54 @@
+require 'thor'
+require 'jack/cli/help'
+require 'jack/version_checker'
+Jack::VersionChecker.new.run unless ENV['TEST']
+
+module Jack
+  class ConfigCLI < Thor
+    desc "upload ENV_NAME", "upload and apply jack config changes to EB environment"
+    long_desc Jack::CLI::Help.upload
+    def upload(env_name)
+      Jack::Config::Upload.new(options.merge(env_name: env_name)).run
+    end
+
+    desc "download ENV_NAME", "downloads environment config to jack/cfg folder"
+    long_desc Jack::CLI::Help.download
+    option :dirty, type: :boolean, desc: "leave the remote eb config and download config behind"
+    def download(env_name)
+      Jack::Config::Download.new(options.merge(env_name: env_name)).run
+    end
+
+    desc "diff ENV_NAME", "diff jack config vs environment config"
+    long_desc Jack::CLI::Help.diff
+    option :dirty, type: :boolean, desc: "leave the remote eb config and download config behind"
+    def diff(env_name)
+      Jack::Config::Diff.new(options.merge(env_name: env_name)).run
+    end
+
+    desc "sort ENV_NAME", "reformat local jack config file to a sorted yaml file format"
+    long_desc Jack::CLI::Help.sort
+    def sort(env_name)
+      Jack::Config::Sort.new(options.merge(env_name: env_name)).run
+    end
+  end
+
+  class CLI < Thor
+    class_option :verbose, type: :boolean
+    class_option :mute, type: :boolean, desc: "mute all output, useful for specs"
+    class_option :noop, type: :boolean, desc: "dont run any destructive commands"
+    class_option :force, type: :boolean, desc: "bypass confirmation prompt"
+    class_option :root, :default => '.', desc: "root of the project, useful for specs"
+    class_option :cfg, aliases: :c, desc: "local config name if want to override the convention"
+    class_option :app, aliases: :a, desc: "app name if want to override the convention"
+
+    desc "create ENV_NAME", "create EB environment"
+    long_desc Help.create
+    def create(env_name)
+      Jack::Create.new(options.merge(env_name: env_name)).run
+    end
+
+    desc "config ACTION ENV_NAME", "manage environment config"
+    long_desc Help.config
+    subcommand "config", ConfigCLI
+  end
+end