screwcap 0.1

data/Gemfile

@@ -0,0 +1,14 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem "net-ssh"
+gem "net-scp"
+gem "net-ssh-gateway"
+
+group :development do
+  gem 'hoe'
+  gem 'newgem'
+  gem 'ruby-debug'
+  gem 'mocha'
+  gem 'rspec', '1.3.1'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activesupport (2.3.9)
+    columnize (0.3.1)
+    hoe (2.6.2)
+      rake (>= 0.8.7)
+      rubyforge (>= 2.0.4)
+    json_pure (1.4.6)
+    linecache (0.43)
+    mocha (0.9.8)
+      rake
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.0.23)
+    net-ssh-gateway (1.0.1)
+      net-ssh (>= 1.99.1)
+    newgem (1.5.3)
+      RedCloth (>= 4.1.1)
+      activesupport (~> 2.3.4)
+      hoe (>= 2.4.0)
+      rubigen (>= 1.5.3)
+      syntax (>= 1.0.0)
+    rake (0.8.7)
+    rspec (1.3.1)
+    rubigen (1.5.5)
+      activesupport (~> 2.3.5)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    syntax (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hoe
+  mocha
+  net-scp
+  net-ssh
+  net-ssh-gateway
+  newgem
+  rspec (= 1.3.1)
+  ruby-debug

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-10-17
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,37 @@
+Gemfile
+Gemfile.lock
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/screwcap
+lib/exts.rb
+lib/screwcap.rb
+lib/screwcap/base.rb
+lib/screwcap/command_set.rb
+lib/screwcap/deployer.rb
+lib/screwcap/sequence.rb
+lib/screwcap/server.rb
+lib/screwcap/task.rb
+lib/trollop.rb
+screwcap.gemspec
+spec/command_set_spec.rb
+spec/deployer_spec.rb
+spec/sequence_spec.rb
+spec/server_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/task_spec.rb
+tasks/rspec.rake
+test/config/command_sets.rb
+test/config/expect.rb
+test/config/gateway.rb
+test/config/no_server.rb
+test/config/rails_tasks.rb
+test/config/simple_recipe.rb
+test/config/undefined_command_set.rb
+test/config/undefined_item.rb
+test/config/undefined_server.rb
+test/config/unknown_use.rb
+test/config/use.rb
+test/test_command_set.rb

data/README.rdoc

@@ -0,0 +1,50 @@
+= screwcap
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+Screwcap is a library that wraps Net::SSH and makes it easy to perform actions on remote servers.  It's not smart and does not make any assumptions about your setup.  
+
+The most obvious task you could use screwcap for is deploying rails applications to remote servers.
+
+== FEATURES/PROBLEMS:
+
+* Screwcap is currently not ready for production use as it is under active development.
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* gem install screwcap
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Grant Ammons
+
+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/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/screwcap'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'screwcap' do
+  self.version  = '0.1'
+  self.developer 'Grant Ammons', 'grant@pipelinedeals.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['net-ssh','>= 2.0.23'],['net-ssh-gateway','>=1.0.1']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+remove_task :default
+task :default => :spec

data/bin/screwcap

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/screwcap')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/trollop')
+
+
+p = Trollop::Parser.new do
+  opt :silent, "Be silent"
+  opt :nocolor, "Do not color output"
+  opt :debug, "Turn on debugger.  Will print full stacktrace if an exeception was raised"
+  opt :help, "Show this message"
+  banner <<-EOF 
+
+    Usage: screwcap [options] file task_name [[task_name2], [task_name3], ...]
+    Example: screwcap config/deploy.rb deploy_to_staging
+  EOF
+end
+
+opts = Trollop::with_standard_exception_handling p do
+  opts = p.parse ARGV
+  if opts[:debug] == true
+    require 'ruby-debug'
+    Debugger.start
+  end
+  raise Trollop::HelpNeeded if ARGV.size < 2
+  recipe_file = ARGV.shift
+  begin
+    Deployer.new(opts.merge(:recipe_file => recipe_file)).run! ARGV.map {|a| a.to_sym }
+  rescue Exception => e
+    raise e if opts[:debug] == true
+    $stderr << e
+    $stderr << "\n"
+  end
+end

