foreplay 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a1dbd3b362d4784a5b5878bba559b812106e9c8
-  data.tar.gz: fe058cb4c473892115225f78587d0f88929bc745
+  metadata.gz: 792102ce293a729754f551ac87b6289ff1c7c81c
+  data.tar.gz: 7d74c817f3aa6b8209b73a0d10cd7202a24a37dc
 SHA512:
-  metadata.gz: 08f86cc7dfb91d26d9865dbfdcd05adf603e1f5afa690e51503215b2005ed3c93982fca7b798589b6de490184f0a3ddd875a6068ce14ed00b0ba1c871065b4cc
-  data.tar.gz: 3d360c7d1ab0a3fdd61d25eaa46d6da0ba38f88df993daa78ac180f57979d43e9073390de2842abb566d63028cf3c6238ad151a69b1c7a37c5ebe8a6384d4974
+  metadata.gz: 63dea290c9868a255eaefa222a159d8f9bc38bd8e9df82e7834cf33fc50b77f770b894d14b8070398aa186053ae383b73c45238ee04432f408fd3a35cc394185
+  data.tar.gz: 40eddda360ffb3caeb8338e96209213f5276893113968ce9b8488434cda06fbd5905178473f70ca0cceafab0b2f2e1d7be6d53493dcb3e71df5de75f11707cc5

data/foreplay.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features|coverage)\/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '>= 3.2'
-  spec.add_runtime_dependency 'foreman', '>= 0.76'
-  spec.add_runtime_dependency 'ssh-shell', '>= 0.4'
+  spec.add_runtime_dependency 'foreman', '>= 0.76', '< 1.0'
+  spec.add_runtime_dependency 'ssh-shell', '>= 0.4', '< 1.0'
+  spec.add_runtime_dependency 'activesupport', '>= 3.2', '< 5.0'
 
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.4'

data/lib/foreplay/cli.rb

@@ -7,6 +7,7 @@ class Foreplay::CLI < Thor
 
   method_option :role,        aliases: '-r'
   method_option :server,      aliases: '-s'
+  method_option :config_file, aliases: '-f'
 
   def deploy(environment)
     Foreplay::Launcher.start [:deploy, environment, options]
@@ -16,6 +17,7 @@ class Foreplay::CLI < Thor
 
   method_option :role,        aliases: '-r'
   method_option :server,      aliases: '-s'
+  method_option :config_file, aliases: '-f'
 
   def check(environment)
     Foreplay::Launcher.start [:check, environment, options]

data/lib/foreplay/engine/remote.rb

@@ -1,4 +1,5 @@
 require 'net/ssh'
+require 'pp' # debug
 
 class Foreplay::Engine::Remote
   include Foreplay
@@ -56,15 +57,29 @@ class Foreplay::Engine::Remote
   def check
     steps.each do |step|
       puts "#{host}#{INDENT}#{(step['commentary'] || step['command']).yellow}" unless step['silent'] == true
-      commands = Foreplay::Engine::Step.new(step, instructions).build
-      commands.each { |command| puts "#{host}#{INDENT * 2}#{command}" unless step['silent'] }
+
+      if step.key? 'key'
+        i = instructions[step['key']]
+
+        if i.is_a? Hash
+          i.each { |k, v| puts "#{host}#{INDENT * 2}#{k}: #{v}" }
+        else
+          puts "#{host}#{INDENT * 2}#{i}"
+        end
+      else
+        commands = Foreplay::Engine::Step.new(step, instructions).build
+
+        commands.each do |command|
+          puts "#{host}#{INDENT * 2}#{command}" unless step['silent']
+        end
+      end
     end
 
     ''
   end
 
   def user
-    @user = instructions[:user]
+    @user = instructions['user']
   end
 
   def host
@@ -82,9 +97,9 @@ class Foreplay::Engine::Remote
   def options
     return @options if @options
 
-    password    = instructions[:password]
-    keyfile     = instructions[:keyfile]
-    private_key = instructions[:private_key]
+    password    = instructions['password']
+    keyfile     = instructions['keyfile']
+    private_key = instructions['private_key']
 
     keyfile.sub! '~', ENV['HOME'] || '/' unless keyfile.blank? # Remote shell won't expand this for us
 

data/lib/foreplay/engine/role.rb

@@ -1,18 +1,17 @@
 class Foreplay::Engine::Role
   attr_reader :environment, :mode, :instructions, :servers
-
   def initialize(e, m, i)
     @environment  = e
     @mode         = m
     @instructions = i
-    @servers      = @instructions[:servers]
+    @servers      = @instructions['servers']
 
     preposition = mode == :deploy ? 'to' : 'for'
 
     return if @servers.length == 1
 
