s5 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc684faafc38e71b4030a868526c0023c98420b7
+  data.tar.gz: 2ec967791830fd872100f6ad6cdf5ed876355760
+SHA512:
+  metadata.gz: 34d07d8a1643313dcf809bdd2b2f25e94b45a5437edba07744f3b3fdb7de02723d0ff86055eb54d127e7f9de9fcec56d4b3b9dfb267fc582ca4b87f35f3b4fa5
+  data.tar.gz: 2639fbe2eef0226e4de69f156b11587d4f70003fe7133e64050099cb7aace5599553f36f5b386a6d8aea47d38369350643f8979b7221aafe577c39758aa9fcf1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 yalab
+
+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,37 @@
+# S5
+
+Secure Sync to Amazon S3(Simple Storage Service).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 's5'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s5
+
+## Usage
+
+For exapme. ~/project directory sync to 'yalab-project' S3 bucket.
+
+```bash
+$ s5 observe ~/project --backet="YOUR_BUCKET_NAME"
+```
+
+Files under ~/project directory will client side encryption and put to S3 bucekt. 
+
+You *must backup* the encryption key. It is to create on **~/.s5.key**.
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/s5/*test.rb']
+  t.verbose = true
+end

data/bin/s5

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "s5/cli"
+wait = 120
+begin
+  S5::Cli.start
+rescue SocketError => e
+  STDERR.puts e
+  STDERR.puts "restart after #{wait} sec."
+  sleep wait
+  retry
+end

data/lib/s5.rb

@@ -0,0 +1,8 @@
+require "aws-sdk"
+
+module S5
+  autoload :Cli,     's5/cli'
+  autoload :Daemon,  's5/daemon'
+  autoload :Sync,    's5/sync'
+  autoload :VERSION, 's5/version'
+end

data/lib/s5/cli.rb

@@ -0,0 +1,18 @@
+require 'thor'
+require 's5'
+
+class S5::Cli < Thor
+  class_option :help, type: :boolean, aliases: '-h', desc: 'Print help message.'
+
+  desc "observe DIRECTORIES", "Observe the DIRECTORIES to sync S3"
+  method_option :bucket, type: :string, default: nil, aliases: '-b', desc: 'Set bucket name.'
+  def observe(directory)
+    if options[:help]
+      S5::Cli.command_help(shell, 'observe')
+      exit
+    end
+    daemon = S5::Daemon.new(directory, bucket_name: options[:bucket])
+    daemon.start
+    daemon
+  end
+end

data/lib/s5/daemon.rb

@@ -0,0 +1,52 @@
+require 'fssm'
+
+class S5::Daemon
+  attr_reader :pid
+  def initialize(*paths, bucket_name: nil)
+    @syncs = paths.map{|path|
+      sync = S5::Sync.new(local_path: path, remote_bucket: bucket_name)
+      sync.encrypt!
+      [path, sync]
+    }
+  end
+
+  def start
+    @pid = fork do
+      observe
+    end
+  end
+
+  def stop
+    Process.kill :QUIT, @pid
+  end
+
+  def observe
+    observers = @syncs.map!{|path, sync|
+      sync.sync!
+      [path, create_or_update(sync), delete(sync)]
+    }
+    FSSM.monitor do
+      observers.each do |_, create_or_update, delete_proc|
+        path _ do
+          glob '**/*'
+          create &create_or_update
+          update &create_or_update
+          delete &delete_proc
+        end
+      end
+    end
+  end
+
+  private
+  def create_or_update(sync)
+    ->(base, relative){
+      sync.put(relative)
+    }
+  end
+
+  def delete(sync)
+    ->(base, relative){
+      sync.delete(relative)
+    }
+  end
+end

data/lib/s5/sync.rb

