rack-api-versioning 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p374@rack-api-versioning"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.5 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rafter_api_version.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick Zalabak
+
+MIT License
+
+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,60 @@
+# RackApiVersioning
+
+Version your Rack based API's using headers either through middleware or routing constraints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-api-versioning'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-api-versioning
+
+## Usage in Rails
+```ruby
+    Your::Application.routes.draw do
+      constraints RackApiVersioning::Constraint.new( :target_version => 3,
+                                                     :default_version => 2,
+                                                     :app_name => "awesome-app",
+                                                     :media_type => "json" ) do
+    		scope :module => :v3 do
+      		resources :orders, :only => [:create, :show] do
+
+      	end
+     	end
+    end
+```
+## Usage in any Rack app
+```ruby
+    Rack::Builder.new do
+      
+      map '/' do        
+        use RackApiVersioning::Middleware, 
+          :app_name => "awesome-app",
+          :default_version => 1,
+          :target_version => 2
+
+        run lambda { |env| 
+          [200, {"Content-Type" => "text/html"}, "Testing RackApiVersioning"] 
+        }
+      end
+
+      map "/new-improved-api" do
+        use RackApiVersioning::Middleware, 
+          :app_name => "awesome-app",
+          :default_version => 2,
+          :target_version => 3
+
+        run lambda { |env| 
+          [200, {"Content-Type" => "text/html"}, "Testing RackApiVersioning"] 
+        } 
+      end
+      
+    end
+```

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rack-api-versioning.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+
+Dir.glob(File.expand_path(File.dirname(__FILE__) + "/rack_api_versioning/*.rb")) { |file| require file }

data/lib/rack_api_versioning/constraint.rb

