aws-sdk-resources 2.9.11 → 2.9.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01a582ab6d06d39226ba147e559072d47bbab6a9
-  data.tar.gz: a1c9de6cfe900a7eebc03729d38a3e4a768c6640
+  metadata.gz: 786d4d8e13a23fa96bb7023bb1ce60c3496cedd8
+  data.tar.gz: 0dd86067e191c9dc953655a66f94e792ed87e768
 SHA512:
-  metadata.gz: 0e314de235b991ed501cbfd2d12f6450e74438047b618d2bcb65c6c48a54a908aecaa1e091a295e17060758abf5a02dbb5b2c236414a87444e1c26712d62b19d
-  data.tar.gz: e0a60ca1c63c28ecf9fe56312a8078425668f77535dce21d42d2afda71a50edca8b884f9f8fa3c4b0c698d78f970248399b992ff26421917e7ea9c04a11a513d
+  metadata.gz: 8268d55e91878e34dff6e29bbf0daabdc0a2a275d087e27e609393ed3da91ac78a40693fcf0145fa18a373c81e88bb0107cc3a4bdc0213e28c0b884c87347fe2
+  data.tar.gz: 5b30960ed192163f10f0ea3c582520cebd7e912bc50cb16cf2b72ead87a8e1fff91c9b042aa68a01c3c79429fd17f205687c069d1a60b124c6bf455c6d0ba2e7

data/lib/aws-sdk-resources/services/s3.rb

@@ -9,6 +9,7 @@ module Aws
     autoload :Encryption, 'aws-sdk-resources/services/s3/encryption'
     autoload :FilePart, 'aws-sdk-resources/services/s3/file_part'
     autoload :FileUploader, 'aws-sdk-resources/services/s3/file_uploader'
+    autoload :FileDownloader, 'aws-sdk-resources/services/s3/file_downloader'
     autoload :MultipartFileUploader, 'aws-sdk-resources/services/s3/multipart_file_uploader'
     autoload :MultipartUploadError, 'aws-sdk-resources/services/s3/multipart_upload_error'
     autoload :ObjectCopier, 'aws-sdk-resources/services/s3/object_copier'

data/lib/aws-sdk-resources/services/s3/file_downloader.rb

@@ -0,0 +1,173 @@
+require 'pathname'
+require 'thread'
+require 'set'
+require 'tmpdir'
+
+module Aws
+  module S3
+    # @api private
+    class FileDownloader
+
+      MIN_CHUNK_SIZE = 5 * 1024 * 1024
+      MAX_PARTS = 10_000
+      THREAD_COUNT = 10
+
+      def initialize(options = {})
+        @client = options[:client] || Client.new
+      end
+      
+      # @return [Client]
+      attr_reader :client
+
+      def download(destination, options = {})
+        @path = destination
+        @mode = options[:mode] || "auto"
+        @thread_count = options[:thread_count] || THREAD_COUNT
+        @chunk_size = options[:chunk_size]
+        @bucket = options[:bucket]
+        @key = options[:key]
+
+        case @mode
+        when "auto" then multipart_download
+        when "single_request" then single_request
+        when "get_range"
+          if @chunk_size
+            resp = @client.head_object(bucket: @bucket, key: @key)
+            multithreaded_get_by_ranges(construct_chunks(resp.content_length))
+          else
+            msg = "In :get_range mode, :chunk_size must be provided"
+            raise ArgumentError, msg
+          end
+        else
+          msg = "Invalid mode #{@mode} provided, "\
+            "mode should be :single_request, :get_range or :auto"
+          raise ArgumentError, msg
+        end
+      end
+      
+      private
+
+      def multipart_download
+        resp = @client.head_object(bucket: @bucket, key: @key, part_number: 1)
+        count = resp.parts_count
+        if count.nil? || count <= 1
+          resp.content_length < MIN_CHUNK_SIZE ?
+            single_request :
+            multithreaded_get_by_ranges(construct_chunks(resp.content_length))
+        else
+          # partNumber is an option
+          resp = @client.head_object(bucket: @bucket, key: @key)
+          resp.content_length < MIN_CHUNK_SIZE ?
+            single_request :
+            compute_mode(resp.content_length, count)
+        end
+      end
+ 
+      def compute_mode(file_size, count)
+        chunk_size = compute_chunk(file_size)
+        part_size = (file_size.to_f / count.to_f).ceil
+        if chunk_size < part_size
+          multithreaded_get_by_ranges(construct_chunks(file_size))
+        else
+          multithreaded_get_by_parts(count)
+        end
+      end
+
+      def construct_chunks(file_size)
+        offset = 0
+        default_chunk_size = compute_chunk(file_size)
+        chunks = []
+        while offset <= file_size
+          progress = offset + default_chunk_size
+          chunks << "bytes=#{offset}-#{progress < file_size ? progress : file_size}"
+          offset = progress + 1
+        end
+        chunks
+      end
+
+      def compute_chunk(file_size)
+        if @chunk_size && @chunk_size > file_size
+          raise ArgumentError, ":chunk_size shouldn't exceed total file size."
+        else
+          default_chunk_size = @chunk_size || [(file_size.to_f / MAX_PARTS).ceil, MIN_CHUNK_SIZE].max.to_i
+        end
+      end
+
+      def sort_files(files)
+        # sort file by start range count or part number
+        files.sort do |a, b|
+          a[/([^\=]+)$/].split('-')[0].to_i <=> b[/([^\=]+)$/].split('-')[0].to_i
+        end
+      end
+
+      def concatenate_parts(fileparts)
+        File.open(@path, 'wb')do |output_path|
+          sort_files(fileparts).each {|part| IO.copy_stream(part, output_path)}
+        end
+      end
+
+      def clean_up_parts(parts)
+        parts.each do |filename|
+          File.unlink(filename) if File.exists?(filename)
+        end
+      end
+
+      def file_batches(chunks, mode)
+        batches = []
+        dir = Dir.tmpdir
+        chunks = (1..chunks) if mode.eql? 'part_number'
+        chunks.each_slice(@thread_count) do |slice|
+          batches << map_files(slice, dir, mode)
+        end
+        batches
+      end
+
+      def map_files(slice, dir, mode)
+        case mode
+        when 'range'
+          slice.inject({}) {|h, chunk| h[chunk] = File.join(dir, chunk); h}
+        when 'part_number'
+          slice.inject({}) {|h, part| h[part] = File.join(dir, "part_number=#{part}"); h}
+        end
+      end
+
+      def multithreaded_get_by_ranges(chunks)
+        thread_batches(chunks, 'range')
+      end
+
+      def multithreaded_get_by_parts(parts)
+        thread_batches(parts, 'part_number')
+      end
+
+      def thread_batches(chunks, param)
+        batches = file_batches(chunks, param)
+        parts = batches.flat_map(&:values)
+        begin
+          batches.each do |batch|
+            threads = []
+            batch.each do |chunk, file|
+              threads << Thread.new do
+                resp = @client.get_object(
+                  :bucket => @bucket,
+                  :key => @key,
+                  param.to_sym => chunk,
+                  :response_target => file
+                )
+              end
+            end
+            threads.each(&:join)
+          end
+          concatenate_parts(parts)
+        ensure
+          clean_up_parts(parts)
+        end
+      end
+
+      def single_request
+        @client.get_object(
+          bucket: @bucket, key: @key, response_target: @path
+        )
+      end
+    end
+  end
+end

