s3mirror 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5348c6d7c5561d1b3ea19662afe87be9513fd340eda30ee8f8bd7c25c5b6b77
+  data.tar.gz: ee3d10e31fb4c899618c1b333906a6497c9e68ef21dc4988e213cb846304a848
+SHA512:
+  metadata.gz: 66c57bc3a30e18f1d4ebe6036f2e48e6f9cb1eee1bfef791e3033816807be93190fccefb5f6a0c487dc27554cd44bca9dcdcaa3234100dd27adba5787ecf6025
+  data.tar.gz: 615e38ad685f696f9b5ebce4e8675d3aae797aee444d8a6e5a379aeda73b0cacbf06ee405c4166aeb543e0896120d27007c2bfb654a8295466834e08e78de2cc

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in s3mirror.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,41 @@
+# S3mirror
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/s3mirror`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3mirror'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install s3mirror
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/s3mirror.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# s3mirror

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,131 @@
+require "s3mirror/version"
+require "s3mirror/configuration"
+
+# usage:
+# s3mirror = S3mirror::Mirror.new({})
+module S3mirror
+  class Error < StandardError; end
+
+  class Mirror
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure(&block)
+      yield(configuration)
+    end
+
+    def initialize(options={})
+      @temp_destination = Mirror.configuration.temp_download_folder #options.delete(:temp_download_folder)
+
+      if !@temp_destination.blank? && !Pathname.new(@temp_destination).absolute?
+        throw 'temp_download_folder should be an absolute path'
+      end
+
+      @s3_main = Mirror.configuration.s3_main #options.delete(:s3_main)
+      @s3_mirrors = Mirror.configuration.s3_mirrors #options.delete(:s3_mirrors)
+    end
+
+    def get_s3_bucket(service)
+      # create a client that will be used by resource, this help switching between different s3 providers without changing default configuration set in initializer (i.e: Aws.config.update({...}))
+      client = Aws::S3::Client.new(
+        endpoint: service[:endpoint],
+        region: service[:region],
+        credentials: Aws::Credentials.new(service[:access_key_id], service[:secret_access_key])
+      )
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Resource.html
+      # if client not supplied, default configuration will be used
+      s3 = Aws::S3::Resource.new(client: client)
+      return s3.bucket(service[:bucket_name])
+    end
+
+    def mirror(key)
+      unique_prefix = 't' + (Time.now.to_f * 1000000).to_s
+
+      # filename is the name of file used for our download
+      filename = File.basename(key)
+
+      # add a temporary unique prefix to the filename to prevent collision (i.e: 2 downloaded file with same name)
+      prefixed_filename = "#{unique_prefix}_#{filename}"
+
+      # all files will be downloaded to your app "tmp" folder (otherwise the specified @temp_destination), the unique prefix above will guarantee uniqueness of files names
+      if @temp_destination.blank?
+        file_path = Rails.root.join('tmp', prefixed_filename)
+      else
+        file_path = File.join(@temp_destination, prefixed_filename)
+      end
+
+      uploaded_now = 0 # uploaded count for the current mirroring try
+      uploaded_total = 0
+
+      if download(key, file_path)
+        begin
+          @s3_mirrors.each do |mirror|
+            mirror_bucket = get_s3_bucket(mirror)
+            if !mirror_has_file?(key, mirror_bucket)
+              uploaded = upload(file_path, key, mirror_bucket)
+              if uploaded
+                uploaded_now += 1
+                uploaded_total += 1
+              end
+            else
+              uploaded_total += 1
+            end
+          end
+        ensure
+          # remove downloaded file
+          File.delete(file_path)
+        end
+      else
+        # throw 'file not downloaded!!'
+      end
+
+      return {
+        mirrored_now: uploaded_now,
+        total_mirrored: uploaded_total,
+        total_failed: @s3_mirrors.size - uploaded_total
+      }
+    end
+
+    # get object from main/primary s3 service
+    def s3_object(key)
+      bucket = get_s3_bucket(@s3_main)
+      bucket.object(key)
+    end
+
+    # read note (1) below
+    def download(key, destination_on_desk)
+      # returns true if downloaded successfully
+      begin
+        s3_object(key).download_file(destination_on_desk)
+      rescue Aws::S3::Errors::NoSuchKey
+        return false
+      end
+    end
+
+    # read note (2) below
+    def upload(file_path, file_key, mirror_bucket)
+      object_name = file_key
+      # create empty object in the mirror bucket with same name as the original file.
+      object = mirror_bucket.object(object_name)
+      # upload file to that object.
+      object.upload_file(file_path) # return true if uploaded successfully)
+    end
+
+    def mirror_has_file?(file_key, mirror_bucket)
+      begin
+        object = mirror_bucket.object(file_key)
+        if object.exists?
+          true
+        else
+          false
+        end
+      rescue Aws::S3::Errors::NotFound
+        false
+      end
+    end
+
+  end
+
+end

data/lib/s3mirror/configuration.rb

@@ -0,0 +1,11 @@
+module S3mirror
+  class Configuration
+
+    attr_accessor :temp_download_folder, :s3_main, :s3_mirrors
+
+    def initialize
+      
+    end
+
+  end
+end

data/lib/s3mirror/version.rb

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

data/s3mirror.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/s3mirror/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3mirror"
+  spec.version       = S3mirror::VERSION
+  spec.authors       = ["scratchoo"]
+  spec.email         = ["support@scratchoo.com"]
+
+  spec.summary       = %q{Mirror your file to s3 compatible services after uploading it.}
+  spec.description   = %q{S3mirror allows you to copy an uploaded file to mirror(s) which are basically any s3 compatible storage.}
+  spec.homepage      = "https://github.com/scratchoo/s3mirror"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/scratchoo/s3mirror"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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-s3'
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: s3mirror
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- scratchoo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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: S3mirror allows you to copy an uploaded file to mirror(s) which are basically
+  any s3 compatible storage.
+email:
+- support@scratchoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/s3mirror.rb
+- lib/s3mirror/configuration.rb
+- lib/s3mirror/version.rb
+- s3mirror.gemspec
+homepage: https://github.com/scratchoo/s3mirror
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/scratchoo/s3mirror
+  source_code_uri: https://github.com/scratchoo/s3mirror
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Mirror your file to s3 compatible services after uploading it.
+test_files: []