rack-gridfs 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Blake Carlson
+
+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,54 @@
+= Rack::GridFS
+
+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
+up the file in the GridFS store.
+
+For example,
+
+  GET '/gridfs/images/foo.jpg'
+  
+If the prefix is "gridfs", then the key will be be "images/foo.jpg".
+
+== Dependencies
+
+* ActiveSupport (activesupport)
+* Mongo Ruby Driver v0.15.1+ (mongo)
+
+== Installation
+
+  sudo gem install skinandbones-rack-gridfs --source=http://gems.github.com
+
+== Usage
+
+  require 'rack/gridfs'
+  use Rack::GridFS, :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs'
+
+You must specify MongoDB database details:
+- hostname: the hostname/IP where the MongoDB server is running.  Default 'localhost'.
+- port: the port of the MongoDB server.  Default 27017.
+- 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
+
+  require 'rubygems'
+  require 'sinatra'
+
+  require 'rack/gridfs'
+  use Rack::GridFS, :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs'
+
+  get /.*/ do
+    "Whatchya talking about?"
+  end
+
+== Copyright
+
+Copyright (c) 2009 Blake Carlson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name              = "rack-gridfs"
+    gem.summary           = "Rack middleware for creating HTTP endpoints for files stored in MongoDB's GridFS"
+    gem.email             = "blake@coin-operated.net"
+    gem.homepage          = "http://github.com/skinandbones/rack-gridfs"
+    gem.authors           = ["Blake Carlson"]
+    gem.rubyforge_project = "rack-gridfs"
+    
+    gem.add_dependency('rack')
+    gem.add_dependency('activesupport')
+    gem.add_dependency('mongo', '0.15.1')
+    
+    gem.add_development_dependency('mocha', '0.9.4')
+    gem.add_development_dependency('rack-test')
+    gem.add_development_dependency('thoughtbot-shoulda')
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Rack::GridFS #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/example/gridfs_server.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'sinatra'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rack', 'gridfs')
+use Rack::GridFS, :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs'
+
+get /.*/ do
+  "Whatchya talking about?"
+end

data/lib/rack/gridfs.rb

@@ -0,0 +1,66 @@
+require 'timeout'
+require 'mongo'
+require 'mongo/gridfs'
+require 'active_support/core_ext'
+
+module Rack
+  
+  class GridFSConnectonError < StandardError ; end
+  
+  class GridFS
+
+    attr_reader :hostname, :port, :database, :prefix, :connection
+    
+    def initialize(app, options = {})
+      options.reverse_merge!(
+        :hostname => 'localhost', 
+        :port => Mongo::Connection::DEFAULT_PORT,
+        :prefix => 'gridfs'
+      )
+
+      @app        = app
+      @hostname   = options[:hostname]
+      @port       = options[:port]
+      @database   = options[:database]
+      @prefix     = options[:prefix]
+      @connection = nil
+
+      connect!
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.path_info =~ /^\/#{prefix}\/(.+)$/
+        gridfs_request($1)
+      else
+        @app.call(env)
+      end
+    end
+
+    def not_found
+      [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)
+      end
+    rescue Exception => e
+      raise Rack::GridFSConnectonError, "Unable to connect to the MongoDB server (#{e.to_s})"
+    end
+    
+  end
+    
+end

data/rack-gridfs.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-gridfs}
+  s.version = "0.2.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.email = %q{blake@coin-operated.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "example/gridfs_server.rb",
+     "lib/rack/gridfs.rb",
+     "rack-gridfs.gemspec",
+     "test/artifacts/3wolfmoon.jpg",
+     "test/artifacts/test.html",
+     "test/artifacts/test.txt",
+     "test/gridfs_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/skinandbones/rack-gridfs}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rack-gridfs}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack middleware for creating HTTP endpoints for files stored in MongoDB's GridFS}
+  s.test_files = [
+    "test/gridfs_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    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_development_dependency(%q<mocha>, ["= 0.9.4"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-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<mocha>, ["= 0.9.4"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-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<mocha>, ["= 0.9.4"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/artifacts/test.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
+   "http://www.w3.org/TR/html4/strict.dtd">
+
+<html lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+	<title>test</title>
+	<meta name="generator" content="TextMate http://macromates.com/">
+	<meta name="author" content="Blake Carlson">
+	<!-- Date: 2009-09-20 -->
+</head>
+<body>
+  Test
+</body>
+</html>

data/test/artifacts/test.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet.

data/test/gridfs_test.rb

@@ -0,0 +1,149 @@
+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
+  
+  def test_database_options
+    { :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs' }
+  end
+  
+  def db
+    @db ||= Mongo::Connection.new(test_database_options[:hostname], test_database_options[:port]).db(test_database_options[:database])
+  end
+  
+  def app 
+    Rack::Builder.new do
+      use Rack::GridFS, :hostname => 'localhost', :port => 27017, :database => 'test', :prefix => 'gridfs'
+      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
+  end
+
+  context "Rack::GridFS" do
+
+    context "on initialization" do
+
+      setup do
+        stub_mongodb_connection
+      end
+
+      should "have a hostname option" do
+        mware = Rack::GridFS.new(nil, options_for_gridfs)
+        assert_equal options_for_gridfs[:hostname], mware.hostname
+      end
+
+      should "have a default hostname" do
+        mware = Rack::GridFS.new(nil, options_for_gridfs.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
+      end
+
+      should "have a default port" do
+        mware = Rack::GridFS.new(nil, options_for_gridfs.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
+      end
+
+      should "not have a default database" do
+        mware = Rack::GridFS.new(nil, options_for_gridfs.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]
+      end
+      
+      should "have a default prefix" do
+        mware = Rack::GridFS.new(nil, options_for_gridfs.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)
+      end
+
+    end
+
+    should "delegate requests with a non-matching prefix" do
+      %w( / /posts /posts/1 /posts/1/comments ).each do |path|
+        get path
+        assert last_response.ok?
+        assert 'Hello, World!', last_response.body
+      end
+    end
+
+    context "with a files in GridFS" do
+      setup do
+        load_artifact('test.txt', 'test.txt', 'text/plain')
+        load_artifact('test.html', 'test.html', 'text/html')
+      end
+
+      should "return TXT files stored in GridFS" do
+        get '/gridfs/test.txt'
+        assert_equal "Lorem ipsum dolor sit amet.\n", last_response.body
+      end
+
+      should "return the proper content type for TXT files" do
+        get '/gridfs/test.txt'
+        assert_equal 'text/plain', last_response.content_type
+      end
+
+      should "return HTML files stored in GridFS" do
+        get '/gridfs/test.html'
+        assert_match /html.*?body.*Test/m, last_response.body
+      end
+
+      should "return the proper content type for HTML files" do
+        get '/gridfs/test.html'
+        assert_equal 'text/html', last_response.content_type
+      end
+      
+      should "return a not found for a unknown path" do
+        get '/gridfs/unknown'
+        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'
+        assert last_response.ok?
+        assert_equal 'image/jpeg', last_response.content_type
+      end
+    end
+
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+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')

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: rack-gridfs
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Blake Carlson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: blake@coin-operated.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- example/gridfs_server.rb
+- lib/rack/gridfs.rb
+- rack-gridfs.gemspec
+- test/artifacts/3wolfmoon.jpg
+- test/artifacts/test.html
+- test/artifacts/test.txt
+- test/gridfs_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/skinandbones/rack-gridfs
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rack-gridfs
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware for creating HTTP endpoints for files stored in MongoDB's GridFS
+test_files: 
+- test/gridfs_test.rb
+- test/test_helper.rb