capistrano-aws 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36f8068fe4189961d4b658b2327961eba895a6d7
+  data.tar.gz: 964f33859ec0721fb3c3d4680c16eec25d1f76f3
+SHA512:
+  metadata.gz: c45c598219bb94f3df58a60aace8e89d309601bcbaf0de8f67e5cc0bc4217ce40c641396dce549983cf7e073a4e28faf769224b47dab0abd3965d7c9fc32e06b
+  data.tar.gz: 913f99fc03edcebc48f02d39e65debdce046f01bc0c2c3f91f95f20219beee908b88460b61ffd184eab9c2af79ffb83f4fe1a313bf4fff5db928f7d5f7eb21d8

data/.editorconfig

@@ -0,0 +1,3 @@
+[*]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+vendor

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    capistrano-aws (0.0.1)
+      aws-sdk (~> 2.9)
+      colorize (~> 0.8)
+      terminal-table (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    aws-sdk (2.9.15)
+      aws-sdk-resources (= 2.9.15)
+    aws-sdk-core (2.9.15)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.9.15)
+      aws-sdk-core (= 2.9.15)
+    aws-sigv4 (1.0.0)
+    colorize (0.8.1)
+    jmespath (1.3.1)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    terminal-table (1.7.0)
+      unicode-display_width (~> 1.1)
+    unicode-display_width (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-aws!
+  rubocop (~> 0.48)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License (MIT)
+
+Copyright (c) 2017 Fernando Carletti
+
+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,79 @@
+Capistrano AWS
+==============
+
+This gem is slightly based on [cap-ec2](https://github.com/forward3d/cap-ec2), which is not maintained for a while, becoming outdated.
+
+The purpose of this gem is to provide a flexible and simple integration to AWS EC2, exposing the aws-sdk connection in order to allow any customization.
+
+# Requirements
+
+* Capistrano 3
+
+# Installation
+
+Add to your `Gemfile` and run `bundler`:
+```ruby
+gem 'capistrano-aws'
+```
+
+Or install the gem system-wide:
+```bash
+gem install cap-ec2
+```
+
+In your `Capfile`:
+```ruby
+require 'capistrano/aws'
+```
+
+# Configuration
+
+```ruby
+# AWS regions to use.
+set :aws_ec2_regions, ['us-east-1']
+
+# Application name to match application tag.
+set :aws_ec2_application, (proc { fetch(:application) })
+
+# Tag to be used for Capistrano stage.
+set :aws_ec2_stage_tag, 'Stage'
+
+# Tag to be used to match the application.
+set :aws_ec2_application_tag, 'Application'
+
+# Tag to be used for Capistrano roles of the server (comma separated list).
+set :aws_ec2_roles_tag, 'Roles'
+
+# How to contact the instance (:public_ip, :public_dns, :private_ip).
+set :aws_ec2_contact_point, :public_ip
+```
+
+The AWS credentials are loaded from your system. Check https://github.com/aws/aws-sdk-ruby#configuration for more information.
+
+# Usage
+
+The instances must be registered in each stage. In your `config/deploy/<stage_name>.rb`, add the following line:
+
+```ruby
+aws_ec2_register
+```
+
+It will use the instance tags to call the `server` function in capistrano. You can pass a hash as an argument, and it will be merged into the function call:
+
+```ruby
+aws_ec2_register user: 'hello', port: 2222
+```
+
+# Utility tasks
+
+## aws:ec2:instances
+
+List all the instances found for with the current configuration.
+
+```bash
+cap production aws:ec2:instances
+```
+
+# Contributing
+
+Open an issue or make a PR, feel free to contribute!

data/capistrano-aws.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name = 'capistrano-aws'
+  gem.version = '1.0.0'
+  gem.author = 'Fernando Carletti'
+  gem.email = 'contact@fernandocarletti.net'
+  gem.homepage = 'http://github.com/xurumelous/capistrano-aws'
+  gem.summary = 'Integrates capistrano with AWS.'
+  gem.description = 'Allow dynamically add servers based on EC2.'
+
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files -z`.split("\x0").reject { |f| f =~ /^docs/ }
+  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.required_ruby_version = '>= 2.0'
+
+  gem.add_dependency 'aws-sdk', '~>2.9'
+  gem.add_dependency 'terminal-table', '~>1.7'
+  gem.add_dependency 'colorize', '~>0.8'
+
+  gem.add_development_dependency 'rubocop', '~>0.48'
+end

data/lib/capistrano/aws.rb

@@ -0,0 +1,11 @@
+require 'capistrano/aws/ec2/ec2'
+require 'capistrano/dsl/aws'
+extend Capistrano::DSL::Aws
+
+load File.expand_path('../tasks/ec2.rake', __FILE__)
+
+namespace :load do
+  task :defaults do
+    load 'capistrano/aws/defaults.rb'
+  end
+end

data/lib/capistrano/aws/defaults.rb

@@ -0,0 +1,17 @@
+# AWS regions to use.
+set :aws_ec2_regions, ['us-east-1']
+
+# Application name to match application tag.
+set :aws_ec2_application, (proc { fetch(:application) })
+
+# Tag to be used for Capistrano stage.
+set :aws_ec2_stage_tag, 'Stage'
+
+# Tag to be used to match the application.
+set :aws_ec2_application_tag, 'Application'
+
+# Tag to be used for Capistrano roles of the server (comma separated list).
+set :aws_ec2_roles_tag, 'Roles'
+
+# How to contact the instance (:public_ip, :public_dns, :private_ip).
+set :aws_ec2_contact_point, :public_ip

data/lib/capistrano/aws/ec2/ec2.rb

@@ -0,0 +1,77 @@
+require 'singleton'
+require 'aws-sdk'
+
+module Capistrano
+  module Aws
+    # EC2 module.
+    module EC2
+      # Handle EC2.
+      class EC2
+        include Singleton
+
+        def initialize
+          @ec2 = {}
+
+          regions.each do |region|
+            @ec2[region] = ::Aws::EC2::Resource.new(region: region)
+          end
+        end
+
+        def regions
+          fetch(:aws_ec2_regions)
+        end
+
+        def instances
+          application = fetch(:aws_ec2_application)
+          raise 'application not set.' if application.nil?
+
+          instances = []
+
+          filters = [
+            {
+              name: "tag:#{fetch(:aws_ec2_application_tag)}",
+              values: [fetch(:aws_ec2_application)]
+            },
+            {
+              name: "tag:#{fetch(:aws_ec2_stage_tag)}",
+              values: [fetch(:stage)]
+            },
+            {
+              name: 'instance-state-name',
+              values: ['running']
+            }
+          ]
+
+          @ec2.each do |_region, client|
+            client.instances(filters: filters).each do |instance|
+              instances << instance
+            end
+          end
+
+          instances
+        end
+      end
+
+      def self.contact_point(instance)
+        case fetch(:aws_ec2_contact_point)
+        when :private_ip
+          instance.private_ip_address
+        when :public_dns
+          instance.public_dns_name
+        else
+          instance.public_ip_address
+        end
+      end
+
+      def self.parse_tag(instance, tag_name)
+        tag = instance.tags.select { |instance_tag| instance_tag.key == tag_name }.first
+
+        if tag.nil?
+          ''
+        else
+          tag.value
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/aws/ec2/instances_table.rb

@@ -0,0 +1,61 @@
+require 'terminal-table'
+require 'colorize'
+
+module Capistrano
+  module Aws
+    module EC2
+      # Generates instances table.
+      class InstancesTable
+        def initialize(instances)
+          @instances = instances
+        end
+
+        def render
+          table = Terminal::Table.new(
+            style: {
+              border_x: '',
+              border_i: '',
+              border_y: ''
+            }
+          )
+
+          table.add_row header_row
+
+          number = 1
+          @instances.each do |instance|
+            table.add_row instance_row(number, instance)
+            number += 1
+          end
+
+          puts table
+        end
+
+        def header_row
+          [
+            'Num'.colorize(mode: :bold),
+            'ID'.colorize(mode: :bold),
+            'Name'.colorize(mode: :bold),
+            'Type'.colorize(mode: :bold),
+            'Contact Point'.colorize(mode: :bold),
+            'Availability Zone'.colorize(mode: :bold),
+            'Roles'.colorize(mode: :bold),
+            'Stages'.colorize(mode: :bold)
+          ]
+        end
+
+        def instance_row(number, instance)
+          [
+            format('%02d:', number),
+            instance.id.colorize(:red),
+            Capistrano::Aws::EC2.parse_tag(instance, 'Name').colorize(:green),
+            instance.instance_type.colorize(:cyan),
+            Capistrano::Aws::EC2.contact_point(instance).colorize(:blue),
+            instance.placement.availability_zone.colorize(:magenta),
+            Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_roles_tag)).colorize(:yellow),
+            Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_stage_tag)).colorize(:yellow)
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/dsl/aws.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  module DSL
+    # Capistrano Aws module.
+    module Aws
+      def aws_ec2
+        Capistrano::Aws::EC2::EC2.instance
+      end
+
+      def aws_ec2_register(options = {})
+        aws_ec2.instances.each do |instance|
+          ip = Capistrano::Aws::EC2.contact_point(instance)
+          roles = Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_roles_tag)).split(',')
+
+          server ip, options.merge(roles: roles, aws_instance_id: instance.id)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/ec2.rake

@@ -0,0 +1,10 @@
+require 'capistrano/aws/ec2/instances_table'
+
+namespace :aws do
+  namespace :ec2 do
+    desc 'List available instances.'
+    task :instances do
+      Capistrano::Aws::EC2::InstancesTable.new(aws_ec2.instances).render
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-aws
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fernando Carletti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+description: Allow dynamically add servers based on EC2.
+email: contact@fernandocarletti.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- capistrano-aws.gemspec
+- lib/capistrano/aws.rb
+- lib/capistrano/aws/defaults.rb
+- lib/capistrano/aws/ec2/ec2.rb
+- lib/capistrano/aws/ec2/instances_table.rb
+- lib/capistrano/dsl/aws.rb
+- lib/capistrano/tasks/ec2.rake
+homepage: http://github.com/xurumelous/capistrano-aws
+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: Integrates capistrano with AWS.
+test_files: []