fs3_cloner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45a407c2fe438966d410c13761cb0d3ae6d481b6
+  data.tar.gz: 0e95f66ee1d328533c572d32dd19e551dddbacfd
+SHA512:
+  metadata.gz: 1d00c6944b50d9bd2f56edbfd3b449bf066fe4a8ba1a615e3eb1ec9a09e88909251141fdebb80157d23af7186fed31f25a5a4b658d9fcbc05361291636adca02
+  data.tar.gz: ac906bbe48c00ca56f3347d3c57109228863440ed3f4d3d44cd30fa14eeda721767d98914d5bad4cdc9baf208293f39b142cd217e16ee44efeeb41c081b91b89

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fs3_cloner.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    fs3_cloner (0.1.0)
+      aws-sdk (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.11.65)
+      aws-sdk-resources (= 2.11.65)
+    aws-sdk-core (2.11.65)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.11.65)
+      aws-sdk-core (= 2.11.65)
+    aws-sigv4 (1.0.2)
+    diff-lcs (1.3)
+    jmespath (1.4.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fs3_cloner!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Faizal Zakaria
+
+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,50 @@
+# Fs3Cloner
+
+Clone your s3 bucket either for backup or migration to a new bucket in new AWS account etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fs3_cloner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fs3_cloner
+
+## Usage
+
+```
+Fs3Cloner::BucketCloner.new(
+  {
+    aws_access_key_id: '123',
+    aws_secret_access_key: '123',
+    bucket: 'bucket_from'
+  },
+  {
+    aws_access_key_id: '123',
+    aws_secret_access_key: '123',
+    bucket: 'bucket_to'
+  }
+).clone
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake 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`. To release a new version, update the version number in `version.rb`, and 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fs3_cloner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "fs3_cloner"
+
+# 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(__FILE__)

data/bin/setup

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

data/fs3_cloner.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fs3_cloner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fs3_cloner"
+  spec.version       = Fs3Cloner::VERSION
+  spec.authors       = ["Faizal Zakaria"]
+  spec.email         = ["fai@code3.io"]
+
+  spec.summary       = %q{S3 cloner},
+  spec.description   = %q{S3 cloner for you to backup your s3 bucket, clone it to a different env etc},
+  spec.homepage      = "https://github.com/faizalzakaria/fs3_cloner",
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "aws-sdk", "~> 2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fs3_cloner/bucket_cloner.rb

@@ -0,0 +1,167 @@
+require 'aws-sdk'
+
+# BucketCloner
+#
+# Ex.
+#
+# Fs3Cloner::BucketCloner.new(
+#   {
+#     aws_access_key_id: '123',
+#     aws_secret_access_key: '123',
+#     bucket: 'bucket_from'
+#   },
+#   {
+#     aws_access_key_id: '123',
+#     aws_secret_access_key: '123',
+#     bucket: 'bucket_to'
+#   }
+# ).clone
+module Fs3Cloner
+  class BucketCloner
+    attr_reader :from_bucket, :to_bucket, :logger
+    attr_reader :excludes, :includes, :prefixes, :copy_opts, :output
+
+    # options
+    # - output        : STDOUT
+    # - includes : ex. [%r(uploads/document), "uploads/1/document.pdf"]
+    # - excludes : ex. [%r(uploads/1)]
+    # - prefixes : ex. ["uploads/document", "uploads/test"] , this will boost to cloning
+    def initialize(from_credentials, to_credentials, options = {})
+      parse_options(options)
+
+      @from_bucket = bucket_from_credentials(from_credentials)
+      @to_bucket   = bucket_from_credentials(to_credentials)
+      @logger      = Logger.new(output)
+    end
+
+    def clone
+      total_sync = 0
+      total_skip = 0
+
+      logger.info "Started syncing ..."
+
+      if prefixes.nil?
+        sync_count, skip_count = process_objects(from_bucket.objects)
+
+        total_sync += sync_count
+        total_skip += skip_count
+      else
+        prefixes.each do |prefix|
+          logger.info "Processing prefix #{prefix} ..."
+          sync_count, skip_count = process_objects(from_bucket.objects(prefix: prefix))
+
+          puts sync_count
+          puts skip_count
+          total_sync += sync_count
+          total_skip += skip_count
+        end
+      end
+
+      logger.info "Done!"
+      logger.info "Synced #{total_sync}"
+      logger.info "Skipped #{total_skip}"
+    end
+
+    private
+
+    def process_objects(objects)
+      sync_count = 0
+      skip_count = 0
+
+      objects.each do |object|
+        if object_needs_syncing?(object)
+          sync(object)
+          sync_count += 1
+        else
+          skip(object)
+          skip_count += 1
+        end
+      end
+
+      [sync_count, skip_count]
+    end
+
+    def parse_options(options)
+      @output    = options[:output] || STDOUT
+      @excludes  = options[:excludes]
+      @includes  = options[:includes]
+      @prefixes  = options[:prefixes]
+      @copy_opts = options[:copy_opts] || {}
+    end
+
+    def sync(object)
+      logger.debug "Syncing #{pp object}"
+      object.copy_to(to_bucket.object(object.key), copy_opts)
+    end
+
+    def skip(object)
+      logger.debug "Skipped #{pp object}"
+    end
+
+    def pp(object)
+      content_length_in_kb = object.content_length / 1024
+
+      [
+        %Q(#{object.key} #{content_length_in_kb}k),
+        %Q(#{object.last_modified.strftime("%b %d %Y %H:%M")})
+      ].join(' ')
+    end
+
+    def skip_object?(object)
+      false ||
+        object_include?(object) ||
+        object_exclude?(object)
+    end
+
+    def object_needs_syncing?(object)
+      to_object = to_bucket.object(object.key)
+
+      return false if skip_object?(object)
+      return true if !to_object.exists?
+      return to_object.etag != object.etag
+    end
+
+    def bucket_from_credentials(credentials)
+      client = Aws::S3::Client.new(access_key_id:      credentials[:aws_access_key_id],
+                                   secret_access_key:  credentials[:aws_secret_access_key])
+
+      bucket = Aws::S3::Bucket.new(credentials[:bucket], client: client)
+
+      return bucket if bucket.exists?
+
+      bucket.create
+    end
+
+    def object_include?(object)
+      return true if includes.nil?
+
+      includes.any? do |pattern|
+        if pattern.is_a?(Regexp)
+          match?(pattern, object.key)
+        elsif pattern.is_a?(String)
+          pattern == object.key
+        else
+          logger.error "Unknown include pattern, #{pattern}"
+        end
+      end
+    end
+
+    def object_exclude?(object)
+      return false if excludes.nil?
+
+      excludes.any? do |pattern|
+        if pattern.is_a?(Regexp)
+          match?(pattern, object.key)
+        elsif pattern.is_a?(String)
+          pattern == object.key
+        else
+          logger.error "Unknown include pattern, #{pattern}"
+        end
+      end
+    end
+
+    def match?(regex, string)
+      !regex.match(string).nil?
+    end
+  end
+end

data/lib/fs3_cloner/version.rb

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

data/lib/fs3_cloner.rb

@@ -0,0 +1,5 @@
+require "fs3_cloner/version"
+require 'fs3_cloner/bucket_cloner'
+
+module Fs3Cloner
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fs3_cloner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Faizal Zakaria
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-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: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: S3 cloner for you to backup your s3 bucket, clone it to a different env
+  etc
+email:
+- fai@code3.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fs3_cloner.gemspec
+- lib/fs3_cloner.rb
+- lib/fs3_cloner/bucket_cloner.rb
+- lib/fs3_cloner/version.rb
+homepage: https://github.com/faizalzakaria/fs3_cloner
+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.6.11
+signing_key: 
+specification_version: 4
+summary: '["S3 cloner", "S3 cloner for you to backup your s3 bucket, clone it to a
+  different env etc", "https://github.com/faizalzakaria/fs3_cloner", "MIT"]'
+test_files: []