necktie 0.3.5 → 1.0.0

data/README.rdoc

@@ -20,6 +20,10 @@ I use it to:
 - Setup MySQL to use a mounted (EBS) volume
 - Install and update cron scripts
 
+To install Necktie:
+
+  $ gem install necktie --source http://gemcutter.org
+
 
 == Tasking
 
@@ -75,20 +79,19 @@ only runs once, before that directory exists.
 
 == cap necktie
 
-I use Capistrano to setup new instances and upgrade existing ones.  I then run
-deploy:cold on the new instances, or deploy to upgrade running instances.
+I use Capistrano to setup new instances and upgrade existing ones.
 
-To use the necktie task set the necktie_url variable and require
-necktie/capistrano:
+To use the Necktie task, set the necktie_url variable to the URL of your
+Necktie repository, and require necktie/capistrano. For example:
 
   require "necktie/capistrano"
   set :necktie_url, "git@example.com:mysetup"
 
-To setup a new server:
+Setting up a new EC2 instance:
 
   cap necktie ROLES=app HOSTS=ec2-75-101-239-12.compute-1.amazonaws.com
 
-To upgrade running instances:
+Upgrading running instances with new configuration:
 
   git push && cap necktie
 
@@ -111,9 +114,9 @@ also:
   chmod 0755, "/etc/init.d/unicorn"
   sh "service start unicorn"
 
-Note: The current directory (Dir.pwd and launch_dir) is the root directory of
-your Necktie repository. You can depend on relative paths when accessing files
-in your Necktie repository.
+The current directory (Dir.pwd and launch_dir) is the root directory of your
+Necktie repository. You can depend on relative paths when accessing files in
+your Necktie repository.
 
 
 == Role play
@@ -137,6 +140,9 @@ the default task instead of setting ROLES each time. In your Necktie file add:
 
   task :default=>:app
 
+You may also want to take advantage of different environments, customizing your
+setup differently between production, staging, etc.
+
 Note: As with Rake, command line arguments are either options (see necktie -H),
 task names (executed in order), or name=value pairs that set environment
 variables (e.g. RAILS_ENV=production).
@@ -166,14 +172,14 @@ rubygems.rb task is all you need:
 
 == One on one
 
-If you need to run Necktie interactively, use the necktie command. The first
-time you run Necktie, it clones the Git repository into the .necktie directory
-in your home directory. You'll need to give it the Git URL, for example:
+You can also run Necktie from the command line directly on the server you're
+configuring.  The first time you run Necktie, it clones the Git repository into
+the ~/.necktie directory. You'll need to give it the Git URL, like this:
 
-  necktie GIT_URL=git@example.com:mysetup app
+  necktie --source git@example.com:mysetup app
 
 Subsequent runs use that repository. You can launch the necktie command from
-anywhere, it will always switch to the .necktie directory, run the tasks and
+anywhere, it will always switch to the ~/.necktie directory, run the tasks and
 switch back to the previous working directory.
 
 If you want to pull changes from the Git repository, use the -U option:

data/bin/necktie

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__)),
-  File.expand_path("../vendor/rake/lib", File.dirname(__FILE__)), File.expand_path("../vendor/rush/lib", File.dirname(__FILE__)),
+  File.expand_path("../vendor/rake/lib", File.dirname(__FILE__)),
+  File.expand_path("../vendor/rush/lib", File.dirname(__FILE__)),
   File.expand_path("../vendor/session/lib", File.dirname(__FILE__))
 require "necktie"
 
+# Mystery revealed: Necktie is really just a shell on top of Rake!
 Rake.application = Necktie::Application.new
 Rake.application.run

data/example/Necktie

