saviour 0.4.5 → 0.4.6

data/spec/models/config_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Saviour::Config do
   describe "#storage" do
     it do
-      expect { Saviour::Config.storage.anything }.to raise_error(RuntimeError)
+      expect { Saviour::Config.storage.anything }.to raise_error(Saviour::ConfigurationError)
     end
 
     it do
@@ -31,7 +31,7 @@ describe Saviour::Config do
         Thread.main.thread_variable_set("Saviour::Config", nil)
 
         Thread.new {
-          expect { Saviour::Config.storage.anything }.to raise_error(RuntimeError)
+          expect { Saviour::Config.storage.anything }.to raise_error(Saviour::ConfigurationError)
         }.join
       end
 

data/spec/models/file_spec.rb

@@ -29,7 +29,7 @@ describe Saviour::File do
     store_dir { "/store/dir" }
   } }
 
-  let(:example_file) { double(read: "some file contents", path: "/my/path", rewind: nil) }
+  let(:example_file) { double(read: "some file contents", filename: "file.txt", rewind: nil) }
 
   let(:dummy_class) {
     klass = Class.new
@@ -51,33 +51,36 @@ describe Saviour::File do
 
     it "shows error if assigned object do not respond to :read" do
       file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-      expect { file.assign(6) }.to raise_error(RuntimeError)
+      expect { file.assign(6) }.to raise_error(Saviour::SourceError)
     end
   end
 
   describe "#write" do
     it "fails without source" do
       file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-      expect { file.write }.to raise_error(RuntimeError)
+      expect { file.write }.to raise_error(Saviour::MissingSource)
     end
 
     describe "filename used" do
       it "is extracted from original_filename if possible" do
         file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-        file.assign(double(read: "contents", original_filename: 'original.jpg', path: "/my/path/my_file.zip", rewind: nil))
+        file.assign(double(read: "contents", original_filename: 'original.jpg', rewind: nil))
         uploader = double
         allow(file).to receive(:uploader).and_return(uploader)
-        expect(uploader).to receive(:write).with("contents", "original.jpg")
+        expect(uploader).to receive(:_process_as_contents).with("contents", "original.jpg")
         file.write
       end
 
       it "is extracted from path if possible" do
         file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-        file.assign(double(read: "contents", path: "/my/path/my_file.zip", rewind: nil))
-        uploader = double
-        allow(file).to receive(:uploader).and_return(uploader)
-        expect(uploader).to receive(:write).with("contents", "my_file.zip")
-        file.write
+        with_test_file("example.xml") do |xml_file|
+          dummy_file = double(read: "contents", path: xml_file.path, rewind: nil)
+          file.assign(dummy_file)
+          uploader = double
+          allow(file).to receive(:uploader).and_return(uploader)
+          expect(uploader).to receive(:_process_as_file).with(an_instance_of(Tempfile), File.basename(xml_file.path))
+          file.write
+        end
       end
 
       it "is random if cannot be guessed" do
@@ -86,18 +89,18 @@ describe Saviour::File do
         allow(SecureRandom).to receive(:hex).and_return("stubbed-random")
         uploader = double
         allow(file).to receive(:uploader).and_return(uploader)
-        expect(uploader).to receive(:write).with("contents", "stubbed-random")
+        expect(uploader).to receive(:_process_as_contents).with("contents", "stubbed-random")
         file.write
       end
     end
 
-    it "returns the path" do
+    it "returns the final contents and path" do
       object = dummy_class.new
       file = Saviour::File.new(uploader_klass, object, :file)
-      file.assign(double(read: "contents", path: "/my/path/my_file.zip", rewind: nil))
+      file.assign(double(read: "contents", filename: "my_file.zip", rewind: nil))
       uploader = double
       allow(file).to receive(:uploader).and_return(uploader)
-      expect(uploader).to receive(:write).with("contents", "my_file.zip").and_return("/store/dir/my_file.zip")
+      expect(uploader).to receive(:_process_as_contents).with("contents", "my_file.zip").and_return(['contents', "/store/dir/my_file.zip"])
       expect(file.write).to eq "/store/dir/my_file.zip"
     end
   end
@@ -114,12 +117,12 @@ describe Saviour::File do
 
     it "is cleared after persisting" do
       file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-      file.assign(double(read: "contents", path: "/my/path/my_file.zip", rewind: nil))
+      file.assign(double(read: "contents", filename: "my_file.zip", rewind: nil))
       expect(file).to be_changed
 
       uploader = double
       allow(file).to receive(:uploader).and_return(uploader)
-      expect(uploader).to receive(:write).and_return("/some/path")
+      expect(uploader).to receive(:_process_as_contents).and_return("/some/path")
       file.write
 
       expect(file).not_to be_changed
@@ -139,37 +142,6 @@ describe Saviour::File do
     end
   end
 
-  describe "#with_copy" do
-    it "provides a copy of the stored file" do
-      file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-      file.set_path! "/path/file.jpg"
-      allow(file).to receive(:read).and_return("some contents")
-
-      file.with_copy do |tmpfile|
-        expect(tmpfile.read).to eq "some contents"
-      end
-    end
-
-    it "deletes the copied file even on exception" do
-      file = Saviour::File.new(uploader_klass, dummy_class.new, :file)
-      file.set_path! "/path/file.jpg"
-      allow(file).to receive(:read).and_return("some contents")
-
-      mocked_tmpfile = double(binmode: "", rewind: "", flush: "", write: "")
-      allow(Tempfile).to receive(:open).and_yield(mocked_tmpfile)
-
-      expect(mocked_tmpfile).to receive(:close)
-      expect(mocked_tmpfile).to receive(:delete)
-
-      test_exception = Class.new(StandardError)
-
-      begin
-        file.with_copy { |_| raise(test_exception, "some exception within the block") }
-      rescue test_exception
-      end
-    end
-  end
-
   describe "#blank?" do
     it "it's true when not yet assigned nor persisted" do
       file = Saviour::File.new(uploader_klass, dummy_class.new, :file)

data/spec/models/local_storage_spec.rb

@@ -21,40 +21,19 @@ describe Saviour::LocalStorage do
       end
     end
 
-    describe "overwritting an existing file" do
-      context "with overwrite protection" do
-        it "raises an error" do
-          path = File.join(@tmpdir, destination_path)
-
-          FileUtils.mkdir_p(File.dirname(path))
-          File.write(path, "some dummy content")
-          expect(File.file?(path)).to be_truthy
-
-          with_test_file("camaloon.jpg") do |file, _|
-            contents = file.read
-            expect { subject.write(contents, destination_path) }.to raise_error(RuntimeError)
-          end
-        end
-      end
-
-      context "without overwrite protection" do
-        subject { Saviour::LocalStorage.new(local_prefix: @tmpdir, overwrite_protection: false) }
-
-        it do
-          path = File.join(@tmpdir, destination_path)
+    it "overwrites the existing file" do
+      path = File.join(@tmpdir, destination_path)
 
-          FileUtils.mkdir_p(File.dirname(path))
-          File.write(path, "some dummy content")
-          expect(File.file?(path)).to be_truthy
+      FileUtils.mkdir_p(File.dirname(path))
+      File.write(path, "some dummy content")
+      expect(File.file?(path)).to be_truthy
 
-          with_test_file("camaloon.jpg") do |file, _|
-            contents = file.read
-            subject.write(contents, destination_path)
+      with_test_file("camaloon.jpg") do |file, _|
+        contents = file.read
+        subject.write(contents, destination_path)
 
-            expect(File.file?(path)).to be_truthy
-            expect(File.read(path)).to eq contents
-          end
-        end
+        expect(File.file?(path)).to be_truthy
+        expect(File.read(path)).to eq contents
       end
     end
   end
@@ -67,7 +46,7 @@ describe Saviour::LocalStorage do
     end
 
     it "fails if the file do not exists" do
-      expect { subject.read("nope.rar") }.to raise_error(RuntimeError)
+      expect { subject.read("nope.rar") }.to raise_error(Saviour::FileNotPresent)
     end
   end
 
@@ -82,7 +61,7 @@ describe Saviour::LocalStorage do
     end
 
     it "fails if the file do not exists" do
-      expect { subject.delete("nope.rar") }.to raise_error(RuntimeError)
+      expect { subject.delete("nope.rar") }.to raise_error(Saviour::FileNotPresent)
     end
 
     it "does not leave an empty dir behind" do
@@ -124,7 +103,7 @@ describe Saviour::LocalStorage do
         with_test_file("camaloon.jpg") do |file, _|
           expect {
             subject.public_url(File.basename(file.path))
-          }.to raise_error(RuntimeError)
+          }.to raise_error(Saviour::LocalStorage::MissingPublicUrlPrefix)
         end
       end
     end

