rack-rest_api_versioning 0.0.1

data/README.rdoc

@@ -0,0 +1,41 @@
+= Rack REST API Versioning
+
+This Rack middleware adds support for RESTful API versioning. According to RESTful best
+practices, the API version should be specified using content negotiation and custom vendor
+MIME types. For example, if your application's API supports multiple versions, a client can
+ask for a specific version like this:
+
+  GET /foo HTTP/1.1
+  Accept: application/vnd.foo.bar-v2+xml
+
+Where "application/vnd.foo.bar-v2+xml" is vendor MIME type your application defines.
+
+See this article: http://barelyenough.org/blog/2008/05/versioning-rest-web-services/ for more
+information about this practice.
+
+This middleware is used like any other rack middleware:
+
+  use Rack::RestApiVersioning
+
+When used, it extracts the version from the Accept header, and makes it available in the
+Rack environment hash as "api_version":
+
+  app = lambda { |env
+    puts env['api_version']
+    [200, {}, []]
+  }
+
+To simplify testing and debugging, this middleware also allows the version to be overriden
+using simple query string parameter:
+
+  GET /foo?version=2 HTTP/1.1
+
+This will ask for version 2, no matter what the Accept header is set to.
+
+Finally, a default version can be specified. This will be used if no version can be extracted:
+
+  use Rack::RestApiVersioning, :default_version => '2.0'
+
+== Legal
+
+Copyright (c) 2010 Adam Cigánek <adam.ciganek@gmail.com>. Released under the terms of MIT License: www.opensource.org/licenses/mit-license.php

data/Rakefile

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'rake'
+require 'rake/testtask'
+ 
+desc 'Default: run unit tests.'
+task :default => :test
+ 
+desc 'Run unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name     = 'rack-rest_api_versioning'
+    gemspec.summary  = 'A Rack middleware to support "the proper way" to version a RESTful API.'
+    gemspec.description = "This midleware allows an application to support multiple versions of a RESTful API following the best RESTful practices to encode the version information in the HTTP request. It's inspired by this article: http://barelyenough.org/blog/2008/05/versioning-rest-web-services/."
+
+    gemspec.email    = 'adam.ciganek@gmail.com'
+    gemspec.homepage = 'http://github.com/madadam/rack-rest_api_versioning'
+    gemspec.authors  = ['Adam Cigánek']
+
+    gemspec.add_dependency 'rack'
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rack/rest_api_versioning.rb

@@ -0,0 +1,38 @@
+require 'rack'
+
+module Rack
+  class RestApiVersioning
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+
+    def call(env)
+      extract_version!(env)
+      @app.call(env)
+    end
+
+    # 1
+    # 1.2
+    # 1.2.3
+    VERSION_STRING       = '(\d+(?:\.\d+)*)'
+
+    # application/vnd.foo.bar-v1+xml
+    # application/vnd.foo.bar-v1.2.3+json
+    # ...
+    HTTP_ACCEPT_PATTERN  = /.*\-v#{VERSION_STRING}/
+
+    # ?version=1.2.3
+    QUERY_STRING_PATTERN = /\bversion=#{VERSION_STRING}/
+
+    private
+
+    def extract_version!(env)
+      version = env['QUERY_STRING'].to_s[QUERY_STRING_PATTERN, 1] ||
+                env['HTTP_ACCEPT'].to_s[HTTP_ACCEPT_PATTERN, 1]   ||
+                @options[:default_version]
+
+      env['api_version'] = version
+    end
+  end
+end

data/test/rest_api_versioning_test.rb

@@ -0,0 +1,67 @@
+require 'test/unit'
+require 'rack'
+require 'rack/test'
+
+require 'rack/rest_api_versioning'
+
+class RestApiVersioningTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    @app
+  end
+
+  def test_extracts_version_from_content_type
+    app! { use Rack::RestApiVersioning }
+
+    get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.acme-v1+json'
+    assert_equal '1', last_request.env['api_version']
+
+    get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.acme-v2+json'
+    assert_equal '2', last_request.env['api_version']
+    
+    get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.acme-v1.2.3+json'
+    assert_equal '1.2.3', last_request.env['api_version']
+  end
+
+  def test_fallbacks_to_default_version_if_no_version_can_be_extracted
+    app! { use Rack::RestApiVersioning, :default_version => '4.5' }
+
+    get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.acme+json'
+    assert_equal '4.5', last_request.env['api_version']
+    
+    get '/', {}, 'HTTP_ACCEPT' => 'application/json'
+    assert_equal '4.5', last_request.env['api_version']
+  end
+
+  def test_does_not_fallback_to_default_version_if_version_can_be_extracted
+    app! { use Rack::RestApiVersioning, :default_version => '6.7' }
+
+    get '/', {}, 'HTTP_ACCEPT' => 'application/vnd.acme-v2+json'
+    assert_equal '2', last_request.env['api_version']
+  end
+
+  def test_allows_version_to_be_overriden_with_query_string_parameter
+    app! { use Rack::RestApiVersioning }
+
+    get '/', 'version' => '1.2'
+    assert_equal '1.2', last_request.env['api_version']
+  end
+  
+  def test_version_in_query_string_takes_precedence_over_version_in_content_type
+    app! { use Rack::RestApiVersioning }
+
+    get '/', 'version' => '1.2', 'HTTP_ACCEPT' => 'application/vnd.acme-v1.3'
+    assert_equal '1.2', last_request.env['api_version']
+  end
+
+  private
+
+  def app!(&block)
+    @app = Rack::Builder.new do
+      instance_eval(&block)
+      run lambda { |env| [200, {}, []] }
+    end.to_app
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: rack-rest_api_versioning
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Adam Cig\xC3\xA1nek"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "This midleware allows an application to support multiple versions of a RESTful API following the best RESTful practices to encode the version information in the HTTP request. It's inspired by this article: http://barelyenough.org/blog/2008/05/versioning-rest-web-services/."
+email: adam.ciganek@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/rest_api_versioning.rb
+- test/rest_api_versioning_test.rb
+has_rdoc: true
+homepage: http://github.com/madadam/rack-rest_api_versioning
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Rack middleware to support "the proper way" to version a RESTful API.
+test_files: 
+- test/rest_api_versioning_test.rb