foreplay 0.9.13 → 0.10.1

data/lib/foreplay/engine/remote.rb

@@ -1,92 +1,99 @@
 require 'net/ssh'
 require 'net/ssh/shell'
 
-class Foreplay::Engine::Remote
-  include Foreplay
-  attr_reader :server, :steps, :instructions
-
-  def initialize(s, st, i)
-    @server = s
-    @steps = st
-    @instructions = i
-  end
-
-  def deploy
-    output = ''
-
-    log "Connecting to #{host} on port #{port}", host: host
-
-    # SSH connection
-    session = start_session(host, user, options)
-
-    log "Successfully connected to #{host} on port #{port}", host: host
-
-    session.shell do |sh|
-      steps.each { |step| output += Foreplay::Engine::Remote::Step.new(host, sh, step, instructions).execute }
+require 'foreplay/engine/remote/check'
+require 'foreplay/engine/remote/step'
+
+module Foreplay
+  class Engine
+    class Remote
+      include Foreplay
+      attr_reader :server, :steps, :instructions
+
+      def initialize(s, st, i)
+        @server = s
+        @steps = st
+        @instructions = i
+      end
+
+      def deploy
+        output = ''
+
+        log "Connecting to #{host} on port #{port}", host: host
+
+        # SSH connection
+        session = start_session(host, user, options)
+
+        log "Successfully connected to #{host} on port #{port}", host: host
+
+        session.shell do |sh|
+          steps.each { |step| output += Foreplay::Engine::Remote::Step.new(host, sh, step, instructions).execute }
+        end
+
+        session.close
+        output
+      end
+
+      # Deployment check: just say what we would have done
+      def check
+        Foreplay::Engine::Remote::Check.new(host, steps, instructions).perform
+      end
+
+      def user
+        @user = instructions['user']
+      end
+
+      def host
+        @host ||= host_port[0]
+      end
+
+      def port
+        @port ||= (host_port[1] || 22)
+      end
+
+      def host_port
+        @host_port ||= server.split(':') # Parse host + port
+      end
+
+      def options
+        return @options if @options
+
+        @options = { verbose: :warn, port: port }
+        password = instructions['password']
+
+        if password.blank?
+          @options[:key_data] = [private_key]
+        else
+          @options[:password] = password
+        end
+
+        @options
+      end
+
+      def private_key
+        pk = instructions['private_key']
+        pk.blank? ? private_key_from_file : pk
+      end
+
+      def private_key_from_file
+        keyfile = instructions['keyfile']
+        keyfile.sub! '~', ENV['HOME'] || '/' unless keyfile.blank? # Remote shell won't expand this for us
+
+        terminate(
+          'No authentication methods supplied. '\
+          'You must supply a private key, key file or password in the configuration file'
+        ) if keyfile.blank?
+
+        # Get the key from the key file
+        log "Using private key from #{keyfile}"
+        File.read keyfile
+      end
+
+      def start_session(host, user, options)
+        Net::SSH.start(host, user, options)
+      rescue SocketError => e
+        terminate "There was a problem starting an ssh session on #{host}:\n#{e.message}"
+      end
     end
-
-    session.close
-    output
-  end
-
-  # Deployment check: just say what we would have done
-  def check
-    Foreplay::Engine::Remote::Check.new(host, steps, instructions).perform
-  end
-
-  def user
-    @user = instructions['user']
-  end
-
-  def host
-    @host ||= host_port[0]
-  end
-
-  def port
-    @port ||= (host_port[1] || 22)
-  end
-
-  def host_port
-    @host_port ||= server.split(':') # Parse host + port
-  end
-
-  def options
-    return @options if @options
-
-    @options = { verbose: :warn, port: port }
-    password = instructions['password']
-
-    if password.blank?
-      @options[:key_data] = [private_key]
-    else
-      @options[:password] = password
-    end
-
-    @options
-  end
-
-  def private_key
-    pk = instructions['private_key']
-    pk.blank? ? private_key_from_file : pk
-  end
-
-  def private_key_from_file
-    keyfile = instructions['keyfile']
-    keyfile.sub! '~', ENV['HOME'] || '/' unless keyfile.blank? # Remote shell won't expand this for us
-
-    terminate(
-      'No authentication methods supplied. '\
-      'You must supply a private key, key file or password in the configuration file'
-    ) if keyfile.blank?
-
-    # Get the key from the key file
-    log "Using private key from #{keyfile}"
-    File.read keyfile
-  end
-
-  def start_session(host, user, options)
-    Net::SSH.start(host, user, options)
-  rescue SocketError => e
-    terminate "There was a problem starting an ssh session on #{host}:\n#{e.message}"
   end
 end

data/lib/foreplay/engine/role.rb