data/lib/exts.rb

@@ -0,0 +1,11 @@
+class Array
+  def blank?
+    self.nil? || self.size == 0
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end

data/lib/screwcap.rb

@@ -0,0 +1,29 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'net/ssh'
+require 'net/scp'
+require 'net/ssh/gateway'
+require 'ostruct'
+require 'logger'
+
+require 'exts'
+require 'screwcap/base'
+require 'screwcap/command_set'
+require 'screwcap/task'
+require 'screwcap/server'
+require 'screwcap/sequence'
+require 'screwcap/deployer'
+
+module Screwcap
+  VERSION='0.1'
+
+  class TaskNotFound < RuntimeError; end
+  class NoServersDefined < Exception; end
+  class NoServerSelected < Exception; end
+  class ConfigurationError < Exception; end
+  class IncludeFileNotFound < Exception; end
+  class InvalidServer < Exception; end
+  class CommandSetDependencyError < Exception; end
+end
+

data/lib/screwcap/base.rb

@@ -0,0 +1,56 @@
+module Screwcap
+  class Base < OpenStruct
+
+    # for debugging purposes only
+    #def method_missing(m, *args, &block)
+    #  $stdout << "For #{self.class.to_s}: calling #{m}\n"
+    #  super(m, args.first)
+    #end
+
+    def set(var, *args)
+      method_missing((var.to_s + "=").to_sym, args.first)
+    end
+
+    def log(msg, options = {})
+      $stdout << msg unless self.__options[:silent] == true
+    end
+
+    def errorlog(msg)
+      $stderr << msg unless self.__options[:silent] == true
+    end
+
+    def bluebold(msg, options = {:clear => true})
+      if self.__options[:nocolor] == true
+        msg
+      else
+        "\033[1;36m#{msg}#{"\033[0m" if options[:clear]}"
+      end
+    end
+
+    def blue(msg, options = {:clear => true})
+      if self.__options[:nocolor] == true
+        msg
+      else
+        "\033[0;36m#{msg}#{"\033[0m" if options[:clear]}"
+      end
+    end
+
+
+    def red(msg)
+      if self.__options[:nocolor] == true
+        msg
+      else
+        "\033[0;31m#{msg}\033[0m"
+      end
+    end
+
+    def green(msg)
+      if self.__options[:nocolor] == true
+        msg
+      else
+        "\033[0;32m#{msg}\033[0m"
+      end
+    end
+
+  end
+end

data/lib/screwcap/command_set.rb

@@ -0,0 +1,56 @@
+class CommandSet < Screwcap::Base
+  def initialize(opts = {}, &block)
+    super
+    self.__name = opts[:name]
+    self.__options = opts
+    self.__commands = []
+    self.__command_sets = []
+    self.__block = block
+  end
+
+  # run a command. basically just pass it a string containing the command you want to run.
+  def run arg, options = {}
+    if arg.class == Symbol
+      self.__commands << {:command => self.send(arg), :type => :remote}
+    else
+      self.__commands << {:command => arg, :type => :remote}
+    end
+  end
+
+  # run a command. basically just pass it a string containing the command you want to run.
+  def local arg, options = {}
+    if arg.class == Symbol
+      self.__commands << {:command => self.send(arg), :type => :local}
+    else
+      self.__commands << {:command => arg, :type => :local}
+    end
+  end
+
+
+  protected
+
+  def method_missing(m, *args)
+    if m.to_s[0..1] == "__" or [:run].include?(m) or m.to_s.reverse[0..0] == "="
+      super(m, args.first) 
+    else
+      if cs = self.__command_sets.find {|cs| cs.name == m }
+        # eval what is in the block
+        clone_table_for(cs)
+        cs.__commands = []
+        cs.instance_eval(&cs.__block)
+        self.__commands += cs.__commands
+      else
+        raise NoMethodError, "Undefined method '#{m.to_s}' for Command Set :#{self.name.to_s}"
+      end
+    end
+  end
+
+  private
+
+  def clone_table_for(object)
+    self.table.each do |k,v|
+      object.set(k, v) unless [:__command_sets, :name, :__commands, :__options, :__block].include?(k)
+    end
+  end
+
+end

data/lib/screwcap/deployer.rb

@@ -0,0 +1,104 @@
+# The deployer is the class that holds the overall params from the screwcap tasks file, and it is also in charge of running the requested task.
+#
+# The deployer can be thought of as the "global scope" of your tasks file.
+class Deployer < Screwcap::Base
+
+  # create a new deployer.
+  def initialize(opts = {})
+    opts = {:recipe_file => File.expand_path("./config/recipe.rb")}.merge opts
+    super
+    self.__options = opts
+    self.__tasks = []
+    self.__servers = []
+    self.__command_sets = []
+    self.__sequences = []
+
+    # ensure that deployer options will not be passed to tasks
+    opts.each_key {|k| self.delete_field(k) }
+
+    log "Reading #{self.__options[:recipe_file]}\n" unless self.__options[:silent] == true
+
+    file = File.open(File.expand_path("./#{self.__options[:recipe_file]}"))
+    data = file.read
+
+    instance_eval(data)
+  end
+
+
+  # create a task.  Minimally, a task needs a :server specified to run the task on.
+  def task_for name, options = {}, &block
+    t = Task.new(options.merge(:name => name, :nocolor => self.__options[:nocolor], :silent => self.__options[:silent], :deployment_servers => self.__servers), &block)
+    clone_table_for(t)
+    t.instance_eval(&block)
+    self.__tasks << t
+  end
+
+  def command_set(name,options = {},&block)
+    t = CommandSet.new(options.merge(:name => name), &block)
+    clone_table_for(t)
+    self.__command_sets << t
+  end
+
+  def server(name, options = {}, &block)
+    server = Server.new(options.merge(:name => name, :servers => self.__servers, :silent => self.__options[:silent]))
+    self.__servers << server
+  end
+
+  def gateway(name, options = {}, &block)
+    server = Server.new(options.merge(:name => name, :is_gateway => true))
+    self.__servers << server
+  end
+
+  def sequence(name, options = {}, &block)
+    self.__sequences << Sequence.new(options.merge(:name => name, :deployment_task_names => self.__tasks.map(&:name)))
+  end
+
+
+  def run!(*tasks)
+    tasks.flatten!
+    # sanity check each task
+
+    tasks_and_sequences = (self.__sequences.map(&:__name) + self.__tasks.map(&:__name))
+    tasks.each do |task_to_run|
+      raise(Screwcap::TaskNotFound, "Could not find task or sequence '#{task_to_run}' in recipe file #{self.__options[:recipe_file]}") unless tasks_and_sequences.include? task_to_run
+    end
+
+    tasks.each do |t| 
+      sequence = self.__sequences.find {|s| s.__name == t }
+      if sequence
+        sequence.__task_names.each {|task_name| self.__tasks.find {|task| task.__name == task_name }.execute!}
+      else
+        self.__tasks.select {|task| task.name.to_s == t.to_s }.first.execute! 
+      end
+    end
+    $stdout << "\033[0m"
+  end
+
+  # dynamically include another file into an existing configuration file.
+  # by default, it looks for the include file in the same path as your tasks file you specified.
+  def use arg
+    if arg.is_a? Symbol
+      begin
+        dirname = File.dirname(self.__options[:recipe_file])
+        instance_eval(File.open(File.dirname(File.expand_path(self.__options[:recipe_file])) + "/" + arg.to_s + ".rb").read)
+      rescue Errno::ENOENT => e
+        raise Screwcap::IncludeFileNotFound, "Could not find #{File.expand_path("./"+arg.to_s + ".rb")}! If the file is elsewhere, call it by using 'use '/path/to/file.rb'"
+      end
+    else
+      begin
+        instance_eval(File.open(File.dirname(File.expand_path(self.__options[:recipe_file])) + "/" + arg).read)
+      rescue Errno::ENOENT => e
+        raise Screwcap::IncludeFileNotFound, "Could not find #{File.expand_path(arg)}! If the file is elsewhere, call it by using 'use '/path/to/file.rb'"
+      end
+    end
+  end
+
+
+  private
+
+  def clone_table_for(object)
+    self.table.each do |k,v|
+      object.set(k, v) unless [:__options, :__tasks, :__servers].include?(k)
+    end
+  end
+end