@@ -0,0 +1,12 @@
+#!ruby
+@hostname = "example.com"
+@git_url = "git@example.com:myapp"
+@deploy_to = "/var/myapp"
+
+task :environment do
+  profile = File.expand_path("~/.bash_profile")
+  append profile, "\nexport RAILS_ENV=#{Necktie.env}\n" unless read(profile)["export RAILS_ENV"]
+  # Change command line prompt for production (LIVE in red) and and staging (STAGE in blue).
+  ps = Necktie.env == "staging" ? "\\e[0;34mSTAGE\\e[m \\w $ " : "\\e[0;31mLIVE\\e[m \\w $ " 
+  append profile, "PS1=\"#{ps}\"\n" unless read(profile)["PS1=\"#{ps}\""]
+end

data/example/etc/cron/snapshot

@@ -0,0 +1,46 @@
+#! /usr/bin/env ruby
+require "mysql"
+require "time"
+require "date"
+
+# NOTE: Change these to match your setup!
+ENV["EC2_PRIVATE_KEY"] = "/mnt/keys/pk-....pem"
+ENV["EC2_CERT"] = "/mnt/keys/cert-....pem"
+ENV["JAVA_HOME"] = "/usr/lib/jvm/java-6-openjdk"
+DB_USER = "root"
+DB_PASSWORD = "..."
+MOUNT = "/vol"
+
+instance = `curl -s http://instance-data.ec2.internal/latest/meta-data/instance-id`
+volume = `ec2-describe-volumes`[/ATTACHMENT\t(.*)\t#{instance}\t/, 1]
+
+c = Mysql.new("localhost", DB_USER, DB_PASSWORD) 
+c.query "FLUSH LOCAL TABLES"
+c.query "FLUSH TABLES WITH READ LOCK"
+c.query "SHOW MASTER STATUS"
+system "sync"
+system "xfs_freeze -f #{MOUNT}"
+system "ec2-create-snapshot #{volume} | logger -t snapshot" rescue nil
+system "xfs_freeze -u #{MOUNT}"
+c.query "UNLOCK TABLES"
+c.close
+
+
+# Snaps is an array of [snapshot-id, time]
+snaps = `ec2-describe-snapshots`.scan(/(snap-.*)\t#{volume}\tcompleted\t(.*)\t/).map { |(id, time)| [id, Time.parse(time)] }
+now = Time.now
+today = now.to_date
+hr24 = (now - 86400)
+# Keep all snaps from past 24 hours
+snaps.delete_if { |s| s.last >= hr24 }
+# Keep only one from each day
+dated = snaps.group_by { |s| s.last.to_date }
+# Keep every day's snapshot from the last week. (We start with today, which is already excluded, so iterate 8 days total)
+today.downto(today - 7).each do |date|
+  dated[date].delete dated[date].sort_by(&:last).last if dated[date]
+end
+# Map to list of snaps
+deleting = dated.inject([]) { |a,(k,v)| a<<v.map(&:first) }.flatten
+deleting.each do |snap|
+  `ec2-delete-snapshot #{snap} > /dev/null`
+end

data/example/etc/init.d/unicorn

@@ -0,0 +1,53 @@
+#!/bin/sh
+set -u
+set -e
+# Example init script, this can be used with nginx, too,
+# since nginx and unicorn accept the same signals
+ 
+# Feel free to change any of the following variables for your app:
+APP_ROOT=/var/myapp/current
+PID=$APP_ROOT/tmp/pids/unicorn.pid
+ENV=production
+CMD="/usr/local/bin/unicorn_rails -D -E $ENV -c config/unicorn.rb"
+ 
+old_pid="$PID.oldbin"
+ 
+cd $APP_ROOT || exit 1
+ 
+sig () {
+	test -s "$PID" && kill -$1 `cat $PID`
+}
+ 
+oldsig () {
+	test -s $old_pid && kill -$1 `cat $old_pid`
+}
+ 
+case $1 in
+start)
+	sig 0 && echo >&2 "Already running" && exit 0
+	$CMD
+	;;
+stop)
+	sig QUIT && exit 0
+	echo >&2 "Not running"
+	;;
+force-stop)
+	sig TERM && exit 0
+	echo >&2 "Not running"
+	;;
+restart|reload)
+	sig HUP && echo reloaded OK && exit 0
+	echo >&2 "Couldn't reload, starting '$CMD' instead"
+	$CMD
+	;;
+upgrade)
+	sig USR2 && sleep 2 && sig 0 && oldsig QUIT && exit 0
+	echo >&2 "Couldn't upgrade, starting '$CMD' instead"
+	$CMD
+	;;
+*)
+	echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop>"
+	exit 1
+	;;
+esac
+