@@ -0,0 +1,63 @@
+##
+# Use an instance of RackApiVersioning::Constraint in a Rackup file or in Rails routing.
+
+module RackApiVersioning
+	class Constraint
+		##
+		# There are four options:
+		# 	:target_version => This is the API version you want to use, 
+		# 										 when left unspecified it defaults to 1.
+		#
+		# 	:default_version => This is the API version to failover to, 
+		# 											when left unspecified it defaults to 1.
+		#
+		#   :app_name => The app name that should be included in the 'Accept' 
+		# 							 header, when left unspecified it defaults to "api".
+		#
+		# 	:media_type => The desired media type the API should respond with, 
+		# 								when left unspecified it defaults to "*".
+		#
+		def initialize(options = {})
+		  @target_version = options[:target_version] || 1
+		  @default_version = options[:default_version] || 1
+		  @app_name = options[:app_name] || "api"
+		  @media_type = options[:media_type] || "*"
+		end
+
+		##
+		# Valid versioned API headers look like this:
+		# Accept: application/vnd.api-v1+json
+		# If no API version header is provided the default API version will be used.
+		def matches?(request)
+		  versioned_accept_header?(request) || default_version?(request)
+		end
+
+		private
+
+		def versioned_accept_header?(request)
+			accept = accept_header(request)
+			accept && accept.match(/application\/vnd\.#{@app_name}-v#{@target_version}\+#{@media_type}/)
+		end
+
+		def unversioned_accept_header?(request)
+		  accept = accept_header(request)
+		  (accept.nil? || accept == "" ) || accept.match(/application\/vnd\.#{@app_name}/).nil?
+		end
+
+		def accept_header(request)
+			if request.respond_to?(:headers)
+		  	# support for Rails ActionDispatch::Request
+				request.headers['Accept']
+
+		  else
+		  	# support for the Rack env request
+		  	request['Accept']
+		  end
+		end
+
+		def default_version?(request)
+		  @target_version == @default_version && unversioned_accept_header?(request)
+		end
+
+	end
+end

data/lib/rack_api_versioning/middleware.rb

@@ -0,0 +1,47 @@
+##
+# Use pure Rack middleware to handle your API versioning
+
+module RackApiVersioning
+
+	class Middleware
+
+		##
+		# Valid options include the same options the RackApiVersioning::Constraint
+		# class uses. Specifically:
+		#
+		# 	:target_version => This is the API version you want to use, 
+		# 										 when left unspecified it defaults to 1.
+		#
+		# 	:default_version => This is the API version to failover to, 
+		# 											when left unspecified it defaults to 1.
+		#
+		#   :app_name => The app name that should be included in the 'Accept' 
+		# 							 header, when left unspecified it defaults to "api".
+		#
+		# 	:media_type => The desired media type the API should respond with, 
+		# 								when left unspecified it defaults to "*".
+		#
+		def initialize(app, options = {})
+			@app = app
+			@api_version_constraint = Constraint.new(options)			
+		end
+
+		def call(env)
+			if @api_version_constraint.matches?(env)
+				@app.call(env)
+			else
+				api_version_error
+			end
+		end
+
+		##
+		# Subclass and override this method if you'd like an alternate behavior.
+		def api_version_error
+			body_text = "The request did not contain an appropriate API version header."
+			[400, {'Content-Type' => 'text/plain; charset=utf-8',
+           	 'Content-Length' => body_text.size.to_s}, [body_text]]
+		end
+
+	end
+
+end

data/lib/rack_api_versioning/version.rb

@@ -0,0 +1,3 @@
+module RackApiVersioning
+  VERSION = "0.0.1"
+end

data/rack_api_versioning.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack_api_versioning/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Zalabak"]
+  gem.email         = ["techwhizbang@gmail.com"]
+  gem.description   = %q{Version your Rack based API's using headers either through middleware or routing constraints}
+  gem.summary       = %q{Version your Rack based API's using headers either through middleware or routing constraints}
+  gem.homepage      = "https://github.com/techwhizbang/rack-api-versioning"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rack-api-versioning"
+  gem.require_paths = ["lib"]
+  gem.version       = RackApiVersioning::VERSION
+  gem.add_dependency %q<rack>, [">= 1.0"]
+  gem.add_development_dependency %q<rake>, ["0.9.2.2"]
+  gem.add_development_dependency %q<rspec>, ["~> 2.12.0"]
+  gem.add_development_dependency %q<rack-test>, ["~> 0.6.2"]
+end

data/spec/constraint_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe RackApiVersioning::Constraint do
+	
+	describe "#match?" do
+
+		context "when a versioned API request header is provided" do
+
+				subject(:api_version) { 
+					RackApiVersioning::Constraint.new(	:default_version => 1,
+																							:target_version => 2,
+																							:app_name => "sweet-api" ) }
+
+				let(:request_with_good_header) do
+					stub('request', :headers => {"Accept" => "application/vnd.sweet-api-v2+json"})
+				end
+
+				let(:request_with_bad_header) do
+					stub('request', :headers => {"Accept" => "application/vnd.wrong-api-v2.json"})
+				end
+
+				it 'returns true when the format matches properly' do
+					api_version.matches?(request_with_good_header).should be_true
+				end
+
+				it 'returns false if the format is incorrect' do
+					api_version.matches?(request_with_bad_header).should be_false
+				end
+
+			end
+
+		end
+
+		context "when a versioned API request is missing" do
+
+				let(:request_with_no_header) { stub('request', :headers => {}) }
+
+				subject(:api_versions_same) { 
+					RackApiVersioning::Constraint.new(	:default_version => 5000,
+																							:target_version => 5000 ) }
+
+				subject(:api_versions_diff) { 
+					RackApiVersioning::Constraint.new(	:default_version => 4999,
+																							:target_version => 5000 ) }
+				
+
+				it 'returns true if the default and target version are the same' do
+					api_versions_same.matches?(request_with_no_header).should be_true
+				end
+
+				it 'returns false if the default and target versions are different' do
+					api_versions_diff.matches?(request_with_no_header).should be_false
+				end
+
+		end
+
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe RackApiVersioning::Middleware do
+
+	include Rack::Test::Methods
+
+	def app
+		Rack::Builder.new do
+      
+      map '/' do				
+	    	use RackApiVersioning::Middleware, 
+      		:app_name => "awesome-app",
+      		:default_version => 1,
+      		:target_version => 2
+
+	      run lambda { |env| 
+	      	[200, {"Content-Type" => "text/html"}, "Testing RackApiVersioning"] 
+	      }
+      end
+
+      map "/new-improved-api" do
+      	use RackApiVersioning::Middleware, 
+      		:app_name => "awesome-app",
+      		:default_version => 2,
+      		:target_version => 3
+
+      	run lambda { |env| 
+	      	[200, {"Content-Type" => "text/html"}, "Testing RackApiVersioning"] 
+	      }	
+      end
+      
+    end
+	end
+
+	context "when the request hits '/'" do
+
+		context "when the API versioning header is included" do
+
+			it 'responds successfully to the request' do
+				get "/", {}, {'Accept' => "application/vnd.awesome-app-v2+json"}
+				last_response.ok?.should be_true
+			end
+
+		end
+
+		context "when the API versioning header is excluded" do
+
+			it 'responds with a 400 status code' do
+				get "/", {}, {}
+				last_response.status.should == 400
+			end
+
+			it 'responds with a plain text error message' do
+				get "/", {}, {}
+				last_response.body.should == "The request did not contain an appropriate API version header."
+			end
+
+		end
+
+		context "when the API versioning header is wrong" do
+
+			it 'responds with a 400 status code' do
+				get "/", {}, {'Accept' => "application/vnd.bad-header-v1+xml"}
+				last_response.status.should == 400
+			end
+
+			it 'responds with a plain text error message' do
+				get "/", {}, {'Accept' => "application/vnd.bad-header-v1+xml"}
+				last_response.body.should == "The request did not contain an appropriate API version header."
+			end
+
+		end
+
+		context "when the target version is wrong" do
+
+			it 'responds with a 400 status code' do
+				get "/", {}, {'Accept' => "application/vnd.awesome-app-v4+json"}
+				last_response.status.should == 400
+			end
+
+		end
+
+	end
+
+	context "when the request hits '/new-improved-api" do
+
+		context "when the API versioning header is included" do
+
+			it 'responds successfully to the request' do
+				get "/new-improved-api", {}, {'Accept' => "application/vnd.awesome-app-v3+json"}
+				last_response.ok?.should be_true
+			end
+
+		end
+
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'rspec'
+require 'rake'
+require "rack/test"
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/rack-api-versioning")
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rack-api-versioning
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Zalabak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Version your Rack based API's using headers either through middleware
+  or routing constraints
+email:
+- techwhizbang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-api-versioning.rb
+- lib/rack_api_versioning/constraint.rb
+- lib/rack_api_versioning/middleware.rb
+- lib/rack_api_versioning/version.rb
+- rack_api_versioning.gemspec
+- spec/constraint_spec.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/techwhizbang/rack-api-versioning
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 423395989637865473
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 423395989637865473
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Version your Rack based API's using headers either through middleware or
+  routing constraints
+test_files:
+- spec/constraint_spec.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb