foreplay 0.0.1

data/.gitignore

@@ -0,0 +1,34 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foreplay.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dominic Sayers
+
+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,110 @@
+# Foreplay
+
+Foreplay: deploying Rails projects to Ubuntu using Foreman
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foreplay'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foreplay
+
+## Usage
+
+    ENV=production rake foreplay:push
+
+or
+
+    ENV=production ROLE=web rake foreplay:push
+
+You can set the environment variables `ENV` and `ROLE` elsewhere if you wish.
+If `ROLE` is not defined then we deploy all roles.
+
+### How it works
+
+Foreplay does this:
+
+1.  Opens an SSH connection to the deloyment target
+2.  Grabs a copy of your code from the repository
+3.  Builds a `.env` file, a `.foreman` file and a `database.yml` file
+4.  Does a `bundle install`
+5.  Uses `foreman` to create an Upstart service (`foreman export`) for your app
+6.  Launches the app
+7.  Directs incoming traffic on port 80 to your app
+8.  If there's a previous instance of the app running, Foreplay shuts it down gracefully after it has switched `iptables` to the new instance
+
+There should be little or no downtime. If the app is b0rked then you can easily switch back to the previous instance: the Upstart service is still configured.
+
+### foreplay.yml
+
+Format:
+
+```YAML
+defaults:       # global defaults for all environments
+  name:         # app name (if omitted then Rails.application.class.parent_name.underscore is used)
+  servers: [server1, server2, server3] # which servers to deploy the app on
+  user:         # The username to connect with (must have SSH permissions)
+  password:     # The password to use to connect (not necessary if you've set up SSH keys)
+  keyfile:      # ...or a file containing a private key that allows the named user access to the server
+  key:          # ...or a private key that allows the named user access to the server
+  path:         # absolute path to deploy the app on each server. %s will be translated to the application name
+  database:     # the database.yml elements to write to the config folder
+  env:          # contents of the .env file
+    key: value  # will go into the .env file as key=value
+  foreman:      # contents of the .foreman file
+    key: value  # will go into the .foreman file as key: value
+production:     # deployment configuration for the production environment
+  defaults:     # defaults for all roles in this environment (structure same as global defaults)
+  role1:        # settings for the a particular role (e.g. web, worker, etc.) (structure same as global defaults)
+```
+
+### Environment
+
+Settings for the `.env` files and `.foreman` files in specific sections will add to the defaults specified earlier. `.env` files will get a `RAILS_ENV=environment` entry (where `environment` is as specified in `foreplay.yml`). You can override this by adding a different `RAILS_ENV` setting to this configuration here.
+
+The first instance of the first entry in `Procfile` that is instantiated by your Foreman concurrency settings will
+be started on port 50100 or 51100 and the external port 80 will be mapped to this port by `iptables`. You cannot
+configure the ports yourself. As an example, if your `Procfile` has a `web` entry on the first line and at
+least one `web` instance is configured in the `.foreman` concurrency setting then the first instance of your `web`
+process will be available to the outside world on port 80.
+
+### Path
+
+You can use `%u` in the path. This will be substituted with the `user` value. You can use `%a` in the path. This will be substituted with the app's `name`
+
+Example:
+
+    user: fred
+    name: myapp
+    path: /home/%u/apps/%a
+
+### Dependencies
+
+```ruby
+gem 'foreman'
+gem 'net-ssh-shell'
+```
+
+You can constrain this to whatever groups you use for initiating deployments, e.g.
+
+```ruby
+group :development, :test do
+  gem 'foreman'
+  gem 'net-ssh-shell'
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/foreplay

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'foreplay/cli'
+Foreplay::CLI.start

data/features/config.feature

@@ -0,0 +1,66 @@
+Feature: Config
+  In order to configure Foreplay
+  As a CLI
+  I want to be as usable as possible
+
+  Scenario: Check configuration
+    When I run `foreplay check`
+    Then the output should contain "OK"
+
+  Scenario: Check configuration parameters - invalid parameter
+    When I run `foreplay check --invalid xyz`
+    Then the output should contain:
+    	"""
+    	ERROR: foreplay check was called with arguments ["--invalid", "xyz"]
+		Usage: "foreplay check".
+    	"""
+
+  Scenario: Check configuration parameters - short invalid parameter
+    When I run `foreplay check -x xyz`
+    Then the output should contain:
+    	"""
+		ERROR: foreplay check was called with arguments ["-x", "xyz"]
+		Usage: "foreplay check".
+    	"""
+
+  Scenario: Check configuration parameters - environment parameter
+    When I run `foreplay check --environment production`
+    Then the output should contain "Checking configuration for"
+    And the output should contain "production environment"
+    And the output should contain "all roles"
+    And the output should contain "all servers"
+
+  Scenario: Check configuration parameters - role parameter
+    When I run `foreplay check --role worker`
+    Then the output should contain "Checking configuration for"
+    And the output should contain "all environments"
+    And the output should contain "worker role"
+    And the output should contain "all servers"
+
+  Scenario: Check configuration parameters - server parameter
+    When I run `foreplay check --server worker.example.com`
+    Then the output should contain "Checking configuration for"
+    And the output should contain "all environments"
+    And the output should contain "all roles"
+    And the output should contain "worker.example.com server"
+
+  Scenario: Check configuration parameters - short environment parameter
+    When I run `foreplay check -e production`
+    Then the output should contain "Checking configuration for"
+    And the output should contain "production environment"
+    And the output should contain "all roles"
+    And the output should contain "all servers"
+
+  Scenario: Check configuration parameters - short role parameter
+    When I run `foreplay check -r worker`
+    Then the output should contain "Checking configuration for"
+    And the output should contain "all environments"
+    And the output should contain "worker role"
+    And the output should contain "all servers"
+
+  Scenario: Check configuration parameters - short server parameter
+    When I run `foreplay check -s worker.example.com`
+    Then the output should contain "Checking configuration for"
+    And the output should contain "all environments"
+    And the output should contain "all roles"
+    And the output should contain "worker.example.com server"

data/features/generator.feature

@@ -0,0 +1,97 @@
+Feature: Setup
+  In order to setup Foreplay
+  As a CLI user
+  I want to be able to create the config scaffold
+
+  Scenario: Setup
+	When I run `foreplay setup`
+	Then the following files should exist:
+		| config/foreplay.yml |
+	And the file "config/foreplay.yml" should contain:
+		"""
+		# Format:
+		#
+		# There is a section for each environment that you will deploy to, plus a section that defines global default
+		# values for all environments, like this:
+		#
+		# defaults:
+		#   ...
+		# production:
+		#   ...
+		# staging:
+		#   ...
+		#
+		# Within each section you can define the server roles for that environment: web, worker, database etc. (the
+		# names of these roles are up to you). You can also define environment-level defaults that apply to all roles.
+		# Like this:
+		#
+		# production:
+		#   defaults:
+		#     ...
+		#   web:
+		#     ...
+		#   worker:
+		#     ...
+		#   scheduler:
+		#     ...
+		#   database:
+		#     ...
+		# staging:
+		#   defaults:
+		#     ...
+		#   web:
+		#     ...
+		#   worker:
+		#     ...
+		#   scheduler:
+		#     ...
+		#   database:
+		#     ...
+		#
+		# Within each role section you can define how the deployment is configured for the servers in that role.
+		# Some of these values will normally be defined as a default, some will be specific to a particular role.
+		# The values you can configure are as follows:
+		#
+		# value         Normally defined as  Notes
+		# ------------- -------------------- -------------------------------------------------------------------
+		# name:         Global default       App name (if omitted then
+		#                                    Rails.application.class.parent_name.underscore is used)
+		# user:         Global default       The username to connect with (must have SSH permissions)
+		# password:     Global default       The password to use to connect (not necessary if you've set up SSH
+		#                                    keys - see below)
+		# keyfile:      Global default       A file containing a private key that allows the named user access
+		#                                    to the server, or...
+		# key:          Global default       A private key that allows the named user access to the server
+		# path:         Global default       An absolute path to deploy the app on each server. %a will be
+		#                                    translated to the application name. %u will be translated to the
+		#                                    login user name
+		# database:     Environment default  The database.yml elements to write to the config folder
+		#   key: value
+		# servers: [server1, server2, server3]
+		#               Role level           Which servers to deploy the app on
+		# env:          Role level           Contents of the .env file
+		#   key: value                       Values will go into the .env file as key=value
+		# foreman:      Role level           Contents of the .foreman file
+		#   key: value
+		#
+		defaults:
+		  name: %q{TODO: Add the app name}
+		  repository: %q{TODO: Add the git repository path}
+		  user: %q{TODO: Add the user to logon to the deployment server}
+		  password: %q{TODO: Add the password for the user on the deployment server}
+		  path: %q{TODO: Add the path to deploy to on the deployment server}
+		production:
+		  defaults:
+		    database:
+		      adapter: postgresql
+		      encoding: utf8
+		      database: %q{TODO: Add the database name}
+		      pool: 5
+		      host: %q{TODO: Add the database host name}
+		      username: %q{TODO: Add the database user}
+		      password: %q{TODO: Add the database user's password}
+		  web:
+		    servers: [%q{TODO: Add the name of the production web server}]
+		    foreman:
+		      concurrency: 'web=1,worker=0,scheduler=0'
+		"""

data/features/support/setup.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/foreplay.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foreplay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "foreplay"
+  spec.version       = Foreplay::VERSION
+  spec.authors       = ["Xenapto"]
+  spec.email         = ["developers@xenapto.com"]
+  spec.description   = %q{Deploying Rails projects to Ubuntu using Foreman}
+  spec.summary       = %q{Example: foreplay push to production}
+  spec.homepage      = "https://github.com/Xenapto/foreplay"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'foreman'
+  spec.add_dependency 'net-ssh-shell'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "gem-release"
+end

data/foreplay.rake

@@ -0,0 +1,28 @@
+# Syntax:
+#
+#     rake ENV=production [ROLE=web] foreplay:command
+#
+# You can set the environment variables ENV and ROLE elsewhere if you wish.
+# If ROLE is not defined then we deploy all roles.
+#
+# Dependencies:
+#
+#    gem 'net-ssh-shell'
+#
+# You can constrain this to whatever group you use for initiating deployments, e.g.
+#
+#    group :development do
+#      gem 'net-ssh-shell'
+#    end
+
+namespace :foreplay do
+  desc 'Push app to deployment targets'
+  task :push => :environment do
+    Foreplay::push
+  end
+
+  desc 'Check deployment configuration'
+  task :check => :environment do
+    Foreplay::push true
+  end
+end

data/foreplay.rb

@@ -0,0 +1,246 @@
+# encoding: utf-8
+require 'yaml'
+require 'net/ssh'
+
+class Foreplay
+  class << self
+    def push check_only = false
+      environment = ENV['ENV']
+      config_file = "#{Rails.root}/config/foreplay.yml"
+      config_all  = YAML.load(File.read(config_file))
+
+      # This environment
+      raise RuntimeError, "No deployment environment defined. Set the ENV environment variable." if environment.blank?
+      raise RuntimeError, "No deployment configuration defined for #{environment} environment. Check #{config_file}" unless config_all.has_key? environment
+      config = config_all[environment]
+
+      # Establish defaults
+      # First the default defaults
+      defaults = {
+        'name'        => Rails.application.class.parent_name.underscore,
+        'environment' => environment,
+        'env'         => { 'RAILS_ENV' => environment }
+      }
+
+      defaults = deep_merge_with_arrays(defaults, config_all['defaults'])  if config_all.has_key? 'defaults'  # Then the global defaults
+      defaults = deep_merge_with_arrays(defaults, config['defaults'])      if config.has_key? 'defaults'      # Then the defaults for this environment
+
+      config.each do |role, additional_instructions|
+        next if role == 'defaults' # 'defaults' is not a role
+        next unless ENV['ROLE'].blank? || ENV['ROLE'] == role # Only deploy to the role we've specified (or all roles if none is specified)
+
+        instructions        = deep_merge_with_arrays(defaults, additional_instructions).symbolize_keys
+        instructions[:role] = role
+        required_keys       = [:name, :environment, :role, :servers, :path, :repository]
+
+        required_keys.each { |key| raise RuntimeError, "Required key #{key} not found in instructions for #{environment} environment. Check #{config_file}" unless instructions.has_key? key }
+
+        deploy_role instructions unless check_only
+      end
+
+      puts check_only ? 'Deployment configuration check was successful' : 'Finished deployment'
+    end
+
+    def deploy_role instructions
+      servers = instructions[:servers]
+      puts "Deploying #{instructions[:name]} to #{servers.join(', ')} for the #{instructions[:role]} role in the #{instructions[:environment]} environment..." if servers.length > 1
+      servers.each { |server| deploy_to_server server, instructions }
+    end
+
+    def deploy_to_server server, instructions
+      name        = instructions[:name]
+      environment = instructions[:environment]
+      role        = instructions[:role]
+      path        = instructions[:path]
+      repository  = instructions[:repository]
+      user        = instructions[:user]
+
+      instructions[:server] = server
+
+      puts "Deploying #{name} to #{server} for the #{role} role in the #{environment} environment"
+
+      # Substitute variables in the path
+      path.sub! '%u', user
+      path.sub! '%a', name
+
+      # Find out which port we're currently running on
+      steps = [ { :command => 'mkdir -p .foreplay && touch .foreplay/current_port && cat .foreplay/current_port', :silent => true } ]
+
+      current_port = execute_on_server(steps, instructions).strip!
+      puts "Current instance is using port #{current_port}"
+
+      # Switch ports
+      if current_port == '50000'
+        current_port  = '51000'
+        former_port   = '50000'
+      else
+        current_port  = '50000'
+        former_port   = '51000'
+      end
+
+      # Contents of .foreman file
+      current_service = '%s-%s' % [name, current_port]
+      former_service  = '%s-%s' % [name, former_port]
+
+      instructions[:foreman]['app']   = current_service
+      instructions[:foreman]['port']  = current_port
+      instructions[:foreman]['user']  = user
+
+      # Commands to execute on remote server
+      steps = [
+        { :command      => "echo #{current_port} > .foreplay/current_port" },
+        { :command      => "mkdir -p #{path} && cd #{path} && rm -rf #{current_port} && git clone #{repository} #{current_port}",
+          :commentary   => "Cloning repository #{repository}" },
+        { :command      => "rvm rvmrc trust #{current_port}" },
+        { :command      => "cd #{current_port}" },
+        { :key          => :env,
+          :delimiter    => '=',
+          :prefix       => '.',
+          :commentary   => 'Building .env' },
+        { :key          => :foreman,
+          :delimiter    => ': ',
+          :prefix       => '.',
+          :commentary   => 'Building .foreman' },
+        { :key          => :database,
+          :delimiter    => ': ',
+          :suffix       => '.yml',
+          :commentary   => 'Building config/database.yml',
+          :before       => '  ',
+          :header       => "#{environment}:", 
+          :path         => 'config/' },
+        { :command      => "bundle install" },
+        { :command      => "sudo ln -f `which foreman` /usr/bin/foreman" },
+        { :command      => "sudo foreman export upstart /etc/init" },
+        { :command      => "sudo start #{current_service} || sudo restart #{current_service}",
+          :ignore_error => true },
+        { :command      => 'sleep 60',
+          :commentary   => 'Waiting 60s to give service time to start' },
+        { :command      => "sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{current_port.to_i + 100}",
+          :commentary   => "Adding firewall rule to direct incoming traffic on port 80 to port #{current_port}" },
+        { :command      => "sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{former_port.to_i + 100}",
+          :commentary   => "Removing previous firewall directing traffic to port #{former_port}",
+          :ignore_error => true },
+        { :command      => "sudo iptables -t nat -L | grep REDIRECT",
+          :ignore_error => true,
+          :commentary   => "Current firewall NAT configuration:" },
+        { :command      => "sudo stop #{former_service} || echo 'No previous instance running'",
+          :ignore_error => true },
+      ]
+
+      execute_on_server steps, instructions
+    end
+
+    def execute_on_server steps, instructions
+      server      = instructions[:server]
+      user        = instructions[:user]
+      password    = instructions[:password]
+      keyfile     = instructions[:keyfile]
+      key         = instructions[:key]
+
+      keyfile.sub! '~' , ENV['HOME'] # Remote shell won't expand this for us
+
+      # SSH authentication methods
+      options = { :verbose => :warn }
+
+      if password.blank?
+        # If there's no password we must supply a private key
+        if key.blank?
+          raise RuntimeError, "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
+          puts "Using private key from #{keyfile}"
+          key = File.read keyfile
+        else
+          puts "Using private key from the configuration file"
+        end
+
+        options[:key_data] = [key]
+      else
+        # Use the password supplied
+        options[:password] = password
+      end
+
+      # Capture output of last command to return to the calling routine
+      output = ''
+
+      # SSH connection
+      Net::SSH.start(server, user, options) do |ssh|
+        puts "Successfully connected to #{server}"
+
+        ssh.shell do |sh|
+          steps.each do |step|
+            # Output from this step
+            output    = ''
+            previous  = '' # We don't need or want the final CRLF
+
+            puts step[:commentary] || step[:command] unless step[:silent] == true
+
+            # Each step can be (1) a command or (2) a series of values to add to a file
+            if step.has_key? :key
+              step[:silent] = true
+
+              # Add values from the config file to a file on the remote machine
+              key       = step[:key]
+              prefix    = step[:prefix]     || ''
+              suffix    = step[:suffix]     || ''
+              path      = step[:path]       || ''
+              before    = step[:before]     || ''
+              delimiter = step[:delimiter]  || ''
+              after     = step[:after]      || ''
+
+              filename  = '%s%s%s%s' % [path, prefix, key, suffix]
+              commands  = step.has_key?(:header) ? ['echo "%s" >> %s' % [step[:header], filename]] : []
+
+              instructions[key].each { |k, v| commands << 'echo "%s%s%s%s%s" >> %s' % [before, k, delimiter, v, after, filename] }
+            else
+              # ...or just execute the command specified
+              commands = [step[:command]]
+            end
+
+            commands.each do |command|
+              process = sh.execute command
+
+              process.on_output do |p, o|
+                previous  = o
+                output    += previous
+              end
+
+              sh.wait!
+
+              if step[:ignore_error] == true || process.exit_status == 0
+                print "#{output}" unless step[:silent] == true
+              else
+                raise RuntimeError, output
+              end
+            end
+          end
+        end
+      end
+
+      output
+    end
+
+    # Returns a new hash with +hash+ and +other_hash+ merged recursively, including arrays.
+    #
+    #   h1 = { x: { y: [4,5,6] }, z: [7,8,9] }
+    #   h2 = { x: { y: [7,8,9] }, z: 'xyz' }
+    #   h1.deep_merge_with_arrays(h2)
+    #   #=> {:x=>{:y=>[4, 5, 6, 7, 8, 9]}, :z=>[7, 8, 9, "xyz"]}
+    def deep_merge_with_arrays(hash, other_hash)
+      new_hash = hash.deep_dup
+
+      other_hash.each_pair do |k,v|
+        tv = new_hash[k]
+
+        if tv.is_a?(Hash) && v.is_a?(Hash)
+          new_hash[k] = deep_merge_with_arrays(tv, v)
+        elsif tv.is_a?(Array) || v.is_a?(Array)
+          new_hash[k] = Array.wrap(tv) + Array.wrap(v)
+        else
+          new_hash[k] = v
+        end
+      end
+
+      new_hash
+    end
+  end
+end

data/lib/foreplay/cli.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'foreplay'
+require 'foreplay/generators/setup'
+
+module Foreplay
+  class CLI < Thor
+    desc 'check', 'Checks if configuration is OK'
+
+    method_option :environment, :aliases => "-e"
+    method_option :role,        :aliases => "-r"
+    method_option :server,      :aliases => "-s"
+
+    def check
+      puts Foreplay::Config.check options
+    end
+
+    desc 'setup', 'Create the Foreplay config file'
+
+    def setup
+      Foreplay::Generators::Setup.start
+    end
+  end
+end

data/lib/foreplay/config.rb

@@ -0,0 +1,25 @@
+require 'active_support/inflector'
+require 'colorize'
+require 'hashie/mash'
+
+module Foreplay
+  class Config
+    def self.check *args
+      options = Hashie::Mash[args.first]
+
+      # Explain what we're going to do
+      environments  = explanatory_text options.environment, 'environment'
+      roles         = explanatory_text options.role, 'role'
+      servers       = explanatory_text options.server, 'server'
+      puts 'Checking configuration for %s, %s, %s' % [environments, roles, servers]
+
+      'Not finished'
+    end
+
+    private
+
+    def self.explanatory_text(value, singular_word)
+      value.nil? ? "all #{singular_word.pluralize}" : "#{value.dup.yellow} #{singular_word}"
+    end
+  end
+end

data/lib/foreplay/generators/foreplay.yml

@@ -0,0 +1,85 @@
+# Format:
+#
+# There is a section for each environment that you will deploy to, plus a section that defines global default
+# values for all environments, like this:
+#
+# defaults:
+#   ...
+# production:
+#   ...
+# staging:
+#   ...
+#
+# Within each section you can define the server roles for that environment: web, worker, database etc. (the
+# names of these roles are up to you). You can also define environment-level defaults that apply to all roles.
+# Like this:
+#
+# production:
+#   defaults:
+#     ...
+#   web:
+#     ...
+#   worker:
+#     ...
+#   scheduler:
+#     ...
+#   database:
+#     ...
+# staging:
+#   defaults:
+#     ...
+#   web:
+#     ...
+#   worker:
+#     ...
+#   scheduler:
+#     ...
+#   database:
+#     ...
+#
+# Within each role section you can define how the deployment is configured for the servers in that role.
+# Some of these values will normally be defined as a default, some will be specific to a particular role.
+# The values you can configure are as follows:
+#
+# value         Normally defined as  Notes
+# ------------- -------------------- -------------------------------------------------------------------
+# name:         Global default       App name (if omitted then
+#                                    Rails.application.class.parent_name.underscore is used)
+# user:         Global default       The username to connect with (must have SSH permissions)
+# password:     Global default       The password to use to connect (not necessary if you've set up SSH
+#                                    keys - see below)
+# keyfile:      Global default       A file containing a private key that allows the named user access
+#                                    to the server, or...
+# key:          Global default       A private key that allows the named user access to the server
+# path:         Global default       An absolute path to deploy the app on each server. %a will be
+#                                    translated to the application name. %u will be translated to the
+#                                    login user name
+# database:     Environment default  The database.yml elements to write to the config folder
+#   key: value
+# servers: [server1, server2, server3]
+#               Role level           Which servers to deploy the app on
+# env:          Role level           Contents of the .env file
+#   key: value                       Values will go into the .env file as key=value
+# foreman:      Role level           Contents of the .foreman file
+#   key: value
+#
+defaults:
+  name: <%= @name %>
+  repository: %q{TODO: Add the git repository path}
+  user: %q{TODO: Add the user to logon to the deployment server}
+  password: %q{TODO: Add the password for the user on the deployment server}
+  path: %q{TODO: Add the path to deploy to on the deployment server}
+production:
+  defaults:
+    database:
+      adapter: postgresql
+      encoding: utf8
+      database: %q{TODO: Add the database name}
+      pool: 5
+      host: %q{TODO: Add the database host name}
+      username: %q{TODO: Add the database user}
+      password: %q{TODO: Add the database user's password}
+  web:
+    servers: [%q{TODO: Add the name of the production web server}]
+    foreman:
+      concurrency: 'web=1,worker=0,scheduler=0'

data/lib/foreplay/generators/setup.rb

@@ -0,0 +1,20 @@
+require 'thor/group'
+
+module Foreplay
+  module Generators
+    class Setup < Thor::Group
+      include Thor::Actions
+
+      Rails ||= nil
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      def create_config_file
+        @name = Rails.nil? ? '%q{TODO: Add the app name}' : Rails.application.class.parent_name.underscore
+        template('foreplay.yml', 'config/foreplay.yml')
+      end
+    end
+  end
+end

data/lib/foreplay/version.rb

@@ -0,0 +1,3 @@
+module Foreplay
+  VERSION = "0.0.1"
+end

data/lib/foreplay.rb

@@ -0,0 +1,6 @@
+require "foreplay/version"
+require "foreplay/config"
+
+module Foreplay
+  # Your code goes here...
+end

data/spec/foreplay_spec.rb

@@ -0,0 +1,7 @@
+require 'foreplay'
+
+describe Foreplay::Config do
+	it "should check the config" do
+		Foreplay::Config.check.should eql('OK')
+	end
+end

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: foreplay
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Xenapto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-shell
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deploying Rails projects to Ubuntu using Foreman
+email:
+- developers@xenapto.com
+executables:
+- foreplay
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/foreplay
+- features/config.feature
+- features/generator.feature
+- features/support/setup.rb
+- foreplay.gemspec
+- foreplay.rake
+- foreplay.rb
+- lib/foreplay.rb
+- lib/foreplay/cli.rb
+- lib/foreplay/config.rb
+- lib/foreplay/generators/foreplay.yml
+- lib/foreplay/generators/setup.rb
+- lib/foreplay/version.rb
+- spec/foreplay_spec.rb
+homepage: https://github.com/Xenapto/foreplay
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -929256133810576486
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -929256133810576486
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! 'Example: foreplay push to production'
+test_files:
+- features/config.feature
+- features/generator.feature
+- features/support/setup.rb
+- spec/foreplay_spec.rb