paperclip_archive_processor 0.3.1

data/test/extractor_test.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class ExtractorTest < Test::Unit::TestCase
+
+  context '#find_extractor' do
+
+    context 'content type "application/x-zip-compressed" given' do
+
+      should 'return the zip extractor' do
+        extractor = PaperclipArchiveProcessor::Extractor.extractor_for("application/x-zip-compressed")
+        assert_same PaperclipArchiveProcessor::Extractor::Zip, extractor
+      end
+
+    end
+
+
+    context 'unknown centent type given' do
+
+      should 'raise an extractor not found error' do
+        assert_raise PaperclipArchiveProcessor::Extractor::ExtractorNotFound do
+          PaperclipArchiveProcessor::Extractor.extractor_for("application/unknown-compressed")
+        end
+      end
+
+    end
+
+  end
+
+  context '#extract' do
+
+    context 'content type "application/x-zip-compressed" given' do
+
+      setup do
+        @extractor = PaperclipArchiveProcessor::Extractor.extractor_for("application/x-zip-compressed")
+      end
+
+      should 'invoke ZipUtil#unpack' do
+        destination = File.join(Dir::tmpdir, 'foo')
+        PaperclipArchiveProcessor::ZipUtil.expects(:unpack).with(file, destination).returns([])
+        @extractor.extract(file, destination)
+      end
+
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'redgreen'
+require 'active_record'
+require 'active_record/version'
+require 'active_support'
+require 'aws/s3'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'paperclip_archive_processor'
+
+ROOT = File.join(File.dirname(__FILE__), '..')
+
+class Test::Unit::TestCase
+  def setup
+    silence_warnings do
+      Object.const_set(:Rails, stub('Rails', :root => ROOT, :env => 'test'))
+    end
+    create_dummy_class
+  end
+end
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config['test'])
+
+
+def reset_class(class_name)
+  ActiveRecord::Base.send(:include, Paperclip::Glue)
+  Object.send(:remove_const, class_name) rescue nil
+  klass = Object.const_set(class_name, Class.new(ActiveRecord::Base))
+  klass.class_eval{ include Paperclip::Glue }
+  klass
+end
+
+def rebuild_table(table_name, options = {})
+  ActiveRecord::Base.connection.create_table table_name, :force => true do |table|
+    table.column :archive_file_name, :string
+    table.column :archive_content_type, :string
+    table.column :archive_file_size, :integer
+    table.column :archive_updated_at, :datetime
+    table.column :archive_fingerprint, :string
+  end
+end
+
+def create_dummy_class
+  reset_class(:Dummy)
+  rebuild_table(:dummies)
+end
+
+def file(name = '5x.zip')
+  (@_files ||= {})[name] ||= File.new(File.join(File.dirname(__FILE__), 'fixtures', name), 'rb')
+end

data/test/integration_test.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class IntegrationTest < Test::Unit::TestCase
+
+  should 'extend paperclip class methods' do
+    Paperclip::Railtie.insert
+    assert Paperclip::ClassMethods.public_method_defined?(:has_attached_file_original)
+  end
+
+  context 'has configured an attachment for :archive' do
+
+    context 'extract_archive option is set to true' do
+
+      setup do
+        Dummy.has_attached_file :archive, :extract_archive => true
+        @dummy = Dummy.new
+      end
+
+      context 'archive file assigned' do
+
+        setup do
+          @dummy.archive = file
+        end
+
+        should 'mark archive as dirty' do
+          @dummy.save
+          assert @dummy.instance_variable_get(:@_archive_has_changed)
+        end
+
+        should 'call the processor extract method' do
+          PaperclipArchiveProcessor::Processor.expects(:extract).with(@dummy.archive)
+          @dummy.save
+        end
+
+      end
+
+      context 'archive file unassigned' do
+
+        should 'mark not archive as dirty' do
+          @dummy.save
+          assert ! @dummy.instance_variable_get(:@_archive_has_changed)
+        end
+
+        should 'not call the processor extract method' do
+          PaperclipArchiveProcessor::Processor.expects(:extract).never
+          @dummy.save
+        end
+
+      end
+
+    end
+
+    context 'extract_archive option is undefined or set to false' do
+
+      setup do
+        Dummy.has_attached_file :archive
+        @dummy = Dummy.new
+        @dummy.archive = file
+      end
+
+      should 'not call the processor extract method' do
+        PaperclipArchiveProcessor::Processor.expects(:extract).never
+        @dummy.save
+      end
+
+    end
+
+  end
+end

data/test/processor_test.rb

