capistrano-releases 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f576772197a855bce09ece4f0886056a0b348adf
+  data.tar.gz: c8a7c0db269716dee53900117f70cb2db42c5ee9
+SHA512:
+  metadata.gz: 77883e54409de8e099b7d83b9718d2aba263eecd511d6f5cf5be0eec6b367d86450e3178e7050f27343aaf75b06738d95c5dd44072c5d322aa9d48dd136f9516
+  data.tar.gz: 9c6d41797623cebd8052ff02268ea83a8921ea9cfd510621e534da579f42142b927ed7e2b905cee225f1b8896f3ea99a4ab9baf7df82bfd5f9086bd0b50043c2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,51 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfInsideElse:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/IdenticalConditionalBranches:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.7

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-releases.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chad Remesch
+
+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,40 @@
+# Capistrano::Releases
+Auto scaling AWS EC2 environments need a way to share the Capistrano 'releases' directory and 'current' symlink.
+This gem provides that capability using AWS S3 to store releases.
+Each release is stored as a zip file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-releases'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-releases
+
+## Usage
+
+    $ releases --help
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chadrem/capistrano-releases.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capistrano/releases'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-releases.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/releases/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-releases'
+  spec.version       = Capistrano::Releases::VERSION
+  spec.authors       = ['Chad Remesch']
+  spec.email         = ['chad@remesch.com']
+
+  spec.summary       = 'Release manager for auto scaling environments.'
+  spec.description   = 'Auto scaling environments need a way to share the releases directory. This gem provides that capability using AWS S3.'
+  spec.homepage      = 'https://github.com/chadrem/capistrano-releases'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  spec.add_dependency 'aws-sdk', '> 2'
+end

data/exe/releases

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'capistrano-releases'
+
+::Capistrano::Releases::CLI.new.run

data/lib/capistrano/releases/cli.rb

@@ -0,0 +1,53 @@
+module Capistrano
+  module Releases
+    # Command line interface class for Manager class.
+    class CLI
+      def run
+        options = {}
+
+        parser = OptionParser.new do |opts|
+          opts.banner = 'Usage: manager [options]'
+
+          opts.on('-bBUCKET', '--bucket=BUCKET',
+                  'S3 bucket to pull/push releases.') do |v|
+            options[:bucket] = v
+          end
+
+          opts.on('-dDEPLOY_TO', '--deploy-to=DEPLOY_TO',
+                  'App directory to deploy to.') do |v|
+            options[:deploy_to] = v
+          end
+
+          opts.on('-mMODE', '--mode=MODE',
+                  "Mode to run: 'push' or 'pull'") do |v|
+            options[:mode] = v
+          end
+        end
+
+        parser.parse!
+
+        unless options[:bucket]
+          puts('-b or --bucket is a required option.') && exit(1)
+        end
+
+        unless options[:deploy_to]
+          puts('-d or --deploy-to is a required option.') && exit(1)
+        end
+
+        puts('-m or --mode is a required option.') && exit(1) unless options[:mode]
+
+        manager = ::Capistrano::Releases::Manager.new(options)
+
+        case options[:mode]
+        when 'push'
+          manager.push
+        when 'pull'
+          manager.pull
+        else
+          puts 'Invalid mode.'
+          exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/releases/manager.rb

