bucket_store 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e251b7658b3f9e155f3e9e329d2022e6f4791e502de43bba2b8a0563634ba499
-  data.tar.gz: f66fbec21d4a07e2ff0feb0ad45383eccb71daa13d733cc92f2a0ae54d6cd9f4
+  metadata.gz: 14fe28facb1db7af27414a3d1ce64ad24974c79e72c5b9faca796860f679c3d8
+  data.tar.gz: 4b6a4fe4e68bb81b4e7df6d76d2f8e14dc6210508955263fe579b067c7b1af61
 SHA512:
-  metadata.gz: cb3aeab11c33767d349fb4c7efe744000c9a129131cfff3054c308de7971da12e1ea3c32fafeaa8722ddf07049d4e2f0e1cf6ba85b24d6c997ac1f3fe4eb14af
-  data.tar.gz: 5f2d1e70e8f0bc27ccfbf998ec3c4e1c89fb9ed0e179b8b2a808a7345bf4cda38dcc45fbadc842a142a0eb42d51fdb44247159c1fe58f5717cf302a6145ecff3
+  metadata.gz: 60b864052d68196fd7bda4a67a67bb66a82ef9bb828f01fb9364ce8aeca67ea414f8f2c34259982fd3dd76a3545b9c72172400e3acbb277fe3cc907d5d449e36
+  data.tar.gz: 5aab2c949368e330f73470f5a9c705c681662ec7209d8e8600c3ea971f852c79d2ce6f6af52350760c9f585cc25ab94f51431001cbb4ff053276333515bf8fd1

data/README.md

@@ -159,6 +159,15 @@ BucketStore.for("inmemory://bucket/path/file.xml").delete!
 => true
 ```
 
+## Development
+
+### Running tests
+BucketStore comes with both unit and integration tests. While unit tests can be run by simply
+executing `bundle exec rspec`, integration tests require running minio locally. We provide an
+helper script (`scripts/run-minio.sh`) that spins up a pre-configured docker container with
+a single test bucket. Once minio has started, integration tests can be executed with
+`bundle exec rspec --tag integration`.
+
 ## License & Contributing
 
 * BucketStore is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/bucket_store/disk.rb

@@ -78,7 +78,7 @@ module BucketStore
     end
 
     def sanitize_filename(filename)
-      filename.gsub(%r{[^0-9A-z.\-/]}, "_")
+      filename.gsub(%r{[^0-9A-z.\- /]}, "_")
     end
   end
 end

data/lib/bucket_store/key_context.rb

@@ -19,18 +19,35 @@ module BucketStore
     end
 
     def self.parse(raw_key)
-      uri = URI(raw_key)
+      uri = URI(escape(raw_key))
+
+      scheme = unescape(uri.scheme)
+      bucket = unescape(uri.host)
 
       # A key should never be `nil` but can be empty. Depending on the operation, this may
       # or may not be a valid configuration (e.g. an empty key is likely valid on a
       # `list`, but not during a `download`).
-      key = uri.path.sub!(%r{/}, "") || ""
+      key = unescape(uri.path).sub!(%r{/}, "") || ""
 
-      raise KeyParseException if [uri.scheme, uri.host, key].map(&:nil?).any?
+      raise KeyParseException if [scheme, bucket, key].map(&:nil?).any?
 
-      KeyContext.new(adapter: uri.scheme,
-                     bucket: uri.host,
+      KeyContext.new(adapter: scheme,
+                     bucket: bucket,
                      key: key)
     end
+
+    def self.escape(key)
+      return key if key.nil?
+
+      URI::DEFAULT_PARSER.escape(key)
+    end
+    private_class_method :escape
+
+    def self.unescape(key)
+      return key if key.nil?
+
+      URI::DEFAULT_PARSER.unescape(key)
+    end
+    private_class_method :unescape
   end
 end

data/lib/bucket_store/key_storage.rb

@@ -153,7 +153,7 @@ module BucketStore
     #
     # @return [bool] `true` if the given key exists, `false` if not
     def exists?
-      list.first == "#{adapter_type}://#{bucket}/#{key}"
+      list(page_size: 1).first == "#{adapter_type}://#{bucket}/#{key}"
     end
 
     private

data/lib/bucket_store/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BucketStore
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/bucket_store.rb

@@ -4,6 +4,7 @@ require "bucket_store/version"
 require "bucket_store/configuration"
 require "bucket_store/key_context"
 require "bucket_store/key_storage"
+require "bucket_store/uri_builder"
 
 # An abstraction layer on the top of file cloud storage systems such as Google Cloud
 # Storage or S3. This module exposes a generic interface that allows interoperability
@@ -41,8 +42,8 @@ module BucketStore
     # Given a `key` in the format of `adapter://bucket/key` returns the corresponding
     # adapter that will allow to manipulate (e.g. download, upload or list) such key.
     #
-    # Currently supported adapters are `gs` (Google Cloud Storage), `inmemory` (an
-    # in-memory key-value storage) and `disk` (a disk-backed key-value store).
+    # Currently supported adapters are `gs` (Google Cloud Storage), `s3` (AWS S3),
+    # `inmemory` (an in-memory key-value storage) and `disk` (a disk-backed key-value store).
     #
     # @param [String] key The reference key
     # @return [KeyStorage] An interface to the adapter that can handle requests on the given key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bucket_store
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3