bfs-s3 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1278091b90948c44f8af9063da019a7995b614a2ab4b773404b8dce4cbfbf830
-  data.tar.gz: 7da078d9683005df07103b486da20490cd4a3198cc13b7d3db16547a098378b8
+  metadata.gz: 4c616f522880311f4ca6a584e333c1f7980cd2ea28d49edcf43ae5f13543bb43
+  data.tar.gz: '067807a2b22a0777b177cc570a5f6919230c749d79f0ce569b021c5c802b715a'
 SHA512:
-  metadata.gz: de52d76401dc6a99665713efc288cabc82a3d3c6ea89e3b4532779f164c96140e85de16edf96a13a2bf4f932cd9a8e807e77a1d3d562779f028d141a5818f7d1
-  data.tar.gz: 1f253f6f75a5f011281cc6fc35347185d4a838a958ab7a80b812f88fde714bb24e035ccbe919588458b24d5622df16c6a74cf11ffb18a6accf6788df0bdfcb4d
+  metadata.gz: 58f0f83dbb3774297246e8a32e047bb1490d16ddca825565a704cf9f68815f397cf7cf56acd9b61784e3b30bb19b2806724ecc657e6d645044978c1450b2bf62
+  data.tar.gz: 97e5fa58ae4774a0703f143d41240df804858de8061b70eedfd0da36fc474d3e186e97d0a2ec0bd32d16f083ee6f543301a79e9eea55b6290c1d4f4799d6a157

data/bfs-s3.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.4.0'
 
-  s.add_dependency 'aws-sdk-s3'
+  s.add_dependency 'aws-sdk-s3', '~> 1.38'
   s.add_dependency 'bfs', s.version
 end

data/lib/bfs/bucket/s3.rb

@@ -6,8 +6,6 @@ module BFS
   module Bucket
     # S3 buckets are operating on s3
     class S3 < Abstract
-      NF_ERRORS = [Aws::S3::Errors::NoSuchKey, Aws::S3::Errors::NoSuchBucket, Aws::S3::Errors::NotFound].freeze
-
       attr_reader :name, :sse, :acl, :storage_class
 
       # Initializes a new S3 bucket
@@ -23,12 +21,14 @@ module BFS
       # @option opts [Symbol] :acl canned ACL
       # @option opts [String] :storage_class storage class
       # @option opts [Aws::S3::Client] :client custom client, uses default_client by default
+      # @option opts [String] :encoding default encoding to use, default: 'binary'
       def initialize(name, opts={})
         opts = opts.dup
         opts.keys.each do |key|
           val = opts.delete(key)
           opts[key.to_sym] = val unless val.nil?
         end
+        super(opts)
 
         @name = name
         @sse = opts[:sse] || opts[:server_side_encryption]
@@ -68,13 +68,20 @@ module BFS
         raise BFS::FileNotFound, path unless info
 
         BFS::FileInfo.new(path, info.content_length, info.last_modified, info.content_type, info.metadata)
-      rescue *NF_ERRORS
+      rescue Aws::S3::Errors::NoSuchKey, Aws::S3::Errors::NoSuchBucket, Aws::S3::Errors::NotFound
         raise BFS::FileNotFound, path
       end
 
       # Creates a new file and opens it for writing
+      # @param [String] path
+      # @param [Hash] opts options
+      # @option opts [String] :encoding file encoding to use, default: 'binary'
+      # @option opts [String] :acl custom ACL override
+      # @option opts [String] :server_side_encryption SSE override
+      # @option opts [String] :storage_class storage class override
       def create(path, opts={}, &block)
         path = full_path(path)
