fragmenter 1.0.0.rc2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5931e8212db98c33d0d78dc0b857214a27f8c33
-  data.tar.gz: 9cc17e75a60b88e87f75e561a7f203874e769898
+  metadata.gz: 492790d602b011f85a9c59b2e7730e897b50b4c2
+  data.tar.gz: 15ce8668a07766801e7d1fbfa946e0a51f8481f2
 SHA512:
-  metadata.gz: 8f48a59ba0829ad7f7366a3e32c3ccb6c9639cabf6cae23fdf54bc6f877e5f184e20bc34e84f83c6cfc9a013923abf3c9deffc1eaf9502e0915fadfdc3bbd6c0
-  data.tar.gz: 6b15e275846e7eb2d3199016f09f3a7e60a766850bdd17e3db49f0bfce624492b9721ea3c17b3dbb6bbd466ab78982fe98d6161cc05dafc4745b9ea525ee759c
+  metadata.gz: 5c5961781e29d00c847b1683e87f50daf5bff5998db3eb92c0acc61065c9a8a657c4a178b695f2002ae3fcc99a81db81e8047f5679403d058554ebb3d9e213f3
+  data.tar.gz: afe3e60454e3b2e304cd351562befcad35168fddc5d0624c4ca4c4284b174a0c318323bdecf09c6e631fb9d6f92b483ba77322bffd6e9099baea8073a3d8eb4e

data/{HISTORY.md → CHANGELOG.md}

@@ -1,3 +1,8 @@
+# 1.0.0
+
+* Provide a convenience IO wrapper for rebuilt data with `Wrapper#to_io`.
+* Add integration specs for testing against the rack request/response interface
+
 # 1.0.0.rc2
 
 * Automatically rewind IO objects between reads. This fixes the issue of

data/README.md