data/spec/models/s3_storage_spec.rb

@@ -32,43 +32,18 @@ describe Saviour::S3Storage do
       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 {
-          Saviour::S3Storage.new(
-              bucket: "fake-bucket",
-              aws_access_key_id: "stub",
-              aws_secret_access_key: "stub",
-              public_url_prefix: "https://fake-bucket.s3.amazonaws.com",
-              overwrite_protection: false
-          )
-        }
-
-        it "overwrites the existing file" do
-          mocked_s3.write("some dummy contents", destination_path)
-          expect(mocked_s3.exists?(destination_path)).to be_truthy
-
-          with_test_file("camaloon.jpg") do |file, _|
-            contents = file.read
-            subject.write(contents, destination_path)
-            expect(mocked_s3.read(destination_path)).to eq contents
-          end
-        end
-      end
-
-      context "with overwrite protection" do
-        it "raises an exception" do
-          mocked_s3.write("some dummy contents", destination_path)
-          expect(mocked_s3.exists?(destination_path)).to be_truthy
+    it "overwrites the existing file" do
+      mocked_s3.write("some dummy contents", destination_path)
+      expect(mocked_s3.exists?(destination_path)).to be_truthy
 
-          with_test_file("camaloon.jpg") do |file, _|
-            contents = file.read
-            expect { subject.write(contents, destination_path) }.to raise_error(RuntimeError)
-          end
-        end
+      with_test_file("camaloon.jpg") do |file, _|
+        contents = file.read
+        subject.write(contents, destination_path)
+        expect(mocked_s3.read(destination_path)).to eq contents
       end
     end
 