@@ -0,0 +1,104 @@
+class S5::Sync
+  attr_reader :remote_bucket
+
+  def self.encrypt_key_path
+    ENV['HOME'] + '/.s5.key'
+  end
+
+  def initialize(local_path: nil, remote_bucket: nil)
+    raise "You must set local_path argument." unless local_path
+    @local_path = local_path.to_s
+    @remote_bucket = remote_bucket || AWS.iam.users.first.name + '-s5sync'
+    @options = {}
+  end
+
+  def delete(key)
+    (path, s3_key) = generate_path_and_key(key)
+    s3_object(s3_key).tap{|o| o.delete }
+  end
+
+  def encrypt!
+    key_path = self.class.encrypt_key_path
+    unless File.exists?(key_path)
+      File.open(key_path, 'w:BINARY', 0600) do |f|
+        f.write OpenSSL::Cipher::AES256.new(:CBC).random_key
+      end
+    end
+    @options[:server_side_encryption] = :aes256
+    @options[:encryption_key] = File.binread(key_path)
+  end
+
+  def get(key)
+    (path, s3_key) = generate_path_and_key(key)
+    FileUtils.mkdir_p(File.dirname(path))
+    File.open(path, 'wb') do |f|
+      f.write s3_object(s3_key).read(@options)
+    end
+  end
+
+  def local_list
+    raise unless @local_path
+    offset = @local_path.to_s.length + 1
+    Hash[Dir.glob(@local_path + '/**/*').to_a.map{|f|
+           next unless File.file?(f)
+           [f[offset..-1], File.mtime(f)]
+         }.compact]
+  end
+
+  def put(key)
+    (path, s3_key) = generate_path_and_key(key)
+    s3_object(s3_key).write(File.binread(path), @options)
+  end
+
+  def remote_list
+    Hash[s3_objects.to_a.map do |object|
+      [object.key, object.last_modified]
+    end.sort_by{|o| o.first }]
+  end
+
+  def sync!
+    local_list = self.local_list
+    remote_list = self.remote_list
+    need_put = local_list.select do |name, mtime|
+      if remote_list[name] && mtime <= remote_list[name]
+        remote_list.delete(name)
+        false
+      else
+        true
+      end
+    end
+    need_put.each do |name, mtime|
+      self.put name
+    end
+    remote_list.each do |key, last_modified|
+      self.get key
+    end
+  end
+
+  private
+  def s3_bucket
+    s3 = AWS.s3
+    _bucket = s3.buckets[@remote_bucket]
+    if _bucket.exists?
+      _bucket
+    else
+      s3.buckets.create(@remote_bucket)
+    end
+  end
+
+  def s3_object(key)
+    s3_objects[key]
+  end
+
+  def s3_objects
+    s3_bucket.objects
+  end
+
+  def generate_path_and_key(path)
+    if Pathname.new(path).absolute?
+      [path, File.basename(path)]
+    else
+      [File.join(@local_path, path), path]
+    end
+  end
+end

data/lib/s5/version.rb

@@ -0,0 +1,3 @@
+module S5
+  VERSION = "0.0.1"
+end

data/s5.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's5/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s5"
+  spec.version       = S5::VERSION
+  spec.authors       = ["yalab"]
+  spec.email         = ["rudeboyjet@gmail.com"]
+  spec.description   = %q{Secure Sync to Amazon S3. }
+  spec.summary       = %q{This gem provides Amazon S3 sync with client side encryption.}
+  spec.homepage      = "https://github.com/yalab/s5"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk"
+  spec.add_dependency "fssm"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/s5/bootstrap_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class S5::BootstrapTest < S5::Test
+  def setup
+    bucket_name = "#{ENV['USER']}-s5-test-bootstrap"
+    s3 = AWS.s3
+    @bucket = s3.buckets.create(bucket_name)
+    @local_dir = File.expand_path('../../bootstrap_test', __FILE__)
+    setup_local
+    setup_remote
+    @sync = S5::Sync.new(local_path: @local_dir, remote_bucket: bucket_name)
+  end
+
+  def teardown
+    @bucket.delete!
+    FileUtils.rm_rf(@local_dir)
+  end
+
+  def setup_remote
+    @remote_object_name = 'remote'
+    object = @bucket.objects[@remote_object_name].write("remotetest")
+    @last_modified = object.last_modified
+  end
+
+  def setup_local
+    @local_file_name = 'local.txt'
+    FileUtils.mkdir_p(@local_dir)
+    File.open(@local_dir + "/#{@local_file_name}", 'w') do |f|
+      f.write("localtest")
+      @mtime = f.mtime
+    end
+  end
+
+  def test_remote_list
+    expect = {@remote_object_name => @last_modified}
+    assert_equal expect, @sync.remote_list
+  end
+
+  def test_local_list
+    FileUtils.mkdir_p(@local_dir + '/dir')
+    expect = {@local_file_name => @mtime}
+    assert_equal expect, @sync.local_list
+  end
+
+  def test_sync!
+    @sync.sync!
+    assert_equal @sync.remote_list.keys.sort, @sync.local_list.keys.sort
+  end
+end

