rack-gridfs 0.2.0 → 0.3.0

data/README.rdoc

@@ -2,19 +2,23 @@
 
 Rack:GridFS is a Rack middleware for creating HTTP endpoints for files
 stored in MongoDB's GridFS.  You can configure a prefix string which
-will be used to match the path of a request and create a key for looking
+will be used to match the path of a request and supply an id for looking
 up the file in the GridFS store.
 
 For example,
 
-  GET '/gridfs/images/foo.jpg'
+  GET '/gridfs/someobjectid'
   
-If the prefix is "gridfs", then the key will be be "images/foo.jpg".
+If the prefix is "gridfs", then the id will be be "someobjectid".
 
-== Dependencies
+== Mongo Driver Compatibility Notes
 
-* ActiveSupport (activesupport)
-* Mongo Ruby Driver v0.15.1+ (mongo)
+This version is currently based off of mongo-0.20.1.  
+
+As of mongo-0.19.1, there have been significant changes to GridFS.  I do
+not plan to support versions of the mongo driver prior to 0.19.  There are
+some compatibility issues with mongo-0.19 vs. mongo-0.20 (Mongo::ObjectID
+vs. BSON::ObjectID).  For now, I am choosing to support mongo-0.20.
 
 == Installation
 
@@ -31,14 +35,10 @@ You must specify MongoDB database details:
 - database: the MongoDB database to connect to.
 - prefix: a string used to match against incoming paths and route to through the middleware.  Default 'gridfs'.
 
-== Caveats
-
-This is an experimental project.  The Ruby GridFS adaptor is still pretty new and the performance
-is known to be slow.  I wouldn't recommend using this middleware for anything high-volume in
-production.
-
 == Sinatra Example
 
+  # TODO: THIS COULD USE A LOT MORE EXPLANATION!
+
   require 'rubygems'
   require 'sinatra'
 
@@ -46,9 +46,9 @@ production.
   use Rack::GridFS, :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs'
 
   get /.*/ do
-    "Whatchya talking about?"
+    "The URL did not match a file in GridFS."
   end
 
 == Copyright
 
-Copyright (c) 2009 Blake Carlson. See LICENSE for details.
+Copyright (c) 2010 Blake Carlson. See LICENSE for details.

data/Rakefile

@@ -12,12 +12,11 @@ begin
     gem.rubyforge_project = "rack-gridfs"
     
     gem.add_dependency('rack')
-    gem.add_dependency('activesupport')
-    gem.add_dependency('mongo', '0.15.1')
+    gem.add_dependency('mongo', '>=0.20.1')
     
     gem.add_development_dependency('mocha', '0.9.4')
     gem.add_development_dependency('rack-test')
-    gem.add_development_dependency('thoughtbot-shoulda')
+    gem.add_development_dependency('shoulda')
   end
   Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new do |rubyforge|

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/rack/gridfs.rb

@@ -1,29 +1,27 @@
 require 'timeout'
 require 'mongo'
-require 'mongo/gridfs'
-require 'active_support/core_ext'
 
 module Rack
   
-  class GridFSConnectonError < StandardError ; end
+  class GridFSConnectionError < StandardError ; end
   
   class GridFS
 
-    attr_reader :hostname, :port, :database, :prefix, :connection
+    attr_reader :hostname, :port, :database, :prefix, :db
     
     def initialize(app, options = {})
-      options.reverse_merge!(
+      options = {
         :hostname => 'localhost', 
-        :port => Mongo::Connection::DEFAULT_PORT,
-        :prefix => 'gridfs'
-      )
+        :prefix   => 'gridfs',
+        :port     => Mongo::Connection::DEFAULT_PORT
+      }.merge(options)
 
       @app        = app
       @hostname   = options[:hostname]
       @port       = options[:port]
       @database   = options[:database]
       @prefix     = options[:prefix]
-      @connection = nil
+      @db         = nil
 
       connect!
     end
@@ -37,28 +35,21 @@ module Rack
       end
     end
 
-    def not_found
+    def gridfs_request(id)
+      file = Mongo::Grid.new(db).get(BSON::ObjectID.from_string(id))
+      [200, {'Content-Type' => file.content_type}, [file.read]]
+    rescue Mongo::GridError, BSON::InvalidObjectID
       [404, {'Content-Type' => 'text/plain'}, ['File not found.']]
     end