@@ -143,6 +143,18 @@ curl -i
 #=> { "content_type": "image/jpeg", "fragments": [1,2], "total": 2 }
 ```
 
+If you need to customize the status codes for partial or complete `PUT`
+requests you can override the `update_status` method within the controller:
+
+```ruby
+private
+
+# Return 201 Created instead of 202 Accepted
+def update_status
+  uploader.complete? ? 201 : 200
+end
+```
+
 ### Validation
 
 Often you will want to be sure that all of the data is being stored without any

data/fragmenter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email        = ['parker@sorentwo.com']
   gem.homepage     = 'https://github.com/dscout/fragmenter'
   gem.license      = 'MIT'
-  gem.description  = %q{Fragmentize and rebuild data}
+  gem.description  = 'Fragmentize and rebuild data'
   gem.summary      = <<-SUMMARY
     Multipart upload support backed by Redis. Fragmenter handles storing
     multiple parts of a larger binary and rebuilding it back into the original
@@ -22,5 +22,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'redis', '~> 3.0.0'
-  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'rspec',     '~> 2.14.0'
+  gem.add_development_dependency 'rack-test', '~> 0.6.2'
+  gem.add_development_dependency 'sinatra',   '~> 1.4.3'
 end

data/lib/fragmenter.rb

@@ -2,6 +2,7 @@ require 'logger'
 require 'redis'
 require 'fragmenter/redis'
 require 'fragmenter/version'
+require 'fragmenter/dummy_io'
 require 'fragmenter/wrapper'
 require 'fragmenter/rails/controller'
 require 'fragmenter/rails/model'

data/lib/fragmenter/dummy_io.rb

@@ -0,0 +1,13 @@
+module Fragmenter
+  class DummyIO < StringIO
+    attr_writer   :content_type, :original_filename
+
+    def original_filename
+      @original_filename || ['dummy', content_type.split('/').last].join('.')
+    end
+
+    def content_type
+      @content_type || 'application/octet-stream'
+    end
+  end
+end

data/lib/fragmenter/rails/controller.rb

@@ -2,7 +2,7 @@ module Fragmenter
   module Rails
     module Controller
       def show
-        render json: fragmenter.as_json
+        render json: fragmenter.as_json, status: 200
       end
 
       def update
@@ -11,14 +11,14 @@ module Fragmenter
         else
           render json: {
             message: 'Upload of part failed.', errors: uploader.errors
-          }, status: :unprocessable_entity
+          }, status: 422
         end
       end
 
       def destroy
         fragmenter.clean!
 
-        render nothing: true, status: :no_content
+        render nothing: true, status: 204
       end
 
       private
@@ -37,13 +37,13 @@ module Fragmenter
             resource:   resource,
             fragmenter: fragmenter,
             body:       request.body,
-            headers:    request.headers
+            headers:    request.env
           ), validators
         )
       end
 
       def update_status
-        uploader.complete? ? :accepted : :ok
+        uploader.complete? ? 202 : 200
       end
     end
   end

data/lib/fragmenter/version.rb

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

data/lib/fragmenter/wrapper.rb

@@ -23,5 +23,11 @@ module Fragmenter
     def as_json
       engine.meta.merge('fragments' => engine.fragments)
     end
+
+    def to_io
+      Fragmenter::DummyIO.new(rebuild).tap do |io|
+        io.content_type = meta['content_type']
+      end
+    end
   end
 end

data/spec/fragmenter/dummy_io_spec.rb

@@ -0,0 +1,39 @@
+require 'fragmenter/dummy_io'
+
+describe Fragmenter::DummyIO do
+  it 'provies IO like access' do
+    io = Fragmenter::DummyIO.new
+
+    expect(io).to respond_to(:read)
+    expect(io).to respond_to(:length)
+  end
+
+  describe '#content_type' do
+    it 'defaults to application/octet-stream' do
+      expect(Fragmenter::DummyIO.new.content_type).to eq('application/octet-stream')
+    end
+
+    it 'can be overridden' do
+      io = Fragmenter::DummyIO.new
+      io.content_type = 'image/png'
+
+      expect(io.content_type).to eq('image/png')
+    end
+  end
+
+  describe '#original_filename' do
+    it 'defaults to a fake mime comprised of dummy and the content type' do
+      io = Fragmenter::DummyIO.new
+      io.content_type = 'image/png'
+
+      expect(io.original_filename).to eq('dummy.png')
+    end
+
+    it 'can be overriden' do
+      io = Fragmenter::DummyIO.new
+      io.original_filename = 'wonderful.png'
+
+      expect(io.original_filename).to eq('wonderful.png')
+    end
+  end
+end

data/spec/fragmenter/rails/controller_spec.rb

@@ -22,7 +22,8 @@ describe Fragmenter::Rails::Controller do
       controller.show
 
       expect(controller).to have_received(:render).with(
-        json: { 'fragments' => [] }
+        json: { 'fragments' => [] },
+        status: 200
       )
     end
   end
@@ -40,7 +41,7 @@ describe Fragmenter::Rails::Controller do
       expect(resource.fragmenter).to have_received(:clean!)
       expect(controller).to have_received(:render).with(
         nothing: true,
-        status: :no_content
+        status: 204
       )
     end
   end
@@ -59,7 +60,7 @@ describe Fragmenter::Rails::Controller do
       expect(uploader).to have_received(:store)
       expect(controller).to have_received(:render).with(
         json: { 'fragments' => [] },
-        status: :ok
+        status: 200
       )
     end
 
@@ -78,7 +79,7 @@ describe Fragmenter::Rails::Controller do
           message: 'Upload of part failed.',
           errors:  []
         },
-        status: :unprocessable_entity
+        status: 422
       )
     end
   end

data/spec/fragmenter/wrapper_spec.rb

@@ -1,15 +1,17 @@
-require 'fragmenter/wrapper'
+require 'fragmenter'
 
 describe Fragmenter::Wrapper do
   let(:object)       { double(:object, id: 1001) }
   let(:engine_class) { double(:engine_class, new: engine) }
   let(:engine)       { double(:engine) }
 
-  subject(:base) { Fragmenter::Wrapper.new(object, engine_class) }
+  subject(:wrapper) do
+    Fragmenter::Wrapper.new(object, engine_class)
+  end
 
   describe '#key' do
     it 'composes a key from the object class and id value' do
-      base.key.should match(/[a-z]+-\d+/)
+      expect(wrapper.key).to match(/[a-z]+-\d+/)
     end
   end
 
@@ -18,14 +20,14 @@ describe Fragmenter::Wrapper do
     let(:headers) { {} }
 
     it 'delegates #store to the storage engine' do
-      engine.should_receive(:store).with(blob, headers)
+      expect(engine).to receive(:store).with(blob, headers)
 
-      base.store(blob, headers)
+      wrapper.store(blob, headers)
     end
 
     it 'delegates #fragments to the storage engine' do
-      engine.should_receive(:fragments)
-      base.fragments
+      expect(engine).to receive(:fragments)
+      wrapper.fragments
     end
   end
 
@@ -34,9 +36,22 @@ describe Fragmenter::Wrapper do
       engine.stub('meta' => { 'content_type' => 'application/octet-stream' },
                   'fragments' => ['1', '2'])
 
-      base.as_json.tap do |json|
-        json.should have_key('content_type')
-        json.should have_key('fragments')
+      wrapper.as_json.tap do |json|
+        expect(json).to have_key('content_type')
+        expect(json).to have_key('fragments')
+      end
+    end
+  end
+
+  describe '#to_io' do
+    it 'wraps the rebuilt data in a Rack::Multipart::UploadedFile compatible IO object' do
+      engine.stub(meta: { 'content_type' => 'image/png' }, rebuild: '0101010')
+
+      wrapper.to_io.tap do |io|
+        expect(io).to be_instance_of(Fragmenter::DummyIO)
+        expect(io.read).to eq('0101010')
+        expect(io.content_type).to eq('image/png')
+        expect(io.original_filename).to eq('dummy.png')
       end
     end
   end

data/spec/requests/uploading_fragments_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'json'
+require 'rack/test'
+require 'support/resource'
+require 'support/uploads_app'
+
+describe 'Uploading Fragments' do
+  include Rack::Test::Methods
+
+  let(:app)      { UploadsApp }
+  let(:resource) { Resource.new(200) }
+
+  around do |example|
+    UploadsApp.resource = resource
+    Fragmenter.logger   = Logger.new('/dev/null')
+
+    example.run
+
+    Fragmenter.logger   = nil
+    UploadsApp.resource = nil
+  end
+
+  it 'Lists uploaded fragments' do
+    get '/'
+
+    expect(last_response.status).to eq(200)
+    expect(decoded_response).to eq('fragments' => [])
+
+    store_fragment(number: 1, total: 2)
+
+    get '/'
+
+    expect(last_response.status).to eq(200)
+    expect(decoded_response).to eq(
+      'content_type' => 'application/octet-stream',
+      'fragments'    => %w[1],
+      'total'        => '2'
+    )
+
+    clean_fragments!
+  end
+
+  it 'Stores uploaded fragments' do
+    header 'Content-Type',      'image/gif'
+    header 'X-Fragment-Number', '1'
+    header 'X-Fragment-Total',  '2'
+
+    put '/', file_data('micro.gif')
+
+    expect(last_response.status).to eq(200)
+    expect(decoded_response).to eq(
+      'content_type' => 'image/gif',
+      'fragments'    => %w[1],
+      'total'        => '2'
+    )
+
+    header 'X-Fragment-Number', '2'
+    header 'X-Fragment-Total',  '2'
+
+    put '/', file_data('micro.gif')
+
+    expect(last_response.status).to eq(202)
+    expect(decoded_response).to eq('fragments' => [])
+  end
+
+  it 'Destroys uploaded fragments' do
+    store_fragment(number: 1, total: 2)
+
+    delete '/'
+
+    expect(last_response.status).to eq(204)
+    expect(last_response.body).to eq('')
+    expect(fragmenter.fragments.length).to be_zero
+  end
+
+  private
+
+  def file_data(file)
+    IO.read("spec/fixtures/#{file}")
+  end
+
+  def decoded_response
+    JSON.parse(last_response.body)
+  end
+
+  def fragmenter
+    resource.fragmenter
+  end
+
+  def store_fragment(options = {})
+    number = options[:number]
+    total  = options[:total]
+
+    fragmenter.store(
+      '0101',
+      content_type: 'application/octet-stream',
+      number: number,
+      total:  total
+    )
+  end
+
+  def clean_fragments!
+    resource.fragmenter.clean!
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
+require 'bundler'
 require 'fragmenter'
 
+Bundler.setup
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/resource.rb

@@ -0,0 +1,9 @@
+require 'fragmenter/rails/model'
+
+Resource = Struct.new(:id) do
+  include Fragmenter::Rails::Model
+
+  def rebuild_fragments
+    fragmenter.rebuild && fragmenter.clean!
+  end
+end

data/spec/support/uploads_app.rb

@@ -0,0 +1,30 @@
+require 'fragmenter/rails/controller'
+require 'sinatra/base'
+
+class UploadsApp < Sinatra::Base
+  include Fragmenter::Rails::Controller
+
+  class << self
+    attr_accessor :resource
+  end
+
+  get('/')    { show }
+  put('/')    { update }
+  delete('/') { destroy }
+
+  private
+
+  def resource
+    self.class.resource
+  end
+
+  def render(options)
+    body = if options[:json]
+      JSON.dump(options[:json])
+    else
+      nil
+    end
+
+    [options[:status], body]
+  end
+end

data/spec/upload_server.rb

@@ -0,0 +1,11 @@
+require 'fragmenter'
+
+class Uploads < Sinatra::Base
+  include Fragmenter::Rails::Controller
+
+  put '/' do
+    show
+  end
+end
+
+run Uploads

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fragmenter
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -38,6 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.3
 description: Fragmentize and rebuild data
 email:
 - parker@sorentwo.com
@@ -48,13 +76,14 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
-- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - fragmenter.gemspec
 - lib/fragmenter.rb
+- lib/fragmenter/dummy_io.rb
 - lib/fragmenter/fragment.rb
 - lib/fragmenter/rails/controller.rb
 - lib/fragmenter/rails/model.rb
@@ -67,6 +96,7 @@ files:
 - lib/fragmenter/version.rb
 - lib/fragmenter/wrapper.rb
 - spec/fixtures/micro.gif
+- spec/fragmenter/dummy_io_spec.rb
 - spec/fragmenter/fragment_spec.rb
 - spec/fragmenter/rails/controller_spec.rb
 - spec/fragmenter/rails/model_spec.rb
@@ -78,7 +108,11 @@ files:
 - spec/fragmenter/validators/image_validator_spec.rb
 - spec/fragmenter/wrapper_spec.rb
 - spec/fragmenter_spec.rb
+- spec/requests/uploading_fragments_spec.rb
 - spec/spec_helper.rb
+- spec/support/resource.rb
+- spec/support/uploads_app.rb
+- spec/upload_server.rb
 homepage: https://github.com/dscout/fragmenter
 licenses:
 - MIT
@@ -94,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.0
@@ -107,6 +141,7 @@ summary: Multipart upload support backed by Redis. Fragmenter handles storing mu
   have been stored.
 test_files:
 - spec/fixtures/micro.gif
+- spec/fragmenter/dummy_io_spec.rb
 - spec/fragmenter/fragment_spec.rb
 - spec/fragmenter/rails/controller_spec.rb
 - spec/fragmenter/rails/model_spec.rb
@@ -118,4 +153,8 @@ test_files:
 - spec/fragmenter/validators/image_validator_spec.rb
 - spec/fragmenter/wrapper_spec.rb
 - spec/fragmenter_spec.rb
+- spec/requests/uploading_fragments_spec.rb
 - spec/spec_helper.rb
+- spec/support/resource.rb
+- spec/support/uploads_app.rb
+- spec/upload_server.rb