rack-mogilefs 0.1.1 → 0.1.2

data/HISTORY.md

@@ -0,0 +1,8 @@
+## 0.1.2 (2010-09-09)
+
+* Add a way to customize mapping of PATH_INFO to MogileFS keys
+* Better test coverage
+
+## 0.1.1 (2010-09-08)
+
+* First release

data/README.md

@@ -1,4 +1,8 @@
-# Rack middleware/endpoint for serving MogileFS files
+# rack-mogilefs
+
+If you are using Nginx you'll probably want to serve MogileFS files with
+the [MogileFS Module](http://www.grid.net.ru/nginx/mogilefs.en.html), but if
+you need to serve them out of a Rack app, this should help.
 
 ## Getting Started:
 
@@ -10,19 +14,19 @@ There are a variety of ways to use it:
 
 ### Rack middleware
     # (config.ru)
-    use Rack::MogileFS, :path => %r{^/system/*}
+    use Rack::MogileFS, :path => %r{^/assets/*}
 
 ### Rails 3:
 
     # (config/routes.rb)
-    match "/system/*" => Rack::MogileFS::Endpoint.new
+    match "/assets/*" => Rack::MogileFS::Endpoint.new
 
 ### Rails 2:
 
-    # (app/metal/mogilefs.rb)
-    class MogileFSMetal
+    # (app/metal/mogilefs_metal.rb)
+    class MogilefsMetal
       def self.call(env)
-        if env["PATH_INFO"] =~ %r{^/system/*}
+        if env["PATH_INFO"] =~ %r{^/assets/*}
           Rack::MogileFS::Endpoint.new.call(env)
         else
           [ 404, { "Content-Type" => "text/html" }, ["Not Found"] ]
@@ -36,10 +40,19 @@ There are a variety of ways to use it:
 content type of the file is detected by the extension, using the `mime-types`
 gem.
 
+If you want to customize the mapping of the PATH_INFO string to a MogileFS key
+you can provide a mapper proc (or anything that responds to call) like this:
+
+    # map '/assets/filename.gif' to the mogilefs key 'filename.gif'
+    # Rack::MogileFS and Rack::MogileFS::Endpoint take the same options
+    use Rack::MogileFS,
+      :path   => %r{^/assets/*},
+      :mapper => lambda { |path| path.sub('/assets/', '') }
+
 ## Configuration
 
-By default will look for a yaml config in `config/mogilefs.yml` that looks
-like this:
+If `Rack::MogileFS` detects it is inside a Rails app, it will look for a yaml
+config in `config/mogilefs.yml` that looks like this:
 
     development:
       connection:
@@ -52,7 +65,7 @@ like this:
       ...
 
 
-and initialize a mogilefs client like this:
+and initialize a MogileFS client like this:
 
     config = YAML.load_file( Rails.root.join("config/mogilefs.yml") )[Rails.env]
     MogileFS::MogileFS.new( config["connection"].symbolize_keys )

data/Rakefile

@@ -9,4 +9,12 @@ task :test do
     t.pattern = 'test/*_test.rb'
     t.verbose = true
   end
-end
+end
+
+desc 'Measures test coverage'
+task :coverage do
+  rm_f "coverage"
+  rm_f "coverage.data"
+  system "rcov -x /Users -Ilib:test test/*_test.rb"
+  system "open coverage/index.html" if PLATFORM['darwin']
+end

data/lib/rack/mogilefs/endpoint.rb

@@ -5,6 +5,7 @@ module Rack
       def initialize(options={})
         @options = {
           :client => nil,
+          :mapper => nil,
           :default_content_type => "image/png"
         }.merge(options)
 
@@ -12,10 +13,11 @@ module Rack
       end
 
       def call(env)
-        data = client.get_file_data(env['PATH_INFO'])
-        [ 200, { "Content-Type" => content_type(env['PATH_INFO']) }, [ data ] ]
-      rescue ::MogileFS::Backend::UnknownKeyError
-        [ 404, { "Content-Type" => "text/html" }, ["Not Found"] ]
+        path = key_for_path(env['PATH_INFO'].dup)
+        data = client.get_file_data(path)
+        [ 200, { "Content-Type" => content_type(path) }, [ data ] ]
+      rescue ::MogileFS::Backend::UnknownKeyError => e
+        [ 404, { "Content-Type" => "text/html" }, [e.message] ]
       rescue ::MogileFS::UnreachableBackendError => e
         [ 503, { "Content-Type" => "text/html" }, [e.message] ]
       rescue ::MogileFS::Error => e
@@ -24,6 +26,10 @@ module Rack
 
       protected
 
+      def key_for_path(path)
+        @options[:mapper].respond_to?(:call) ? @options[:mapper].call(path) : path
+      end
+
       def content_type(path_info)
         ext = path_info.split(".").last
         MIME::Types.type_for(ext).first.content_type

data/test/mogilefs_test.rb

@@ -1,42 +1,85 @@
 require 'test_helper'
 
 class TestMiddleWare < Test::Unit::TestCase
-  class MockMogileFsClient
-    def get_file_data(key)
-      "Mock Data"
-    end
+  def setup
+    @client = MockMogileFsClient.new
   end
 
-  def test_middleware_with_path
-    app = Rack::Builder.new do
-      use Rack::Lint
-      use Rack::MogileFS, :path => %r{^/system/*}
-      use Rack::Lint
-      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
-    end
+  def test_path_matching
+    app_with :path => %r{^/assets/*}
+    get '/'
 
-    response = Rack::MockRequest.new(app).get('/')
-    assert_equal "Hello, World!", response.body
+    assert_body "Hello, World!"
+  end
+
+  def test_unreachable_exception
+    app_with :path => %r{^/assets/*}
+    get '/assets/unreachable.txt'
+
+    assert_status 503
+    assert_body "couldn't connect to mogilefsd backend"
+  end
+
+  def test_unknown_key_exception
+    @client.expects(:get_file_data).raises(MogileFS::Backend::UnknownKeyError)
+
+    app_with :path => %r{^/assets/*}, :client => @client
+    get '/assets/unknown.txt'
 
-    response = Rack::MockRequest.new(app).get('/system/unreachable.txt')
-    assert_equal "couldn't connect to mogilefsd backend", response.body
-    assert_equal 503, response.status
+    assert_status 404
+  end
+
+  def test_mogilefs_exception
+    @client.expects(:get_file_data).raises(MogileFS::Error)
+
+    app_with :path => %r{^/assets/*}, :client => @client
+    get '/assets/error.txt'
+
+    assert_status 500
   end
 
   def test_middleware_with_mock_mogile_client
-    app = Rack::Builder.new do
-      use Rack::Lint
-      use Rack::MogileFS, :path => %r{^/system/*}, :client => MockMogileFsClient.new
-      use Rack::Lint
-      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
-    end
+    app_with :path => %r{^/assets/*}, :client => @client
+    get '/assets/asset.txt'
+
+    assert_body "Mock Data for /assets/asset.txt"
+  end
 
-    response = Rack::MockRequest.new(app).get('/')
-    assert_equal "Hello, World!", response.body
+  def test_content_type_lookup
+    app_with :path => %r{^/assets/*}, :client => @client
+    get '/assets/asset.txt'
 
-    response = Rack::MockRequest.new(app).get('/system/mocked.txt')
-    assert_equal "Mock Data", response.body
-    assert_equal 200, response.status
-    assert_equal "text/plain", response.headers['Content-Type']
+    assert_status 200
+    assert_content_type "text/plain"
+
+    get '/assets/asset.png'
+
+    assert_status 200
+    assert_content_type "image/png"
+
+    get '/assets/asset.xml'
+
+    assert_status 200
+    assert_content_type "application/xml"
   end
+
+  def test_default_content_type
+    app_with :path => %r{^/assets/*}, :client => @client
+    get '/assets/asset.xxx'
+
+    assert_status 200
+    assert_content_type "image/png"
+  end
+
+  def test_custom_key_mapping
+    @client.expects(:get_file_data).with("image.png").returns("")
+    app_with(
+      :path   => %r{^/assets/*},
+      :client => @client,
+      :mapper => lambda { |p| p.sub('/assets/', '') }
+    )
+
+    get '/assets/image.png'
+  end
+
 end

data/test/test_helper.rb

@@ -4,3 +4,36 @@ require "rack"
 require "rack/mock"
 require "mocha"
 require "rack/mogilefs"
+
+class MockMogileFsClient
+  def get_file_data(key)
+    "Mock Data for #{key}"
+  end
+end
+
+class Test::Unit::TestCase
+  def app_with(*args)
+    @app = Rack::Builder.new do
+      use Rack::Lint
+      use Rack::MogileFS, *args
+      use Rack::Lint
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    end
+  end
+
+  def get(path)
+    @response = Rack::MockRequest.new(@app).get(path)
+  end
+
+  def assert_body(body)
+    assert_equal body, @response.body
+  end
+
+  def assert_status(code)
+    assert_equal code, @response.status
+  end
+
+  def assert_content_type(content_type)
+    assert_equal content_type, @response.headers["Content-Type"]
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-mogilefs
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ben Marini
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 -07:00
+date: 2010-09-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,6 +91,7 @@ files:
 - lib/rack-mogilefs.rb
 - README.md
 - Rakefile
+- HISTORY.md
 - test/mogilefs_test.rb
 - test/test_helper.rb
 has_rdoc: true