capistrano_s3 0.1.2 → 0.2.1

data/README

@@ -14,18 +14,26 @@ If the tarball is already in S3 (from a previous deployment, say to a staging in
 = Installation
   gem install capistrano_s3
 
+= Usage 
+Please read carefully if upgrading from 0.1 as the options have changed.
+
 To use it, specify properties in <tt>config/deploy.rb</tt>:
   set :deploy_via, :s3_bucket
-  set :deploy_s3_bucket, 'com.example.releases' # The name of the S3 bucket that should get releases
   s3_config = YAML::load(ERB.new(IO.read("secret/s3.yml")).result) # Follow this pattern and don't ckin your secrets
-  # s3_config = { 'AWS_ACCOUNT_NUMBER' => '1234-5678-9012', 'AWS_ACCESS_KEY_ID' => 'ABCDEFGHIJKLMNOPQRST', 'AWS_SECRET_ACCESS_KEY' => 'abcdefghijklmnopqrstuvwxyz01234567890ABC' }
+  # s3_config = { 
+  #   'access_key_id' => 'ABCDEFGHIJKLMNOPQRST', 
+  #   'secret_access_key' => 'abcdefghijklmnopqrstuvwxyz01234567890ABC' ,
+  #   'bucket_name' => 'com.example.releases' # The name of the S3 bucket that should get releases
+  # }
   set :s3_config, s3_config
 
 Now regular capistrano deployment tasks will go through S3
 
 = About
 
-Rubyforge Project:: http://rubyforge.org/projects/capistrano-s3
-Author:: Bill Kirtley - bill.kirtley at [nospam] gmail dt com
+GitHub Project:: http://github.com/Viximo/capistrano-s3
+Authors:: 
+  Bill Kirtley - bill.kirtley at [nospam] gmail dt com
+  Matt Griffin - matt@griffinonline.org
 License:: Distributed under MIT License
 Copyright:: 2008 Bill Kirtley, Virosity Inc.

data/lib/capistrano/recipes/deploy/strategy/s3_bucket.rb

@@ -1,11 +1,9 @@
 require 'capistrano/recipes/deploy/strategy/copy'
-require 'fileutils'
-require 'tempfile'  # Dir.tmpdir
 
 #implementing a capistrano deploy strategy that:
 # - Expects a deploy_bucket it can read from and write to
 # - Uses configuration[:s3_config] to find creds
-# - Names releases {application}_{revision}.tgz
+# - Names releases {package_prefix}_{revision}.tgz
 # - Looks in the bucket for a file with that name - skip to actual deployment if found
 # - Checks out the specified revision, bundles it up, and pushes to the S3 bucket
 # - depends on the s3cmd command, perhaps installed with `gem install s3sync`
@@ -14,6 +12,9 @@ require 'tempfile'  # Dir.tmpdir
 # Distributed via MIT license
 # Feedback appreciated: bill at [nospam] virosity dt com
 
+# Note: this fork depends on a commit in this Capistrano fork which has not yet been pulled in
+# http://github.com/Viximo/capistrano/commit/e9aa71293ae7d4150627891e3633b9e7bfecd437
+
 module Capistrano
   module Deploy
     module Strategy
@@ -21,15 +22,15 @@ module Capistrano
       class S3Bucket < Copy
 
         def deploy!
-          logger.debug "getting (via #{copy_strategy}) revision #{revision} to #{destination}"
-          logger.debug "#{configuration[:release_path]} #{File.basename(configuration[:release_path])}"
-          put_package
-          
-          run "#{aws_environment} s3cmd get #{bucket_name}:#{package_name} #{remote_filename}"
-          run "mkdir #{configuration[:release_path]} && cd #{configuration[:release_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
-          logger.debug "done!"
+          if bucket_includes_package
+            logger.debug "#{package_name} already in bucket #{bucket_name}"
+            distribute!
+          else
+            logger.debug "#{package_name} not found in bucket #{bucket_name} so ckout to add it"
+            super
+          end
         end
-
+        
         #!! implement me!
         # Performs a check on the remote hosts to determine whether everything
         # is setup such that a deploy could succeed.
@@ -37,44 +38,59 @@ module Capistrano
         # end
 
     private
+        def distribute!
+          put_package unless bucket_includes_package
+          run "#{s3cmd} get #{bucket_name}:#{package_name} #{remote_filename}"
+          run "cd #{configuration[:releases_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
+          
+          # Archive may have been cached from a previous release so rename the resulting dir
+          run "cd #{configuration[:releases_path]} && mv #{release_name} #{configuration[:release_path]}"
+          logger.debug "done!"
+        end
+        
         def aws_environment
-          @aws_environment ||= "AWS_ACCOUNT_NUMBER=#{configuration[:s3_config]['AWS_ACCOUNT_NUMBER']} AWS_ACCESS_KEY_ID=#{configuration[:s3_config]['AWS_ACCESS_KEY_ID']} AWS_SECRET_ACCESS_KEY=#{configuration[:s3_config]['AWS_SECRET_ACCESS_KEY']}"
+          @aws_environment ||= "AWS_ACCESS_KEY_ID=#{configuration[:s3_config]['access_key_id']} AWS_SECRET_ACCESS_KEY=#{configuration[:s3_config]['secret_access_key']}"
         end
+        
+        def s3cmd
+          "env #{aws_environment} s3cmd"
+        end
+        
         # Responsible for ensuring that the package for the current revision is in the bucket
         def put_package
-          set :release_name, revision
-          logger.debug "#{package_name} already in bucket #{bucket_name}" and return if bucket_includes_package
-          logger.debug "#{package_name} not found in bucket #{bucket_name} so ckout to add it"
-          
-          # Do the checkout locally
-          system(command)
-          File.open(File.join(destination, "REVISION"), "w") { |f| f.puts(revision) }
-
-          # Compress it
-          logger.trace "compressing in #{destination}"
-          logger.trace compress('*', package_path).join(" ")
-
-          Dir.chdir(destination) { system(compress('*', package_path).join(" ")) }
-
-          # Put to S3
           logger.trace "pushing to S3 bucket #{bucket_name} key #{package_name}"
-          system("s3cmd put #{bucket_name}:#{package_name} #{package_path}")
+          system("#{s3cmd} put #{bucket_name}:#{package_name} #{filename}")
         end
 
         def bucket_includes_package
-          /#{package_name}/.match(`s3cmd list #{bucket_name}:#{package_name}`)
+          if @bucket_includes_package.nil?
+            @bucket_includes_package = /#{package_name}/.match(`#{s3cmd} list #{bucket_name}:#{package_name}`)
+            @bucket_includes_package = false if @bucket_includes_package.nil?
+          end
+
+          @bucket_includes_package
         end
 
+        def release_name
+          "#{configuration[:s3_config]['package_prefix']}_#{revision}"
+        end
+        
         def package_name
-          @package_name ||= "#{configuration[:application]}_#{revision}.tgz"
+          @package_name ||= "#{release_name}.#{compression.extension}"
         end
         
-        def package_path
-          @package_path ||= File.join(tmpdir, package_name)
+        # Copy the checked out project to a directory using the name of the revision, not the release
+        # since the archive will be cached
+        def destination
+          @destination ||= File.join(tmpdir, release_name)
+        end
+                  
+        def remote_filename
+          @remote_filename ||= @remote_filename ||= File.join(remote_dir, package_name)
         end
         
         def bucket_name
-          configuration[:deploy_s3_bucket]
+          configuration[:s3_config]['bucket_name']
         end
         
         def bucket
@@ -83,13 +99,13 @@ module Capistrano
 
         def initialize(config={})
           super(config)
-          
+        
           raise "Failed to find :s3_config" unless configuration[:s3_config]
-          # Annoying that merge doesnt work because ENV isn't really a Hash:
-          # ENV.merge(configuration[:s3_config])
-          configuration[:s3_config].each_pair { |name, value| ENV[name] = value }
+          
+          # Set defaults
+          configuration[:s3_config]['package_prefix'] ||= 'release'
+          configuration[:s3_config]['bucket_name'] ||= 'capistrano_s3_deploy'
         end
-
       end
     end
   end

data/lib/version.rb

@@ -1,8 +1,8 @@
-module Capistrano_S3 #:nodoc:
+module CapistranoS3 #:nodoc:
   module Version #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 2
+    MINOR = 2
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/deploy_s3_bucket_test.rb

@@ -16,9 +16,8 @@ context "Capistrano::Deploy::Strategy::S3Bucket" do
                 :release_path => "/u/apps/test/releases/1234567890",
                 :real_revision => "154",
                 :deploy_s3_bucket => 'com.example.bucket',
-                :s3_config => {'AWS_ACCOUNT_NUMBER' => '1234-5678-9012', 
-                               'AWS_ACCESS_KEY_ID' => 'ABCDEFGHIJKLMNOPQRST', 
-                               'AWS_SECRET_ACCESS_KEY' => 'abcdefghijklmnopqrstuvwxyz01234567890ABC' }
+                :s3_config => {'access_key_id' => 'ABCDEFGHIJKLMNOPQRST', 
+                               'secret_access_key' => 'abcdefghijklmnopqrstuvwxyz01234567890ABC' }
                  }
     @source = mock("source")
     @config.stubs(:source).returns(@source)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano_s3
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 21
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Bill Kirtley
@@ -16,29 +16,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-14 00:00:00 -05:00
+date: 2011-03-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: capistrano
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  name: capistrano
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 51
         segments: 
         - 2
-        - 1
-        - 0
-        version: 2.1.0
-  type: :runtime
-  version_requirements: *id001
+        - 5
+        - 20
+        version: 2.5.20
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: s3sync
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :runtime
+  name: s3sync
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,12 +48,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id002
+  requirement: *id002
 description: A deployment strategy for capistrano using S3
-email: 
-- bill.kirtley@gmail.com
-- matt@griffinonline.org
+email: matt@griffinonline.org
 executables: []
 
 extensions: []
@@ -67,7 +65,7 @@ files:
 - README
 - MIT-LICENSE
 has_rdoc: true
-homepage: http://github.com/cluesque/capistrano-s3
+homepage: http://github.com/Viximo/capistrano-s3
 licenses: []
 
 post_install_message: 
@@ -95,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: capistrano_s3
+rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3