data/lib/aws-sdk-resources/services/s3/object.rb

@@ -252,7 +252,39 @@ module Aws
         uploader.upload(source, uploading_options.merge(bucket: bucket_name, key: key))
         true
       end
-
+     
+      # Downloads a file in S3 to a path on disk.
+      #
+      #     # small files (< 5MB) are downloaded in a single API call
+      #     obj.download_file('/path/to/file')
+      #
+      # Files larger than 5MB are downloaded using multipart method
+      #
+      #     # large files are split into parts
+      #     # and the parts are downloaded in parallel
+      #     obj.download_file('/path/to/very_large_file')
+      # 
+      # @param [String] destination Where to download the file to
+      #
+      # @option options [String] mode `auto`, `single_request`, `get_range`
+      #  `single_request` mode forces only 1 GET request is made in download,
+      #  `get_range` mode allows `chunk_size` parameter to configured in
+      #  customizing each range size in multipart_download,
+      #  By default, `auto` mode is enabled, which performs multipart_download
+      #
+      # @option options [String] chunk_size required in get_range mode
+      #
+      # @option options [String] thread_count Customize threads used in multipart
+      #   download, if not provided, 10 is default value
+      #
+      # @return [Boolean] Returns `true` when the file is downloaded
+      #   without any errors.
+      def download_file(destination, options = {})
+        downloader = FileDownloader.new(client: client)
+        downloader.download(
+          destination, options.merge(bucket: bucket_name, key: key))
+        true
+      end
     end
   end
 end

data/lib/aws-sdk-resources/services/s3/object_summary.rb

@@ -60,6 +60,14 @@ module Aws
         object.upload_file(source, options)
       end
 
+      # @param (see Object#download_file)
+      # @options (see Object#download_file)
+      # @return (see Object#download_file)
+      # @see Object#download_file
+      def download_file(destination, options = {})
+        object.download_file(destination, options)
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resources
 version: !ruby/object:Gem::Version
-  version: 2.9.11
+  version: 2.9.12
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.11
+        version: 2.9.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.11
+        version: 2.9.12
 description: Provides resource oriented interfaces and other higher-level abstractions
   for many AWS services. This gem is part of the official AWS SDK for Ruby.
 email:
@@ -72,6 +72,7 @@ files:
 - lib/aws-sdk-resources/services/s3/encryption/kms_cipher_provider.rb
 - lib/aws-sdk-resources/services/s3/encryption/materials.rb
 - lib/aws-sdk-resources/services/s3/encryption/utils.rb
+- lib/aws-sdk-resources/services/s3/file_downloader.rb
 - lib/aws-sdk-resources/services/s3/file_part.rb
 - lib/aws-sdk-resources/services/s3/file_uploader.rb
 - lib/aws-sdk-resources/services/s3/multipart_file_uploader.rb