Rails Vendor Mime Types

README.md

Example of using Vendor MIME Types to determine how to route a request coming into a Rails application.

api_version.rb

class ApiVersion
  def initialize(version=1)
    @version = version
  end

  def matches?(request)
    versioned_accept_header?(request)
  end

  private

  def versioned_accept_header?(request)
    accept = request.headers['Accept']
    accept && accept[/application\/vnd\.my_app-v#{@version}\+json/]
  end
end

app_controller.rb

class Api::V1::AppsController < ApplicationController

  load_and_authorize_resource :apps

  respond_to :my_app_v1_json

  protect_from_forgery :except => :index

  def index
  end

end

browser.rb

class Browser

  def matches?(request)
    accept = request.headers['Accept']
    accept.blank? || accept[/text\/html/] || accept[/application\/xhtml\+xml/] || accept[/application\/xml/]
  end

end

mime_types.rb

# Be sure to restart your server when you modify this file.

# Add new mime types for use in respond_to blocks:
# Mime::Type.register "text/richtext", :rtf
# Mime::Type.register_alias "text/html", :iphone

Mime::Type.register 'application/vnd.my_app-v1+json', :my_app_v1_json

routes.rb

MyApp::Application.routes.draw do
  # Resource Routes
  current_routes = lambda do
    resources :apps
  end

  # Browser Resource Routes
  constraints Browser.new do
    scope &current_routes
  end

  # API Resource Routes
  constraints ApiVersion.new(1) do
    scope :module => "Api::V1" do
      scope &current_routes
    end
  end

end