fragmenter 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d849a0a1482e71d93c6c90ea5a9336e2ced2be6
-  data.tar.gz: 1d87cae0a38cc7dddce3d76a08a5181a7d11587b
+  metadata.gz: b5931e8212db98c33d0d78dc0b857214a27f8c33
+  data.tar.gz: 9cc17e75a60b88e87f75e561a7f203874e769898
 SHA512:
-  metadata.gz: 14a4a61707cf76f83ceff137473dd8343b2ec7a1a0f5c645900c78dbb472516a943075cdae551be02efdf2e7e527e87e7a01afe62e21299738d23f04914382e0
-  data.tar.gz: 3720a5b353199f1be826f663b758873d0311d0fa4a032a9ebdb99bcfeedcad5059bf4e9b180fea48e2b359dd5726551e6093a89bd718a3bb9b9c6c1b0ebaa47d
+  metadata.gz: 8f48a59ba0829ad7f7366a3e32c3ccb6c9639cabf6cae23fdf54bc6f877e5f184e20bc34e84f83c6cfc9a013923abf3c9deffc1eaf9502e0915fadfdc3bbd6c0
+  data.tar.gz: 6b15e275846e7eb2d3199016f09f3a7e60a766850bdd17e3db49f0bfce624492b9721ea3c17b3dbb6bbd466ab78982fe98d6161cc05dafc4745b9ea525ee759c

data/HISTORY.md

@@ -1,3 +1,12 @@
+# 1.0.0.rc2
+
+* Automatically rewind IO objects between reads. This fixes the issue of
+  multiple validations preventing storage.
+* Expose storage errors along with validation errors when using the uploader.
+* Make good on the documented `ImageValidator`. The implemented version has no
+  additional gem dependencies, but does rely on ImageMagick for its `identify`
+  command.
+
 # 1.0.0.rc1
 
 * Add modules for easiy integration with Rails controllers and models.

data/README.md

@@ -170,10 +170,11 @@ response with an accompanying message and errors:
   ]
 }
 ```
+
 As images uploads are a common use-case for fragmented uploading an
-ImageValidator is included, but not one of the default validators. You can
-control with validators are used by overriding the `validators` method within
-the controller:
+ImageValidator is included, but not as one of the defaults. You can control
+which validators are used by overriding the `validators` method within the
+controller:
 
 ```ruby
 class AvatarUploader < ApplicationController
