aws-rsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45ef533111eb698d4ad5dc531b5c4aeda473f8f20071ac16e96aab269619f55f
+  data.tar.gz: 11a0cfe34f59d1f15b2ad1c42e6c1fcd81d5bd50d868c16e7f499bd09992a069
+SHA512:
+  metadata.gz: 6dcd4ec76f9ddcea259941cc1749c78513ecefd7455a265654159fbc9224159aadcca477e5bb00cc40db577d2e83fdd8548cb7f22efd09ea364c1468b918f10e
+  data.tar.gz: 4a0d6d9717a75583b83f9ea9ac4c6182c42ef68986a2ffe73db1ae5b0e1352b81eafdee16e2ded50867aa7ed2249f45ff826fda32710357d67da076d142c588a

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [0.1.0]
+- Initial release.
+- initial aws-rsync sync command
+- watch mode working
+- AWS_RSYNC_EXCLUDE AWS_RSYNC_OPTIONS override abilities

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem dependencies in aws_rsync.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    aws-rsync (0.1.0)
+      colorize
+      filewatcher
+      hashie
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.0)
+    codeclimate-test-reporter (0.4.4)
+      simplecov (>= 0.7.1, < 1.0.0)
+    colorize (0.8.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    filewatcher (1.0.1)
+      trollop (~> 2.1, >= 2.1.2)
+    hashie (3.5.7)
+    multi_json (1.10.1)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thor (0.20.0)
+    trollop (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-rsync!
+  bundler
+  byebug
+  codeclimate-test-reporter
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tung Nguyen
+
+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,48 @@
+# AwsRsync
+
+Rsync local files to an AWS EC2 instance for a faster development flow.
+
+This tool is useful for working with single EC2 instances.  It takes the instance's id as the main argument and uses it to look up the instance's IP address. It then rsyncs your local project folder to a folder on the specified EC2 instance.
+
+Some convenient things the tool does:.
+
+* rsync default options are provided.
+* The rsync exclude option is derived from the `.gitignore` and `.dockerignore` files in the local folding being sync.
+
+
+## Usage
+
+```sh
+aws-rsync sync INSTANCE_ID
+```
+
+Examples:
+
+```sh
+aws-rsync sync i-123456789
+aws-rsync sync i-123456789 --watch
+aws-rsync sync i-123456789 --private-ip
+aws-rsync sync i-123456789 --private-ip --watch
+aws-rsync sync i-123456789 --noop
+```
+
+## Overriding the rsync command
+
+You can override the rsync command that gets used with 2 environment variables:
+
+* AWS_RSYNC_OPTIONS: Override the rsync main options used.
+* AWS_RSYNC_EXCLUDE: Override the rsync exclude options used.
+
+## Installation
+
+```sh
+$ gem install aws-rsync
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/aws-rsync.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aws_rsync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "aws-rsync"
+  spec.version       = AwsRsync::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.description   = %q{Tool rsyncs local files to AWS EC2 instance for a faster development flow}
+  spec.summary       = %q{Tool rsyncs local files to AWS EC2 instance for a faster development flow}
+  spec.homepage      = "https://github.com/tongueroo/aws-rsync"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+  spec.add_dependency "filewatcher"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/exe/aws-rsync

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 1
+  exit
+}
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "aws-rsync"
+require "aws_rsync/cli"
+
+AwsRsync::CLI.start(ARGV)

data/lib/aws-rsync.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "aws_rsync/version"
+require "colorize"
+
+module AwsRsync
+  autoload :Help, "aws_rsync/help"
+  autoload :Command, "aws_rsync/command"
+  autoload :CLI, "aws_rsync/cli"
+  autoload :AwsServices, "aws_rsync/aws_services"
+  autoload :Sync, "aws_rsync/sync"
+  autoload :Host, "aws_rsync/host"
+  autoload :Watch, "aws_rsync/watch"
+end

data/lib/aws_rsync/aws_services.rb

@@ -0,0 +1,7 @@
+require 'aws-sdk-ec2'
+
+module AwsRsync::AwsServices
+  def ec2
+    @ec2 ||= Aws::EC2::Client.new
+  end
+end

data/lib/aws_rsync/cli.rb

@@ -0,0 +1,26 @@
+module AwsRsync
+  class CLI < Command
+    class_option :noop, type: :boolean
+
+    desc "sync INSTANCE_ID", "rsync files on your local machine to a server"
+    long_desc Help.text(:sync)
+    option :watch, type: :boolean, desc: "watches your folder for changes and re-runs sync"
+    option :private_ip, type: :boolean, desc: "whether to use the private or public ip address"
+    option :folder, default: File.basename(Dir.pwd), desc: "the destination folder"
+    option :user, default: "ec2-user", desc: "user to use to connect to server"
+    option :cwd, default: ".", desc: "The local directory to sync"
+    def sync(instance_id)
+      merged_options = options.merge(instance_id: instance_id)
+      if @options[:watch]
+        Watch.new(merged_options).run
+      else
+        Sync.new(merged_options).run
+      end
+    end
+
+    desc "version", "prints version"
+    def version
+      puts AwsRsync::VERSION
+    end
+  end
+end

data/lib/aws_rsync/command.rb

@@ -0,0 +1,46 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module AwsRsync
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   aws_rsync command help
+        #   aws_rsync command -h
+        #   aws_rsync command --help
+        #   aws_rsync command -D
+        #
+        # as well thor's normal way:
+        #
+        #   aws_rsync help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   aws_rsync --version
+        #   aws_rsync -v
+        version_flags = ["-v", "--version"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/aws_rsync/help.rb

@@ -0,0 +1,9 @@
+module AwsRsync::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/aws_rsync/help/sync.md

@@ -0,0 +1,11 @@
+Rsync local folder to an EC2 instance so you can quickly develop and test. Example:
+
+  $ aws-rsync sync i-123456789
+
+To watch changed files and re-run rsync automatically, use the --watch flag. Example:
+
+  $ aws-rsync sync i-123456789 --watch
+
+By default, the public ip address of the ec2 instance is used.  If you would like to use the private ip address instead, use the --private-ip flag. Example:
+
+  $ aws-rsync sync i-123456789 --private-ip

data/lib/aws_rsync/host.rb

@@ -0,0 +1,41 @@
+module AwsRsync
+  class Host
+    include AwsServices
+
+    def initialize(options={})
+      @options = options
+      @instance_id = options[:instance_id]
+    end
+
+    def instance
+      instance = find_instance
+      unless instance
+        puts "ERROR: unable to find instance '#{@instance_id}' in this aws account and region: #{region}"
+        exit 1
+      end
+      instance
+    end
+
+    def find_instance
+      instances = ec2.describe_instances(instance_ids: [@instance_id]).
+        reservations.first["instances"] || []
+      instance = instances.first
+    rescue Aws::EC2::Errors::ServiceError => e
+      puts "ERROR: Could not find the instance #{@instance_id}".colorize(:red)
+      puts e.message
+      puts "For the full internal backtrace re-run the command with DEBUG=1" unless ENV['DEBUG']
+      puts e.backtrace if ENV['DEBUG']
+      exit 1
+    end
+
+    def region
+      `aws configure get region`.strip rescue 'us-east-1'
+    end
+
+    def ip
+      @options[:private_ip] ?
+        instance.private_ip_address :
+        instance.public_ip_address
+    end
+  end
+end

data/lib/aws_rsync/sync.rb

@@ -0,0 +1,92 @@
+module AwsRsync
+  class Sync
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      puts "=> #{command}".colorize(:green)
+      return if @options[:noop]
+      success = system(command)
+      unless success
+        puts "ERROR: rsync command failed".colorize(:red)
+        exit 1
+      end
+      note_time
+    end
+
+    def command
+      main_options = build_main_options
+      exclude = build_exclude_options
+      options = "#{main_options} #{exclude}"
+      dest = "#{user}@#{host.ip}:#{folder}"
+
+      "rsync #{options} #{src} #{dest}"
+    end
+
+    # A default set of options is provided.
+    # You can override this with the environment variable AWS_RSYNC_OPTIONS.
+    #
+    def build_main_options
+      return ENV['AWS_RSYNC_OPTIONS'] if ENV['AWS_RSYNC_OPTIONS']
+
+      # --numeric-ids               don't map uid/gid values by user/group name
+      # --safe-links                ignore symlinks that point outside the tree
+      # -a, --archive               recursion and preserve almost everything (-rlptgoD)
+      # -x, --one-file-system       don't cross filesystem boundaries
+      # -z, --compress              compress file data during the transfer
+      # -S, --sparse                handle sparse files efficiently
+      # -v, --verbose               verbose
+      #     --delete                delete extraneous files from destination dirs
+      #
+      "--delete --numeric-ids --safe-links -axzSv"
+    end
+
+    # The rsync exclude options are automatically calculated and added with some
+    # sane defaults. You can override the options with the environment variable
+    # AWS_RSYNC_EXCLUDE.  To have no exclude options at all use a blank string:
+    # AWS_RSYNC_EXCLUDE=''
+    def build_exclude_options
+      return ENV['AWS_RSYNC_EXCLUDE'] if ENV['AWS_RSYNC_EXCLUDE']
+
+      exclude = %w/.git tmp log/ # default values
+      exclude += get_excludes('.gitignore')
+      exclude += get_excludes('.dockerignore')
+      exclude = exclude.uniq.map{|path| "--exclude='#{path}'"}.join(' ')
+      exclude
+    end
+
+    def user
+      @options[:user] || "ec2-user"
+    end
+
+    def host
+      @host ||= Host.new(@options)
+    end
+
+    # destination folder
+    def folder
+      src = src == '.' ? Dir.pwd : src
+      @options[:folder] || File.basename(src)
+    end
+
+    def src
+      src = @options[:cwd] || Dir.pwd
+      src[-1] == '/' ? src : "#{src}/" # ensure trailing /
+    end
+
+    def get_excludes(file)
+      exclude = []
+      path = "#{@options[:cwd]}/#{file}"
+      if File.exist?(path)
+        exclude = File.read(path).split("\n")
+      end
+      result = exclude.map {|i| i.strip}.reject {|i| i =~ /^#/ || i.empty?}
+      result
+    end
+
+    def note_time
+      puts "Last synced at: #{Time.now}".colorize(:green)
+    end
+  end
+end

data/lib/aws_rsync/version.rb

@@ -0,0 +1,3 @@
+module AwsRsync
+  VERSION = "0.1.0"
+end

data/lib/aws_rsync/watch.rb

@@ -0,0 +1,22 @@
+require 'filewatcher'
+
+module AwsRsync
+  class Watch
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      Dir.chdir(@options[:cwd]) do
+        puts "Watching dir #{@options[:cwd]}"
+        ignore = %w[. .. .git log tmp] # TODO: dynamically look up ignores
+        files = Dir.glob(['.*','*']) - ignore
+        return false if @options[:noop]
+        Sync.new(@options).run
+        Filewatcher.new(files).watch() do |filename, event|
+          Sync.new(@options).run
+        end
+      end
+    end
+  end
+end

data/spec/lib/cli_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+# to run specs with what"s remembered from vcr
+#   $ rake
+#
+# to run specs with new fresh data from aws api calls
+#   $ rake clean:vcr ; time rake
+describe AwsRsync::CLI do
+  before(:all) do
+    @args = "--from Tung"
+  end
+
+  describe "aws-rsync" do
+    it "should hello world" do
+      out = execute("exe/aws-rsync hello world #{@args}")
+      expect(out).to include("from: Tung\nHello world")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+ENV["TEST"] = "1"
+
+# require "simplecov"
+# SimpleCov.start
+
+require "pp"
+
+root = File.expand_path("../../", __FILE__)
+require "#{root}/lib/aws-rsync"
+
+module Helpers
+  def execute(cmd)
+    puts "Running: #{cmd}" if ENV["DEBUG"]
+    out = `#{cmd}`
+    puts out if ENV["DEBUG"]
+    out
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: aws-rsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: colorize
+  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: filewatcher
+  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: byebug
+  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: Tool rsyncs local files to AWS EC2 instance for a faster development
+  flow
+email:
+- tongueroo@gmail.com
+executables:
+- aws-rsync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws-rsync.gemspec
+- exe/aws-rsync
+- lib/aws-rsync.rb
+- lib/aws_rsync/aws_services.rb
+- lib/aws_rsync/cli.rb
+- lib/aws_rsync/command.rb
+- lib/aws_rsync/help.rb
+- lib/aws_rsync/help/sync.md
+- lib/aws_rsync/host.rb
+- lib/aws_rsync/sync.rb
+- lib/aws_rsync/version.rb
+- lib/aws_rsync/watch.rb
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tongueroo/aws-rsync
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Tool rsyncs local files to AWS EC2 instance for a faster development flow
+test_files:
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb