Skip to content

Commit

Permalink
Updated the README and added an rdoc task.
Browse files Browse the repository at this point in the history
  • Loading branch information
Blake Carlson committed Sep 21, 2009
1 parent d3227be commit d850fca
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
rdoc
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
47 changes: 47 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
= 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 (mongodb-mongo)

== Usage

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'.

== 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

== TODO

- Make it awesome.
- What's up with the performance?
- Gem it up. Anyone care?

== Copyright

Copyright (c) 2009 Blake Carlson. See LICENSE for details.
8 changes: 8 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,11 @@ Rake::TestTask.new(:test) do |test|
test.pattern = 'test/**/*_test.rb'
test.verbose = true
end

require 'rake/rdoctask'
Rake::RDocTask.new do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = "Rack::GridFS 0.0.1"
rdoc.rdoc_files.include('README*')
rdoc.rdoc_files.include('lib/**/*.rb')
end

0 comments on commit d850fca

Please sign in to comment.