@@ -188,8 +189,12 @@ end
 ```
 
 To add a custom validator you must add it at some point in the validator chain.
-A validator can be any class that responds to `valid?` with a boolean value and
-provides a list of errors. See the [ImageValidator][1] for an example validator
-that only performs validation when all fragments are complete.
+A validator can be any class that responds to `valid?`, `part?`, and provides a
+list of errors. See the [ImageValidator][1] for an example validator that only
+performs validation when all fragments are complete.
+
+Note that [ImageMagick][2] is required for the ImageValidator to work, but it
+doesn't require `RMagick` or `MiniMagick`.
 
 [1]:lib/fragmenter/validators/image
+[2]:http://www.imagemagick.org/script/identify.php

data/fragmenter.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors      = ['Parker Selbert']
   gem.email        = ['parker@sorentwo.com']
   gem.homepage     = 'https://github.com/dscout/fragmenter'
+  gem.license      = 'MIT'
   gem.description  = %q{Fragmentize and rebuild data}
   gem.summary      = <<-SUMMARY
     Multipart upload support backed by Redis. Fragmenter handles storing

data/lib/fragmenter.rb

@@ -8,6 +8,7 @@ require 'fragmenter/rails/model'
 require 'fragmenter/services/uploader'
 require 'fragmenter/services/storer'
 require 'fragmenter/validators/checksum_validator'
+require 'fragmenter/validators/image_validator'
 
 module Fragmenter
   class << self

data/lib/fragmenter/request.rb

@@ -11,7 +11,7 @@ module Fragmenter
 
     def body
       if @body.respond_to?(:read)
-        @body.read
+        @body.read.tap { |_| @body.rewind }
       else
         @body
       end

data/lib/fragmenter/services/uploader.rb

@@ -16,7 +16,7 @@ module Fragmenter
       end
 
       def store
-        stored    = valid? && storer.store
+        stored    = parts_valid? && storer.store && rebuilt_valid?
         @complete = fragmenter.complete?
 
         if stored && complete?
@@ -27,15 +27,19 @@ module Fragmenter
       end
 
       def errors
-        validator_instances.map(&:errors).flatten
+        [validator_instances.map(&:errors), storer.errors].flatten
       end
 
       def complete?
         !!@complete
       end
 
-      def valid?
-        validator_instances.all?(&:valid?)
+      def parts_valid?
+        validator_instances.select(&:part?).all?(&:valid?)
+      end
+
+      def rebuilt_valid?
+        validator_instances.reject(&:part?).all?(&:valid?)
       end
 
       private

data/lib/fragmenter/validators/checksum_validator.rb

@@ -10,6 +10,10 @@ module Fragmenter
         @errors  = []
       end
 
+      def part?
+        true
+      end
+
       def valid?
         matches = expected.nil? || expected == calculated
 

data/lib/fragmenter/validators/image_validator.rb

@@ -0,0 +1,42 @@
+module Fragmenter
+  module Validators
+    class ImageValidator
+      attr_reader :errors, :request
+
+      def initialize(request)
+        @request = request
+        @errors  = []
+      end
+
+      def part?
+        false
+      end
+
+      def valid?
+        return true unless fragmenter.complete?
+
+        identifiable = identifiable?
+
+        unless identifiable
+          errors << 'Rebuilt fragments are not a valid image'
+        end
+
+        identifiable
+      end
+
+      private
+
+      def fragmenter
+        request.fragmenter
+      end
+
+      def identifiable?
+        IO.popen('identify -', 'w', err: '/dev/null', out: '/dev/null') do |io|
+          io << fragmenter.rebuild
+        end
+
+        $?.success?
+      end
+    end
+  end
+end

data/lib/fragmenter/version.rb

@@ -1,3 +1,3 @@
 module Fragmenter
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

data/spec/fragmenter/request_spec.rb

@@ -7,6 +7,11 @@ describe Fragmenter::Request do
       expect(request.body).to eq('blob')
     end
 
+    it 'automaticaly rewinds after reading IO' do
+      request = Fragmenter::Request.new(body: StringIO.new('blob'))
+      expect([request.body, request.body]).to eq(%w[blob blob])
+    end
+
     it 'does not attempt to read the body if it is not IO' do
       request = Fragmenter::Request.new(body: 'blob')
       expect(request.body).to eq('blob')

data/spec/fragmenter/services/uploader_spec.rb

@@ -13,8 +13,12 @@ describe Fragmenter::Services::Uploader do
       expect(uploader.store).to be_true
     end
 
-    it 'does not attempt to store fragments if any validators are invalid' do
+    it 'does not attempt to store fragments if any part validators are invalid' do
       validator = Struct.new(:request) do
+        def part?
+          true
+        end
+
         def valid?
           false
         end
@@ -42,6 +46,25 @@ describe Fragmenter::Services::Uploader do
 
       uploader.store
     end
+
+    it 'does not instruct the resource to rebuild if the full content is invalid' do
+      validator = Struct.new(:request) do
+        def part?;  false; end
+        def valid?; false; end
+      end
+
+      resource   = double(:resource)
+      fragmenter = double(:fragmenter, complete?: true)
+      storer     = double(:storer, store: true)
+      request    = Fragmenter::Request.new(resource: resource, fragmenter: fragmenter)
+      uploader   = Uploader.new(request, [validator])
+
+      uploader.storer = storer
+
+      expect(resource).to_not receive(:rebuild_fragments)
+
+      uploader.store
+    end
   end
 
   describe '#complete?' do
@@ -53,21 +76,23 @@ describe Fragmenter::Services::Uploader do
   end
 
   describe '#errors' do
-    it 'merges the errors from all validators' do
+    it 'merges the errors from all validators and the storer' do
       validator_a = Struct.new(:request) do
+        def part?;  true;  end
         def valid?; false; end
         def errors; ['bad']; end
       end
 
       validator_b = Struct.new(:request) do
+        def part?;  true; end
         def valid?; false; end
         def errors; ['invalid']; end
       end
 
       uploader = Uploader.new({}, [validator_a, validator_b])
-      uploader.valid?
+      uploader.storer = double(:storer, errors: ['horrible'])
 
-      expect(uploader.errors).to eq(%w[bad invalid])
+      expect(uploader.errors).to eq(%w[bad invalid horrible])
     end
   end
 end

data/spec/fragmenter/validators/checksum_validator_spec.rb

@@ -1,11 +1,13 @@
 require 'fragmenter/validators/checksum_validator'
 
 describe Fragmenter::Validators::ChecksumValidator do
-  Validator = Fragmenter::Validators::ChecksumValidator
+  let(:validator) do
+    Fragmenter::Validators::ChecksumValidator
+  end
 
   describe '#valid?' do
     it 'is always valid if no expected checksum was given' do
-      expect(Validator.new(double(headers: {}))).to be_valid
+      expect(validator.new(double(headers: {}))).to be_valid
     end
 
     it 'is valid if the expected checksum matches the body checksum' do
@@ -14,7 +16,7 @@ describe Fragmenter::Validators::ChecksumValidator do
         headers: { 'HTTP_CONTENT_MD5' => '4ac8660969d304047daa9c3539f63682' }
       )
 
-      expect(Validator.new(request)).to be_valid
+      expect(validator.new(request)).to be_valid
     end
 
     it 'is not valid if the expected checksum does not match the body checksum' do
@@ -23,7 +25,7 @@ describe Fragmenter::Validators::ChecksumValidator do
         headers: { 'HTTP_CONTENT_MD5' => 'a9c3539f636824ac8660969d304047da' }
       )
 
-      expect(Validator.new(request)).to_not be_valid
+      expect(validator.new(request)).to_not be_valid
     end
 
     it 'records an error when the checksums do not match' do
@@ -32,10 +34,10 @@ describe Fragmenter::Validators::ChecksumValidator do
         headers: { 'HTTP_CONTENT_MD5' => 'a9c3539f636824ac8660969d304047da' }
       )
 
-      validator = Validator.new(request)
-      validator.valid?
+      instance = validator.new(request)
+      instance.valid?
 
-      expect(validator.errors.length).to be_nonzero
+      expect(instance.errors.length).to be_nonzero
     end
   end
 end

data/spec/fragmenter/validators/image_validator_spec.rb

@@ -0,0 +1,35 @@
+require 'fragmenter/request'
+require 'fragmenter/validators/image_validator'
+
+describe Fragmenter::Validators::ImageValidator do
+  let(:validator) do
+    Fragmenter::Validators::ImageValidator
+  end
+
+  describe '#valid?' do
+    it 'bypasses validation checking if the fragmenter is incomplete' do
+      fragmenter = double(:fragmenter, complete?: false)
+      request    = Fragmenter::Request.new(fragmenter: fragmenter)
+
+      expect(validator.new(request)).to be_valid
+    end
+
+    it 'is invalid with a body that can not be parsed as an image' do
+      fragmenter = double(:fragmenter, complete?: true, rebuild: '01010101')
+      request    = Fragmenter::Request.new(fragmenter: fragmenter)
+
+      instance = validator.new(request)
+
+      expect(instance).to_not be_valid
+      expect(instance.errors.length).to be_nonzero
+    end
+
+    it 'is valid with a body that can be parsed as an image' do
+      image = IO.read('spec/fixtures/micro.gif')
+      fragmenter = double(:fragmenter, complete?: true, rebuild: image)
+      request    = Fragmenter::Request.new(fragmenter: fragmenter)
+
+      expect(validator.new(request)).to be_valid
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fragmenter
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -63,8 +63,10 @@ files:
 - lib/fragmenter/services/storer.rb
 - lib/fragmenter/services/uploader.rb
 - lib/fragmenter/validators/checksum_validator.rb
+- lib/fragmenter/validators/image_validator.rb
 - lib/fragmenter/version.rb
 - lib/fragmenter/wrapper.rb
+- spec/fixtures/micro.gif
 - spec/fragmenter/fragment_spec.rb
 - spec/fragmenter/rails/controller_spec.rb
 - spec/fragmenter/rails/model_spec.rb
@@ -73,11 +75,13 @@ files:
 - spec/fragmenter/services/storer_spec.rb
 - spec/fragmenter/services/uploader_spec.rb
 - spec/fragmenter/validators/checksum_validator_spec.rb
+- spec/fragmenter/validators/image_validator_spec.rb
 - spec/fragmenter/wrapper_spec.rb
 - spec/fragmenter_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dscout/fragmenter
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -102,6 +106,7 @@ summary: Multipart upload support backed by Redis. Fragmenter handles storing mu
   parts of a larger binary and rebuilding it back into the original after all parts
   have been stored.
 test_files:
+- spec/fixtures/micro.gif
 - spec/fragmenter/fragment_spec.rb
 - spec/fragmenter/rails/controller_spec.rb
 - spec/fragmenter/rails/model_spec.rb
@@ -110,6 +115,7 @@ test_files:
 - spec/fragmenter/services/storer_spec.rb
 - spec/fragmenter/services/uploader_spec.rb
 - spec/fragmenter/validators/checksum_validator_spec.rb
+- spec/fragmenter/validators/image_validator_spec.rb
 - spec/fragmenter/wrapper_spec.rb
 - spec/fragmenter_spec.rb
 - spec/spec_helper.rb