+        enc  = opts.delete(:encoding) || @encoding
         opts = opts.merge(
           bucket: name,
           key: path,
@@ -83,8 +90,8 @@ module BFS
         opts[:server_side_encryption] ||= @sse if @sse
         opts[:storage_class] ||= @storage_class if @storage_class
 
-        temp = BFS::TempWriter.new(path, opts) do |t|
-          File.open(t, binmode: true) do |file|
+        temp = BFS::TempWriter.new(path, encoding: enc) do |t|
+          File.open(t, encoding: enc) do |file|
             @client.put_object(opts.merge(body: file))
           end
         end
@@ -98,9 +105,13 @@ module BFS
       end
 
       # Opens an existing file for reading
+      # @param [String] path
+      # @param [Hash] opts options
+      # @option opts [String] :encoding file encoding to use, default: 'binary'
       def open(path, opts={}, &block)
         path = full_path(path)
-        temp = Tempfile.new(File.basename(path), binmode: true)
+        enc  = opts.delete(:encoding) || @encoding
+        temp = Tempfile.new(File.basename(path), encoding: enc)
         temp.close
 
         opts = opts.merge(
@@ -110,8 +121,8 @@ module BFS
         )
         @client.get_object(opts)
 
-        File.open(temp.path, binmode: true, &block)
-      rescue *NF_ERRORS
+        File.open(temp.path, encoding: enc, &block)
+      rescue Aws::S3::Errors::NoSuchKey, Aws::S3::Errors::NoSuchBucket, Aws::S3::Errors::NotFound
         raise BFS::FileNotFound, trim_prefix(path)
       end
 
@@ -123,7 +134,7 @@ module BFS
           key: path,
         )
         @client.delete_object(opts)
-      rescue *NF_ERRORS # rubocop:disable Lint/HandleExceptions
+      rescue Aws::S3::Errors::NoSuchKey, Aws::S3::Errors::NoSuchBucket, Aws::S3::Errors::NotFound # rubocop:disable Lint/HandleExceptions
       end
 
       # Copies a file.
@@ -136,7 +147,7 @@ module BFS
           key: dst,
         )
         @client.copy_object(opts)
-      rescue *NF_ERRORS
+      rescue Aws::S3::Errors::NoSuchKey, Aws::S3::Errors::NoSuchBucket, Aws::S3::Errors::NotFound
         raise BFS::FileNotFound, trim_prefix(src)
       end
 
@@ -157,8 +168,11 @@ end
 
 BFS.register('s3') do |url|
   params = CGI.parse(url.query.to_s)
+  prefix = BFS.norm_path(params.key?('prefix') ? params['prefix'].first : url.path)
+  prefix = nil if prefix.empty?
 
   BFS::Bucket::S3.new url.host,
+    prefix: prefix,
     region: params.key?('region') ? params['region'].first : nil,
     sse: params.key?('sse') ? params['sse'].first : nil,
     access_key_id: params.key?('access_key_id') ? params['access_key_id'].first : nil,

data/spec/bfs/bucket/s3_spec.rb

@@ -24,10 +24,16 @@ RSpec.describe BFS::Bucket::S3, if: run_spec do
   it_behaves_like 'a bucket'
 
   it 'should resolve from URL' do
-    bucket = BFS.resolve("s3://#{sandbox[:bucket]}?acl=private")
+    bucket = BFS.resolve("s3://#{sandbox[:bucket]}/?acl=private")
     expect(bucket).to be_instance_of(described_class)
     expect(bucket.name).to eq(sandbox[:bucket])
     expect(bucket.acl).to eq(:private)
+    expect(bucket.instance_variable_get(:@prefix)).to be_nil
+
+    bucket = BFS.resolve("s3://#{sandbox[:bucket]}/a/b/")
+    expect(bucket).to be_instance_of(described_class)
+    expect(bucket.name).to eq(sandbox[:bucket])
+    expect(bucket.instance_variable_get(:@prefix)).to eq('a/b')
   end
 
   it 'should enumerate over a large number of files' do

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: bfs-s3
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2019-06-17 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'
+        version: '1.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.38'
 - !ruby/object:Gem::Dependency
   name: bfs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: 0.4.0
 description: https://github.com/bsm/bfs.rb
 email: dimitrij@blacksquaremedia.com
 executables: []
@@ -60,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: S3 bucket adapter for bfs