data/test/s5/cli_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class S5::CliTest < S5::Test
+  def test_observe_directory
+    daemon = S5::Cli.new.observe(@fixtures_path.to_s)
+    assert daemon.pid
+    sleep 0.1
+    daemon.stop
+  end
+end

data/test/s5/daemon_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class S5::DaemonTest < S5::Test
+  class DaemonFiber < S5::Daemon
+    attr_accessor :fiber
+    def observe
+      @fiber = Fiber.new do
+        super
+      end
+    end
+
+    %w(create_or_update delete).each do |name|
+      module_eval <<-METHOD, __FILE__, __LINE__
+        def #{name}(*args)
+          proc = super
+          ->(base, relative){
+            proc.call(base, relative).tap{
+              Fiber.yield
+            }
+          }
+        end
+      METHOD
+    end
+
+    def resume
+      @fiber.resume
+    end
+  end
+
+  def setup
+    super
+    @bucket_name = "#{ENV["USER"]}-s5-daemon-test"
+    @daemon = DaemonFiber.new(@fixtures_path, bucket_name: @bucket_name)
+    @path = @fixtures_path.join(Time.now.to_f.to_s)
+    FileUtils.rm_rf @path
+  end
+
+  def teardown
+    super
+    bucket.delete! if bucket.exists? && bucket.versioned?
+  end
+
+  def test_sync_when_initialize
+    sync = S5::Sync.new(local_path: @fixtures_path,
+                        remote_bucket: @bucket_name)
+    assert_equal sync.remote_list.keys.sort, sync.local_list.keys.sort
+  end
+
+  def test_touch_new_file_and_delete
+    @daemon.observe
+    user_context{ FileUtils.touch @path }
+    @daemon.resume
+    key = File.basename(@path)
+    assert true, s3_object(key).exists?
+
+    user_context{ FileUtils.rm_rf(@path) }
+    @daemon.resume
+    assert_raises AWS::S3::Errors::NoSuchKey do
+      s3_object(key).read
+    end
+  end
+
+  private
+  def user_context
+    fork do
+      sleep 0.5
+      yield
+    end
+  end
+
+  def s3_object(key)
+    bucket.objects[key]
+  end
+
+  def bucket
+    AWS.s3.buckets[@bucket_name]
+  end
+end

data/test/s5/sync_test.rb

