forked from skinandbones/rack-gridfs
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the README and added an rdoc task.
- Loading branch information
Blake Carlson
committed
Sep 21, 2009
1 parent
d3227be
commit d850fca
Showing
4 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
rdoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters