s3_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21b7c36e704bf5137f2d5174392c866c6c40eca9
+  data.tar.gz: 77b4b62cbb95ddfb9d4ed8770f59916ffbe8e08f
+SHA512:
+  metadata.gz: a97b9662e324210196b7ffe6422cdab8ace7377cb3835f2391a06ecdcbe1149960d59ae765e6e76da13d9261cc7c7a66d675efef1bbb43fa5a653d7449a92ffb
+  data.tar.gz: af3c01969d935069f520f54270afa510d01dfb93e60a885687c17b309658313d58d6eb024b6f3a9823d4481db11929917f7ff1b3d2da8092ce2886226de4b5d5

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,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.5

data/CREDITS.md

@@ -0,0 +1,7 @@
+# Credits, Notes, and Reference
+ + http://stackoverflow.com/questions/2889720/one-liner-in-ruby-for-displaying-a-prompt-getting-input-and-assigning-to-a-var
+ + https://robots.thoughtbot.com/mygem-configure-block
+ + http://brandonhilkert.com/blog/ruby-gem-configuration-patterns/
+ + http://stackoverflow.com/questions/10584638/setting-up-configuration-settings-when-writing-a-gem
+ + http://docs.aws.amazon.com/sdkforruby/api/index.html
+ +

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 MJ Rossetti (@s2t2)
+
+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,111 @@
+# s3_sync
+
+Securely sync (upload and download) files with [Amazon Simple Storage Service (s3)](http://aws.amazon.com/s3).
+
+Specify credentials, file names, and other options during configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_sync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3_sync
+
+## Usage
+
+### Configuring
+
+Configure the gem to use the same options when uploading and downloading.
+
+```` rb
+S3Sync.configure do |config|
+  config.key_id = "mykey123"
+  config.key_secret = "secret456"
+  config.region = "us-east-1"
+  config.bucket = "my-backups"
+  config.secret_phrase = "my-s3cr3t"
+  config.files = [
+    File.join(Dir.home,".bash_profile"),
+    File.join(Dir.home,".gitconfig"),
+    File.join(Dir.home,".ssh","config")
+  ]
+  config.downloads_dir = File.join(Dir.home,"Desktop","my-s3-downloads")
+end
+````
+
+#### Configuration Options
+
+attribute name | description | default value
+--- | --- | ---
+`key_id` | The s3 user's *Access Key Id*. | N/A
+`key_secret` | The s3 user's *Access Key Secret*. | N/A
+`region` | The s3 region. | N/A
+`bucket` | The s3 bucket (top-level directory) name. | N/A
+`secret_phrase` | The phrase to use when encrypting and decrypting files. | N/A
+`files` | A list of local file paths to be synced. | N/A
+`downloads_dir` | A staging directory to house downloaded files. | `File.join(Dir.home,"Desktop","s3-downloads")`
+
+### Uploading
+
+Upload files from your computer to s3.
+
+```` rb
+S3Sync::Upload.new
+````
+
+The uploads bucket gets created automatically, and can be configured with `config.bucket`.
+
+### Downloading
+
+Download files from s3 to your computer.
+
+```` rb
+S3Sync::Download.new
+````
+
+Files are downloaded to a staging directory, which can be configured with `config.downloads_dir`. The staging directory helps mitigate the risk of accidentally over-writing local files.
+
+## Prerequisites
+
+Create an [AWS Identity and Access Management (IAM)](http://aws.amazon.com/iam/) user and obtain its *Access Key Id* and *Secret Access Key*.
+
+Create an AWS IAM group.
+
+Create an AWS IAM policy with the *arn:aws:iam::aws:policy/AmazonS3FullAccess* permission set.
+
+Attach the policy to the group.
+
+Add the user to the group.
+
+## Contributing
+
+Browse [existing issues](https://github.com/s2t2/s3-sync-ruby/issues) or create a [new issue](https://github.com/s2t2/s3-sync-ruby/issues/new) to communicate bugs, desired features, etc.
+
+After forking the repo and pushing your changes, create a [pull request](https://github.com/s2t2/s3-sync-ruby/pulls/new) referencing the applicable issue(s).
+
+### Installation
+
+Check out the repo with `git clone git@github.com:s2t2/s3-sync-ruby.git`, and `cd s3-sync-ruby`.
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+### Testing
+
+Run `bundle exec rake` or `bundle exec rspec spec/` 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`.
+
+### Releasing
+
+Update the version number in `version.rb`, then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "s3_sync"
+
+# 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

data/bin/setup

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

data/lib/s3_sync/configuration.rb

@@ -0,0 +1,26 @@
+module S3Sync
+  class Configuration
+    attr_accessor :key_id, :key_secret, :region, :bucket, :secret_phrase, :downloads_dir, :files
+
+    # @param [Hash] options
+    #   @option options [String] :key_id The "Access Key Id" for your s3 user
+    #   @option options [String] :key_secret The "Access Key Secret" for your s3 user
+    #   @option options [String] :region The s3 region
+    #   @option options [String] :bucket The s3 bucket (top-level directory) name
+    #   @option options [String] :secret_phrase The encryption phrase to use when uploading (encrypting) and downloading (decrypting) files
+    #   @option options [Array] :downloads_dir A staging directory to house files downloaded from s3
+    #   @option options [Array] :files A list of local file paths
+    #
+    # @example
+    #   S3Sync::Configuration.new(:key_id => "mykey123", :key_secret => "secret456", :region => "us-east-1", :bucket => "my-backups", :files => [".bash_profile",".gitconfig"], :secret_phrase => "my-s3cr3t")
+    def initialize(options = {})
+      @key_id = options[:key_id]
+      @key_secret = options[:key_secret]
+      @secret_phrase = options[:secret_phrase]
+      @bucket = options[:bucket]
+      @region = options[:region]
+      @downloads_dir = options[:downloads_dir] || File.join(Dir.home,"Desktop","s3-downloads")
+      @files = options[:files]
+    end
+  end
+end

data/lib/s3_sync/download.rb

@@ -0,0 +1,47 @@
+module S3Sync
+  class Download
+    attr_accessor :key_id, :key_secret, :region, :bucket, :secret_phrase, :downloads_dir, :files
+
+    def initialize(options = S3Sync.configuration)
+      @key_id = options.key_id
+      @key_secret = options.key_secret
+      @region = options.region
+      @bucket = options.bucket
+      @secret_phrase = options.secret_phrase
+      @files = options.files
+      @downloads_dir = options.downloads_dir
+      raise "check your configuration" unless [@key_id, @key_secret, @region, @bucket, @secret_phrase, @downloads_dir].map{|s| s.class}.uniq == [String] && @files.is_a?(Array)
+
+      creds = Aws::Credentials.new(@key_id, @key_secret)
+      client = Aws::S3::Client.new(:region => @region, :credentials => creds)
+
+      # Find latest uploads directory.
+
+      object_keys = []
+      objects = client.list_objects(:bucket => @bucket)
+      while objects.last_page? == false
+        object_keys << objects.contents.map{|obj| obj.key}
+        objects = objects.next_page
+      end
+      object_directories = object_keys.flatten.map{|str| str.split("/").first}.compact.uniq
+      days = object_directories.map{|str| Date.parse(str) rescue nil}.compact
+      latest_day = days.max.to_s
+
+      # Create downloads directory.
+
+      FileUtils.mkdir_p(@downloads_dir)
+
+      # Download files.
+
+      files.each do |file|
+        s3_file = File.join(latest_day, file)
+        local_file = File.join(@downloads_dir, @bucket, file)
+        FileUtils.mkdir_p(local_file.gsub(local_file.split("/").last,""))
+        client.get_object({:bucket => @bucket, :key => s3_file}, target: local_file)
+        decrypted_file_contents = Encryptor.decrypt(File.read(local_file), :key => secret_phrase)
+        File.write(local_file, decrypted_file_contents)
+        puts "downloaded and decrypted #{@bucket}/#{s3_file} to #{local_file}"
+      end
+    end
+  end
+end

data/lib/s3_sync/upload.rb

@@ -0,0 +1,35 @@
+module S3Sync
+  class Upload
+    attr_accessor :key_id, :key_secret, :region, :bucket, :secret_phrase, :files
+
+    def initialize(options = S3Sync.configuration)
+      @key_id = options.key_id
+      @key_secret = options.key_secret
+      @region = options.region
+      @bucket = options.bucket
+      @secret_phrase = options.secret_phrase
+      @files = options.files
+      raise "check your configuration" unless [@key_id, @key_secret, @region, @bucket, @secret_phrase].map{|s| s.class}.uniq == [String] && @files.is_a?(Array)
+
+      creds = Aws::Credentials.new(@key_id, @key_secret)
+
+      # Create bucket.
+
+      resource = Aws::S3::Resource.new(:region => @region, credentials: creds)
+      bucket_names = resource.buckets.map{|b| b.name}
+      resource.create_bucket(:bucket => @bucket, :acl => "private") unless bucket_names.include?(@bucket)
+
+      # Upload files
+
+      client = Aws::S3::Client.new(:region => @region, :credentials => creds)
+
+      @files.each do |file|
+        raise "couldn't find file #{file}" unless File.exist?(file)
+        encrypted_file_contents = Encryptor.encrypt(File.read(file), :key => @secret_phrase)
+        s3_file = File.join(Date.today.to_s, file)
+        client.put_object(:bucket => @bucket, :key => s3_file, :body => encrypted_file_contents)
+        puts "uploaded encrypted contents of #{file} to #{@bucket}/#{s3_file}"
+      end
+    end
+  end
+end

data/lib/s3_sync/version.rb

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

data/lib/s3_sync.rb

@@ -0,0 +1,21 @@
+require "aws-sdk"
+require "encryptor"
+
+require "s3_sync/configuration"
+require "s3_sync/download"
+require "s3_sync/upload"
+require "s3_sync/version"
+
+module S3Sync
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= S3Sync::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) #if block_given?
+  end
+end

data/s3_sync.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_sync"
+  spec.version       = S3Sync::VERSION
+  spec.authors       = ["MJ Rossetti (@s2t2)"]
+  spec.email         = ["s2t2mail+git@gmail.com"]
+
+  spec.summary       = %q{Securely sync (upload and download) files with Amazon Simple Storage Service (s3).}
+  spec.description   = %q{Securely sync (upload and download) files with Amazon Simple Storage Service (s3). Specify credentials, file names, and other options during configuration.}
+
+  spec.homepage      = "https://github.com/s2t2/s3-sync-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  ### if spec.respond_to?(:metadata)
+  ###   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  ### else
+  ###   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  ### end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'encryptor'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: s3_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MJ Rossetti (@s2t2)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: encryptor
+  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'
+description: Securely sync (upload and download) files with Amazon Simple Storage
+  Service (s3). Specify credentials, file names, and other options during configuration.
+email:
+- s2t2mail+git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CREDITS.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/s3_sync.rb
+- lib/s3_sync/configuration.rb
+- lib/s3_sync/download.rb
+- lib/s3_sync/upload.rb
+- lib/s3_sync/version.rb
+- s3_sync.gemspec
+homepage: https://github.com/s2t2/s3-sync-ruby
+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
+signing_key: 
+specification_version: 4
+summary: Securely sync (upload and download) files with Amazon Simple Storage Service
+  (s3).
+test_files: []