magic-paperclip 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+test/debug.log
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in paperclip-filemagic.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,74 @@
+# MagicPaperclip
+
+[Paperclip] is a wonderful module by Thoughtbot that lets makes handling
+attachments in Rails a breeze, except for one minor niggle - file types. It
+relies on the content type header sent by the browser which is woefully
+inconsistent. For example, when uploading a zip the possible values sent
+for content type are:
+
++ '`application/octet-stream`'
++ '`application/x-zip-compressed`'
++ '`application/zip`'
++ '' (yes empty)
+
+In short you can't rely on Content-Type from the browser to ever have a
+sensible value.
+
+Thus the purpose of this module: it uses the wonderful
+[libmagic](http://www.darwinsys.com/file/) to work out the file type based
+on the contents of the uploaded file without shelling out to `file` to do its
+work.
+
+# Requirements
+
+The ruby-filemagic gem (which this gem uses) depends upon `libmagic` must be
+installed to give us file type detection. On Linux this means installing the
+relevant package:
+
+    sudo apt-get install libmagic-dev # Deb
+    sudo yum install file-devel # rpm
+    sudo emerge file # gentoo
+
+On OSX ships with the `file` binary but not the `libmagic` shared library so I
+recommend installing it via [homebrew]:
+
+    brew install libmagic
+    # Since this will be in a non-standard place we need to build ruby-filemagic specially
+    gem install ruby-filemagic -- --with-opt-dir=$(brew list libmagic | head -n1 | xargs dirname)
+
+# Installation
+
+Include the gem in your Gemfile:
+
+    gem 'magic-paperclip'
+
+# Usage
+
+Its all automatic - magic-paperclip does its trick by just being in the
+Gemfile (via a Railtie).
+
+When a Paperclip attachment is assigned to its content_type will be detected
+and will overwrite what the browser sends.
+
+# Caveats/Bugs
+
+libmagic often returns charset info or similar for files (i.e. `text/plain;
+charset=us-asci`) that this module attempts to remove to use just the base
+type. Supposedly older versions of libmagic might return this in a
+different format and thus not get removed. If you find an example of this
+happening please let me know.
+
+# Credits & License
+
+![digiresults](https://www.digiresults.com/stylesheets/images/logo_white.png)
+
+This gem was developed for use at [DigiResults] and pulled out into a reusable gem.
+
+Released under the [MIT License][MIT]
+
+Copyright (c) 2011, Ash Berlin and DigiResults Ltd.
+
+[Paperclip]: http://github.com/thoughtbot/paperclip
+[homebrew]: http://mxcl.github.com/homebrew/
+[MIT]: http://creativecommons.org/licenses/MIT/
+[DigiResults]: http://www.digiresults.com/

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/magic-paperclip.rb

@@ -0,0 +1,48 @@
+# Released under MIT License
+# Copyright (c) 2011 Ash Berlin and DigiResults Ltd.
+
+require 'filemagic'
+require 'paperclip'
+
+require 'magic-paperclip/railtie'
+
+module Paperclip
+  def self.magic_content_type!
+    Attachment.send :include, MagicPaperclip
+  end
+end
+
+module MagicPaperclip
+  def self.included( base )
+    base.class_eval do
+      alias_method :assign_without_filemagic, :assign
+      alias_method :assign, :assign_with_filemagic
+    end
+  end
+
+  def assign_with_filemagic( uploaded_file )
+    # Call next method up the chain
+    val = assign_without_filemagic( uploaded_file )
+
+    return val if uploaded_file.is_a?( Paperclip::Attachment )
+
+    if uploaded_file
+      magic = FileMagic.new( FileMagic::MAGIC_MIME )
+
+      if defined?( StringIO ) && uploaded_file.is_a?( StringIO )
+        type = magic.buffer( uploaded_file.string )
+      else
+        type = magic.file( uploaded_file.path )
+      end
+
+      # Remove the '; charset=us-ascii' from the end if there is one
+      type.sub! /\s*;.*$/, ''
+
+      instance_write( :content_type, type )
+    end
+    val
+  ensure
+    magic.close if magic
+  end
+
+end

data/lib/magic-paperclip/railtie.rb

@@ -0,0 +1,12 @@
+require 'magic-paperclip'
+
+module MagicPaperclip
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'magic-paperclip' do
+        Paperclip.magic_content_type!
+      end
+    end
+  end
+end

data/lib/magic-paperclip/version.rb

@@ -0,0 +1,3 @@
+module MagicPaperclip
+  VERSION = "0.0.1"
+end

data/magic-paperlcip.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "magic-paperclip/version"
+
+Gem::Specification.new do |s|
+  s.name        = "magic-paperclip"
+  s.version     = MagicPaperclip::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ash Berlin"]
+  s.email       = ["ash.berlin@gmail.com"]
+  s.homepage    = "https://github.com/DigiResults/magic-paperclip"
+  s.summary     = %q{Filemagic based mimetype detection for Paperclip}
+  s.description = %q{Adds better (a.k.a magic) file type detection support into Thoughtbot's Paperclip}
+
+  #s.rubyforge_project = "paperclip-filemagic"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'ruby-filemagic'
+  s.add_dependency 'paperclip'
+
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'sqlite3-ruby'
+end

data/test/content_type_test.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class ContentTypeTest < Test::Unit::TestCase
+  context "Assigning a StringIO attachment" do
+    setup do
+      rebuild_model
+      @file  = StringIO.new("abc")
+      @file.stubs(:original_filename).returns("5k.png\n\n")
+      @file.stubs(:content_type).returns("image/png\n\n")
+      @file.stubs(:to_tempfile).returns(@file)
+      @dummy = Dummy.new
+      @dummy.avatar = @file
+    end
+
+    should "set content_type based on file magic" do
+      assert_equal "text/plain", @dummy.avatar.content_type
+      assert_equal "text/plain", @dummy.avatar_content_type
+    end
+  end
+
+  context "Assigning a ZIP upfile attachment" do
+    setup do
+      rebuild_model
+      @file = File.new File.join( FIXTURES_DIR, 'zip_file_called.txt' )
+      class << @file
+        include Paperclip::Upfile
+      end
+
+      @file.stubs(:content_type).returns("") # Some versions of chrome do this
+      @dummy = Dummy.new
+      @dummy.avatar = @file
+    end
+
+    should "set content_type based on file magic" do
+      assert_equal "application/zip", @dummy.avatar.content_type
+      assert_equal "application/zip", @dummy.avatar_content_type
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/helper.rb

@@ -0,0 +1,42 @@
+# Copied from Paperclip's own test suite
+
+require 'active_record'
+require 'mocha'
+require 'shoulda'
+require 'test/unit'
+
+require 'magic-paperclip'
+
+Paperclip.magic_content_type!
+
+FIXTURES_DIR = File.join(File.dirname(__FILE__), "fixtures")
+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'])
+
+
+class Dummy
+end
+
+def rebuild_model options = {}
+  ActiveRecord::Base.connection.create_table :dummies, :force => true do |table|
+    table.column :other, :string
+    table.column :avatar_file_name, :string
+    table.column :avatar_content_type, :string
+    table.column :avatar_file_size, :integer
+    table.column :avatar_updated_at, :datetime
+    table.column :avatar_fingerprint, :string
+  end
+  rebuild_class options
+end
+
+def rebuild_class options = {}
+  ActiveRecord::Base.send(:include, Paperclip::Glue)
+  Object.send(:remove_const, "Dummy") rescue nil
+  Object.const_set("Dummy", Class.new(ActiveRecord::Base))
+  Dummy.class_eval do
+    include Paperclip::Glue
+    has_attached_file :avatar, options
+  end
+end
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: magic-paperclip
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ash Berlin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-filemagic
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Adds better (a.k.a magic) file type detection support into Thoughtbot's Paperclip
+email: 
+- ash.berlin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/magic-paperclip.rb
+- lib/magic-paperclip/railtie.rb
+- lib/magic-paperclip/version.rb
+- magic-paperlcip.gemspec
+- test/content_type_test.rb
+- test/database.yml
+- test/fixtures/zip_file_called.txt
+- test/helper.rb
+has_rdoc: true
+homepage: https://github.com/DigiResults/magic-paperclip
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Filemagic based mimetype detection for Paperclip
+test_files: 
+- test/content_type_test.rb
+- test/database.yml
+- test/fixtures/zip_file_called.txt
+- test/helper.rb