@@ -1,22 +1,26 @@
-class Foreplay::Engine::Role
-  attr_reader :environment, :mode, :instructions, :servers
-  def initialize(e, m, i)
-    @environment  = e
-    @mode         = m
-    @instructions = i
-    @servers      = @instructions['servers']
+module Foreplay
+  class Engine
+    class Role
+      attr_reader :environment, :mode, :instructions, :servers
+      def initialize(e, m, i)
+        @environment  = e
+        @mode         = m
+        @instructions = i
+        @servers      = @instructions['servers']
 
-    preposition = mode == :deploy ? 'to' : 'for'
+        preposition = mode == :deploy ? 'to' : 'for'
 
-    return if @servers.length == 1
+        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..."
-  end
+        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
-    servers.map do |server|
-      Thread.new { Foreplay::Engine::Server.new(environment, mode, instructions, server).execute }
+      def threads
+        servers.map do |server|
+          Thread.new { Foreplay::Engine::Server.new(environment, mode, instructions, server).execute }
+        end
+      end
     end
   end
 end

data/lib/foreplay/engine/secrets.rb

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

data/lib/foreplay/engine/server.rb

@@ -1,68 +1,79 @@
-class Foreplay::Engine::Server
-  include Foreplay::Engine::Port
-  attr_reader :environment, :mode, :instructions, :server
+module Foreplay
+  class Engine
+    class Server
+      include Foreplay::Engine::Port
+      attr_reader :environment, :mode, :instructions, :server
 
-  def initialize(e, m, i, s)
-    @environment  = e
-    @mode         = m
-    @instructions = i
-    @server       = s
-  end
+      def initialize(e, m, i, s)
+        @environment  = e
+        @mode         = m
+        @instructions = i
+        @server       = s
+      end
 
-  def execute
-    execute_announce
-    foreman
-    env
-    Foreplay::Engine::Remote.new(server, steps, instructions).__send__ mode
-  end
+      def execute
+        execute_announce
+        foreman
+        env
 
-  def execute_announce
-    preposition = mode == :deploy ? 'to' : 'for'
-    puts "#{mode.capitalize}ing #{name.yellow} #{preposition} #{host.yellow} "\
-        "for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
-  end
+        Foreplay::Engine::Remote.new(server, steps, instructions).__send__ mode
+      end
 
-  def foreman
-    instructions['foreman'].merge!(
-      'app'   => current_service,
-      'port'  => current_port,
-      'user'  => user,
-      'log'   => "$HOME/#{path}/#{current_port}/log"
-    )
-  end
+      def execute_announce
+        preposition = mode == :deploy ? 'to' : 'for'
+        puts "#{mode.capitalize}ing #{name.yellow} #{preposition} #{host.yellow} "\
+            "for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
+      end
 
-  def env
-    instructions['env'].merge!(
-      'HOME'  => '$HOME',
-      'SHELL' => '$SHELL',
-      'PATH'  => '$PATH:`which bundle`'
-    )
-  end
+      def foreman
+        instructions['foreman'] = {} unless instructions.key? 'foreman'
 
-  def role
-    @role ||= instructions['role']
-  end
+        instructions['foreman'].merge!(
+          'app'   => current_service,
+          'port'  => current_port,
+          'user'  => user,
+          'log'   => "$HOME/#{path}/#{current_port}/log"
+        )
+      end
 
-  def user
-    @user ||= instructions['user']
-  end
+      def env
+        instructions['env'] = {} unless instructions.key? 'env'
 
-  def path
-    return @path if @path
+        instructions['env'].merge!(
+          'HOME'      => '$HOME',
+          'SHELL'     => '$SHELL',
+          'PATH'      => '$PATH:`which bundle`',
+          'GEM_HOME'  => '$HOME/.rvm/gems/`rvm tools identifier`',
+          'RAILS_ENV' => environment
+        )
+      end
 
-    @path = instructions['path']
-    @path.gsub! '%u', user
-    @path.gsub! '%a', name
-    @path
-  end
+      def role
+        @role ||= instructions['role']
+      end
+
+      def user
+        @user ||= instructions['user']
+      end
+
+      def path
+        return @path if @path
+
+        @path = instructions['path']
+        @path.gsub! '%u', user
+        @path.gsub! '%a', name
+        @path
+      end
 