-    puts "#{mode.capitalize}ing #{instructions[:name].yellow} #{preposition} #{@servers.join(', ').yellow} "\
-         "for the #{instructions[:role].dup.yellow} role in the #{environment.dup.yellow} environment..."
+    puts "#{mode.capitalize}ing #{instructions['name'].yellow} #{preposition} #{@servers.join(', ').yellow} "\
+         "for the #{instructions['role'].dup.yellow} role in the #{environment.dup.yellow} environment..."
   end
 
   def threads

data/lib/foreplay/engine/secrets.rb

@@ -0,0 +1,32 @@
+class Foreplay::Engine::Secrets
+  attr_reader :environment, :secret_locations
+
+  def initialize(e, sl)
+    @environment = e
+    @secret_locations = sl
+  end
+
+  def fetch
+    return unless secret_locations
+
+    secrets = {}
+
+    secret_locations.each do |secret_location|
+      secrets.merge! fetch_from(secret_location)
+    end
+
+    secrets
+  end
+
+  def fetch_from(secret_location)
+    return unless secret_location['url']
+
+    headers = secret_location['headers'].map { |k, v| " -H \"#{k}: #{v}\"" }.join
+    command = "curl -k -L#{headers} #{secret_location['url']}"
+
+    secrets_all = YAML.load(`#{command}`)
+    secrets_all[environment]
+  rescue Psych::SyntaxError
+    nil
+  end
+end

data/lib/foreplay/engine/server.rb

@@ -1,5 +1,3 @@
-require 'active_support/inflector'
-
 class Foreplay::Engine::Server
   include Foreplay
   attr_reader :environment, :mode, :instructions, :server
@@ -18,35 +16,36 @@ class Foreplay::Engine::Server
     message += "for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
     puts message
 
-    instructions[:foreman]['app']   = current_service
-    instructions[:foreman]['port']  = current_port
-    instructions[:foreman]['user']  = user
-    instructions[:foreman]['log']   = "$HOME/#{path}/#{current_port}/log"
+    # Contents of .foreman file
+    instructions['foreman']['app']   = current_service
+    instructions['foreman']['port']  = current_port
+    instructions['foreman']['user']  = user
+    instructions['foreman']['log']   = "$HOME/#{path}/#{current_port}/log"
 
     # Contents of .env file
-    instructions[:env]['HOME']  = '$HOME'
-    instructions[:env]['SHELL'] = '$SHELL'
-    instructions[:env]['PATH']  = '$PATH:`which bundle`'
+    instructions['env']['HOME']  = '$HOME'
+    instructions['env']['SHELL'] = '$SHELL'
+    instructions['env']['PATH']  = '$PATH:`which bundle`'
 
     Foreplay::Engine::Remote.new(server, steps, instructions).__send__ mode
   end
 
   def role
-    @role ||= instructions[:role]
+    @role ||= instructions['role']
   end
 
   def user
-    @user ||= instructions[:user]
+    @user ||= instructions['user']
   end
 
   def name
-    @name ||= instructions[:name]
+    @name ||= instructions['name']
   end
 
   def path
     return @path if @path
 
-    @path = instructions[:path]
+    @path = instructions['path']
     @path.gsub! '%u', user
     @path.gsub! '%a', name
     @path
@@ -69,19 +68,19 @@ class Foreplay::Engine::Server
   end
 
   def current_port
-    @current_port ||= port_details[:current_port]
+    @current_port ||= port_details['current_port']
   end
 
   def current_service
-    @current_service ||= port_details[:current_service]
+    @current_service ||= port_details['current_service']
   end
 
   def former_port
-    @former_port ||= port_details[:former_port]
+    @former_port ||= port_details['former_port']
   end
 
   def former_service
-    @former_service ||= port_details[:former_service]
+    @former_service ||= port_details['former_service']
   end
 
   def current_port_file
@@ -109,15 +108,15 @@ class Foreplay::Engine::Server
     end
 
     cp      = current_port_string.to_i
-    port    = instructions[:port]
+    port    = instructions['port']
     ports   = [port + 1000, port]
     cp, fp  = cp == port ? ports : ports.reverse
 
     @port_details = {
-      current_port: cp,
-      current_service: "#{name}-#{cp}",
-      former_port: fp,
-      former_service: "#{name}-#{fp}"
+      'current_port'    => cp,
+      'current_service' => "#{name}-#{cp}",
+      'former_port'     => fp,
+      'former_service'  => "#{name}-#{fp}"
     }
   end
 end

data/lib/foreplay/engine/steps.yml

@@ -1,8 +1,8 @@
 ---
 - command:      "echo Foreplay version <%= VERSION %>"
   commentary:   "Foreplay running from <%= `hostname -f` %><%= `which foreman` %>"
