paperclip-gridfs 1.0 → 1.1

data/README.md

@@ -1,13 +1,15 @@
 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
+A rewrite of gmontard/paperclip-gridfs, made to work as a real plugin, packaged as a gem and updated to work with the current mongo gem version. It brings GridFS support to [Paperclip](https://github.com/thoughtbot/paperclip) and supports plain Mongo, but it can also be used in complement with any ORM gem, like MongoMapper or Mongoid.
 
 ## Usage
 
+The following examples are for MongoMapper, but the procedure should be similar to any other mongo ORM gem.
+
 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:
+Creating a connection looks something like this: you pass in `:storage => :gridfs`, along with a `:gridfs => {}` hash which includes the options.
 
     class User
       include MongoMapper::Document
@@ -18,7 +20,9 @@ Creating a connection looks something like this:
       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:
+You can pass in the host, port, database, username and password settings for MongoDB, but the only required value is the database name. Any values you don't set will just get filled in with MongoDB's defaults. If you optionally pass in the username and password keys, the connection will also get authenticated. 
+
+When you already have a Mongo connection object (for example through Mongoid or MongoMapper) you can also just reuse this connection:
 
     class User
       include MongoMapper::Document
@@ -29,17 +33,11 @@ When you already have a Mongo connection object (for example through Mongoid or
       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:
+However, as the files stored inside GridFS are stored in a database, rather than the filesystem, you will need to work out a way to serve these files over HTTP. You can use a helper method, `.to_file(style)`, which returns the attachment0s binary contents. An example solution, done in Sinatra, for the above examples:
 
     # 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
-
+      user = User.first(:id => params[:id])
+      content_type user.avatar.content_type
+      user.avatar.to_file(params[:style])
+    end

data/lib/paperclip-gridfs/version.rb

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

data/lib/paperclip/storage/gridfs.rb

@@ -73,7 +73,7 @@ module Paperclip
       
       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 = Mongo::MongoClient.new(creds[:host], creds[:port]).db(creds[:database])
         db.authenticate(creds[:username], creds[:password]) if creds[:username] && creds[:password]
         return db
       end

data/paperclip-gridfs.gemspec

@@ -21,5 +21,5 @@ spec = Gem::Specification.new do |s|
   #s.rdoc_options << '--line-numbers' << '--inline-source'
 
   s.add_dependency 'paperclip'
-  s.add_dependency 'mongo', '>=1.1.4'
+  s.add_dependency 'mongo', '>=1.8.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-gridfs
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 1.8.0
 description: Paperclip extension to make it support GridFS
 email: blaz.hrast@gmail.com
 executables: []