data/example/etc/nginx/unicorn.conf

@@ -0,0 +1,51 @@
+upstream unicorn {
+  server unix:/var/myapp/current/tmp/sockets/unicorn.sock;
+} 
+
+server {
+  listen 0.0.0.0:80;
+  server_name  _;
+
+  access_log  /var/log/nginx/localhost.access.log;
+
+  location / {
+    root /var/myapp/current/public/;
+    if (-f $request_filename) {
+      expires 4h;
+      break;        # Static asset
+    } if (-f $document_root/system/maintenance.html) {
+      return 503;   # Temporarily unavailable
+    } if (!-f $document_root/system/maintenance.html) {
+      error_page 500 501 502 503 504 /500.html;
+      proxy_pass              http://unicorn;
+    }
+
+    proxy_set_header        Host $host;       
+    proxy_set_header        X-Real-IP       $remote_addr;
+    proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
+    client_max_body_size    10m;
+    client_body_buffer_size 128k;
+    proxy_connect_timeout   90;
+    proxy_send_timeout      90;
+    proxy_read_timeout      90;
+    proxy_buffer_size       16k;
+    proxy_buffers           32 16k;
+    proxy_busy_buffers_size 64k;
+    
+    error_page 503 /system/maintenance.html;
+    location /system/maintenance.html {
+      error_page 405 /system/maintenance.html;
+      rewrite ^ /system/maintenance.html break;
+    }
+  }
+
+  # output compression saves bandwidth 
+  gzip              on;
+  gzip_http_version 1.0;
+  gzip_comp_level   2;
+  gzip_proxied      any;
+  gzip_types        text/plain text/html text/css text/xml application/x-javascript application/atom+xml;
+
+}
+
+

data/example/tasks/app.rb

@@ -0,0 +1,49 @@
+task :rubygems do
+  # These gems are needed in the enviroment (i.e not bundled with your Rails app).
+  # For example: unicorn, rake, mysql, starling. To install a new gem or upgrade
+  # existing one:
+  #   $ cp /opt/local/lib/ruby/gems/1.9.1/cache/unicorn-0.93.3.gem gems/
+  #   $ git add gems
+  #   $ git commit -m "Added Unicorn gem"
+  #   $ git push && cap necktie
+  Dir["gems/*.gem"].each do |gem|
+    install_gem gem
+  end
+end
+
+task :memcached do
+  # Out of the box, memcached listens to local requests only. We want all servers
+  # in the same security group to access each other's memcached.
+  unless processes.find { |p| p.cmdline[/memcached\s.*-l\s0.0.0.0/] }
+    update "/etc/memcached.conf", /^-l 127.0.0.1/, "-l 0.0.0.0"
+    services.start "memcached"
+  end
+end
+
+task :unicorn=>[:rubygems, "#{@deploy_to}/current"] do
+  # Install init.d script to manage Unicorn, before we can start it.
+  cp "etc/init.d/unicorn", "/etc/init.d/"
+  chmod 0755, "/etc/init.d/unicorn"
+  services.start "unicorn"
+end
+
+task :nginx=>:unicorn do
+  # We only care about one Nginx configuration, so enable it and disable all others.
+  unless services.running?("nginx")
+    rm_rf Dir["/etc/nginx/sites-enabled/*"]
+    cp "etc/nginx/unicorn.conf", "/etc/nginx/sites-available/"
+    ln_sf "/etc/nginx/sites-available/unicorn.conf", "/etc/nginx/sites-enabled/"
+    services.start "nginx"
+  end
+end
+
+task :email do
+  # Have postfix send emails on behalf of our host, and start it. 
+  unless services.running?("postfix")
+    update "/etc/postfix/main.cf", /^myhostname\s*=.*$/, "myhostname = #{@hostname}"
+    write "/etc/mailname", @hostname
+    services.start "postfix"
+  end
+end
+
+task :app=>[:environment, :memcached, :nginx, :email]