-- command:      "mkdir -p <%= path %> && cd <%= path %> && rm -rf <%= current_port %> && git clone -b <%= instructions[:branch] || 'master' %> <%= instructions[:repository] %> <%= current_port %>"
-  commentary:   "Cloning <%= instructions[:branch] || 'master' %> branch of repository <%= instructions[:repository] %>"
+- command:      "mkdir -p <%= path %> && cd <%= path %> && rm -rf <%= current_port %> && git clone -b <%= instructions['branch'] || 'master' %> <%= instructions['repository'] %> <%= current_port %>"
+  commentary:   "Cloning <%= instructions['branch'] || 'master' %> branch of repository <%= instructions['repository'] %>"
 - command:      "rvm rvmrc trust <%= current_port %>"
   commentary:   'Trusting the .rvmrc file for the new instance'
 - command:      "rvm rvmrc warning ignore <%= current_port %>"
@@ -14,22 +14,29 @@
   commentary:   'If you have a .rvmrc file there may be a delay now while we install a new ruby'
 - command:      'if [ -f .ruby-version ] ; then rvm install `cat .ruby-version` ; else echo "No .ruby-version file found" ; fi'
   commentary:   'If you have a .ruby-version file there may be a delay now while we install a new ruby'
-- key:          :env
+- key:          'env'
   delimiter:    '='
   prefix:       '.'
   commentary:   'Building .env'
-- key:          :foreman
+- key:          'foreman'
   delimiter:    ': '
   prefix:       '.'
   commentary:   'Building .foreman'
-- key:          :database
+- key:          'database'
   delimiter:    ': '
   suffix:       '.yml'
   commentary:   'Building config/database.yml'
   before:       '  '
   header:       "<%= environment %>:"
   path:         'config/'
-- key:          :resque
+- key:          'application'
+  delimiter:    ': '
+  suffix:       '.yml'
+  commentary:   'Building config/application.yml'
+  before:       '  '
+  header:       "<%= environment %>:"
+  path:         'config/'
+- key:          'resque'
   delimiter:    ': '
   suffix:       '.yml'
   commentary:   'Building config/resque.yml'

data/lib/foreplay/engine.rb

@@ -1,12 +1,13 @@
 require 'yaml'
 require 'string'
+require 'active_support/core_ext/object'
 
 class Foreplay::Engine
   include Foreplay
-  attr_reader :environment, :filters, :mode
+  attr_reader :mode, :environment, :filters
 
-  DEFAULTS_KEY  = 'defaults'
-  CONFIG_FILE   = "#{Dir.getwd}/config/foreplay.yml"
+  DEFAULT_CONFIG_FILE = "#{Dir.getwd}/config/foreplay.yml"
+  DEFAULTS_KEY        = 'defaults'
 
   def initialize(e, f)
     @environment  = e
@@ -56,7 +57,7 @@ class Foreplay::Engine
     fail 'supermerge only works if you pass two hashes. '\
       "You passed a #{hash.class} and a #{other_hash.class}." unless hash.is_a?(Hash) && other_hash.is_a?(Hash)
 
-    new_hash = hash.deep_dup.with_indifferent_access
+    new_hash = hash.deep_dup
 
     other_hash.each_pair do |k, v|
       tv = new_hash[k]
@@ -76,21 +77,21 @@ class Foreplay::Engine
   private
 
   def explanatory_text(hsh, key)
-    hsh.key?(key) ? "#{hsh[key].dup.yellow} #{key}" : "all #{key.pluralize}"
+    hsh.key?(key) ? "#{hsh[key].dup.yellow} #{key}" : "all #{key}s"
   end
 
   def build_instructions(role, additional_instructions)
-    instructions        = supermerge(defaults, additional_instructions).symbolize_keys
-    instructions[:role] = role
-    required_keys       = [:name, :environment, :role, :servers, :path, :repository]
+    instructions          = supermerge(defaults, additional_instructions)
+    instructions['role']  = role
+    required_keys         = %w(name environment role servers path repository)
 
     required_keys.each do |key|
       next if instructions.key? key
-      terminate("Required key #{key} not found in instructions for #{environment} environment.\nCheck #{CONFIG_FILE}")
+      terminate("Required key #{key} not found in instructions for #{environment} environment.\nCheck #{config_file}")
     end
 
     # Apply server filter
-    instructions[:servers] &= server_filter if server_filter
+    instructions['servers'] &= server_filter if server_filter
     instructions
   end
 
@@ -98,20 +99,30 @@ class Foreplay::Engine
     @server_filter ||= filters['server'].split(',') if filters.key?('server')
   end
 
