saviour 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 319d2711e341ea64600303c886f98cba1d698946
-  data.tar.gz: 2d48a9c86baa03ade58dd34b5932735080120b2c
+  metadata.gz: 74f1d7faa90b8712dbf65f86ce592db60c296ac3
+  data.tar.gz: 680a73e0bb124fc7de9ca66ea09e1ee486088731
 SHA512:
-  metadata.gz: 0d49c6f41a7ab74b67e52b99e85e13c6c653c7fce639231835ba9ca1cbd6991213231558505ea9d42be51d0b173226a144d5657779ef36570e3960ad156b4ddb
-  data.tar.gz: 4aad76005e7bb31d153a8e135816ac255cd2e812cd1af00360147c1122c1eba54f296d70f5cd363f139fa858f3fd3c2f6db61c27eff4826a5dfc23afe1833963
+  metadata.gz: a152333b01f299de797c04ab0d76a07401ebdf673cb2e2d93f02151b495b4d8d18bafbec884b9ddb53aaf12ae94bf409d0e1769ae60e0e06fa939be14486a2ea
+  data.tar.gz: eabe42debcdc6c8caf0e48f8fbb4645964bb848329198844607ef0b7b3cd93bd41855bfdf5ccb71aaaac717921c10b6c6203203ad203d3eb1c03236fced79860

data/README.md

@@ -267,6 +267,30 @@ on a path that already exists. This behaviour in enabled by default, but you can
 argument when instantiating the storage: `overwrite_protection: false`. This feature requires an additional HEAD request
 to verify existence for every write.
 
+NOTE: Be aware that S3 has a limit of 1024 bytes for the keys (paths) used. Be sure to truncate to that maximum length
+if you're using an s3 storage, for example with a processor like this:
+
+```ruby
+  # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
+  # Max 1024 bytes for keys in S3
+  def truncate_at_max_key_size(contents, filename)
+    # Left 20 bytes of margin (up to 1024) to have some room for a name
+    if store_dir.bytesize > 1004
+      raise "The store_dir used is already bigger than 1004 bytes, must be reduced!"
+    end
+
+    key = "#{store_dir}#{filename}"
+    new_filename = if key > 1024
+                     # note mb_chars is an active support's method
+                     filename.mb_chars.limit(1024 - store_dir.bytesize).to_s
+                   else
+                     filename
+                   end
+
+    [contents, new_filename]
+  end
+``` 
+
 
 ## Source abstraction
 
@@ -384,6 +408,8 @@ When using `process_with_file`, the last file instance you return from your last
 `process_with_file` will be automatically deleted by Saviour. Be aware of this if you return
 some File instance different than the one you received pointing to a file.
 
+From inside a process you can also access the current store dir with `store_dir`.
+
 Finally, processors can be disabled entirely via a configuration parameter. Example:
 
 ```

data/lib/saviour/base_uploader.rb

@@ -20,7 +20,6 @@ module Saviour
     end
 
     def write(contents, filename)
-      store_dir = Uploader::StoreDirExtractor.new(self).store_dir
       raise RuntimeError, "Please use `store_dir` before trying to write" unless store_dir
 
       if Config.processing_enabled
@@ -32,6 +31,10 @@ module Saviour
       path
     end
 
+    def store_dir
+      @store_dir ||= Uploader::StoreDirExtractor.new(self).store_dir
+    end
+
     class << self
       def store_dirs
         @store_dirs ||= []

data/lib/saviour/s3_storage.rb

@@ -19,6 +19,12 @@ module Saviour
       raise(RuntimeError, "The path you're trying to write already exists!") if @overwrite_protection && exists?(path)
 
       path = sanitize_leading_slash(path)
+
+      # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
+      if path.bytesize > 1024
+        raise(RuntimeError, "The key in S3 must be at max 1024 bytes, this key is too big: #{path}")
+      end
+
       directory.files.create({
                                  key: path,
                                  body: contents,

data/lib/saviour/version.rb

@@ -1,3 +1,3 @@
 module Saviour
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/spec/feature/{access_to_model_and_mounted_as_spec.rb → processors_api.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "access to model data from uploaders" do
+describe "processor's API" do
   before { allow(Saviour::Config).to receive(:storage).and_return(Saviour::LocalStorage.new(local_prefix: @tmpdir, public_url_prefix: "http://domain.com")) }
 
   let(:uploader) {
@@ -22,7 +22,7 @@ describe "access to model data from uploaders" do
     klass
   }
 
-  describe "file store" do
+  describe "can access to model and attached_as" do
     it do
       with_test_file("example.xml") do |example, name|
         a = klass.new
@@ -34,4 +34,25 @@ describe "access to model data from uploaders" do
       end
     end
   end
+
+  describe "can access store_dir" do
+    let(:uploader) {
+      Class.new(Saviour::BaseUploader) do
+        store_dir { "/store/dir/#{model.id}" }
+        process { |contents, name| ["FAKE: #{store_dir}", name] }
+      end
+    }
+
+    it do
+      with_test_file("example.xml") do |example, name|
+        a = klass.new
+        a.file = example
+        path = a.file.write
+
+        contents = Saviour::Config.storage.read(path)
+        expect(Saviour::Config.storage.exists?(path)).to be_truthy
+        expect(contents).to eq "FAKE: /store/dir/87"
+      end
+    end
+  end
 end

data/spec/models/s3_storage_spec.rb

@@ -27,6 +27,11 @@ describe Saviour::S3Storage do
       end
     end
 
+    it "raises exception if key > 1024 bytes" do
+      key = "a" * 1025
+      expect { subject.write("contents", key) }.to raise_error.with_message(/The key in S3 must be at max 1024 bytes, this key is too big/)
+    end
+
     describe "overwritting" do
       context "without overwrite protection" do
         subject {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saviour
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Roger Campos
@@ -173,12 +173,12 @@ files:
 - lib/saviour/validator.rb
 - lib/saviour/version.rb
 - saviour.gemspec
-- spec/feature/access_to_model_and_mounted_as_spec.rb
 - spec/feature/allow_overriding_attached_as_method.rb
 - spec/feature/crud_workflows_spec.rb
 - spec/feature/dirty_spec.rb
 - spec/feature/follow_file_spec.rb
 - spec/feature/persisted_path_spec.rb
+- spec/feature/processors_api.rb
 - spec/feature/reload_model_spec.rb
 - spec/feature/rewind_source_before_read.rb
 - spec/feature/uploader_declaration.rb