capistrano-s3copy-awscli 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Takayuki Okawa
+
+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,158 @@
+# Capistrano::S3copy::Awscli
+
+This is a revised implementation of the ideas in Bill Richie McMahon [capistrano-s3-copy](http://github.com/richie/capistrano-s3-copy) gem.  
+
+Part of my revising've simply to use the aws-cli.
+
+aws-cli supports 
+
+* Environment variables
+* Config file
+* IAM Role
+
+*But this gem don't support Config file.*
+
+This gem use Capistrano's own code to package the tarball, but instead of deploying it to each
+machine, we deploy it to a configured S3 bucket (using aws-cli provided by the https://github.com/aws/aws-cli),
+then deploy it from there to the known nodes from the capistrano script.
+
+## Installation
+    
+    gem build capistrano-s3copy-awscli.gemspec
+    gem install --local capistrano-s3copy-awscli-[version].gem
+
+## Usage
+
+In your deploy.rb file, we need to tell Capistrano to adopt our new strategy:
+
+    set :deploy_via, :s3_copy
+
+If you want to use Environment variables then we need to provide AWS account details to authorize the upload/download of our 
+package to S3
+
+    set :aws_access_key_id,     ENV['AWS_ACCESS_KEY_ID']
+    set :aws_secret_access_key, ENV['AWS_SECRET_ACCESS_KEY']
+
+Finally, we need to indicate which region and bucket to store the packages in:
+
+    set :aws_region, 'mybucket-region'
+    set :aws_releases_bucket, 'mybucket-deployments'
+
+The package will be stored in S3 prefixed with a rails_env that was set in capistrano:
+
+e.g.
+
+    S3://mybucket-deployment/production/201307212007.tar.gz
+
+If the deployment succeeds, another file is written to S3:
+
+    S3://mybucket-deployment/production/aws_install.sh
+
+The intention is that auto-scaled instances started after the deploy could download this well-known script
+to an AMI, and executing it would bring down the latest tarball, and extract it in a manner similar to
+someone running:
+
+  cap deploy:setup
+  cap deploy
+
+Of course, everyone has tweaks that they make to the standard capistrano recipe. For this reason, the script
+thats executed is generated from an ERB template.
+
+
+    #!/bin/sh
+
+    # Auto-scaling capistrano like deployment script Rails3 specific.
+
+    set -x
+    set -e
+
+    echo "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}"
+    echo "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}"
+
+    if [ "${AWS_ACCESS_KEY_ID}" == "" ]; then
+      echo "Expecting the environment variable AWS_ACCESS_KEY_ID to be set"
+      exit 1
+    fi
+    
+    if [ "${AWS_SECRET_ACCESS_KEY}" == "" ]; then
+      echo "Expecting the environment variable AWS_SECRET_ACCESS_KEY to be set"
+      exit 2
+    fi
+
+    AWS_RELEASES_BUCKET=<%= configuration[:aws_releases_bucket] %>
+    AWS_REGION=<%= configuration[:aws_region] %>
+    RAILS_ENV=<%= configuration[:rails_env] %>              # e.g. production
+    DEPLOY_TO=<%= configuration[:deploy_to] %>              # e.g. /u/apps/myapp
+    RELEASES_PATH=<%= configuration[:releases_path] %>      # e.g. /u/apps/myapp/releases
+    RELEASE_PATH=<%= configuration[:release_path] %>        # e.g. /u/apps/myapp/releases/20130720210958
+    SHARED_PATH=<%= configuration[:shared_path] %>          # e.g. /u/apps/myapp/shared
+    CURRENT_PATH=<%= configuration[:current_path] %>        # e.g. /u/apps/myapp/current
+
+    PACKAGE_NAME=<%= File.basename(filename) %>             # e.g. 20130720210958.tar.gz
+    S3_PACKAGE_PATH=${RAILS_ENV}/${PACKAGE_NAME}            # e.g. production/20130720210958.tar.gz
+    DOWNLOADED_PACKAGE_PATH=<%= remote_filename %>          # e.g. /tmp/20130720210958.tar.gz
+    DECOMPRESS_CMD="<%= decompress(remote_filename).join(" ") %>" # e.g. tar xfz /tmp/20130720210958.tar.gz
+
+    mkdir -p $DEPLOY_TO
+    mkdir -p $RELEASES_PATH
+    mkdir -p ${SHARED_PATH}
+    mkdir -p ${SHARED_PATH}/system
+    mkdir -p ${SHARED_PATH}/log
+    mkdir -p ${SHARED_PATH}/pids
+
+    touch ${SHARED_PATH}/log/${RAILS_ENV}.log
+    chmod 0666 ${SHARED_PATH}/log/${RAILS_ENV}.log
+    chmod -R g+w ${DEPLOY_TO}
+
+    # AFTER: cap deploy:setup
+    # Project specific shared directories
+    # mkdir -p ${SHARED_PATH}/content
+    # mkdir -p ${SHARED_PATH}/uploads
+
+    # cap deploy:update_code
+    s3cmd get ${AWS_RELEASES_BUCKET}:${S3_PACKAGE_PATH} ${DOWNLOADED_PACKAGE_PATH} 2>&1
+    cd ${RELEASES_PATH} && ${DECOMPRESS_CMD} && rm ${DOWNLOADED_PACKAGE_PATH}
+
+    # cap deploy:assets_symlink   (Rails 3.x specific)
+    rm -rf ${RELEASE_PATH}/public/assets
+    mkdir -p ${RELEASE_PATH}/public
+    mkdir -p ${DEPLOY_TO}/shared/assets
+    ln -s ${SHARED_PATH}/assets ${RELEASE_PATH}/public/assets
+
+    # cap deploy:finalize_update
+    chmod -R g+w ${RELEASE_PATH}
+    rm -rf ${RELEASE_PATH}/log
+    rm -rf ${RELEASE_PATH}/public/system
+    rm -rf ${RELEASE_PATH}/tmp/pids
+    mkdir -p ${RELEASE_PATH}/public
+    mkdir -p ${RELEASE_PATH}/tmp
+    ln -s ${SHARED_PATH}/system ${RELEASE_PATH}/public/system
+    ln -s ${SHARED_PATH}/log ${RELEASE_PATH}/log
+    ln -s ${SHARED_PATH}/pids ${RELEASE_PATH}/tmp/pids
+
+    # AFTER: cap deploy:finalize_update
+    cd ${RELEASE_PATH}
+    bundle install --gemfile ${RELEASE_PATH}/Gemfile --path ${SHARED_PATH}/bundle --deployment --quiet --without development test
+
+    # AFTER: cap deploy:update_code
+    # cap deploy:assets:precompile
+    cd ${RELEASE_PATH}
+    bundle exec rake RAILS_ENV=${RAILS_ENV} RAILS_GROUPS=assets assets:precompile
+
+    # Project specific shared symlinking
+    #ln -nfs ${SHARED_PATH}/content ${RELEASE_PATH}/public/content
+    #ln -nfs ${SHARED_PATH}/uploads ${RELEASE_PATH}/public/uploads
+
+    # cap deploy:create_symlink
+    rm -f ${CURRENT_PATH}
+    ln -s ${RELEASE_PATH} ${CURRENT_PATH}
+
+    # cap deploy:restart
+    # touch ${CURRENT_PATH}/tmp/restart.txt
+
+    # AFTER: cap deploy:restart
+    # cd ${CURRENT_PATH};RAILS_ENV=${RAILS_ENV} script/delayed_job restart
+
+An alternative ERB script can be configured via something like this:
+
+    set :aws_install_script, File.read(File.join(File.dirname(__FILE__), "custom_aws_install.sh.erb")

data/Rakefile

@@ -0,0 +1,22 @@
+#rake #!/usr/bin/env rake
+require 'rdoc/task'
+require "bundler/gem_tasks"
+
+desc "Build the RDoc API documentation"
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "doc"
+  rdoc.title    = "Capistrano S3Copy aws-cli"
+  rdoc.options += %w(--main README)
+  rdoc.rdoc_files.include('README.md', 'LICENSE', 'lib/**/*.rb')
+end
+
+desc "Build documentation"
+task :doc => [ :rdoc ]
+
+desc "Clean up generated directories and files"
+task :clean do
+  rm_rf "pkg"
+  rm_rf "doc"
+end
+
+task :default => [ :clean, :build, :doc ]

data/capistrano-s3copy-awscli.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+#lib = File.expand_path('../lib', __FILE__)
+#$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/capistrano-s3copy-awscli/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-s3copy-awscli"
+  gem.version       = Capistrano::S3copy::Awscli::VERSION
+  gem.authors       = ["Takayuki Okawa"]
+  gem.email         = ["takayuki.ohkawa@gmail.com"]
+  gem.description   = %q{Capistrano deployment strategy that creates and pushes a tarball
+into S3, for both pushed deployments and pulled auto-scaling.
+Modified to use aws-cli(https://github.com/aws/aws-cli) from s3cmd.
+The original source is Capistrano-S3-Copy(http://github.com/richie/capistrano-s3-copy)}
+  gem.summary       = %q{Capistrano deployment strategy that transfers the release on S3}
+  gem.homepage      = "https://github.com/bacter1a/capistrano-s3copy-awscli"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  #gem.add_development_dependency "bundler", "~> 1.3"
+  #gem.add_development_dependency "rake"
+  gem.add_dependency 'capistrano', ">= 2.12.0"
+end

data/lib/capistrano-s3copy-awscli.rb

@@ -0,0 +1,2 @@
+require "capistrano-s3copy-awscli/version"
+require 'capistrano-s3copy-awscli/recipes/s3_copy'

data/lib/capistrano-s3copy-awscli/recipes/s3_copy.rb

@@ -0,0 +1,15 @@
+Capistrano::Configuration.instance(false).load do
+
+  namespace :s3_copy do
+
+    desc "Internal hook that updates the aws_install.sh script to latest if the deploy completed"
+    task :store_aws_install_script_on_success do
+      cmd = fetch(:s3_copy_aws_install_cmd)
+      if cmd
+        run_locally(cmd)
+      end
+    end
+  end
+
+  after 'deploy', 's3_copy:store_aws_install_script_on_success'
+end

data/lib/capistrano-s3copy-awscli/version.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module S3copy
+    module Awscli
+      VERSION = "0.0.2"
+    end
+  end
+end

data/lib/capistrano/recipes/deploy/strategy/aws_install.sh.erb

@@ -0,0 +1,93 @@
+#!/bin/sh
+
+# Auto-scaling capistrano like deployment script Rails3 specific.
+
+set -x
+set -e
+
+echo "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}"
+echo "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}"
+
+if [ "${AWS_ACCESS_KEY_ID}" == "" ]; then
+  echo "Expecting the environment variable AWS_ACCESS_KEY_ID to be set"
+  exit 1
+fi
+
+if [ "${AWS_SECRET_ACCESS_KEY}" == "" ]; then
+  echo "Expecting the environment variable AWS_SECRET_ACCESS_KEY to be set"
+  exit 2
+fi
+
+AWS_RELEASES_BUCKET=<%= configuration[:aws_releases_bucket] %>
+
+RAILS_ENV=<%= configuration[:rails_env] %>              # e.g. production
+DEPLOY_TO=<%= configuration[:deploy_to] %>              # e.g. /u/apps/myapp
+RELEASES_PATH=<%= configuration[:releases_path] %>      # e.g. /u/apps/myapp/releases
+RELEASE_PATH=<%= configuration[:release_path] %>        # e.g. /u/apps/myapp/releases/20120428210958
+SHARED_PATH=<%= configuration[:shared_path] %>          # e.g. /u/apps/myapp/shared
+CURRENT_PATH=<%= configuration[:current_path] %>        # e.g. /u/apps/myapp/current
+
+PACKAGE_NAME=<%= File.basename(filename) %>             # e.g. 20120428210958.tar.gz
+S3_PACKAGE_PATH=${RAILS_ENV}/${PACKAGE_NAME}            # e.g. production/20120428210958.tar.gz
+DOWNLOADED_PACKAGE_PATH=<%= remote_filename %>          # e.g. /tmp/20120428210958.tar.gz
+DECOMPRESS_CMD="<%= decompress(remote_filename).join(" ") %>" # e.g. tar xfz /tmp/20120428210958.tar.gz
+
+mkdir -p $DEPLOY_TO
+mkdir -p $RELEASES_PATH
+mkdir -p ${SHARED_PATH}
+mkdir -p ${SHARED_PATH}/system
+mkdir -p ${SHARED_PATH}/log
+mkdir -p ${SHARED_PATH}/pids
+
+touch ${SHARED_PATH}/log/${RAILS_ENV}.log
+chmod 0666 ${SHARED_PATH}/log/${RAILS_ENV}.log
+chmod -R g+w ${DEPLOY_TO}
+
+# AFTER: cap deploy:setup
+# Project specific shared directories
+# mkdir -p ${SHARED_PATH}/content
+# mkdir -p ${SHARED_PATH}/uploads
+
+# cap deploy:update_code
+s3cmd get ${AWS_RELEASES_BUCKET}:${S3_PACKAGE_PATH} ${DOWNLOADED_PACKAGE_PATH} 2>&1
+cd ${RELEASES_PATH} && ${DECOMPRESS_CMD} && rm ${DOWNLOADED_PACKAGE_PATH}
+
+# cap deploy:assets_symlink   (Rails 3.x specific)
+rm -rf ${RELEASE_PATH}/public/assets
+mkdir -p ${RELEASE_PATH}/public
+mkdir -p ${DEPLOY_TO}/shared/assets
+ln -s ${SHARED_PATH}/assets ${RELEASE_PATH}/public/assets
+
+# cap deploy:finalize_update
+chmod -R g+w ${RELEASE_PATH}
+rm -rf ${RELEASE_PATH}/log
+rm -rf ${RELEASE_PATH}/public/system
+rm -rf ${RELEASE_PATH}/tmp/pids
+mkdir -p ${RELEASE_PATH}/public
+mkdir -p ${RELEASE_PATH}/tmp
+ln -s ${SHARED_PATH}/system ${RELEASE_PATH}/public/system
+ln -s ${SHARED_PATH}/log ${RELEASE_PATH}/log
+ln -s ${SHARED_PATH}/pids ${RELEASE_PATH}/tmp/pids
+
+# AFTER: cap deploy:finalize_update
+cd ${RELEASE_PATH}
+bundle install --gemfile ${RELEASE_PATH}/Gemfile --path ${SHARED_PATH}/bundle --deployment --quiet --without development test
+
+# AFTER: cap deploy:update_code
+# cap deploy:assets:precompile
+cd ${RELEASE_PATH}
+bundle exec rake RAILS_ENV=${RAILS_ENV} RAILS_GROUPS=assets assets:precompile
+
+# Project specific shared symlinking
+#ln -nfs ${SHARED_PATH}/content ${RELEASE_PATH}/public/content
+#ln -nfs ${SHARED_PATH}/uploads ${RELEASE_PATH}/public/uploads
+
+# cap deploy:create_symlink
+rm -f ${CURRENT_PATH}
+ln -s ${RELEASE_PATH} ${CURRENT_PATH}
+
+# cap deploy:restart
+# touch ${CURRENT_PATH}/tmp/restart.txt
+
+# AFTER: cap deploy:restart
+# cd ${CURRENT_PATH};RAILS_ENV=${RAILS_ENV} script/delayed_job restart

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

@@ -0,0 +1,87 @@
+require 'capistrano/recipes/deploy/strategy/copy'
+require 'erb'
+
+
+module Capistrano
+  module Deploy
+    module Strategy
+      class S3Copy < Copy
+
+        def initialize(config={})
+          super(config)
+
+          s3cmd_vars = []
+          ["aws_access_key_id", "aws_secret_access_key"].each do |var|
+            value = configuration[var.to_sym]
+          #  This error handling was commented for IAM role
+          #  raise Capistrano::Error, "Missing configuration[:#{var}] setting" if value.nil?
+            s3cmd_vars << "#{var.upcase}=#{value}"
+          end
+          @aws_environment = s3cmd_vars.join(" ")
+
+          @bucket_name = configuration[:aws_releases_bucket]
+          raise Capistrano::Error, "Missing configuration[:aws_releases_bucket]" if @bucket_name.nil?
+
+          @region_name = configuration[:aws_region]
+          raise Capistrano::Error, "Missing configuration[:aws_region]" if @region_name.nil?
+        end
+
+        def check!
+          super.check do |d|
+            d.local.command("aws s3")
+            d.remote.command("aws s3")
+          end
+        end
+
+        # Distributes the file to the remote servers
+        def distribute!
+          package_path = filename
+          package_name = File.basename(package_path)
+          s3_push_cmd = "#{aws_environment} aws s3 put-object --bucket #{bucket_name} --region #{region_name} --key #{rails_env}/#{package_name} --body #{package_path} 2>&1"
+
+          if configuration.dry_run
+            logger.debug s3_push_cmd
+          else
+            system(s3_push_cmd)
+            raise Capistrano::Error, "shell command failed with return code #{$?}" if $? != 0
+          end
+
+          run "#{aws_environment} aws s3 get-object --bucket #{bucket_name} --region #{region_name} --key #{rails_env}/#{package_name} #{remote_filename} 2>&1"
+          run "cd #{configuration[:releases_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
+          logger.debug "done!"
+
+          build_aws_install_script
+        end
+
+        def build_aws_install_script
+          template_text = configuration[:aws_install_script]
+          template_text = File.read(File.join(File.dirname(__FILE__), "aws_install.sh.erb")) if template_text.nil?
+          template_text = template_text.gsub("\r\n?", "\n")
+          template = ERB.new(template_text, nil, '<>-')
+          output = template.result(self.binding)
+          local_output_file = File.join(copy_dir, "aws_install.sh")
+          File.open(local_output_file, "w") do  |f|
+            f.write(output)
+          end
+          configuration[:s3_copy_aws_install_cmd] = "#{aws_environment} aws s3 put-object --bucket #{bucket_name} --region #{region_name} --key #{rails_env}/aws_install.sh --body #{local_output_file} 2>&1"
+        end
+
+        def binding
+          super
+        end
+
+        def aws_environment
+          @aws_environment
+        end
+
+        def bucket_name
+          @bucket_name
+        end
+        
+        def region_name
+          @region_name
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-s3copy-awscli
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Takayuki Okawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: ! 'Capistrano deployment strategy that creates and pushes a tarball
+
+  into S3, for both pushed deployments and pulled auto-scaling.
+
+  Modified to use aws-cli(https://github.com/aws/aws-cli) from s3cmd.
+
+  The original source is Capistrano-S3-Copy(http://github.com/richie/capistrano-s3-copy)'
+email:
+- takayuki.ohkawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-s3copy-awscli.gemspec
+- lib/capistrano-s3copy-awscli.rb
+- lib/capistrano-s3copy-awscli/recipes/s3_copy.rb
+- lib/capistrano-s3copy-awscli/version.rb
+- lib/capistrano/recipes/deploy/strategy/aws_install.sh.erb
+- lib/capistrano/recipes/deploy/strategy/s3_copy.rb
+homepage: https://github.com/bacter1a/capistrano-s3copy-awscli
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Capistrano deployment strategy that transfers the release on S3
+test_files: []