capistrano-net_storage-s3 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0333b3c27bc12d2efe91107c6e97572bfa2f60e8
+  data.tar.gz: 2c58481cb021d63e7dfc41378ba59ede934717f3
+SHA512:
+  metadata.gz: e1587ffac5828fd71d58c08e798548dbeec8aad0cfd185e6154cd97733341510691c7157a713cc368537ac606924fb920773ee33efc34b867c38d14e78472cf1
+  data.tar.gz: 3b71b8431885200a19913d4271738c6ffb502a4f412f5052a3e785d9b6f648d032acb1cd3c9d1da47d52043bf8c8e51b9b9ca488a8290ffaa0b43884be91ab93

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Editor Artifacts
+*.sw[pon]
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.8
+- 2.2.0
+before_install: gem install bundler -v 1.14.6
+install: bundle _1.14.6_ install
+script: bundle _1.14.6_ exec rake spec
+notifications:
+  slack:
+    secure: WFEsKPeewkV6n/LmpsvLbu17nT5AWxVr1yglUjhCEe8OGIukTOpTbdsnhv9ticj0vXNdKZZRQEe4B0BhC8Fn+iPbFLyi1Z4is7dmABVU+b1qSOKIQlCCoPqa8RzYuVPYzMcVs9E1ldVdrQfLXKYoVeFAFeFSzcrf4mmTDrJbHhOXFIp1GYfYnhCIf01R72pcc2sHfWrzL3croIAqVYFiYJlimjQgduqQGVnyQjCeFmERCnnJU4t4VUlDU1gxTi3VYLfUtyUFyo5Kp+msRMbjr7LVuXyv/JplnNX3skG7VYN2nyhL6VuuOMAfCDpDCeCpH5mJcB1xLagide+GgDVYPJMJG419Ao7vCNI+1cl4VojT8aZKOs6vR7AMBSCP6gittrDIWOCuD61fc5HLFBSzL5dD5u2b2AxAUuODohNKigKwY59tE5CePuMycS/wVaFBtZjAKwDJDKU95m8JCtqJGzHQ0mEMKrXKICal9O7GWwEuEV+EnU+yzk+ZqWM6AHpGJ48DSm3pMnlnoPy3SBs4W8tFH+IS18cKBJ795Nj2vdwZFEYUEo0UwZrch/STY0/rPHayts9/7vgzZOIur168kxIw5bDNisPqzMTeNiYECnNLYWBSa0Xqn8mKPu52GVJYW6L0Wa8LRxln6BcNv2DkS+JFjyUC04T5wAdD4ADnQd4=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.2.0 (2017/4/12)
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-net_storage-s3.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi
+
+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,85 @@
+# Capistrano::NetStorage::S3
+
+**Capistrano::NetStorage::S3** is a transport plugin of
+[Capistrano::NetStorage](https://github.com/DeNADev/capistrano-net_storage) to deploy application
+via [Amazon S3](https://aws.amazon.com/s3/).  
+And Capistrano::NetStorage is a plugin of [Capistrano](http://capistranorb.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-net_storage-s3'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-net_storage-s3
+
+## Configuration
+
+Set Capistrano variables by `set name, value`.
+
+ Name | Default | Description
+------|---------|------------
+ `:scm`  | `nil` | Set `:net_storage`
+ `:net_storage_transport` | `nil` | Set `Capistrano::NetStorage::S3::Transport`
+ `:net_storage_s3_broker` | `:aws_cli` | Type of transportation broker
+ `:net_storage_s3_aws_access_key_id` | `ENV['AWS_ACCESS_KEY_ID']` | AWS Access Key ID
+ `:net_storage_s3_aws_secret_access_key` | `ENV['AWS_SECRET_ACCESS_KEY']` | AWS Secret Access Key
+ `:net_storage_s3_aws_session_token` | `ENV['AWS_SESSION_TOKEN']` | AWS Session Token
+ `:net_storage_s3_aws_region` | `ENV['AWS_DEFAULT_REGION']` | AWS Region
+ `:net_storage_s3_aws_profile` | `ENV['AWS_DEFAULT_PROFILE']` | AWS Profile
+ `:net_storage_s3_aws_config_file` | `ENV['AWS_CONFIG_FILE']` | AWS Config File
+ `:net_storage_s3_bucket` | `nil` | S3 bucket name
+ `:net_storage_s3_archives_directory` | `nil` | Directory for application archives in S3 bucket
+ `:net_storage_s3_max_retry` | `3` | Max retry times for S3 operations
+
+See also
+[the configuration section of Capistrano::NetStorage](https://github.com/DeNADev/capistrano-net_storage#configuration).
+
+## Usage
+
+Edit Capfile:
+
+```ruby
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+require 'capistrano/net_storage'
+# Load transport plugin for Capistrano::NetStorage
+require 'capistrano/net_storage/s3'
+```
+
+Edit your `config/deploy.rb`:
+
+```ruby
+set :scm, :net_storage
+set :net_storage_transport, Capistrano::NetStorage::S3::Transport
+# set :net_storage_config_files, [your_config_files]
+# set :net_storage_with_bundle, true
+# set :net_storage_archiver, Capistrano::NetStorage::Archiver::TarGzip
+set :net_storage_s3_bucket, 'example-bucket'
+# set :net_storage_s3_archives_directory, your_favorite_directory_path
+```
+
+## Example
+
+You can see typical usage of this library by
+[capistrano-net_storage_demo](https://github.com/DeNADev/capistrano-net_storage_demo/tree/net_storage-s3).
+
+## License
+
+Available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) 2017 DeNA Co., Ltd., IKEDA Kiyoshi
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano-net_storage-s3.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/net_storage/s3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-net_storage-s3'
+  spec.version       = Capistrano::NetStorage::S3::VERSION
+  spec.authors       = ['progrhyme']
+
+  spec.summary       = 'Plugin of capistrano-net_storage for Amazon S3'
+  spec.description   = 'A transport plugin of capistrano-net_storage to deploy application via Amazon S3.'
+  spec.homepage      = 'https://github.com/DeNADev/capistrano-net_storage-s3'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency 'capistrano-net_storage'
+  spec.add_runtime_dependency 'retryable'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/capistrano/net_storage/s3.rb

@@ -0,0 +1,8 @@
+require 'capistrano/net_storage/s3/base'
+require 'capistrano/net_storage/s3/error'
+require 'capistrano/net_storage/s3/config'
+require 'capistrano/net_storage/s3/broker/aws_cli'
+require 'capistrano/net_storage/s3/transport'
+require 'capistrano/net_storage/s3/version'
+
+Capistrano::NetStorage::S3.setup!(config: Capistrano::NetStorage::S3::Config.new)

data/lib/capistrano/net_storage/s3/base.rb

@@ -0,0 +1,18 @@
+require 'forwardable'
+
+module Capistrano
+  module NetStorage
+    class S3
+      class << self
+        attr_reader :config
+
+        extend Forwardable
+        def_delegator :config, :broker
+      end
+
+      def self.setup!(params)
+        @config = params[:config]
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/s3/broker/aws_cli.rb

@@ -0,0 +1,63 @@
+require 'retryable'
+
+require 'capistrano/net_storage/s3/base'
+require 'capistrano/net_storage/s3/broker/base'
+
+class Capistrano::NetStorage::S3::Broker::AwsCLI < Capistrano::NetStorage::S3::Broker::Base
+  def check
+    execute_aws_s3('ls', config.bucket_url)
+  end
+
+  def find_uploaded
+    if capture_aws_s3('ls', config.archive_url)
+      set :net_storage_uploaded_archive, true
+    end
+  rescue SSHKit::Runner::ExecuteError
+    c = config
+    on :local do
+      info "Archive is not found on #{c.archive_url}"
+    end
+  end
+
+  def upload
+    c  = config
+    ns = net_storage
+    Retryable.retryable(tries: c.max_retry, sleep: 0.1) do
+      execute_aws_s3('cp', ns.local_archive_path, c.archive_url)
+    end
+  end
+
+  def download
+    c  = config
+    ns = net_storage
+    on ns.servers, in: :groups, limit: ns.max_parallels do
+      Retryable.retryable(tries: c.max_retry, sleep: 0.1) do
+        within releases_path do
+          with(c.aws_environments) do
+            execute :aws, 's3', 'cp', c.archive_url, ns.archive_path
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def execute_aws_s3(cmd, *args)
+    c = config
+    on :local do
+      with(c.aws_environments) do
+        execute :aws, 's3', cmd, *args
+      end
+    end
+  end
+
+  def capture_aws_s3(cmd, *args)
+    c = config
+    on :local do
+      with(c.aws_environments) do
+        capture :aws, 's3', cmd, *args
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/s3/broker/base.rb

@@ -0,0 +1,38 @@
+require 'capistrano/net_storage/s3/base'
+
+class Capistrano::NetStorage::S3
+  module Broker
+    # @abstract
+    class Base
+      # @abstract
+      def check
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def find_uploaded
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def upload
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def download
+        raise NotImplementedError
+      end
+
+      private
+
+      def config
+        Capistrano::NetStorage::S3.config
+      end
+
+      def net_storage
+        Capistrano::NetStorage.config
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/s3/config.rb

@@ -0,0 +1,121 @@
+require 'uri'
+
+require 'capistrano/net_storage/s3/base'
+require 'capistrano/net_storage/s3/error'
+require 'capistrano/net_storage/s3/broker/aws_cli'
+
+class Capistrano::NetStorage::S3
+  class Config
+    # Broker object for transport operations
+    # @return [Capistrano::NetStorage::S3::Broker::Base]
+    def broker
+      @broker ||= begin
+        case fetch(:net_storage_s3_broker, :aws_cli)
+        when :aws_cli
+          Broker::AwsCLI.new
+        else
+          raise Capistrano::NetStorage::S3::Error, "No broker defined! #{fetch(:net_storage_s3_broker)}"
+        end
+      end
+    end
+
+    # AWS configurations
+
+    # @return [String] AWS Access Key ID
+    def aws_access_key_id
+      @aws_access_key_id ||= fetch(:net_storage_s3_aws_access_key_id, ENV['AWS_ACCESS_KEY_ID'])
+    end
+
+    # @return [String] AWS Secret Access Key
+    def aws_secret_access_key
+      @aws_secret_access_key ||= fetch(:net_storage_s3_aws_secret_access_key)
+      @aws_secret_access_key ||= ENV['AWS_SECRET_ACCESS_KEY']
+    end
+
+    # @return [String] AWS Session Token
+    def aws_session_token
+      @aws_session_token ||= fetch(:net_storage_s3_aws_session_token, ENV['AWS_SESSION_TOKEN'])
+    end
+
+    # @return [String] AWS Region
+    def aws_region
+      @aws_region ||= fetch(:net_storage_s3_aws_region, ENV['AWS_DEFAULT_REGION'])
+    end
+
+    # @return [String] AWS Profile
+    def aws_profile
+      @aws_profile ||= fetch(:net_storage_s3_aws_profile, ENV['AWS_DEFAULT_PROFILE'])
+    end
+
+    # AWS Config File
+    def aws_config_file
+      @aws_config_file ||= fetch(:net_storage_s3_aws_config_file, ENV['AWS_CONFIG_FILE'])
+    end
+
+    # @return [Hash] AWS environment variables
+    def aws_environments
+      @aws_environments ||= begin
+        environments = {}
+        environments[:aws_config_file]       = aws_config_file       if aws_config_file
+        environments[:aws_default_profile]   = aws_profile           if aws_profile
+        environments[:aws_default_region]    = aws_region            if aws_region
+        environments[:aws_access_key_id]     = aws_access_key_id     if aws_access_key_id
+        environments[:aws_secret_access_key] = aws_secret_access_key if aws_secret_access_key
+        environments[:aws_session_token]     = aws_session_token     if aws_session_token
+        environments
+      end
+    end
+
+    # S3 bucket URL via which one transports application archives
+    # @return [URI::Generic]
+    def bucket_url
+      @bucket ||= begin
+        unless bucket = fetch(:net_storage_s3_bucket)
+          raise Capistrano::NetStorage::S3::Error, ':net_storage_s3_bucket is not configured!'
+        end
+        URI.parse("s3://#{bucket}")
+      end
+    end
+
+    # S3 URL which contains application archives
+    # @return [URI::Generic]
+    def archives_url
+      @archives_url ||= begin
+        if archives_directory
+          bucket_url + archives_directory
+        else
+          bucket_url
+        end
+      end
+    end
+
+    # S3 URL of the application archive for current deployment
+    # @return [URI::Generic]
+    def archive_url
+      @archive_url ||= begin
+        unless revision = fetch(:current_revision)
+          raise Capistrano::NetStorage::Error, ':current_revision is not set!'
+        end
+        archive_file = "#{revision}.#{Capistrano::NetStorage.config.archive_suffix}"
+        archives_url + archive_file
+      end
+    end
+
+    # Max retrial number for S3 operations
+    # @return [Fixnum]
+    def max_retry
+      @max_retry ||= fetch(:net_storage_s3_max_retry, 3)
+    end
+
+    private
+
+    # @return [String]
+    def archives_directory
+      # append '/' in case missing
+      @archives_directory ||= begin
+        dir = fetch(:net_storage_s3_archives_directory)
+        dir.sub(%r{[^/]\Z}, '\&/') if dir
+      end
+    end
+  end
+end

data/lib/capistrano/net_storage/s3/error.rb

@@ -0,0 +1,6 @@
+require 'capistrano/net_storage/s3/base'
+
+class Capistrano::NetStorage::S3
+  class Error < StandardError
+  end
+end

data/lib/capistrano/net_storage/s3/transport.rb

@@ -0,0 +1,17 @@
+require 'forwardable'
+
+require 'capistrano/net_storage/transport/base'
+
+require 'capistrano/net_storage/s3/base'
+require 'capistrano/net_storage/s3/config'
+
+class Capistrano::NetStorage::S3::Transport < Capistrano::NetStorage::Transport::Base
+  extend Forwardable
+  def_delegators :broker, :check, :find_uploaded, :upload, :download
+
+  private
+
+  def broker
+    Capistrano::NetStorage::S3.broker
+  end
+end

data/lib/capistrano/net_storage/s3/version.rb

@@ -0,0 +1,5 @@
+require 'capistrano/net_storage/s3/base'
+
+class Capistrano::NetStorage::S3
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-net_storage-s3
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- progrhyme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano-net_storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A transport plugin of capistrano-net_storage to deploy application via
+  Amazon S3.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-net_storage-s3.gemspec
+- lib/capistrano-net_storage-s3.rb
+- lib/capistrano/net_storage/s3.rb
+- lib/capistrano/net_storage/s3/base.rb
+- lib/capistrano/net_storage/s3/broker/aws_cli.rb
+- lib/capistrano/net_storage/s3/broker/base.rb
+- lib/capistrano/net_storage/s3/config.rb
+- lib/capistrano/net_storage/s3/error.rb
+- lib/capistrano/net_storage/s3/transport.rb
+- lib/capistrano/net_storage/s3/version.rb
+homepage: https://github.com/DeNADev/capistrano-net_storage-s3
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Plugin of capistrano-net_storage for Amazon S3
+test_files: []