rack-grid-serve 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f5f4c81166fc96ed26ff25aa25d666fd3eb95f8
+  data.tar.gz: 942718fcfc8c8c49c89bf3c12393de2caadb6dfc
+SHA512:
+  metadata.gz: d3d479c97d22a6f2ac53f264a167f39b7c6f7333241940f4cfacc031b75e47345278eb7cafe36d4a990539c136f5727c1c016a8c9f40163cdf8a2f324873d777
+  data.tar.gz: 6be2ba4449518d0886307ae5efa6a7c999537f72be046c40dfe0285982f071c5672596bb769cf592af92a0ba4ee4a54fc484ca3c22e4e4ca2473586be88080d0

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_STORE
+*.swp
+.ruby-version
+pkg/
+Gemfile.lock
+*.gem
+.bundle/
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Mickael Riga
+
+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.md

@@ -0,0 +1,45 @@
+Rack Grid Serve
+===============
+
+The purpose of `Rack::GridServe` is to provide an alternative to
+[Rack::Gridfs]() which works with the `Mongo` ruby driver version 2.0 
+and above. This driver has a different API and while the `Rack::Gridfs` 
+team is working on it, it is not yet ready.
+
+While `Rack::GridServe` can be used the same way, it is by no mean
+as complete and well crafted as `Rack::Gridfs`. So I recommend that
+you switch back when their next version is ready.
+
+Until then, the function is the same, you can mount the middleware
+in order to serve images which are hosted in the `GridFS` part
+of a `Mongo` database.
+
+How it works
+------------
+
+Here is how you mount it in your `config.ru`:
+
+```ruby
+require 'rack/grid_serve'
+use Rack::GridServe, {
+  db: $db,
+  prefix: 'gridfs', # Path prefix, default is "gridfs"
+  cache_control: 'no-cache' # Default is "no-cache"
+}
+```
+
+These are the only options so far.
+
+`Rack::GridServe` sets the `ETag` and `Last-Modified` response
+headers and uses `Rack::ConditionalGet` to let the browser use
+cached version of the files when possible.
+
+Testing
+-------
+
+Run tests this way:
+
+```
+bundle exec ruby -I lib test.rb
+```
+

data/lib/rack/grid_serve.rb

@@ -0,0 +1,69 @@
+require 'mongo'
+require 'rack/request'
+require 'rack/conditional_get'
+
+class Rack::GridServe
+
+  VERSION = '0.0.1'
+
+  def initialize app, opts={}
+    @app = app
+    @db = opts[:db]
+    @prefix = opts[:prefix] || 'gridfs'
+    @cache_control = opts[:cache_control] || 'no-cache'
+  end
+
+  def call env
+    dup._call env
+  end
+
+  def _call env
+    req = Rack::Request.new env
+    if under_prefix? req
+      file = find_file req
+      if file.nil?
+        [404, {'Content-Type'=>'text/plain'}, 'Not Found']
+      else
+        last_modified = Time.at file.info.upload_date.to_i
+        headers = {
+          'Content-Type' => file.info.content_type,
+          'ETag' => file.info.md5,
+          'Last-Modified' => last_modified.httpdate,
+          'Cache-Control' => @cache_control
+        }
+        Rack::ConditionalGet.new(lambda {|cg_env|
+          [200, headers, [file.data]]
+        }).call(env)
+      end
+    else
+      @app.call env
+    end
+  end
+
+  private
+
+  def under_prefix? req
+    req.path_info =~ %r|/#@prefix/(.*)|
+  end
+
+  def id_or_filename req
+    str = req.path_info.sub %r|/#@prefix/|, ''
+    if BSON::ObjectId.legal? str
+      BSON::ObjectId.from_string str
+    else
+      str
+    end
+  end
+
+  def find_file req
+    str = id_or_filename req
+    @db.fs.find_one({
+      '$or' => [
+        {_id: str},
+        {filename: str}
+      ]
+    })
+  end
+
+end
+

