paperclip_archive_processor 0.3.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'paperclip', '~> 2.3.3'
+gem 'zip', '>= 2.0.2'
+gem 'aws-s3', :require => 'aws/s3'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "mocha", ">= 0"
+  gem "redgreen"
+  gem "activerecord"
+  gem "activesupport"
+  gem "sqlite3-ruby", "~>1.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    aws-s3 (0.6.2)
+      builder
+      mime-types
+      xml-simple
+    builder (2.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mime-types (1.16)
+    mocha (0.9.10)
+      rake
+    paperclip (2.3.8)
+      activerecord
+      activesupport
+    rake (0.8.7)
+    rcov (0.9.9)
+    redgreen (1.2.2)
+    shoulda (2.11.3)
+    sqlite3-ruby (1.3.2)
+    tzinfo (0.3.24)
+    xml-simple (1.0.12)
+    zip (2.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activesupport
+  aws-s3
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  mocha
+  paperclip (~> 2.3.3)
+  rcov
+  redgreen
+  shoulda
+  sqlite3-ruby (~> 1.3.0)
+  zip (>= 2.0.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 sleistner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= paperclip_archive_processor
+
+Description goes here.
+
+== Contributing to paperclip_archive_processor
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 sleistner. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,61 @@
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "paperclip_archive_processor"
+  gem.homepage = "http://github.com/sleistner/paperclip_archive_processor"
+  gem.license = "MIT"
+  gem.summary = %Q{
+    extract paperclip attachments and save them to file or s3 storage
+  }
+  gem.description = %Q{
+    extract paperclip attachments and save them to file or s3 storage
+  }
+  gem.email = "sleistner@gmail.com"
+  gem.authors = ["sleistner"]
+  gem.add_dependency 'paperclip', '~> 2.3.3'
+  gem.add_dependency 'zip', '>= 2.0.2'
+  gem.add_dependency 'aws-s3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "paperclip_archive_processor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Start an IRB session with all necessary files required.'
+task :shell do |t|
+  chdir File.dirname(__FILE__)
+  exec 'irb -I lib/ -I lib/paperclip_archive_processor -r rubygems -r tempfile -r test/helper'
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/lib/paperclip_archive_processor.rb

@@ -0,0 +1,11 @@
+require 'paperclip'
+require 'paperclip_archive_processor/integration'
+require 'paperclip_archive_processor/processor'
+require 'paperclip_archive_processor/extractor'
+require 'paperclip_archive_processor/zip_util'
+
+if defined?(Paperclip::InstanceMethods)
+  Paperclip::ClassMethods.send(:extend, PaperclipArchiveProcessor::Integration)
+end
+
+

data/lib/paperclip_archive_processor/extractor.rb

@@ -0,0 +1,27 @@
+module PaperclipArchiveProcessor
+
+  module Extractor
+
+    class ExtractorNotFound < StandardError; end
+
+    def self.extractor_for(content_type)
+      case content_type
+      when /zip/ then Zip
+      else
+        raise ExtractorNotFound, "Cannot load extractor for content type '#{content_type}'"
+      end
+    end
+
+    class Zip
+
+      def self.extract(file, destination)
+        PaperclipArchiveProcessor::ZipUtil.unpack(file, destination).map do |entry|
+          entry.name
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/paperclip_archive_processor/integration.rb

@@ -0,0 +1,66 @@
+module PaperclipArchiveProcessor
+
+  module Integration
+    def self.extended(base)
+      base.extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+
+    def self.extended(base)
+      base.module_eval do
+
+        private
+
+        def create_callback(name, &block)
+          class_eval do
+            define_method(name, &block)
+          end
+        end
+
+        def define_before_save_callback(variable_name, attachment_name)
+          name = "before_save_filter_for_#{attachment_name}"
+          create_callback(name) do
+            instance_variable_set(variable_name, try(attachment_name).dirty?)
+            true
+          end
+          send(:before_save, name)
+        end
+
+        def define_after_save_callback(variable_name, attachment_name)
+          name = "after_save_filter_for_#{attachment_name}"
+          create_callback(name) do
+            if instance_variable_get(variable_name)
+              PaperclipArchiveProcessor::Processor.extract(try(attachment_name))
+              true
+            end
+          end
+          send(:after_save, name)
+        end
+
+        def define_processor_callbacks(attachment_name)
+          variable_name = "@_#{attachment_name}_has_changed"
+          define_before_save_callback(variable_name, attachment_name)
+          define_after_save_callback(variable_name, attachment_name)
+        end
+
+        public
+
+        alias has_attached_file_original has_attached_file
+
+        def has_attached_file(name, options = {})
+          has_attached_file_original(name, options)
+
+          if options.delete(:extract_archive)
+            define_processor_callbacks(name)
+          end
+        end
+      end
+
+    end
+
+  end
+
+end
+

data/lib/paperclip_archive_processor/processor.rb

@@ -0,0 +1,63 @@
+module PaperclipArchiveProcessor
+
+  module Processor
+
+    class StorageMethodNotFound < StandardError; end
+
+    def self.extract(attachment)
+      extractor = PaperclipArchiveProcessor::Extractor.extractor_for(attachment.content_type)
+      processor = processor_for(attachment)
+      processor.extract(attachment, extractor)
+    end
+
+    private
+
+    def self.processor_for(attachment)
+      storage_class_name = attachment.instance_variable_get(:@storage).to_s.capitalize
+      begin
+        PaperclipArchiveProcessor::Processor.const_get(storage_class_name)
+      rescue NameError
+        raise StorageMethodNotFound, "Cannot load storage module '#{storage_class_name}'"
+      end
+    end
+
+    class Filesystem
+      def self.extract(attachment, extractor)
+        path = attachment.to_file.path
+        extractor.extract(path, File.dirname(path))
+      end
+    end
+
+    class S3
+
+      def self.extract(attachment, extractor)
+        extract_path    = Dir.mktmpdir
+        s3_path_prefix  = File.dirname(attachment.path)
+        bucket_name     = attachment.instance_variable_get(:@options)[:bucket]
+        options         = options_for(attachment)
+
+        extractor.extract(attachment.to_file.path, extract_path).each do |name|
+          file = File.join(extract_path, name)
+          write(File.join(s3_path_prefix, name), File.new(file), bucket_name, options) if File.file?(file)
+        end
+      end
+
+      def self.options_for(attachment)
+        { :content_type => attachment.content_type,
+          :access => attachment.instance_variable_get(:@s3_permissions)
+        }.merge(attachment.instance_variable_get(:@s3_headers))
+      end
+
+      def self.write(path, file, bucket_name, options)
+        begin
+          AWS::S3::S3Object.store(path, file, bucket_name, options)
+        rescue AWS::S3::ResponseError
+          raise
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/paperclip_archive_processor/zip_util.rb

@@ -0,0 +1,74 @@
+require 'zip/zipfilesystem'
+require 'fileutils'
+
+module PaperclipArchiveProcessor
+
+  class ZipUtil #:nodoc:
+
+    # Pack up an archive from a directory on disk
+    def self.pack(input, archive, excludes)
+      Zip::ZipFile.open(archive, Zip::ZipFile::CREATE) do |zip|
+        add_file_to_zip(zip, input, excludes)
+      end
+    end
+
+    def self.pack_single_file(input, archive)
+      Zip::ZipFile.open(archive, Zip::ZipFile::CREATE) do |zip|
+        file_name = File.basename(input)
+        zip.add(file_name, input)
+      end
+    end
+
+    # Unpack an archive to a directory on disk
+    def self.unpack(archive, destination)
+      Zip::ZipFile.open(archive) do |zip|
+        unpack_file(zip, destination)
+      end
+    end
+
+    def self.unpack_file(zip, destination, path='')
+      if(zip.file.file?(path))
+        FileUtils.mkdir_p(destination)
+        File.open(File.join(destination, path), 'w') do |dest|
+          zip.file.open(path) do |src|
+            dest.write src.read
+          end
+        end
+      else
+        dir = File.join(destination, path)
+        Dir.mkdir(dir) rescue puts("Directory Exists #{dir}")
+        zip.dir.foreach(path) do |dir|
+          unpack_file(zip, destination, File.join(path, dir))
+        end
+      end
+    end
+
+    def self.add_file_to_zip(zip, path, excludes)
+      if(File.directory?(path))
+        zip.dir.mkdir(path)
+        Dir.open(path).each do |child|
+          if(!excluded?(child, excludes))
+            add_file_to_zip(zip, File.join(path, child), excludes)
+          end
+        end
+      else
+        File.open(path) do |src|
+          zip.file.open(path, 'w') do |dest|
+            dest.write src.read
+          end
+        end
+      end
+    end
+
+    def self.excluded?(str, excludes)
+      excludes.each do |exc|
+        if(str == exc)
+          return true
+        end
+      end
+      return false
+    end
+
+  end
+
+end

data/paperclip_archive_processor.gemspec

@@ -0,0 +1,120 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{paperclip_archive_processor}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["sleistner"]
+  s.date = %q{2011-01-20}
+  s.description = %q{
+    extract paperclip attachments and save them to file or s3 storage
+  }
+  s.email = %q{sleistner@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://github.com/sleistner/paperclip_archive_processor}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{extract paperclip attachments and save them to file or s3 storage}
+  s.test_files = [
+    "test/extractor_test.rb",
+    "test/helper.rb",
+    "test/integration_test.rb",
+    "test/processor_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<paperclip>, ["~> 2.3.3"])
+      s.add_runtime_dependency(%q<zip>, [">= 2.0.2"])
+      s.add_runtime_dependency(%q<aws-s3>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<redgreen>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<paperclip>, ["~> 2.3.3"])
+      s.add_runtime_dependency(%q<zip>, [">= 2.0.2"])
+      s.add_runtime_dependency(%q<aws-s3>, [">= 0"])
+    else
+      s.add_dependency(%q<paperclip>, ["~> 2.3.3"])
+      s.add_dependency(%q<zip>, [">= 2.0.2"])
+      s.add_dependency(%q<aws-s3>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<redgreen>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, ["~> 1.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<paperclip>, ["~> 2.3.3"])
+      s.add_dependency(%q<zip>, [">= 2.0.2"])
+      s.add_dependency(%q<aws-s3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<paperclip>, ["~> 2.3.3"])
+    s.add_dependency(%q<zip>, [">= 2.0.2"])
+    s.add_dependency(%q<aws-s3>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<redgreen>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, ["~> 1.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<paperclip>, ["~> 2.3.3"])
+    s.add_dependency(%q<zip>, [">= 2.0.2"])
+    s.add_dependency(%q<aws-s3>, [">= 0"])
+  end
+end
+