-
-    def gridfs_request(key)
-      if ::GridFS::GridStore.exist?(connection, key)
-        ::GridFS::GridStore.open(connection, key, 'r') do |file|
-          [200, {'Content-Type' => file.content_type}, [file.read]]
-        end
-      else
-        not_found
-      end
-    end
     
     private
     
     def connect!
       Timeout::timeout(5) do
-        @connection = Mongo::Connection.new(hostname).db(database)
+        @db = Mongo::Connection.new(hostname).db(database)
       end
     rescue Exception => e
-      raise Rack::GridFSConnectonError, "Unable to connect to the MongoDB server (#{e.to_s})"
+      raise Rack::GridFSConnectionError, "Unable to connect to the MongoDB server (#{e.to_s})"
     end
     
   end

data/rack-gridfs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-gridfs}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blake Carlson"]
-  s.date = %q{2009-10-19}
+  s.date = %q{2010-05-11}
   s.email = %q{blake@coin-operated.net}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -47,26 +47,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rack>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<mongo>, ["= 0.15.1"])
+      s.add_runtime_dependency(%q<mongo>, [">= 0.20.1"])
       s.add_development_dependency(%q<mocha>, ["= 0.9.4"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
       s.add_dependency(%q<rack>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<mongo>, ["= 0.15.1"])
+      s.add_dependency(%q<mongo>, [">= 0.20.1"])
       s.add_dependency(%q<mocha>, ["= 0.9.4"])
       s.add_dependency(%q<rack-test>, [">= 0"])
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
     s.add_dependency(%q<rack>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<mongo>, ["= 0.15.1"])
+    s.add_dependency(%q<mongo>, [">= 0.20.1"])
     s.add_dependency(%q<mocha>, ["= 0.9.4"])
     s.add_dependency(%q<rack-test>, [">= 0"])
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
 

data/test/gridfs_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 class Rack::GridFSTest < Test::Unit::TestCase
   include Rack::Test::Methods
   
-  def options_for_gridfs
-    { :hostname => 'myhostname.mydomain', :port => 8765, :database => 'mydatabase', :prefix => 'myprefix' }
-  end
-  
   def stub_mongodb_connection
     Rack::GridFS.any_instance.stubs(:connect!).returns(true)
   end
@@ -20,19 +16,16 @@ class Rack::GridFSTest < Test::Unit::TestCase
   end
   
   def app 
+    gridfs_opts = test_database_options
     Rack::Builder.new do
-      use Rack::GridFS, :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs'
+      use Rack::GridFS, gridfs_opts
       run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]] }
     end
   end
 
-  def load_artifact(filename, key, content_type)
-    GridFS::GridStore.unlink(db, key)
-    GridFS::GridStore.open(db, key, 'w', :content_type => content_type) do |dest|
-      File.open(File.join(File.dirname(__FILE__), 'artifacts', filename), 'r') do |orig|
-        dest.puts orig.read
-      end
-    end
+  def load_artifact(filename, content_type)
+    contents = File.read(File.join(File.dirname(__FILE__), 'artifacts', filename))
+    Mongo::Grid.new(db).put(contents, :filename => filename, :content_type => content_type)
   end
 
   context "Rack::GridFS" do
@@ -41,51 +34,52 @@ class Rack::GridFSTest < Test::Unit::TestCase
 
       setup do
         stub_mongodb_connection
+        @options = { :hostname => 'myhostname.mydomain', :port => 8765, :database => 'mydatabase', :prefix => 'myprefix' }
       end
 
       should "have a hostname option" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs)
-        assert_equal options_for_gridfs[:hostname], mware.hostname
+        mware = Rack::GridFS.new(nil, @options)
+        assert_equal @options[:hostname], mware.hostname
       end
 
       should "have a default hostname" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs.except(:hostname))
+        mware = Rack::GridFS.new(nil, @options.except(:hostname))
         assert_equal 'localhost', mware.hostname
       end
 
       should "have a port option" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs)
-        assert_equal options_for_gridfs[:port], mware.port
+        mware = Rack::GridFS.new(nil, @options)
+        assert_equal @options[:port], mware.port
       end
 
       should "have a default port" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs.except(:port))