data/rack-grid-serve.gemspec

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'lib/rack/grid_serve')
+
+Gem::Specification.new do |s| 
+
+  s.authors = ["Mickael Riga"]
+  s.email = ["mig@mypeplum.com"]
+  s.homepage = "https://github.com/mig-hub/rack-grid-serve"
+  s.licenses = ['MIT']
+
+  s.name = 'rack-grid-serve'
+  s.version = Rack::GridServe::VERSION
+  s.summary = "Rack middleware for serving files stored in MongoDB GridFS"
+  s.description = "Rack::GridServe is a Rack middleware for serving files stored in MongoDB GridFS. It is meant as a simple replacement for Rack::GridFS until it is ready for Mongo driver version 2.0 and above."
+
+  s.platform = Gem::Platform::RUBY
+  s.files = `git ls-files`.split("\n").sort
+  s.test_files = 'test.rb'
+  s.require_paths = ['lib']
+
+  s.add_dependency('rack')
+  s.add_dependency('mongo', '~> 2.0')
+
+  s.add_development_dependency('minitest', '~> 5.8')
+  s.add_development_dependency('rack-test')
+
+end
+

data/test.rb

@@ -0,0 +1,75 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rack/grid_serve'
+require 'rack/test'
+require 'minitest/autorun'
+
+class TestRackGridServe < MiniTest::Test
+
+  MONGO = Mongo::Client.new([ '127.0.0.1:27017' ], :database => 'rack-grid-serve-test')
+  DB = MONGO.database
+  DB.drop
+  FILE = Mongo::Grid::File.new('.cowabunga {}', :filename => 'tmnt.css', content_type: 'text/css')
+  FILE_ID = DB.fs.insert_one(FILE)
+
+  include Rack::Test::Methods
+
+  def app
+    Rack::GridServe.new(inner_app, db: DB)
+  end
+
+  def inner_app
+    lambda {|env| 
+      [200, {'Content-Type'=>'text/plain'}, "Inner"] 
+    }
+  end
+
+  def assert_file_found
+    assert_equal 200, last_response.status
+    assert_equal 13, last_response.body.size
+    assert_equal FILE.info.content_type, last_response.headers['Content-Type']
+    assert_equal FILE.info.md5, last_response.headers['ETag']
+    assert_equal Time.at(FILE.info.upload_date.to_i).httpdate, last_response.headers['Last-Modified']
+    assert_equal 'no-cache', last_response.headers['Cache-Control']
+  end
+
+  def test_finds_file_by_id
+    get "/gridfs/#{FILE_ID}"
+    assert_file_found
+  end
+
+  def test_finds_file_by_name
+    get '/gridfs/tmnt.css'
+    assert_file_found
+  end
+
+  def test_uses_conditional_get
+    get '/gridfs/tmnt.css', {}, {'HTTP_IF_NONE_MATCH'=>FILE.info.md5}
+    assert_equal 304, last_response.status
+  end
+
+  def test_not_found_if_filename_has_no_match
+    get '/gridfs/unexisting-id'
+    assert_equal 404, last_response.status
+  end
+
+  def test_pass_if_prefix_only
+    get '/gridfs'
+    assert_equal 200, last_response.status
+    assert_equal "Inner", last_response.body
+  end
+
+  def test_pass_if_root
+    get '/'
+    assert_equal 200, last_response.status
+    assert_equal "Inner", last_response.body
+  end
+
+  def test_pass_if_prefix_not_match
+    get '/wrong-prefix/1234'
+    assert_equal 200, last_response.status
+    assert_equal "Inner", last_response.body
+  end
+
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rack-grid-serve
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mickael Riga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack::GridServe is a Rack middleware for serving files stored in MongoDB
+  GridFS. It is meant as a simple replacement for Rack::GridFS until it is ready for
+  Mongo driver version 2.0 and above.
+email:
+- mig@mypeplum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/rack/grid_serve.rb
+- rack-grid-serve.gemspec
+- test.rb
+homepage: https://github.com/mig-hub/rack-grid-serve
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware for serving files stored in MongoDB GridFS
+test_files:
+- test.rb