outatime 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad66a0137663ddd2acc6eb4d723360557dd39c9b
+  data.tar.gz: dbf910aa8229373c9d7d305ab83abcb82c67fcad
+SHA512:
+  metadata.gz: d85e34909a6fd7b71555565e207519fe537c3b416ca625ea5b93b96fa38428c9ecb5eede76812525fb62a326149de5652dfebb592cfc388bedbb10f0d893cc57
+  data.tar.gz: 34f8bc3d299908d13c035475c1a8e21eaf8d53bd0dadc049bc9776723cf62782864b39993da1c8dce37f1e768616cff2fa690bd2d7e91b1f7d231d34e7652a86

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Pressed.net
+
+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,42 @@
+# Outatime
+
+For users of versioned AWS S3 buckets. This command-line tool will allow you to download a snapshot of the files in that bucket from a given point in time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'outatime'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install outatime
+
+## Usage
+
+```
+outatime -r {region} -b {bucket-name} -f {date} -p {subdirectory} --profile {aws profile name}
+```
+
+Example:
+```
+outatime -r us-east-1 -b my-bucket -f '21 Oct 2015' -p schematics/hoverboard --profile aws-profile
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pressednet/outatime.
+
+## LICENSE
+
+MIT License, see [LICENSE](LICENSE) for details.

data/Rakefile

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

data/bin/outatime

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/outatime'
+
+begin
+  options = Trollop::options do
+    opt :region, "AWS region", type: :string, default: "us-west-2"
+    opt :bucket, "Bucket name", type: :string, required: true
+    opt :from, "Time description", type: :string, required: true
+    opt :prefix, "Restore files from this prefix", type: :string, default: ""
+    opt :destination, "Destination for restored files", type: :string, required: true
+    opt :profile, "AWS Profile Name", type: :string, required: false, default: nil
+    opt :threads, "Number of download threads", type: :integer, default: 20
+    opt :verbose, "Verbose Mode", type: :boolean, default: false
+  end
+
+  if options[:profile]
+    Outatime.update_aws_profile(
+      region:      options[:region],
+      credentials: Aws::SharedCredentials.new(profile_name: options[:profile])
+    )
+  end
+
+  Outatime::CLI.new(options).run
+
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/lib/outatime.rb

@@ -0,0 +1,20 @@
+require "aws-sdk"
+require "chronic"
+require "pathname"
+require "ruby-progressbar"
+require "thread"
+require "trollop"
+require_relative "outatime/version"
+require_relative "outatime/fetcher"
+require_relative "outatime/cli"
+
+module Outatime
+  # Public: Update AWS profile
+  #
+  # params - Hash of profile settings.
+  #
+  # Returns nothing.
+  def self.update_aws_profile(params)
+    Aws.config.update(params)
+  end
+end

data/lib/outatime/cli.rb

@@ -0,0 +1,35 @@
+module Outatime
+  class CLI
+    attr_accessor :options
+
+    # Public: It will fetch the correct version of a file from S3 and shows a
+    # progress bar to indicate its progress.
+    #
+    # options - The Hash options used to configure how fetcher works:
+    #           :region      - The AWS region.
+    #           :bucket      - The versioned bucket name.
+    #           :from        - Time description.
+    #           :prefix      - Restore files from this prefix.
+    #           :destination - Destination for restored files
+    #           :threads     - Number of download threads
+    #           :verbose     - Verbose Mode
+    #
+    def initialize(options)
+      @options = options
+    end
+
+    # Public: Runs the fetcher and download the correct files version.
+    def run
+      fetcher = Outatime::Fetcher.new(options)
+
+      pb = ProgressBar.create(total: fetcher.total_size,
+                              format: "%t: |%B| %f %c/%C %R MB/sec",
+                              rate_scale: lambda { |rate| rate / 1024 / 1024 },
+                              throttle_rate: 0.5)
+
+      fetcher.fetch! do |file|
+        pb.progress += file.size
+      end
+    end
+  end
+end

data/lib/outatime/fetcher.rb

@@ -0,0 +1,142 @@
+module Outatime
+  class Fetcher
+    attr_accessor :options
+
+    # Public: Fetcher will fetch the correct version of a file from S3.
+    #
+    # options - The Hash options used to configure how fetcher works:
+    #           :bucket      - The versioned bucket name (required).
+    #           :destination - Destination for restored files (required).
+    #           :from        - Time description (required).
+    #           :prefix      - Restore files from this prefix.
+    #           :s3_client   - An existing Aws::S3::Client.
+    #           :threads     - Number of download threads
+    #           :verbose     - Verbose Mode
+    #
+    def initialize(options = {})
+      @options           = options
+      @files_mutex       = Mutex.new
+      @fetch_block_mutex = Mutex.new
+      @s3_client         = options[:s3_client] if options[:s3_client]
+      @from = ::Chronic.parse(@options[:from]) if @options[:from]
+
+      # raise if the date/time was not parsed
+      raise ArgumentError, "The from time was not parseable." if @from.nil?
+    end
+
+    # Public: Fetches the file versions from S3 bucket.
+    #
+    # block - an optional block that receives the file description after it is
+    # downloaded to the local.
+    #
+    # Returns nothing.
+    def fetch!(&block)
+      fetch_objects(object_versions, &block)
+    end
+
+    # Public: Returns the objects total size.
+    #
+    # Returns an integer.
+    def total_size
+      object_versions.inject(0) { |sum, obj| sum += obj.size }
+    end
+
+    # Public: Fetch the S3 object versions.
+    #
+    # Returns an Array of Aws::S3::Types::ObjectVersion.
+    def object_versions
+      puts "fetching object versions from #{@from}" if verbose?
+      @files ||= begin
+        versions = []
+        delete_markers = []
+
+        s3_client.list_object_versions(bucket: @options[:bucket],
+          prefix: @options[:prefix]).each do |response|
+
+          versions       += filter_future_items(response.versions, @from)
+          delete_markers += filter_future_items(response.delete_markers, @from)
+        end
+
+        # keep only the latest versions
+        # AWS lists the latest versions first, so it should be OK to use uniq here.
+        versions.uniq!       { |obj| obj.key }
+        delete_markers.uniq! { |obj| obj.key }
+
+        delete_marker_keys = delete_markers.map { |dm| dm.key }
+
+        # check versions to see if we have newer delete_markers
+        # if so, delete those versions
+        versions.delete_if do |version|
+          if dm_index = delete_marker_keys.index(version.key)
+            if version.last_modified <= delete_markers[dm_index].last_modified
+              true
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    # Private: Checks if it is in verbose mode.
+    #
+    # Returns a boolean.
+    def verbose?
+      @options[:verbose]
+    end
+
+    # Private: Fetches the objects from S3 bucket.
+    #
+    # files - an Array of Aws::S3::Types::ObjectVersion.
+    #
+    # Returns nothing.
+    def fetch_objects(files)
+      threads = []
+
+      @options[:threads].times do
+        threads << Thread.new do
+          while !(file = @files_mutex.synchronize { files.pop }).nil? do
+            dest = Pathname.new("#{@options[:destination]}/#{file.key}")
+
+            if file.key.end_with?("/")
+              puts "Creating s3 subdirectory #{file.key} - #{Time.now}" if verbose?
+              dest.mkpath
+            else
+              dest.dirname.mkpath
+
+              puts "Copying from s3 #{file.key} - #{Time.now}" if verbose?
+              s3_client.get_object(response_target: "#{dest}",
+                            bucket: @options[:bucket],
+                            key: file.key,
+                            version_id: file.version_id)
+            end
+
+            @fetch_block_mutex.synchronize { yield file } if block_given?
+          end
+        end
+      end
+
+      threads.map(&:join)
+    end
+
+    # Private: Creates the S3 client instance.
+    #
+    # Returns an Aws::S3::Client.
+    def s3_client
+      region = @options[:region] || ENV["AWS_REGION"]
+      @s3_client ||= Aws::S3::Client.new(region: region)
+    end
+
+    # Private: Returns an Array of items modified on or before the given date/time.
+    #
+    # items - An Array of objects. Object must respond to #last_modified.
+    # date_time - Comparison date/time.
+    #
+    # Returns Array.
+    def filter_future_items(items, date_time)
+      items.find_all do |obj|
+        obj.last_modified <= @from
+      end
+    end
+  end
+end

data/lib/outatime/version.rb

@@ -0,0 +1,3 @@
+module Outatime
+  VERSION = "0.2.0"
+end

data/outatime.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outatime/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "outatime"
+  spec.version       = Outatime::VERSION
+  spec.authors       = ["Justin Mazzi", "Rubem Nakamura", "Mike Boone"]
+  spec.email         = ["justin@pressed.net", "rubem.nakamura@pressed.net", "mike.boone@pressed.net"]
+
+  spec.summary       = %q{Choose versioned S3 files from a point in time.}
+  spec.description   = %q{Choose file versions from a versioned S3 bucket based on a given time.}
+  spec.homepage      = "https://github.com/pressednet/outatime/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "aws-sdk", "~> 2.6", ">= 2.6.14"
+  spec.add_runtime_dependency "chronic", "~> 0.10.2"
+  spec.add_runtime_dependency "ruby-progressbar", "~> 1.8.1"
+  spec.add_runtime_dependency "thread", "~> 0.2.2"
+  spec.add_runtime_dependency "trollop", "~> 2.1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport", "~> 5.0.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: outatime
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Justin Mazzi
+- Rubem Nakamura
+- Mike Boone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 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.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.14
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: thread
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.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'
+description: Choose file versions from a versioned S3 bucket based on a given time.
+email:
+- justin@pressed.net
+- rubem.nakamura@pressed.net
+- mike.boone@pressed.net
+executables:
+- outatime
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/outatime
+- lib/outatime.rb
+- lib/outatime/cli.rb
+- lib/outatime/fetcher.rb
+- lib/outatime/version.rb
+- outatime.gemspec
+homepage: https://github.com/pressednet/outatime/
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Choose versioned S3 files from a point in time.
+test_files: []