@@ -0,0 +1,94 @@
+require 'helper'
+
+class ProcessorTest < Test::Unit::TestCase
+
+  context 'extract' do
+
+    context 'attachment content type "application/x-zip-compressed"' do
+
+      setup do
+        Dummy.has_attached_file :archive, :extract_archive => true
+        @dummy = Dummy.new
+        @dummy.archive = file
+      end
+
+      context 'attachment is configured to use the filesystem storage' do
+
+        should 'use the filesystem processor' do
+          PaperclipArchiveProcessor::Processor::Filesystem.expects(:extract).with(@dummy.archive, PaperclipArchiveProcessor::Extractor::Zip)
+          PaperclipArchiveProcessor::Processor.extract(@dummy.archive)
+        end
+
+        should 'call the extractor with local file paths' do
+          path = @dummy.archive.to_file.path
+          destination = File.dirname(path)
+          PaperclipArchiveProcessor::Extractor::Zip.expects(:extract).with(path, destination).returns([])
+          PaperclipArchiveProcessor::Processor.extract(@dummy.archive)
+        end
+
+      end
+
+      context 'attachment is configured to use the s3 storage' do
+
+      setup do
+        Dummy.has_attached_file :archive,
+                                :storage => :s3,
+                                :s3_credentials => { :access_key_id => 'id', :secret_access_key => 'key' },
+                                :url => ':s3_alias_url',
+                                :path => 'foo',
+                                :bucket => 'test',
+                                :extract_archive => true
+        @dummy = Dummy.new
+        @dummy.archive = file('5x.zip')
+      end
+
+        should 'use the s3 processor' do
+          PaperclipArchiveProcessor::Processor::S3.expects(:extract).with(@dummy.archive, PaperclipArchiveProcessor::Extractor::Zip)
+          PaperclipArchiveProcessor::Processor.extract(@dummy.archive)
+        end
+
+        should 'call the extractor with tempfile destination path' do
+          Dir.expects(:mktmpdir).returns(Dir.tmpdir).at_least_once
+          path = @dummy.archive.to_file.path
+          PaperclipArchiveProcessor::Extractor::Zip.expects(:extract).with(path, Dir.mktmpdir).returns([])
+          PaperclipArchiveProcessor::Processor.extract(@dummy.archive)
+        end
+
+        should 'upload to s3' do
+          archive = @dummy.archive
+          AWS::S3::S3Object.expects(:store).with(
+            regexp_matches(/.*[1-5]+$/),
+            kind_of(File),
+            archive.instance_variable_get(:@options)[:bucket],
+            {
+              :content_type => archive.content_type,
+              :access => archive.instance_variable_get(:@s3_permissions)
+            }.merge(archive.instance_variable_get(:@s3_headers))
+          ).times(5)
+          PaperclipArchiveProcessor::Processor.extract(@dummy.archive)
+        end
+
+      end
+
+      context 'attachment is configured to use an unknown storage type' do
+
+        setup do
+          Dummy.has_attached_file :archive, :extract_archive => true
+          @dummy = Dummy.new
+          @dummy.archive = file
+          @dummy.archive.instance_variable_set(:@storage, :tape)
+        end
+
+        should 'raise an storage not found error' do
+          assert_raise PaperclipArchiveProcessor::Processor::StorageMethodNotFound do
+            PaperclipArchiveProcessor::Processor.extract(@dummy.archive)
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,323 @@
+--- !ruby/object:Gem::Specification 
+name: paperclip_archive_processor
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
+platform: ruby
+authors: 
+- sleistner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: paperclip
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: zip
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: aws-s3
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: mocha
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: redgreen
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: activerecord
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: activesupport
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3-ruby
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id010
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id011
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id012
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: paperclip
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  requirement: *id013
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: zip
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  requirement: *id014
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: aws-s3
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id015
+description: "\n    extract paperclip attachments and save them to file or s3 storage\n  "
+email: sleistner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/paperclip_archive_processor.rb
+- lib/paperclip_archive_processor/extractor.rb
+- lib/paperclip_archive_processor/integration.rb
+- lib/paperclip_archive_processor/processor.rb
+- lib/paperclip_archive_processor/zip_util.rb
+- paperclip_archive_processor.gemspec
+- public/system/archives/1/original/1
+- public/system/archives/1/original/2
+- public/system/archives/1/original/3
+- public/system/archives/1/original/4
+- public/system/archives/1/original/5
+- public/system/archives/1/original/5x.zip
+- test/database.yml
+- test/debug.log
+- test/extractor_test.rb
+- test/fixtures/1x.zip
+- test/fixtures/2x.zip
+- test/fixtures/3x.zip
+- test/fixtures/4x.zip
+- test/fixtures/5x.zip
+- test/helper.rb
+- test/integration_test.rb
+- test/processor_test.rb
+has_rdoc: true
+homepage: http://github.com/sleistner/paperclip_archive_processor
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: extract paperclip attachments and save them to file or s3 storage
+test_files: 
+- test/extractor_test.rb
+- test/helper.rb
+- test/integration_test.rb
+- test/processor_test.rb