freerange_deploy 0.1.1 → 0.1.5

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README

@@ -6,28 +6,27 @@ Allows simple, git-based deployment on freerange-compatible servers (see assumpt
 How to use
 ----------
 
-In your project, create a Capfile, like this:
+In your project, run:
 
-    require 'freerange/deploy'
+    $ freerange-deploy setup REPOSITORY HOST [NAME]
 
-    server "gofreerange.com", :app, :web, :db, :primary => true
-    set :application, "gofreerange.com" # defaults to the name of the repo at origin
+This should add a Capfile, config/deploy.rb and config/deploy/production.rb files to the project.  Feel free to edit the deploy.rb and production.rb files as you wish.
 
-Next, prepare the server:
+When ready, from your project run:
 
-    $ cap deploy:setup
-    
-This adds a git remote to your local repository, and creates an apache virtual host configuration on the server, and performs the initial git deploy. To deploy again, just push to 'production'
+    $ cap production host:setup
+    $ cap production deploy:setup
 
-    % git push production master
+The first command adds a VHOST file to /etc/apache2/sites-available and enables it.  The second does the standard capistrano setup stuff.
 
+For simple apps, you should now be able to deploy:
 
+    $ cap production deploy
 
 Assumptions
 -----------
 
 1. You're deploying as 'deploy'
 2. You're deploying to /var/www/<application>
-3. Your apache is setup to read vhost files from /var/www/apache_vhost
-4. The deploy user has write access to that directory
-5. The deploy user is a sudoer
+3. The deploy user has write access to /etc/apache2/sites-available
+4. The deploy user is a sudoer

data/Rakefile

@@ -2,7 +2,7 @@ require "rubygems"
 require "rake/gempackagetask"
 require "rake/rdoctask"
 
-
+path = File.expand_path("..", __FILE__)
 
 task :default => :package do
   puts "Don't forget to write some tests!"
@@ -16,24 +16,30 @@ end
 spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
-  s.name              = "freerange_deploy"
-  s.version           = "0.1.1"
-  s.summary           = "Enables simple git-based deployments to freerange-compatible hosts"
-  s.author            = "James Adam"
-  s.email             = "james.adam@gofreerange.com"
-  s.homepage          = "http://gofreerange.com"
-
+  s.name               = "freerange_deploy"
+  s.version            = "0.1.5"
+  s.summary            = "Enables simple git-based deployments to freerange-compatible hosts"
+  s.author             = "James Adam, Tom Ward"
+  s.email              = "lets@gofreerange.com"
+  s.homepage           = "http://gofreerange.com"
+  s.default_executable = %q{freerange-deploy}
+  s.executables        = ["freerange-deploy"]
+  
   s.has_rdoc          = true
   s.extra_rdoc_files  = %w(README)
   s.rdoc_options      = %w(--main README)
 
   # Add any extra files to include in the gem
-  s.files             = %w(freerange_deploy.gemspec Rakefile README) + Dir.glob("{lib/**/*}")
+  s.files             = `cd #{path} && git ls-files`.split("\n").sort
   s.require_paths     = ["lib"]
 
   # If you want to depend on other gems, add them here, along with any
   # relevant versions
-  s.add_dependency("git-deploy", "~> 0.3.0")
+  s.add_dependency("capistrano")
+  s.add_dependency("capistrano-ext")
+  s.add_dependency("thor")
+  s.add_dependency("tinder")
+  s.add_dependency("json")
 
   # If your tests use any gems, include them here
   # s.add_development_dependency("mocha") # for example
@@ -48,12 +54,28 @@ end
 # about that here: http://gemcutter.org/pages/gem_docs
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
+end
 
-  # Generate the gemspec file for github.
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, "w") {|f| f << spec.to_ruby }
+# Stolen from jeweler
+def prettyify_array(gemspec_ruby, array_name)
+  gemspec_ruby.gsub(/s\.#{array_name.to_s} = \[.+?\]/) do |match|
+    leadin, files = match[0..-2].split("[")
+    leadin + "[\n    #{files.split(",").join(",\n   ")}\n  ]"
+  end
 end
 
+task :gemspec do
+  output = spec.to_ruby
+  output = prettyify_array(output, :files)
+  output = prettyify_array(output, :test_files)
+  output = prettyify_array(output, :extra_rdoc_files)
+
+  file = File.expand_path("../#{spec.name}.gemspec", __FILE__)
+  File.open(file, "w") {|f| f << output }
+end
+
+task :package => :gemspec
+
 # Generate documentation
 Rake::RDocTask.new do |rd|
   rd.main = "README"

data/bin/freerange-deploy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'freerange/cli/deploy'
+FreeRange::CLI::Deploy.start

data/freerange_deploy.gemspec

@@ -2,18 +2,34 @@
 
 Gem::Specification.new do |s|
   s.name = %q{freerange_deploy}
-  s.version = "0.1.1"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["James Adam"]
-  s.date = %q{2010-02-22}
-  s.email = %q{james.adam@gofreerange.com}
-  s.extra_rdoc_files = ["README"]
-  s.files = ["freerange_deploy.gemspec", "Rakefile", "README", "lib/freerange", "lib/freerange/deploy.rb"]
+  s.authors = ["James Adam, Tom Ward"]
+  s.date = %q{2010-04-07}
+  s.default_executable = %q{freerange-deploy}
+  s.email = %q{lets@gofreerange.com}
+  s.executables = ["freerange-deploy"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+    "README",
+    "Rakefile",
+    "bin/freerange-deploy",
+    "freerange_deploy.gemspec",
+    "lib/freerange/cli/deploy.rb",
+    "lib/freerange/cli/templates/Capfile.erb",
+    "lib/freerange/cli/templates/deploy.rb.erb",
+    "lib/freerange/cli/templates/production.rb.erb",
+    "lib/freerange/cli/templates/staging.rb.erb",
+    "lib/freerange/deploy.rb"
+  ]
   s.homepage = %q{http://gofreerange.com}
   s.rdoc_options = ["--main", "README"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Enables simple git-based deployments to freerange-compatible hosts}
 
   if s.respond_to? :specification_version then
@@ -21,11 +37,23 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<git-deploy>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<capistrano>, [">= 0"])
+      s.add_runtime_dependency(%q<capistrano-ext>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
+      s.add_runtime_dependency(%q<tinder>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
     else
-      s.add_dependency(%q<git-deploy>, ["~> 0.3.0"])
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<capistrano-ext>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+      s.add_dependency(%q<tinder>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
     end
   else
-    s.add_dependency(%q<git-deploy>, ["~> 0.3.0"])
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<capistrano-ext>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+    s.add_dependency(%q<tinder>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
   end
 end

data/lib/freerange/cli/deploy.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'thor'
+
+module FreeRange
+  module CLI
+    class Deploy < Thor
+      include Thor::Actions
+      
+      def self.source_root
+        File.expand_path("../templates", __FILE__)
+      end
+      
+      argument :repository, :required => true, :desc => 'Git repository containing app, e.g. git@github.com:freerange/deploy.git'
+      argument :host, :required => true, :desc => 'Hostname to deploy to, e.g api.hashblue.com'
+      argument :name, :required => false, :desc => 'Name of app, e.g firehose'
+      
+      desc 'setup', 'Setup freerange deployment files, eg freerange-deploy setup git@github.com:freerange/o2-firehose.git api.firehose.com firehose'
+      def setup
+        self.name ||= host
+        template 'Capfile.erb', 'Capfile'
+        template 'deploy.rb.erb', 'config/deploy.rb'
+        template 'staging.rb.erb', 'config/deploy/staging.rb'
+        template 'production.rb.erb', 'config/deploy/production.rb'
+      end
+    end
+  end
+end

data/lib/freerange/cli/templates/Capfile.erb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+load 'config/deploy' # remove this line to skip loading any of the default tasks

data/lib/freerange/cli/templates/deploy.rb.erb

@@ -0,0 +1,19 @@
+set :stages, %w(staging production)
+set :default_stage, "production"
+
+require 'freerange/deploy'
+
+set :application, "<%= name %>"
+set :repository,  "<%= repository %>"
+
+# Set the following to announce releases in campfire rooms
+
+# set :campfire_domain,   "subdomain"
+# set :campfire_room,     "room-name"
+# set :campfire_key,  "abcdef1234567890"
+
+after "deploy:finalize_update" do
+  # The default recipe already runs bundler install and db:migrate
+  # but other steps you need to run after the code has been updated
+  # (such as generate css) should go here
+end

data/lib/freerange/cli/templates/production.rb.erb

@@ -0,0 +1,4 @@
+server "<%= host %>", :app, :web, :db, :primary => true
+
+# Set the host name.  Used to generate virtual host file
+set :domain, "<%= host %>"

data/lib/freerange/cli/templates/staging.rb.erb

@@ -0,0 +1,4 @@
+server "staging.<%= host %>", :app, :web, :db, :primary => true
+
+# Set the host name.  Used to generate virtual host file
+set :domain, "staging.<%= host %>"

data/lib/freerange/deploy.rb

@@ -1,4 +1,4 @@
-require "git_deploy"
+  require 'capistrano/ext/multistage'
 
 Capistrano::Configuration.instance(:must_exist).load do
   # User details
@@ -11,50 +11,111 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   # SCM settings
   set :scm,           'git'
-  # set to the name of git remote you intend to deploy to
-  set :remote,        'production' # overrides the default git-deploy setting of 'origin'
-  # specify the deployment branch
-  set :branch,        'master'
+  set :deploy_via, :remote_cache
 
-  # The appliation name defaults to the name of the repository at the origin remote
-  set(:application) { File.basename(`#{source.local.scm('config', "remote.origin.url")}`, ".git") }
-  
   # Deploy to our default location
   set(:deploy_to)   { "/var/www/#{application}" }
+  set(:sites)       { }
 
   # Git settings for Capistrano
   default_run_options[:pty]     = true # needed for git password prompts
   ssh_options[:forward_agent]   = true # use the keys for the person running the cap command to check out the app
 
-
-  before "deploy:setup", "freerange:setup_git_remote"
-  after "deploy:setup", "freerange:setup_apache"
-
-  namespace "freerange" do
-    task :setup_git_remote do
-      remote_url = "deploy@#{roles[:app].first}:/var/www/#{application}"
-      puts "Setting up git remote '#{remote}' -> #{remote_url}"
-      `git remote add #{remote} #{remote_url}`
-    end
-    task :setup_apache do
+  namespace :host do
+    task :create do
       vhost_template =<<-EOT
 <VirtualHost *:80>
-  DocumentRoot /var/www/#{application}/public
-  ServerName #{application}
-  <Directory "/var/www/#{application}/public">
+  ServerName #{domain}
+  DocumentRoot /var/www/#{application}/current/public
+  <Directory "/var/www/#{application}/current/public">
     allow from all
     Options +Indexes
-    </Directory>
+  </Directory>
 </VirtualHost>
       EOT
-
-      put vhost_template.strip, "/var/www/apache_vhosts/#{application}"
-      
-      # Disable the default site, just in case; it will get in the way.
-      sudo "a2dissite default"
       
-      # Restart apache
-      sudo "apache2ctl restart"
+      put vhost_template.strip, "/etc/apache2/sites-available/#{domain}"
+    end
+    
+    task :enable do
+      run "a2ensite #{domain}"
+      sudo "apache2ctl graceful"
+    end
+    
+    task :disable do
+      run "a2dissite #{domain}"
+      sudo "apache2ctl graceful"
+    end
+    
+    task :setup do
+      host.create
+      host.enable
+    end
+  end
+  
+  # We're using passenger, so start/stop don't apply, while restart needs to just
+  # touch path/restart.txt
+
+  namespace :deploy do
+    task :start do ; end
+    task :stop do ; end
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+    end
+
+    task :bundle, :roles => :app do
+      run "cd #{release_path} && bundle install"
+    end
+
+    task :announce do
+      if room = fetch('campfire_room', nil)
+        require 'tinder'
+        require 'json'
+        campfire = Tinder::Campfire.new(fetch('campfire_domain', 'gofreerange'))
+        campfire.login(fetch('campfire_key'), 'x')
+        room = campfire.find_room_by_name(room)
+
+        name = `git config --get user.name`.strip
+
+        source_repo_url = repository
+        deploying = `git rev-parse HEAD`[0,7]
+        begin
+          deployed = previous_revision[0,7]
+        rescue
+          deployed = "000000"
+        end
+
+        github_url = repository.gsub(/git@/, 'http://').gsub(/\.com:/,'.com/').gsub(/\.git/, '')
+        compare_url = "#{github_url}/compare/#{deployed}...#{deploying}"
+
+        hosts = roles[:app].collect{|r| r.host }.join(", ")
+
+        room.speak "#{name} has deployed build #{deployed} of #{application} to #{hosts}"
+        room.speak "Changes: #{compare_url}"
+      end
+    end
+  end
+
+  after "deploy:finalize_update" do
+    deploy.bundle
+    deploy.migrate
+  end
+
+  after "deploy:restart" do
+    deploy.announce
+  end
+
+  desc "Tail server log files" 
+  task :tail, :roles => :app do
+    trap("INT") { exit(0) }
+    puts
+    puts "Checking server time"
+    run "date"
+    puts
+    run "tail -f #{shared_path}/log/#{stage}.log" do |channel, stream, data|
+      puts  # for an extra line break before the host name
+      puts "#{channel[:host]}: #{data}" 
+      break if stream == :err    
     end
   end
 end

metadata

@@ -1,39 +1,101 @@
 --- !ruby/object:Gem::Specification 
 name: freerange_deploy
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
-- James Adam
+- James Adam, Tom Ward
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 +00:00
-default_executable: 
+date: 2010-04-14 00:00:00 +01:00
+default_executable: freerange-deploy
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: git-deploy
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capistrano-ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: tinder
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.0
-    version: 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
 description: 
-email: james.adam@gofreerange.com
-executables: []
-
+email: lets@gofreerange.com
+executables: 
+- freerange-deploy
 extensions: []
 
 extra_rdoc_files: 
 - README
 files: 
-- freerange_deploy.gemspec
-- Rakefile
+- .gitignore
 - README
+- Rakefile
+- bin/freerange-deploy
+- freerange_deploy.gemspec
+- lib/freerange/cli/deploy.rb
+- lib/freerange/cli/templates/Capfile.erb
+- lib/freerange/cli/templates/deploy.rb.erb
+- lib/freerange/cli/templates/production.rb.erb
+- lib/freerange/cli/templates/staging.rb.erb
 - lib/freerange/deploy.rb
 has_rdoc: true
 homepage: http://gofreerange.com
@@ -49,18 +111,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Enables simple git-based deployments to freerange-compatible hosts