paperclip-gridfs 1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/README.md

@@ -0,0 +1,45 @@
+paperclip-gridfs
+================
+
+A fork of gmontard/paperclip-gridfs (which was apparently a fork of kristianmandrup/paperclip), however no fork reference was wanted to thoughtbot/paperclip
+
+## Usage
+
+There are two ways of configuring the GridFS connection. Either you create a connection or you reuse an existing connection.
+
+Creating a connection looks something like this:
+
+    class User
+      include MongoMapper::Document
+      include Paperclip::Glue
+
+      key :avatar_file_name, String
+      key :avatar_content_type, String
+      has_attached_file :avatar, :storage => :gridfs, :gridfs => {:database => 'avatars', :host => 'test.com'}, :path => "avatars/:style/:filename", :url => "/avatars/:style/:filename"
+    end
+
+When you already have a Mongo connection object (for example through Mongoid or MongoMapper) you can also reuse this connection:
+
+    class User
+      include MongoMapper::Document
+      include Paperclip::Glue
+
+      key :avatar_file_name, String
+      key :avatar_content_type, String
+      has_attached_file :avatar, :storage => :gridfs, :gridfs => {:database => MongoMapper.database}, :path => "avatars/:style/:filename", :url => "/avatars/:style/:filename"
+    end
+
+However, one then needs to also tie the URL's inside the app with the GridFS attachments (which can be viewed with `.to_file(style)`, outputting the binary contents, same as File.read). An example done in Sinatra, for the above class:
+
+    # Get user avatar
+    get '/avatars/:style/:id.:extension' do
+      if params[:id] != 'missing'
+        u = User.first(:id => params[:id])
+        content_type u.avatar.content_type
+        u.avatar.to_file(params[:style])
+      else
+        content_type 'image/png'
+        File.open('public/avatars/missing.png').read #haxx
+      end
+    end
+

data/lib/paperclip-gridfs.rb

@@ -0,0 +1 @@
+require 'paperclip/storage/gridfs'

data/lib/paperclip-gridfs/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module GridFS
+    VERSION = "1.0" unless defined? Paperclip::GridFS::VERSION
+  end
+end

data/lib/paperclip/storage/gridfs.rb

@@ -0,0 +1,95 @@
+module Paperclip
+  module Storage
+    # MongoDB's GridFS storage system (http://www.mongodb.org/display/DOCS/GridFS) uses
+    # a chunking strategy to store files in a mongodb database.
+    # Specific options for GridFS:
+    # * +gridfs_credentials+: Similar to +s3_credentials+, this can be a path, a File, or
+    #   a Hash. Keys are as follows:
+    #   * +database+: the name of the MongoDB database to connect to. This can also be
+    #     a +Mongo::DB+ object, in which case that connection will be used, and other
+    #     credentials will be ignored.
+    #   * +host+: defaults to +localhost+
+    #   * +username+ and +password+: optional authentication for the database server.
+    #
+    # Note that, because files stored using the +:gridfs+ storage module are stored
+    # within the database rather than the file system, you'll need to work out a method
+    # to extract the file data to serve it over HTTP. This is pretty trivial using
+    # Rails Metal.
+
+    module Gridfs
+      def self.extended base
+        begin
+          require 'mongo'
+        rescue LoadError => e
+          e.message << " (You may need to install the mongo gem)"
+          raise e
+        end
+      
+        base.instance_eval do
+          @gridfs_connection = get_database_connection(parse_credentials(@options[:gridfs]))
+          @gridfs            = Mongo::GridFileSystem.new(@gridfs_connection)
+        end
+      end
+
+      def parse_credentials creds
+        creds = find_credentials(creds).stringify_keys
+        env = Object.const_defined?(:Rails) ? Rails.env : nil
+        (creds[env] || creds).symbolize_keys
+      end
+      
+      def exists? style = default_style
+        if original_filename
+          !!@gridfs.exist?(:filename => path(style))
+        else
+          false
+        end
+      end
+      
+      # Returns a binary representation of the data of the file assigned to the given style
+      def to_file style = default_style
+        @queued_for_write[style] || (@gridfs.open(path(style), 'r') if exists?(style))
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          log("saving #{path(style)}")
+          @gridfs.open(path(style), 'w', :content_type => content_type) do |f|
+            f.write file.read
+          end
+        end
+        after_flush_writes # allows attachment to clean up temp files
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          log("deleting #{path}")
+          @gridfs.delete(path)
+        end
+        @queued_for_delete = []
+      end
+
+      private
+      
+      def get_database_connection creds
+        return creds[:database] if creds[:database].is_a? Mongo::DB
+        db = Mongo::Connection.new(creds[:host] || Mongo::Connection::DEFAULT_HOST, creds[:port] || Mongo::Connection::DEFAULT_PORT).db(creds[:database])
+        db.authenticate(creds[:username], creds[:password]) if creds[:username] && creds[:password]
+        return db
+      end
+
+      def find_credentials creds
+        case creds
+        when File
+          YAML::load(ERB.new(File.read(creds.path)).result)
+        when String, Pathname
+          YAML::load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          raise ArgumentError, "Credentials are not a path, file or hash."
+        end
+      end
+    end
+  end
+end

data/paperclip-gridfs.gemspec

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'paperclip-gridfs/version'
+
+spec = Gem::Specification.new do |s|
+  s.name          = 'paperclip-gridfs'
+  s.version       = Paperclip::GridFS::VERSION
+  s.authors       = ['Blaž Hrastnik']
+  s.email         = 'blaz.hrast@gmail.com'
+  s.homepage      = 'https://github.com/archSeer/paperclip-gridfs'
+  s.description   = 'Paperclip extension to make it support GridFS'
+  s.summary       = 'Paperclip GridFS support'
+
+  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.has_rdoc          = true
+  #s.extra_rdoc_files  = Dir["README*"]
+  #s.rdoc_options << '--line-numbers' << '--inline-source'
+
+  s.add_dependency 'paperclip'
+  s.add_dependency 'mongo', '>=1.1.4'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-gridfs
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Blaž Hrastnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+description: Paperclip extension to make it support GridFS
+email: blaz.hrast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/paperclip-gridfs.rb
+- lib/paperclip-gridfs/version.rb
+- lib/paperclip/storage/gridfs.rb
+- paperclip-gridfs.gemspec
+homepage: https://github.com/archSeer/paperclip-gridfs
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Paperclip GridFS support
+test_files: []