-  def steps
-    @steps ||= YAML.load(
-      ERB.new(
-        File.read(
-          "#{File.dirname(__FILE__)}/steps.yml"
+      def steps
+        @steps ||= YAML.load(
+          ERB.new(
+            File.read(
+              "#{File.dirname(__FILE__)}/steps.yml"
+            )
+          ).result(binding)
         )
-      ).result(binding)
-    )
+      end
+    end
   end
 end

data/lib/foreplay/engine/step.rb

@@ -1,117 +1,121 @@
-class Foreplay::Engine::Step
-  include Foreplay
-  attr_reader :host, :step, :instructions
-
-  def initialize(h, s, i)
-    @host = h
-    @step = s
-    @instructions = i
-  end
-
-  def commands
-    return @commands if @commands
-
-    # Each step can be (1) a command or (2) a series of values to add to a file
-    if step.key?('key')
-      if instructions.key?(step['key'])
-        build_commands
-      else
-        @commands = []
+module Foreplay
+  class Engine
+    class Step
+      include Foreplay
+      attr_reader :host, :step, :instructions
+
+      def initialize(h, s, i)
+        @host = h
+        @step = s
+        @instructions = i
       end
-    else
-      # ...or just execute the command specified
-      @commands = [command]
-    end
-
-    @commands
-  end
 
-  def build_commands
-    step['silent'] = true
-
-    if header?
-      @commands  = ["echo \"#{header}\" > #{filename}"]
-      redirect
-    else
-      @commands  = []
-    end
+      def commands
+        return @commands if @commands
+
+        # Each step can be (1) a command or (2) a series of values to add to a file
+        if step.key?('key')
+          if instructions.key?(step['key'])
+            build_commands
+          else
+            @commands = []
+          end
+        else
+          # ...or just execute the command specified
+          @commands = [command]
+        end
+
+        @commands
+      end
 
-    if instructions[key].is_a? Hash
-      build_commands_from_hash
-    else
-      build_commands_from_string
-    end
-  end
+      def build_commands
+        step['silent'] = true
+
+        if header?
+          @commands  = ["echo \"#{header}\" > #{filename}"]
+          redirect
+        else
+          @commands  = []
+        end
+
+        if instructions[key].is_a? Hash
+          build_commands_from_hash
+        else
+          build_commands_from_string
+        end
+      end
 
-  def build_commands_from_hash
-    instructions[key].each do |k, v|
-      @commands << "echo \"#{before}#{k}#{delimiter}#{v}#{after}\" #{redirect} #{filename}"
-    end
-  end
+      def build_commands_from_hash
+        instructions[key].each do |k, v|
+          @commands << "echo \"#{before}#{k}#{delimiter}#{v}#{after}\" #{redirect} #{filename}"
+        end
+      end
 
-  def build_commands_from_string
-    @commands << "echo \"#{before}#{delimiter}#{instructions[key]}#{after}\" #{redirect} #{filename}"
-  end
+      def build_commands_from_string
+        @commands << "echo \"#{before}#{delimiter}#{instructions[key]}#{after}\" #{redirect} #{filename}"
+      end
 
-  def redirect
-    if @redirect
-      '>>'
-    else
-      @redirect = true
-      '>'
-    end
-  end
+      def redirect
+        if @redirect
+          '>>'
+        else
+          @redirect = true
+          '>'
+        end
+      end
 
-  def command
-    @command ||= step['command']
-  end
+      def command
+        @command ||= step['command']
+      end
 
-  def filename
-    @filename ||= "#{path}#{prefix}#{key}#{suffix}"
-  end
+      def filename
+        @filename ||= "#{path}#{prefix}#{key}#{suffix}"
+      end
 
-  def key
-    @key ||= step['key']
-  end
+      def key
+        @key ||= step['key']
+      end
 
-  def prefix
-    @prefix ||= step['prefix'] || ''
-  end
+      def prefix
+        @prefix ||= step['prefix'] || ''
+      end
 
-  def suffix
-    @suffix ||= step['suffix'] || ''
-  end
+      def suffix
+        @suffix ||= step['suffix'] || ''
+      end
 
-  def path
-    @path ||= step['path'] || ''
-  end
+      def path
+        @path ||= step['path'] || ''
+      end
 
-  def before
-    @before ||= step['before'] || ''
-  end
+      def before
+        @before ||= step['before'] || ''
+      end
 
-  def delimiter
-    @delimiter ||= step['delimiter'] || ''
-  end
+      def delimiter
+        @delimiter ||= step['delimiter'] || ''
+      end
 
-  def after
-    @after ||= step['after'] || ''
-  end
+      def after
+        @after ||= step['after'] || ''
+      end
 
-  def header
-    @header ||= step['header']
-  end
+      def header
+        @header ||= step['header']
+      end
 
-  def header?
-    header.present?
-  end
+      def header?
+        header.present?
+      end
 
-  def silent
-    @silent ||= step['silent']
-  end
+      def silent
+        @silent ||= step['silent']
+      end
 
-  def announce
-    log "#{(step['commentary'] || command).yellow}", host: host, silent: silent
-    log command.cyan, host: host, silent: silent if instructions['verbose'] && step['commentary'] && command
+      def announce
+        log "#{(step['commentary'] || command).yellow}", host: host, silent: silent
+        log command.cyan, host: host, silent: silent if instructions['verbose'] && step['commentary'] && command
+      end
+    end
   end
 end