+  def config_file
+    @config_file ||= (filters['config_file'] || DEFAULT_CONFIG_FILE)
+  end
+
   def defaults
     return @defaults if @defaults
 
     # Establish defaults
     # First the default defaults
     @defaults = {
-      name:         File.basename(Dir.getwd),
-      environment:  environment,
-      env:          { 'RAILS_ENV' => environment },
-      port:         50_000
+      'name'        =>  File.basename(Dir.getwd),
+      'environment' =>  environment,
+      'env'         =>  { 'RAILS_ENV' => environment },
+      'port'        =>  50_000
     }
 
+    # Add secret environment variables
+    secrets = Foreplay::Engine::Secrets.new(environment, roles_all['secrets']).fetch || {}
+    @defaults['env'] = @defaults['env'].merge secrets
+    @defaults['application'] = secrets
+
     @defaults = supermerge(@defaults, roles_all[DEFAULTS_KEY]) if roles_all.key? DEFAULTS_KEY
     @defaults = supermerge(@defaults, roles[DEFAULTS_KEY])     if roles.key? DEFAULTS_KEY
+    @defaults
   end
 
   def roles
@@ -121,18 +132,18 @@ class Foreplay::Engine
   def roles_all
     return @roles_all if @roles_all
 
-    @roles_all = YAML.load(File.read(CONFIG_FILE))
+    @roles_all = YAML.load(File.read(config_file))
 
     # This environment
     unless @roles_all.key? environment
-      terminate("No deployment configuration defined for #{environment} environment.\nCheck #{CONFIG_FILE}")
+      terminate("No deployment configuration defined for #{environment} environment.\nCheck #{config_file}")
     end
 
     @roles_all
   rescue Errno::ENOENT
-    terminate "Can't find configuration file #{CONFIG_FILE}.\nPlease run foreplay setup or create the file manually."
+    terminate "Can't find configuration file #{config_file}.\nPlease run foreplay setup or create the file manually."
   rescue Psych::SyntaxError
-    terminate "I don't understand the configuration file #{CONFIG_FILE}.\n"\
+    terminate "I don't understand the configuration file #{config_file}.\n"\
       'Please run foreplay setup or edit the file manually.'
   end
 end

data/lib/foreplay/foreplay.rb

@@ -1,6 +1,3 @@
-require 'active_support/core_ext/object'
-require 'active_support/core_ext/hash'
-
 module Foreplay
   INDENT = "\t"
 

data/lib/foreplay/version.rb

@@ -1,3 +1,3 @@
 module Foreplay
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/foreplay.rb

@@ -4,5 +4,6 @@ require 'foreplay/launcher'
 require 'foreplay/engine'
 require 'foreplay/engine/remote'
 require 'foreplay/engine/role'
+require 'foreplay/engine/secrets'
 require 'foreplay/engine/server'
 require 'foreplay/engine/step'

data/spec/lib/foreplay/engine_spec.rb

@@ -10,23 +10,23 @@ describe Foreplay::Engine do
     end
 
     it 'should merge two simple hashes' do
-      expect(engine.supermerge({ a: 'x' }, b: 'y')).to eq('a' => 'x', 'b' => 'y')
+      expect(engine.supermerge({ a: 'x' }, b: 'y')).to eq(a: 'x', b: 'y')
     end
 
     it 'should merge two hashes both with arrays at the same key' do
-      expect(engine.supermerge({ a: ['x'] }, a: ['y'])).to eq('a' => %w(x y))
+      expect(engine.supermerge({ a: ['x'] }, a: ['y'])).to eq(a: %w(x y))
     end
 
     it 'should merge an array and a value at the same key' do
-      expect(engine.supermerge({ a: 'x' }, a: ['y'])).to eq('a' => %w(x y))
+      expect(engine.supermerge({ a: 'x' }, a: ['y'])).to eq(a: %w(x y))
     end
 
     it 'should replace a value at the same key' do
-      expect(engine.supermerge({ a: 'x' }, a: 'y')).to eq('a' => 'y')
+      expect(engine.supermerge({ a: 'x' }, a: 'y')).to eq(a: 'y')
     end
 
     it 'should merge two subhashes at the same key' do
-      expect(engine.supermerge({ a: { b: 'x' } }, a: { c: 'y' })).to eq('a' => { 'b' => 'x', 'c' => 'y' })
+      expect(engine.supermerge({ a: { b: 'x' } }, a: { c: 'y' })).to eq(a: { b: 'x', c: 'y' })
     end
   end
 end

metadata

@@ -1,57 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: foreplay
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Xenapto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: foreman
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.76'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.76'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: foreman
+  name: ssh-shell
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: ssh-shell
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +224,7 @@ files:
 - lib/foreplay/engine.rb
 - lib/foreplay/engine/remote.rb
 - lib/foreplay/engine/role.rb
+- lib/foreplay/engine/secrets.rb
 - lib/foreplay/engine/server.rb
 - lib/foreplay/engine/step.rb
 - lib/foreplay/engine/steps.yml