@@ -0,0 +1,164 @@
+module Capistrano
+  module Releases
+    # Class for pushing/pulling Capistrano releases.
+    class Manager
+      attr_reader :params
+
+      class << self
+        attr_reader :defaults
+      end
+
+      class << self
+        attr_writer :defaults
+      end
+
+      def initialize(parameters = {})
+        @params = parameters
+
+        params[:bucket] ||=
+          defaults[:bucket] || raise('bucket_name is a required parameter')
+
+        params[:deploy_to] ||=
+          defaults[:deploy_to] || raise('deploy_to is a required parameter')
+
+        params[:keep_releases] ||=
+          (defaults[:keep_releases] || 5)
+      end
+
+      def push
+        make_dirs
+        remotes = Set.new(remote_releases)
+        to_upload = local_releases.reject { |r| remotes.include?(r) }
+        to_upload.each { |r| upload(r) }
+        self.remote_current = local_current
+
+        to_upload
+      end
+
+      def pull
+        make_dirs
+        locals = Set.new(local_releases)
+        puts "Local releases: #{locals.to_a.inspect}"
+        to_download = remote_releases.last(params[:keep_releases])
+                                     .reject { |r| locals.include?(r) }
+        to_download.each do |r|
+          puts "Downloading release: #{r}"
+          download(r)
+        end
+        self.local_current = remote_current
+        puts "Setting local current to: #{local_current}"
+        Dir.chdir(File.join(params[:deploy_to], 'current'))
+
+        to_download
+      end
+
+      private
+
+      def make_dirs
+        dirs = %w[
+          shared
+          shared/public
+          shared/public/assets
+          shared/public/system
+          shared/log
+          shared/tmp
+          shared/tmp/cache
+          shared/tmp/pids
+          shared/tmp/sockets
+          shared/vendor
+          releases
+        ]
+
+        dirs.each do |dir|
+          full_dir = File.join(params[:deploy_to], dir)
+          unless Dir.exist?(full_dir)
+            Dir.mkdir(full_dir)
+            puts "Creating directory: #{full_dir}"
+          end
+        end
+      end
+
+      def defaults
+        self.class.defaults || {}
+      end
+
+      def local_releases_path
+        File.join(params[:deploy_to], 'releases')
+      end
+
+      def local_releases
+        Dir.glob("#{local_releases_path}/*")
+           .sort
+           .map { |r| r.split('/').last }.sort
+      end
+
+      def remote_releases
+        bucket.objects
+              .map(&:key)
+              .select { |k| k.end_with?('.tar.gz') }
+              .map { |k| k.gsub(/\.tar\.gz\z/, '') }
+              .sort
+      end
+
+      def local_current
+        File.readlink(File.join(params[:deploy_to], 'current')).split('/').last
+      end
+
+      def remote_current
+        bucket.object('current.txt').get.body.read
+      end
+
+      def local_current=(release)
+        cur_path = File.join(params[:deploy_to], 'current')
+        rel_path = File.join(local_releases_path, release)
+
+        File.unlink(cur_path) if File.symlink?(cur_path)
+        File.symlink(rel_path, cur_path)
+
+        nil
+      end
+
+      def remote_current=(release)
+        bucket.object('current.txt').put(body: release)
+
+        nil
+      end
+
+      def upload(release)
+        tmp = Tempfile.new(["capistrano-releases_upload-#{release}", '.tar.gz'],
+                           Dir.tmpdir, encoding: 'BINARY')
+
+        begin
+          system!(['tar', 'Ccfz', local_releases_path, tmp.path, release])
+          bucket.object("#{release}.tar.gz").put(body: tmp)
+        ensure
+          tmp.close
+          tmp.unlink
+        end
+      end
+
+      def download(release)
+        tmp = Tempfile.new(["capistrano-releases_download-#{release}", '.tar.gz'],
+                           Dir.tmpdir, encoding: 'BINARY')
+
+        begin
+          bucket.object("#{release}.tar.gz").get(response_target: tmp)
+          system!(['tar', 'Cxfz', local_releases_path, tmp.path])
+        ensure
+          tmp.close
+          tmp.unlink
+        end
+      end
+
+      def bucket
+        @bucket ||= Aws::S3::Bucket.new(params[:bucket])
+      end
+
+      def system!(cmd_array)
+        raise 'Must be an array' unless cmd_array.is_a?(Array)
+        cmd = cmd_array.map { |c| Shellwords.shellescape(c) }.join(' ')
+        raise "command failed: #{cmd}" unless system(cmd)
+      end
+    end
+  end
+end

data/lib/capistrano/releases/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Releases
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/capistrano/releases.rb

@@ -0,0 +1,13 @@
+require 'tempfile'
+require 'shellwords'
+require 'optparse'
+require 'aws-sdk'
+
+require 'capistrano/releases/version'
+require 'capistrano/releases/cli'
+require 'capistrano/releases/manager'
+
+module Capistrano
+  module Releases
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-releases
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Remesch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Auto scaling environments need a way to share the releases directory.
+  This gem provides that capability using AWS S3.
+email:
+- chad@remesch.com
+executables:
+- releases
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-releases.gemspec
+- exe/releases
+- lib/capistrano/releases.rb
+- lib/capistrano/releases/cli.rb
+- lib/capistrano/releases/manager.rb
+- lib/capistrano/releases/version.rb
+homepage: https://github.com/chadrem/capistrano-releases
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Release manager for auto scaling environments.
+test_files: []