+
     it "ignores leading slash" do
       subject.write("trash contents", "/folder/file.out")
       expect(subject.exists?("folder/file.out")).to be_truthy
@@ -77,7 +52,7 @@ describe Saviour::S3Storage do
     end
 
     describe "fog create options" do
-      subject { Saviour::S3Storage.new(bucket: "fake-bucket", aws_access_key_id: "stub", aws_secret_access_key: "stub", public_url_prefix: "https://fake-bucket.s3.amazonaws.com", create_options: {'Cache-Control' => 'max-age=31536000'}) }
+      subject { Saviour::S3Storage.new(bucket: "fake-bucket", aws_access_key_id: "stub", aws_secret_access_key: "stub", public_url_prefix: "https://fake-bucket.s3.amazonaws.com", create_options: { 'Cache-Control' => 'max-age=31536000' }) }
 
       it "uses passed options to create new files in S3" do
         with_test_file("camaloon.jpg") do |file, _|
@@ -103,7 +78,7 @@ describe Saviour::S3Storage do
     end
 
     it "fails if the file do not exists" do
-      expect { subject.read("nope.rar") }.to raise_error(RuntimeError)
+      expect { subject.read("nope.rar") }.to raise_error(Saviour::FileNotPresent)
     end
   end
 
@@ -122,7 +97,7 @@ describe Saviour::S3Storage do
     end
 
     it "fails if the file do not exists" do
-      expect { subject.delete("nope.rar") }.to raise_error(RuntimeError)
+      expect { subject.delete("nope.rar") }.to raise_error(Saviour::FileNotPresent)
     end
   end
 
@@ -152,7 +127,7 @@ describe Saviour::S3Storage do
         with_test_file("camaloon.jpg") do |file, _|
           contents = file.read
           mocked_s3.write(contents, destination_path)
-          expect { subject.public_url(destination_path) }.to raise_error(RuntimeError)
+          expect { subject.public_url(destination_path) }.to raise_error(Saviour::S3Storage::MissingPublicUrlPrefix)
         end
       end
     end

data/spec/models/url_source_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Saviour::UrlSource do
   describe "initialization" do
     it "fails if no valid uri" do