data/example/tasks/current.rb

@@ -0,0 +1,49 @@
+user, group = "nginx", "nginx"
+
+shared_path = "#{@deploy_to}/shared"
+cached_copy = "#{shared_path}/cached-copy"
+releases_path = "#{@deploy_to}/releases"
+release = Time.now.utc.strftime("%Y%m%d%H%M%S")
+release_path = "#{releases_path}/#{release}"
+current_path = "#{@deploy_to}/current"
+
+file @deploy_to do
+  mkdir_p @deploy_to
+  chown user, group, @deploy_to
+  chmod 0770, @deploy_to
+end
+
+file shared_path=>@deploy_to do
+  mkdir_p ["#{shared_path}/system", "#{shared_path}/pids", "#{shared_path}/log"]
+  chown_R user, group, shared_path
+  chmod_R 0770, shared_path
+end
+
+file releases_path=>@deploy_to do
+  mkdir_p releases_path
+  chown user, group, releases_path
+  chmod 0770, releases_path
+end
+
+file cached_copy=>shared_path do
+  sh "git clone #{@git_url} #{cached_copy}"
+  chown_R user, group, cached_copy
+end
+
+file release_path=>[releases_path, cached_copy] do
+  cp_r cached_copy, release_path
+  revision = bash("git --git-dir=#{cached_copy}/.git rev-parse --verify HEAD")
+  write "#{release_path}/REVISION", revision
+  touch release_path
+  sh "chmod -R g+w #{release_path}"
+  rm_rf ["#{release_path}/log", "#{release_path}/public/system", "#{release_path}/tmp/pids"]
+  mkdir_p ["#{release_path}/public", "#{release_path}/tmp"]
+  ln_s "#{shared_path}/log", "#{release_path}/log"
+  ln_s "#{shared_path}/system", "#{release_path}/public/system"
+  ln_s "#{shared_path}/pids", "#{release_path}/tmp/pids"
+end
+
+file current_path=>[release_path, shared_path] do
+  rm_f current_path
+  ln_s release_path, current_path
+end

data/example/tasks/db.rb

@@ -0,0 +1,30 @@
+task "/etc/cron/snapshot" do
+  cp "etc/cron/snapshot", "/etc/cron.hourly/"
+  chmod 0755, "/etc/cron/snapshot"
+end
+
+task "/vol" do
+  # Assumes we attach EBS volume to /dev/sdh, formatted it to XFS, mounted to /vol.
+  append "/etc/fstab", "/dev/sdh /vol xfs noatime,nobarrier 0 0\n" unless read("/etc/fstab")["/dev/sdh "]
+  sh "mount /vol"
+end
+
+task "/etc/mysql"=>"/vol" do
+  # Mount the respective MySQL directories. Make sure they exist on your EBS volume first, see:
+  # http://developer.amazonwebservices.com/connect/entry.jspa?externalID=1663
+  mounts = { "/vol/etc/mysql"=>"/etc/mysql",
+             "/vol/lib/mysql"=>"/var/lib/mysql",
+             "/vol/log/mysql"=>"/var/log/mysql" }
+  mounts.each do |vol, path|
+    mkdir_p path
+    append "/etc/fstab", "#{vol} #{path} none bind\n" unless read("/etc/fstab")["#{vol} "]
+    sh "mount #{path}"
+  end
+  chmod 0755, "/etc/mysql/debian-start"
+end
+
+task "mysql"=>"/etc/mysql" do
+  services.start "mysql" unless services.running?("mysql")
+end
+
+task :db=>[:environment, :mysql, "/etc/cron/snapshot"]