@@ -0,0 +1,98 @@
+require 'test_helper'
+
+class S5::SyncTest < S5::Test
+  def setup
+    super
+    @encrypt_key_path = S5::Sync.encrypt_key_path
+    @encrypt_key_path_backup = @encrypt_key_path + '.s5_test'
+    if File.exists?(@encrypt_key_path)
+      FileUtils.mv @encrypt_key_path, @encrypt_key_path_backup
+    end
+    @remote_bucket = "#{ENV['USER']}-s5-test"
+    @sync = S5::Sync.new(local_path: @fixtures_path, remote_bucket: @remote_bucket)
+  end
+
+  def teardown
+    super
+    if File.exists?(@encrypt_key_path_backup)
+      FileUtils.mv @encrypt_key_path_backup, @encrypt_key_path
+    end
+    bucket = @sync.send(:s3_bucket)
+    bucket.delete! if bucket.exists? && bucket.versioned?
+  end
+
+  class DefaultValues < self
+    def test_encrypt_key_path
+      assert_equal ENV['HOME'] + '/.s5.key', S5::Sync.encrypt_key_path
+    end
+  end
+
+  module SyncPutGetTest
+    def test_sync_put_get
+      s3_object = @sync.put(@path)
+      assert_equal @plain, s3_object.read
+      FileUtils.rm_rf(File.dirname(@path))
+      @sync.get(@path)
+      assert_equal @plain, File.read(@path)
+    end
+
+    def test_sync_put_with_encrypt
+      @sync.encrypt!
+      assert File.exists?(S5::Sync.encrypt_key_path)
+      s3_object = @sync.put(@path)
+      refute_equal @plain, s3_object.read
+      assert_equal @plain, s3_object.read(encryption_key: File.binread(@encrypt_key_path))
+      FileUtils.rm_rf(File.dirname(@path))
+      @sync.get(@path)
+      assert_equal @plain, File.binread(@path)
+    end
+  end
+
+  class SinglePathTest < self
+    include SyncPutGetTest
+    def setup
+      super
+      @plain = Digest::SHA2.hexdigest(Time.now.to_f.to_s) + 'test'
+      @path = @fixtures_path.join('test.txt')
+      File.open(@path, 'w') do |f|
+        f.write @plain
+      end
+    end
+
+    def test_default_remote_bucket
+      assert_match '-s5sync', S5::Sync.new(local_path: @fixtures_path).remote_bucket
+    end
+  end
+
+  class RelativePathTest < self
+    include SyncPutGetTest
+    def setup
+      super
+      @plain = Digest::SHA2.hexdigest(Time.now.to_f.to_s) + 'test'
+      @key = 'fixtures/test.txt'
+      basedir = File.expand_path('../../', __FILE__)
+      @sync = S5::Sync.new(local_path: basedir, remote_bucket: @remote_bucket)
+      @path = basedir + '/' + @key
+      FileUtils.mkdir_p File.dirname(@path)
+      File.open(@path, 'w') do |f|
+        f.write @plain
+      end
+    end
+
+    def test_object_path
+      s3_object = @sync.put(@key)
+      assert_equal @key, s3_object.key
+      FileUtils.rm_rf(File.dirname(@path))
+      @sync.get(@key)
+      assert_equal @plain, File.binread(@path)
+    end
+
+    def test_delete
+      @sync.put(@key)
+      s3_object = @sync.delete(@key)
+      assert_raises AWS::S3::Errors::NoSuchKey do
+        s3_object.read
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'digest/sha2'
+require 'fileutils'
+require 's5'
+
+class S5::Test < MiniTest::Test
+  def setup
+    @fixtures_path ||= Pathname.new(File.expand_path('../fixtures', __FILE__)).tap{|path|
+      FileUtils.mkdir_p path.to_s
+    }
+  end
+
+  def teardown
+    FileUtils.rm_rf(@fixtures_path)
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: s5
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yalab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: fssm
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  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: 'Secure Sync to Amazon S3. '
+email:
+- rudeboyjet@gmail.com
+executables:
+- s5
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/s5
+- lib/s5.rb
+- lib/s5/cli.rb
+- lib/s5/daemon.rb
+- lib/s5/sync.rb
+- lib/s5/version.rb
+- s5.gemspec
+- test/s5/bootstrap_test.rb
+- test/s5/cli_test.rb
+- test/s5/daemon_test.rb
+- test/s5/sync_test.rb
+- test/test_helper.rb
+homepage: https://github.com/yalab/s5
+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.0.3
+signing_key: 
+specification_version: 4
+summary: This gem provides Amazon S3 sync with client side encryption.
+test_files:
+- test/s5/bootstrap_test.rb
+- test/s5/cli_test.rb
+- test/s5/daemon_test.rb
+- test/s5/sync_test.rb
+- test/test_helper.rb