-      expect { Saviour::UrlSource.new("%^7QQ#%%@#@@") }.to raise_error(ArgumentError).with_message(/is not a valid URI/)
+      expect { Saviour::UrlSource.new("%^7QQ#%%@#@@") }.to raise_error(Saviour::UrlSource::InvalidUrl).with_message(/is not a valid URI/)
     end
 
     it "does not fail if provided a valid uri" do
@@ -23,7 +23,7 @@ describe Saviour::UrlSource do
       allow(Net::HTTP).to receive(:get_response).and_return(Net::HTTPNotFound)
 
       a = Saviour::UrlSource.new("http://aboubaosdubioaubosdubaou.com/path/file.jpg")
-      expect { a.read }.to raise_error(RuntimeError).with_message(/failed after 3 attempts/)
+      expect { a.read }.to raise_error(Saviour::UrlSource::ConnectionFailed).with_message(/failed after 3 attempts/)
     end
 
     it "retries the request 3 times on error" do
@@ -54,7 +54,7 @@ describe Saviour::UrlSource do
       expect(response).to receive(:[]).with("location").exactly(10).times.and_return("http://example.org")
       expect(Net::HTTP).to receive(:get_response).exactly(10).times.and_return(response)
 
-      expect { Saviour::UrlSource.new("http://faked.blabla").read }.to raise_error(RuntimeError).with_message(/Max number of allowed redirects reached \(10\) when resolving/)
+      expect { Saviour::UrlSource.new("http://faked.blabla").read }.to raise_error(Saviour::UrlSource::TooManyRedirects).with_message(/Max number of allowed redirects reached \(10\) when resolving/)
     end
 
     it "fails if the redirected location is not a valid URI" do
@@ -63,7 +63,7 @@ describe Saviour::UrlSource do
 
       expect(Net::HTTP).to receive(:get_response).and_return(response)
 
-      expect { Saviour::UrlSource.new("http://faked.blabla").read }.to raise_error(ArgumentError).with_message(/is not a valid URI/)
+      expect { Saviour::UrlSource.new("http://faked.blabla").read }.to raise_error(Saviour::UrlSource::InvalidUrl).with_message(/is not a valid URI/)
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'bundler/setup'
 require 'rspec'
 require 'active_record'
 require 'sqlite3'
+require 'get_process_mem'
 
 require File.expand_path("../../lib/saviour", __FILE__)
 
@@ -43,6 +44,9 @@ RSpec.configure do |config|
     }
   end
 
+  config.before do
+    Test.delete_all
+  end
   config.after { Fog::Mock.reset }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saviour
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Roger Campos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: File storage handler following active record model lifecycle
 email:
 - roger@rogercampos.com
@@ -150,14 +164,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/4.0.gemfile
-- gemfiles/4.1.gemfile
-- gemfiles/4.2.gemfile
 - gemfiles/5.0.gemfile
 - gemfiles/5.1.gemfile
 - lib/saviour.rb
 - lib/saviour/base_uploader.rb
 - lib/saviour/config.rb
+- lib/saviour/db_helpers.rb
 - lib/saviour/file.rb
 - lib/saviour/integrator.rb
 - lib/saviour/life_cycle.rb
@@ -173,17 +185,20 @@ files:
 - lib/saviour/validator.rb
 - lib/saviour/version.rb
 - saviour.gemspec
-- spec/feature/allow_overriding_attached_as_method.rb
+- spec/feature/allow_overriding_attached_as_method_spec.rb
 - spec/feature/crud_workflows_spec.rb
 - spec/feature/dirty_spec.rb
 - spec/feature/follow_file_spec.rb
 - spec/feature/halt_processor_spec.rb
+- spec/feature/memory_usage_spec.rb
 - spec/feature/persisted_path_spec.rb
-- spec/feature/processors_api.rb
+- spec/feature/processors_api_spec.rb
 - spec/feature/reload_model_spec.rb
-- spec/feature/rewind_source_before_read.rb
-- spec/feature/uploader_declaration.rb
+- spec/feature/rewind_source_before_read_spec.rb
+- spec/feature/transactional_behavior_spec.rb
+- spec/feature/uploader_declaration_spec.rb
 - spec/feature/validations_spec.rb
+- spec/feature/with_copy_spec.rb
 - spec/models/base_uploader_spec.rb
 - spec/models/config_spec.rb
 - spec/models/file_spec.rb
@@ -209,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="