data/lib/necktie/{rake.rb → application.rb}

@@ -13,17 +13,18 @@ module Necktie
 
     def run
       standard_exception_handling do
-        init
-        repo = File.expand_path(".necktie")
+        init "necktie"
+        puts "(#{options.env})"
+        repo = File.expand_path("~/.necktie")
         if File.exist?(repo)
           Dir.chdir repo do
-            puts "Pulling latest updates ..."
+            puts "Pulling latest updates to #{repo} ..."
             sh "git pull origin #{ENV["BRANCH"] || "master"}", :verbose=>false
           end if options.pull
         else
-          git_url = ENV["GIT_URL"] or fail "Need GIT_URL variable to point to Git repository, can't clone without it"
-          puts "Cloning #{git_url} to #{repo}"
-          sh "git clone #{git_url} #{repo.inspect}", :verbose=>false
+          options.git_url or fail "Need to set Git URL: use --source command line option"
+          puts "Cloning #{options.git_url} to #{repo}"
+          sh "git clone #{options.git_url} #{repo.inspect}", :verbose=>false
         end
         Dir.chdir repo do
           load_rakefile
@@ -34,11 +35,27 @@ module Necktie
 
     def necktie_options
       [
-        ['--env', '-e [NAME]', "Sets the environment (defaults to 'production').",
+        ['--env', '-e NAME', "Sets the environment (defaults to 'production').",
           lambda { |value|
             options.env = value
           }
         ],
+        ['--source', '-S GIT_URL', "Git URL to your Necktie repository",
+          lambda { |value| options.git_url = value }
+        ],
+        ['--update', '-U', "Update .necktie directory (git pull)",
+          lambda { |value| options.pull = true }
+        ],
+        ['--tasks', '-T [PATTERN]', "Display the tasks (matching optional PATTERN) with descriptions, then exit.",
+          lambda { |value|
+            options.show_tasks = :tasks
+            options.show_task_pattern = Regexp.new(value || '')
+            Rake::TaskManager.record_task_metadata = true
+          }
+        ],
+        ['--prereqs', '-P', "Display the tasks and dependencies, then exit.",
+          lambda { |value| options.show_prereqs = true }
+        ],
         ['--describe', '-D [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
           lambda { |value|
             options.show_tasks = :describe
@@ -46,6 +63,13 @@ module Necktie
             TaskManager.record_task_metadata = true
           }
         ],
+        ['--where', '-W [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
+          lambda { |value|
+            options.show_tasks = :lines
+            options.show_task_pattern = Regexp.new(value || '')
+            Rake::TaskManager.record_task_metadata = true
+          }
+        ],
         ['--execute-print',  '-p CODE', "Execute some Ruby code, print the result, then exit.",
           lambda { |value|
             puts eval(value)
@@ -56,16 +80,6 @@ module Necktie
           "Execute some Ruby code, then continue with normal task processing.",
           lambda { |value| eval(value) }            
         ],
-        ['--prereqs', '-P', "Display the tasks and dependencies, then exit.",
-          lambda { |value| options.show_prereqs = true }
-        ],
-        ['--tasks', '-T [PATTERN]', "Display the tasks (matching optional PATTERN) with descriptions, then exit.",
-          lambda { |value|
-            options.show_tasks = :tasks
-            options.show_task_pattern = Regexp.new(value || '')
-            Rake::TaskManager.record_task_metadata = true
-          }
-        ],
         ['--trace', '-t', "Turn on invoke/execute tracing, enable full backtrace.",
           lambda { |value|
             options.trace = true
@@ -82,26 +96,16 @@ module Necktie
             exit
           }
         ],
-        ['--where', '-W [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
-          lambda { |value|
-            options.show_tasks = :lines
-            options.show_task_pattern = Regexp.new(value || '')
-            Rake::TaskManager.record_task_metadata = true
-          }
-        ],
-        ['--update', '-U', "Update .necktie directory (git pull)",
-          lambda { |value| options.pull = true }
-        ]
       ]
     end
 
     # Read and handle the command line options.
     def handle_options
-      options.rakelib = ['necktie']
+      options.rakelib = ['tasks']
       options.top_level_dsl = true
 
       OptionParser.new do |opts|
-        opts.banner = "necktie git_url {options} tasks..."
+        opts.banner = "necktie {options} tasks..."
         opts.separator ""
         opts.separator "Options are ..."
 
@@ -111,7 +115,6 @@ module Necktie
         end
 
         necktie_options.each { |args| opts.on(*args) }
-        opts.environment('RAKEOPT')
       end.parse!
 
       Rake::DSL.include_in_top_scope
@@ -122,7 +125,7 @@ module Necktie
       fail "No Necktie file found (looking for: #{@rakefiles.join(', ')})" if @rakefile.nil?
       Rake::Environment.load_rakefile(File.expand_path(@rakefile)) if @rakefile && @rakefile != ''
       options.rakelib.each do |rlib|
-        glob("necktie/*.rb") do |name|
+        glob("#{rlib}/*.rb") do |name|
           add_import name
         end
       end

data/lib/necktie/capistrano.rb

@@ -7,7 +7,7 @@ Capistrano::Configuration.instance.load do
     gem_file = File.join(Gem.dir, "cache", gem_spec.file_name)
     upload gem_file, File.basename(gem_file), :via=>:scp
     sudo "gem install #{File.basename(gem_file)}"
-    roles = ENV["ROLES"].to_s.gsub(',', ' ') # roles => task names
-    sudo "necktie GIT_URL=#{necktie_url} -U #{roles} -e #{fetch(:rails_env, "production")}"
+    tasks = ENV["ROLES"].to_s.split(",") # ROLES => task names
+    sudo "necktie --source #{necktie_url} --update --environment #{fetch(:rails_env, "production")} #{task.join(" ")}"
   end
 end

data/lib/necktie/files.rb

@@ -1,7 +1,12 @@
+# Return the contents of the file (same as File.read).
 def read(name)
   File.read(name)
 end
 
+# Writes contents to a new file, or overwrites existing file.
+# Takes string as second argument, or yields to block. For example:
+#   write "/etc/mailname", "example.com"
+#   write("/var/run/bowtie.pid") { Process.pid }
 def write(name, contents = nil)
   contents ||= yield
   File.open name, "w" do |f|
@@ -9,6 +14,9 @@ def write(name, contents = nil)
   end
 end
 
+# Append contents to a file, creating it if necessary.
+# Takes string as second argument, or yields to block. For example:
+#   append "/etc/fstab", "/dev/sdh /vol xfs\n" unless read("/etc/fstab")["/dev/sdh "]
 def append(name, contents = nil)
   contents ||= yield
   File.open name, "a" do |f|
@@ -16,6 +24,11 @@ def append(name, contents = nil)
   end
 end
 
+# Updates a file: read contents, substitue and write it back.
+# Takes two arguments for substitution, or yields to block.
+# These two are equivalent:
+#   update "/etc/memcached.conf", /^-l 127.0.0.1/, "-l 0.0.0.0"
+#   update("/etc/memcached.conf") { |s| s.sub(/^-l 127.0.0.1/, "-l 0.0.0.0") }
 def update(name, from = nil, to = nil)
   contents = File.read(name)
   if from && to

data/lib/necktie/gems.rb

@@ -1,5 +1,13 @@
 require "rubygems/dependency_installer"
 
+# Installs the specified gem, if not already installed. First argument is the
+# name of the gem, or file containing the gem. Second argument is version requirement.
+# For example:
+#   install_gem "unicorn", "~>0.93"
+#
+#   Dir["gems/*.gem"].each do |gem|
+#     install_gem gem
+#   end
 def install_gem(name, version = nil)
   installer = Gem::DependencyInstaller.new
   spec = installer.find_spec_by_name_and_version(name, version).first.first

data/lib/necktie/rush.rb

@@ -1,7 +1,7 @@
 require "rush"
 include Rush
 
-class Object
+class Object #:nodoc:
   include Rush
   Rush.methods(false).each do |method|
     define_method method do |*args|

data/lib/necktie/services.rb

@@ -1,4 +1,7 @@
 class Services
+  # Enables service to run after boot and starts it. Same as:
+  #   update_rc.d <name> defaults
+  #   service <name> start
   def start(name)
     puts " ** Starting service #{name}"
     system "update-rc.d #{name} defaults" and
@@ -6,10 +9,14 @@ class Services
       fail "failed to start #{name}"
   end
 
+  # Enables service to run after boot.
   def enable(name)
     system "update-rc.d #{name} defaults" or "cannot enable #{name}"
   end
 
+  # Disables service and stops it. Same as:
+  #   service <name> stop
+  #   update_rc.d <name> remove
   def stop(name)
     puts " ** Stopping service #{name}"
     system "service #{name} stop" and
@@ -17,21 +24,31 @@ class Services
       fail "failed to stop #{name}"
   end
 
+  # Disables service from running after boot.
   def disable(name)
     system "update-rc.d -f #{name} remove" or fail "cannot disable #{name}"
   end
 
+  # Restart service. Same as:
+  #   service <name> restart
   def restart(name)
-    puts " ** Stopping service #{name}"
+    puts " ** Restarting service #{name}"
     system "service #{name} restart" or fail "failed to restart #{name}"
   end
 
+  # Checks if service is running. Returns true or false based on the outcome
+  # of service <name> status, and nil if service doesn't have a status command.
+  # (Note: Not all services report their running state, or do so reliably)
   def running?(name)
     status = File.read("|service --status-all 2>&1")[/^ \[ (.) \]  #{Regexp.escape name}$/,1]
     status == "+" ? true : status == "-" ? false : nil
   end
 end
 
+# Returns Services object. Examples:
+#   services.restart "nginx"
+#   services.start "mysql" unless services.running?("mysql")
+#   services.enable "memcached" # but don't start yet
 def services
   @services ||= Services.new
 end

data/lib/necktie.rb

@@ -1,8 +1,5 @@
-require "necktie/rake"
+require "necktie/application"
 require "necktie/files"
 require "necktie/gems"
 require "necktie/services"
 require "necktie/rush"
-
-module Necktie
-end

data/necktie.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |spec|
   spec.name           = "necktie"
-  spec.version        = "0.3.5"
+  spec.version        = "1.0.0"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://github.com/assaf/necktie"
   spec.summary        = "Dress to impress"
   spec.description    = "Configure your servers remotely using Ruby and Git"
 
-  spec.files          = Dir["{bin,lib,vendor}/**/*", "*.{gemspec,rdoc}"]
+  spec.files          = Dir["{bin,lib,vendor,example}/**/*", "*.{gemspec,rdoc}"]
   spec.executable     = "necktie"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: necktie
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  version: 1.0.0
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 -07:00
+date: 2009-10-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,10 +23,10 @@ extra_rdoc_files: []
 
 files: 
 - bin/necktie
+- lib/necktie/application.rb
 - lib/necktie/capistrano.rb
 - lib/necktie/files.rb
 - lib/necktie/gems.rb
-- lib/necktie/rake.rb
 - lib/necktie/rush.rb
 - lib/necktie/services.rb
 - lib/necktie.rb
@@ -236,6 +236,14 @@ files:
 - vendor/session/lib/session-2.4.0.rb
 - vendor/session/lib/session.rb
 - vendor/session/test/session.rb
+- example/etc/cron/snapshot
+- example/etc/init.d/unicorn
+- example/etc/nginx/unicorn.conf
+- example/gems/unicorn-0.93.3.gem
+- example/Necktie
+- example/tasks/app.rb
+- example/tasks/current.rb
+- example/tasks/db.rb
 - necktie.gemspec
 - README.rdoc
 has_rdoc: true