+        mware = Rack::GridFS.new(nil, @options.except(:port))
         assert_equal Mongo::Connection::DEFAULT_PORT, mware.port
       end
 
       should "have a database option" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs)
-        assert_equal options_for_gridfs[:database], mware.database
+        mware = Rack::GridFS.new(nil, @options)
+        assert_equal @options[:database], mware.database
       end
 
       should "not have a default database" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs.except(:database))
+        mware = Rack::GridFS.new(nil, @options.except(:database))
         assert_nil mware.database
       end
 
       should "have a prefix option" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs)
-        assert_equal mware.prefix, options_for_gridfs[:prefix]
+        mware = Rack::GridFS.new(nil, @options)
+        assert_equal mware.prefix, @options[:prefix]
       end
       
       should "have a default prefix" do
-        mware = Rack::GridFS.new(nil, options_for_gridfs.except(:prefix))
+        mware = Rack::GridFS.new(nil, @options.except(:prefix))
         assert_equal mware.prefix, 'gridfs'
       end
 
       should "connect to the MongoDB server" do
         Rack::GridFS.any_instance.expects(:connect!).returns(true).once
-        Rack::GridFS.new(nil, options_for_gridfs)
+        Rack::GridFS.new(nil, @options)
       end
 
     end
@@ -98,29 +92,33 @@ class Rack::GridFSTest < Test::Unit::TestCase
       end
     end
 
-    context "with a files in GridFS" do
+    context "with files in GridFS" do
       setup do
-        load_artifact('test.txt', 'test.txt', 'text/plain')
-        load_artifact('test.html', 'test.html', 'text/html')
+        @text_id = load_artifact('test.txt', 'text/plain')
+        @html_id = load_artifact('test.html', 'text/html')
+      end
+
+      teardown do
+        db.collection('fs.files').remove
       end
 
       should "return TXT files stored in GridFS" do
-        get '/gridfs/test.txt'
-        assert_equal "Lorem ipsum dolor sit amet.\n", last_response.body
+        get "/gridfs/#{@text_id}"
+        assert_equal "Lorem ipsum dolor sit amet.", last_response.body
       end
 
       should "return the proper content type for TXT files" do
-        get '/gridfs/test.txt'
+        get "/gridfs/#{@text_id}"
         assert_equal 'text/plain', last_response.content_type
       end
 
       should "return HTML files stored in GridFS" do
-        get '/gridfs/test.html'
+        get "/gridfs/#{@html_id}"
         assert_match /html.*?body.*Test/m, last_response.body
       end
-
+      
       should "return the proper content type for HTML files" do
-        get '/gridfs/test.html'
+        get "/gridfs/#{@html_id}"
         assert_equal 'text/html', last_response.content_type
       end
       
@@ -129,15 +127,9 @@ class Rack::GridFSTest < Test::Unit::TestCase
         assert last_response.not_found?
       end
       
-      should "handle complex file paths" do
-        load_artifact('test.html', 'stuff/187d/foo.html', 'text/html')
-        get '/gridfs/stuff/187d/foo.html'
-        assert_equal 'text/html', last_response.content_type
-      end
-      
       should "work for small images" do
-        load_artifact('3wolfmoon.jpg', 'images/3wolfmoon.jpg', 'image/jpeg')
-        get '/gridfs/images/3wolfmoon.jpg'
+        image_id = load_artifact('3wolfmoon.jpg', 'image/jpeg')
+        get "/gridfs/#{image_id}"
         assert last_response.ok?
         assert_equal 'image/jpeg', last_response.content_type
       end

data/test/test_helper.rb

@@ -7,8 +7,13 @@ require 'rack/builder'
 require 'rack/mock'
 require 'rack/test'
 
-gem 'mongo', '>= 0.15.1'
-
 require 'mongo'
-require 'mongo/gridfs'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'rack', 'gridfs')
+
+
+class Hash
+  def except(*keys)
+    rejected = Set.new(respond_to?(:convert_key) ? keys.map { |key| convert_key(key) } : keys)
+    reject { |key,| rejected.include?(key) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-gridfs
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Blake Carlson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 -04:00
+date: 2010-05-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,25 +22,15 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: mongo
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.15.1
+        version: 0.20.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: mocha
@@ -63,7 +53,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: shoulda
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement