disk_store 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a169969f0a6815116676b69bccfada6d9c021c00
-  data.tar.gz: 4047279dfc9bc369a3012e495b73a5d22e5e4f59
+  metadata.gz: e58eb0c302ae1fdb782a4dee97571d9579b9981e
+  data.tar.gz: 7469c9c689d3658ffa1fe50a30ae5c7c0c9142de
 SHA512:
-  metadata.gz: bfbbe98e30b10f1790fc29d4136df196063eccacbf7d47dd2f28bca6e62e130c88136d79f41ceb9b2d33e341b91e5a4852803f5155ec3789ca342846fcdcbf79
-  data.tar.gz: d9d4184f527e83e14102b6347bb40906047581f84497bdc21533246c9aefeb8b9fd8e53ed4228874057cd521925630b8c40ba98199a6bd59d8d85fc864f23d9b
+  metadata.gz: 51c2e56da273a2984c84fe2805642b0cfe95960198a96e1392fa2716cd7d0eb1602675269074532c3745329a1e09e7c1a38e0a147ff5723c2fae0518078a1caf
+  data.tar.gz: 50437b7e690559f8c90bac340f7522df7fc08f159bf1946bd7aa428495ae3d18359aaff73d213340851bacd8f9d7ba0b2427f02969a4f88fe48b119c96a21f3e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    disk_store (0.3.0)
+    disk_store (0.4.0)
       celluloid
       rake
 

data/lib/disk_store/version.rb

@@ -1,3 +1,3 @@
 class DiskStore
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/disk_store.rb

@@ -2,6 +2,8 @@ require 'open-uri'
 require 'disk_store/reaper'
 
 class DiskStore
+  class MD5DidNotMatch < StandardError; end
+
   DIR_FORMATTER = "%03X"
   FILENAME_MAX_SIZE = 228 # max filename size on file system is 255, minus room for timestamp and random characters appended by Tempfile (used by atomic write)
   EXCLUDED_DIRS = ['.', '..'].freeze
@@ -15,15 +17,20 @@ class DiskStore
     @reaper = Reaper.spawn_for(@root_path, @options)
   end
 
-  def read(key)
-    File.open(key_file_path(key), 'rb')
+  def read(key, md5 = nil)
+    fd = File.open(key_file_path(key), 'rb')
+    validate_file!(key_file_path(key), md5) if !md5.nil?
+    fd
+  rescue MD5DidNotMatch => e
+    delete(key)
+    raise e
   end
 
-  def write(key, io)
+  def write(key, io, md5 = nil)
     file_path = key_file_path(key)
     ensure_cache_path(File.dirname(file_path))
 
-    File.open(file_path, 'wb') do |f|
+    fd = File.open(file_path, 'wb') do |f|
       begin
         f.flock File::LOCK_EX
         IO::copy_stream(io, f)
@@ -34,6 +41,12 @@ class DiskStore
         f.flock File::LOCK_UN
       end
     end
+
+    validate_file!(file_path, md5) if !md5.nil?
+    fd
+  rescue MD5DidNotMatch => e
+    delete(key)
+    raise e
   end
 
   def exist?(key)
@@ -49,17 +62,17 @@ class DiskStore
     true
   end
 
-  def fetch(key)
+  def fetch(key, md5 = nil)
     if block_given?
       if exist?(key)
-        read(key)
+        read(key, md5)
       else
         io = yield
-        write(key, io)
+        write(key, io, md5)
         read(key)
       end
     else
-      read(key)
+      read(key, md5)
     end
   end
 
@@ -84,6 +97,13 @@ private
     File.join(@root_path, DIR_FORMATTER % dir_1, DIR_FORMATTER % dir_2, *fname_paths)
   end
 
+  def validate_file!(file_path, md5)
+    real_md5 = Digest::MD5.file(file_path).hexdigest
+    if md5 != real_md5
+      raise MD5DidNotMatch.new("MD5 mismatch. Expected: #{md5}, Actual: #{real_md5}")
+    end
+  end
+
   # Make sure a file path's directories exist.
   def ensure_cache_path(path)
     FileUtils.makedirs(path) unless File.exist?(path)

data/spec/disk_store_spec.rb

@@ -29,13 +29,39 @@ describe DiskStore do
   end
 
   context "#read" do
-    it "reads from disk" do
+    before(:each) do
       cache.write(key, file)
       file.close
       file.unlink # ensure the tempfile is deleted
+    end
+
+    it "reads from disk" do
       expect(cache.read(key)).to be_an_instance_of(File)
       expect(cache.read(key).read).to eq file_contents
     end
+
+    describe "md5 validation" do
+      let(:expected_md5) { Digest::MD5.hexdigest(file_contents) }
+
+      it "validates the md5 when reading from disk" do
+        expect(cache).to receive(:validate_file!)
+        cache.read(key, expected_md5)
+      end
+
+      it "does not throw an exception when the md5 is correct" do
+        expect {
+          cache.read(key, expected_md5)
+        }.to_not raise_error
+      end
+
+      it "raises an exception and deletes the file when the md5 is incorrect" do
+        expect {
+          cache.read(key, "naw")
+        }.to raise_error(DiskStore::MD5DidNotMatch)
+
+        expect(cache.exist?(key)).to be_false
+      end
+    end
   end
 
   context "#write" do
@@ -47,6 +73,29 @@ describe DiskStore do
       file_path = Dir[File.join(@tmpdir, "**/*")].last
       expect(File.binread(file_path)).to eq file_contents
     end
+
+    describe "md5 validation" do
+      let(:expected_md5) { Digest::MD5.hexdigest(file_contents) }
+
+      it "validates md5 after writing to disk" do
+        expect(cache).to receive(:validate_file!)
+        cache.write(key, file, expected_md5)
+      end
+
+      it "does not throw an exception when the md5 is correct" do
+        expect {
+          cache.write(key, file, expected_md5)
+        }.to_not raise_error
+      end
+
+      it "raises an exception and deletes the file when the md5 is incorrect" do
+        expect {
+          cache.write(key, file, "i am incorrect")
+        }.to raise_error(DiskStore::MD5DidNotMatch)
+
+        expect(cache.exist?(key)).to be_false
+      end
+    end
   end
 
   context "#delete" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disk_store
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kelly Sutton