versioncake 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad6b180d713a358c8dca71c1ee7d13763b33d61c
+  data.tar.gz: 6b3a64e7b6af7ebf8839d27c8f427c0dcdf1030d
+SHA512:
+  metadata.gz: c13e158b7af821d0099ac548bc20f723554b335383088b857e886b7483fea4cae52880087b9713745e7450fd160787323471e59169c953eb9d0ed6fc796a2248
+  data.tar.gz: 9d371dcb0558ec42eeb179141c908e7c9a4b6c2831c6836e0063412772b5cfb9dc397db6f79af65e41db6f2d981c8be6eafb94f90d87439b2fe173b20c881fca

data/.gitignore

@@ -1,5 +1,8 @@
 .idea
 .rvmrc
+.ruby-gemset
+.ruby-version
 spec/log
 log/
 *.gem
+coverage/

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+## Unreleased Changes
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v1.1...master)
+
+* No significant changes.
+
+## 1.1.0 (May 18, 2013)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v1.0...v1.1)
+
+
+Bug Fixes:
+
+* HttpAcceptParameterStrategy will now accept multiple digit versions
+
+Enhancements:
+
+* Added this CHANGELOG!
+* New configuration parameter default_version to set the desired version when a client does not send a version instead of the default latest version. Thanks to [Billy Catherall](https://github.com/bcatherall) for implementing this.
+* Internal refactoring of strategies for better testability.
+* Isolated Rails hooks.
+
+Deprecations:
+
+* None
+
+## 1.0.0 (March 14, 2013)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v0.5...v1.0)
+
+## 0.5.0 (December 6, 2012)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v0.4...v0.5)
+
+## 0.4.0 (October 29, 2012)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/0fe364999ec9e5fe27faf39f82d8f7f2d26f38be...v0.4)

data/Gemfile

@@ -1,17 +1,15 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
 gem 'rack'
-gem 'actionpack'
-gem 'activerecord'
 gem 'multi_json'
-gem 'i18n', '0.6.1'
 gem 'tzinfo'
-gem 'sqlite3'
+gem 'coveralls', require: false
 
 group :development do
   # for travis-ci.org
   gem "rake"
   gem 'test-unit'
+  gem 'mocha', '~> 0.12.0', :require => false
 end

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    versioncake (1.0.0)
+    versioncake (1.1.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionpack (3.2.8)
       activemodel (= 3.2.8)
@@ -22,22 +22,24 @@ GEM
     activemodel (3.2.8)
       activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
     activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    arel (3.0.2)
     builder (3.0.0)
+    colorize (0.5.8)
+    coveralls (0.6.3)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
     erubis (2.7.0)
     hike (1.2.1)
     i18n (0.6.1)
     journey (1.0.4)
     json (1.7.5)
     metaclass (0.0.1)
+    mime-types (1.21)
     mocha (0.12.3)
       metaclass (~> 0.0.1)
     multi_json (1.3.6)
@@ -58,11 +60,16 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
     test-unit (2.5.2)
     thor (0.16.0)
     tilt (1.3.3)
@@ -72,14 +79,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack
-  activerecord
-  i18n (= 0.6.1)
-  mocha
+  coveralls
+  mocha (~> 0.12.0)
   multi_json
   rack
   rake
-  sqlite3
   test-unit
   tzinfo
   versioncake!

data/README.md

@@ -2,6 +2,9 @@
 
 [![Build Status](https://secure.travis-ci.org/bwillis/versioncake.png?branch=master)](http://travis-ci.org/bwillis/versioncake)
 [![Code Climate](https://codeclimate.com/github/bwillis/versioncake.png)](https://codeclimate.com/github/bwillis/versioncake)
+[![Coverage Status](https://coveralls.io/repos/bwillis/versioncake/badge.png?branch=master)](https://coveralls.io/r/bwillis/versioncake)
+[![Dependency Status](https://gemnasium.com/bwillis/versioncake.png)](https://gemnasium.com/bwillis/versioncake)
+[![Gem Version](https://badge.fury.io/rb/versioncake.png)](http://badge.fury.io/rb/versioncake)
 
 Co-authored by Ben Willis ([@bwillis](https://github.com/bwillis/)) and Jim Jones ([@aantix](https://github.com/aantix)).
 
@@ -159,12 +162,17 @@ When no version is specified, the latest version of the view is rendered.  In th
 ## How to use
 
 ### Configuration
+The configuration should be placed in your Rails projects `config/application.rb`. It is also suggested to enable different settings per environment, for example development and test can have extraction strategies that make it easier to develop or write test code.
 
+#### Supported Versions
 You need to define the supported versions in your Rails application.rb file as `view_versions`. Use this config to set the range of supported API versions that can be served:
 
 ```ruby
-config.view_versions = [1,3,4,5] # or (1...5)
+config.view_versions = [1,2,3,4,5] # or (1..5)
 ```
+
+#### Extraction Strategy
+
 You can also define the way to extract the version. The `view_version_extraction_strategy` allows you to set one of the default strategies or provide a proc to set your own. You can also pass it a prioritized array of the strategies.
 ```ruby
 config.view_version_extraction_strategy = :query_parameter # [:http_header, :http_accept_parameter]
@@ -176,7 +184,17 @@ These are the available strategies:
  - **http_accept_parameter**: HTTP Accept header ie. ```Accept: application/xml; version=1``` [why do this?](http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http#i_want_my_api_to_be_versioned)
  - **custom**: `lambda {|request| request.headers["HTTP_X_MY_VERSION"].to_i }` takes the request object and must return an integer
 
-The strategies use a default string of `api_version`, but that can be changed:
+
+#### Default Version
+
+When no version is supplied by a client, the version rendered will be the latest version by default. If you want to override this to another version, set the following property:
+```ruby
+config.default_version = 4
+```
+
+#### Version String
+
+The extraction strategies use a default string key of `api_version`, but that can be changed:
 ```ruby
 config.view_version_string = "special_version_parameter_name"
 ```
@@ -264,6 +282,16 @@ AppName::Application.config.view_versions.each do |supported_version|
 end
 ```
 
+# Thanks!
+
+Thanks to all those who have helped make Version Cake really sweet:
+
+* [Manilla](https://github.com/manilla)
+* [Alicia](https://github.com/alicial)
+* [Rohit](https://github.com/rg)
+* Sevag
+* [Billy](https://github.com/bcatherall)
+
 # Related Material
 
 ## Usages
@@ -285,6 +313,7 @@ end
 - [Ruby5 on versioncake](http://ruby5.envylabs.com/episodes/310-episode-306-september-18th-2012/stories/2704-version-cake)
 - [Rails core discussion](https://groups.google.com/forum/#!msg/rubyonrails-core/odwmEYYIum0/9POep66BvoMJ)
 - [RubyWeekly](http://rubyweekly.com/archive/119.html)
+- [API building tools on Ruby Toolbox](https://www.ruby-toolbox.com/categories/API_Builders)
 
 # Questions?
 

data/lib/versioncake/configuration.rb

@@ -0,0 +1,46 @@
+require 'active_support/core_ext/module/attribute_accessors.rb'
+
+module VersionCake
+  module Configuration
+
+    SUPPORTED_VERSIONS_DEFAULT = (1..10)
+
+    mattr_accessor :supported_version_numbers
+    self.supported_version_numbers = SUPPORTED_VERSIONS_DEFAULT
+
+    mattr_accessor :extraction_strategies
+    self.extraction_strategies = [VersionCake::QueryParameterStrategy.new]
+
+    mattr_accessor :default_version
+    self.default_version = nil
+
+    def self.extraction_strategy=(val)
+      @@extraction_strategies.clear
+      Array.wrap(val).each do |configured_strategy|
+        @@extraction_strategies << VersionCake::ExtractionStrategy.lookup(configured_strategy)
+      end
+    end
+
+    def self.supported_version_numbers=(val)
+      @@supported_version_numbers = val.respond_to?(:to_a) ? val.to_a : Array.wrap(val)
+      @@supported_version_numbers.sort!.reverse!
+    end
+
+    def self.supported_versions(requested_version_number=nil)
+      supported_version_numbers.collect do |supported_version_number|
+        if requested_version_number.nil? || supported_version_number <= requested_version_number
+          :"v#{supported_version_number}"
+        end
+      end
+    end
+
+    def self.supports_version?(version)
+      supported_version_numbers.include? version
+    end
+
+    def self.latest_version
+      supported_version_numbers.first
+    end
+
+  end
+end

data/lib/versioncake/controller_additions.rb

@@ -0,0 +1,24 @@
+require 'action_controller'
+
+module VersionCake
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    attr_accessor :requested_version, :is_latest_version, :derived_version
+
+    included do
+      prepend_before_filter :set_version
+    end
+
+    protected
+    def set_version(override_version=nil)
+      versioned_request         = VersionCake::VersionedRequest.new(request, override_version)
+      @requested_version        = versioned_request.extracted_version
+      @derived_version          = versioned_request.version
+      @_lookup_context.versions = versioned_request.supported_versions
+      @is_latest_version        = versioned_request.is_latest_version
+    end
+  end
+end
+
+ActionController::Base.send(:include, VersionCake::ControllerAdditions)

data/lib/versioncake/railtie.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+class ActionViewVersions < Rails::Railtie
+  initializer "view_versions" do |app|
+    ActiveSupport.on_load(:action_view) do
+      if app.config.respond_to?(:view_versions)
+        VersionCake::Configuration.supported_version_numbers = app.config.view_versions
+      end
+
+      if app.config.respond_to?(:view_version_extraction_strategy)
+        VersionCake::Configuration.extraction_strategy = app.config.view_version_extraction_strategy
+      end
+
+      if app.config.respond_to?(:view_version_string)
+        VersionCake::ExtractionStrategy.version_string = app.config.view_version_string
+      end
+
+      if app.config.respond_to?(:default_version)
+        VersionCake::Configuration.default_version = app.config.default_version
+      end
+    end
+  end
+end

data/lib/versioncake/strategies/custom_strategy.rb

@@ -0,0 +1,11 @@
+module VersionCake
+  class CustomStrategy < ExtractionStrategy
+    def initialize(callback)
+      @callback = callback
+    end
+
+    def execute(request)
+      @callback.call(request)
+    end
+  end
+end

data/lib/versioncake/strategies/extraction_strategy.rb

@@ -0,0 +1,37 @@
+require 'active_support/core_ext/class/attribute_accessors.rb'
+
+module VersionCake
+  class ExtractionStrategy
+
+    cattr_accessor :version_string
+    @@version_string = 'api_version'
+
+    def extract(request)
+      version = execute(request)
+      return version.to_i if version
+    end
+
+    def execute(request)
+      raise Exception, "ExtractionStrategy requires execute to be implemented"
+    end
+
+    def self.lookup(strategy)
+      if strategy.class == Proc
+        if strategy.arity == 1
+          VersionCake::CustomStrategy.new(strategy)
+        else
+          raise Exception, "Custom extraction strategy requires a single parameter"
+        end
+      else
+        strategy_name = "#{strategy}_strategy".camelize
+        begin
+          VersionCake.const_get(strategy_name).new
+        rescue
+          raise Exception, "Unknown VersionCake extraction strategy #{strategy_name}"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/versioncake/strategies/http_accept_parameter_strategy.rb

@@ -0,0 +1,12 @@
+module VersionCake
+  class HttpAcceptParameterStrategy < ExtractionStrategy
+
+    def execute(request)
+      if request.headers.has_key?("HTTP_ACCEPT") &&
+          match = request.headers["HTTP_ACCEPT"].match(/#{@@version_string}=([0-9]+)/)
+        match[1]
+      end
+    end
+
+  end
+end

data/lib/versioncake/strategies/http_header_strategy.rb

@@ -0,0 +1,11 @@
+module VersionCake
+  class HttpHeaderStrategy < ExtractionStrategy
+
+    def execute(request)
+      if request.headers.has_key? "HTTP_X_#{@@version_string.upcase}"
+        request.headers["HTTP_X_#{@@version_string.upcase}"]
+      end
+    end
+
+  end
+end

data/lib/versioncake/strategies/query_parameter_strategy.rb

@@ -0,0 +1,11 @@
+module VersionCake
+  class QueryParameterStrategy < ExtractionStrategy
+
+    def execute(request)
+      if request.query_parameters.has_key? @@version_string.to_sym
+        request.query_parameters[@@version_string.to_sym]
+      end
+    end
+
+  end
+end

data/lib/versioncake/strategies/request_parameter_strategy.rb

@@ -0,0 +1,11 @@
+module VersionCake
+  class RequestParameterStrategy < ExtractionStrategy
+
+    def execute(request)
+      if request.request_parameters.has_key? @@version_string.to_sym
+        request.request_parameters[@@version_string.to_sym].to_i
+      end
+    end
+
+  end
+end

data/lib/versioncake/version.rb

@@ -1,3 +1,3 @@
 module VersionCake
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/versioncake/versioned_request.rb

@@ -0,0 +1,38 @@
+module VersionCake
+  class VersionedRequest
+    attr_reader :version, :extracted_version, :is_latest_version
+
+    def initialize(request, version_override=nil)
+      @version = version_override || extract_version(request)
+      @is_latest_version = @version == VersionCake::Configuration.latest_version
+    end
+
+    def supported_versions
+      VersionCake::Configuration.supported_versions(@version)
+    end
+
+    private
+
+    def apply_strategies(request)
+      version = nil
+      VersionCake::Configuration.extraction_strategies.each do |strategy|
+        version = strategy.extract(request)
+        break unless version.nil?
+      end
+      version
+    end
+
+    def extract_version(request)
+      @extracted_version = apply_strategies(request)
+      if @extracted_version.nil?
+        @version = VersionCake::Configuration.default_version || VersionCake::Configuration.latest_version
+      elsif VersionCake::Configuration.supports_version? @extracted_version
+        @version = @extracted_version
+      elsif @extracted_version > VersionCake::Configuration.latest_version
+        raise ActionController::RoutingError.new("No route match for version")
+      else
+        raise ActionController::RoutingError.new("Version is deprecated")
+      end
+    end
+  end
+end

data/lib/versioncake/{action_view/resolver.rb → view_additions.rb}

@@ -1,5 +1,10 @@
 require 'action_view'
 
+# register an addition detail for the lookup context to understand,
+# this will allow us to have the versions available upon lookup in
+# the resolver.
+ActionView::LookupContext.register_detail(:versions){ VersionCake::Configuration.supported_versions }
+
 ActionView::PathResolver.class_eval do
 
   # not sure why we are doing this yet, but looks like a good idea
@@ -10,4 +15,14 @@ ActionView::PathResolver.class_eval do
   # it to the default pattern
   ActionView::PathResolver::DEFAULT_PATTERN.replace ":prefix/:action{.:locale,}{.:versions,}{.:formats,}{.:handlers,}"
 
+end
+
+ActionView::Template.class_eval do
+
+  # the identifier method name filters out numbers,
+  # but we want to preserve them for v1 etc.
+  def identifier_method_name #:nodoc:
+    inspect.gsub(/[^a-z0-9_]/, '_')
+  end
+
 end

data/lib/versioncake.rb

@@ -1,6 +1,12 @@
-require 'versioncake/action_view/template'
-require 'versioncake/action_view/versions'
-require 'versioncake/action_view/lookup_context'
-require 'versioncake/action_view/resolver'
-require 'versioncake/action_controller/versioning'
-require 'versioncake/action_view/railtie'
+require 'versioncake/strategies/extraction_strategy'
+require 'versioncake/strategies/http_accept_parameter_strategy'
+require 'versioncake/strategies/http_header_strategy'
+require 'versioncake/strategies/query_parameter_strategy'
+require 'versioncake/strategies/request_parameter_strategy'
+require 'versioncake/strategies/custom_strategy'
+
+require 'versioncake/configuration'
+require 'versioncake/controller_additions'
+require 'versioncake/view_additions'
+require 'versioncake/versioned_request'
+require 'versioncake/railtie'

data/test/app/controllers/renders_controller.rb

@@ -3,5 +3,8 @@ require "action_controller/base"
 
 class RendersController < ActionController::Base
   def index
+    if params[:override_version]
+      set_version(params[:override_version].to_i)
+    end
   end
-end
+end

data/test/config/application.rb

@@ -1,13 +1,11 @@
-require 'rails/all'
+require "action_controller/railtie"
+require "active_support/railtie"
+
+# Auto-require default libraries and those for the current Rails environment.
+Bundler.require :default, Rails.env
 
 module RendersTest
   class Application < Rails::Application
-    config.encoding = "utf-8"
-    config.filter_parameters += [:password]
-    config.active_support.escape_html_entities_in_json = true
-    config.active_record.whitelist_attributes = true
-    config.assets.enabled = true
-    config.assets.version = '1.0'
     config.active_support.deprecation = :stderr
     config.view_versions = (1..3)
     config.view_version_extraction_strategy = :http_header

data/test/functional/renders_controller_test.rb

@@ -6,11 +6,11 @@ class RendersControllerTest < ActionController::TestCase
 
   setup do
     # change the version string for configuration testing
-    ActionView::Template::Versions.version_string = "version"
+    VersionCake::ExtractionStrategy.version_string = "version"
   end
 
   teardown do
-    ActionView::Template::Versions.version_string = "api_version"
+    VersionCake::ExtractionStrategy.version_string = "api_version"
   end
 
   test "render latest version of partial" do
@@ -33,22 +33,34 @@ class RendersControllerTest < ActionController::TestCase
     assert !@controller.is_latest_version
   end
 
-  test "exposes the derived version when the version is not set" do
+  test "exposes the derived version when the version is not set and no default" do
     get :index
     assert_equal 3, @controller.derived_version
   end
 
+  test "exposes the default version when the version is not set default is set" do
+    VersionCake::Configuration.default_version = 1
+    get :index
+    assert_equal 1, @controller.derived_version
+    VersionCake::Configuration.default_version = nil
+  end
+
   test "requested version is blank when the version is not set" do
     get :index
     assert_blank @controller.requested_version
   end
+
+  test "set_version can be called to override the requested version" do
+    get :index, "version" => "1", "override_version" => 2
+    assert_equal 2, @controller.derived_version
+  end
 end
 
 class ParameterStragegyTest < ActionController::TestCase
   tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = :query_parameter
+    VersionCake::Configuration.extraction_strategy = :query_parameter
   end
 
   test "render version 1 of the partial based on the parameter _api_version" do
@@ -71,7 +83,7 @@ class CustomHeaderStrategyTest < ActionController::TestCase
 tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = :http_header
+    VersionCake::Configuration.extraction_strategy = :http_header
   end
 
   test "renders version 1 of the partial based on the header API-Version" do
@@ -97,7 +109,7 @@ class RequestBodyStrategyTest < ActionController::TestCase
  tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = :request_parameter
+    VersionCake::Configuration.extraction_strategy = :request_parameter
   end
 
   test "requested version is in the body" do
@@ -110,7 +122,7 @@ class AcceptHeaderStrategyTest < ActionController::TestCase
   tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = :http_accept_parameter
+    VersionCake::Configuration.extraction_strategy = :http_accept_parameter
   end
 
   test "render version 1 of the partial based on the header Accept" do
@@ -136,13 +148,22 @@ class AcceptHeaderStrategyTest < ActionController::TestCase
     get :index
     assert_equal @response.body, "index.v2.html.erb"
   end
+
+  test "render the default version version of the partial" do
+    VersionCake::Configuration.default_version = 1
+    @controller.request.stubs(:headers).returns({"HTTP_ACCEPT" => "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8;api_version=abc"})
+    get :index
+    assert_equal @response.body, "index.v1.html.erb"
+    VersionCake::Configuration.default_version = nil
+  end
+
 end
 
 class CustomStrategyTest < ActionController::TestCase
   tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = lambda { |request| 2 }
+    VersionCake::Configuration.extraction_strategy = lambda { |request| 2 }
   end
 
   test "renders version 2 of the partial based on the header Accept" do
@@ -155,7 +176,7 @@ class MultipleStrategyTest < ActionController::TestCase
   tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = [:http_accept_parameter, :query_parameter]
+    VersionCake::Configuration.extraction_strategy = [:http_accept_parameter, :query_parameter]
   end
 
   test "renders version 1 of the partial based on the header Accept" do
@@ -180,7 +201,7 @@ class UnsupportedVersionTest < ActionController::TestCase
   tests RendersController
 
   setup do
-    ActionView::Template::Versions.extraction_strategy = :query_parameter
+    VersionCake::Configuration.extraction_strategy = :query_parameter
   end
 
   test "responds with 404 when the version is larger than the supported version" do
@@ -190,7 +211,7 @@ class UnsupportedVersionTest < ActionController::TestCase
   end
 
   test "responds with 404 when the version is lower than the latest version, but not an available version" do
-    ActionView::Template::Versions.supported_version_numbers = [2,3]
+    VersionCake::Configuration.supported_version_numbers = [2,3]
     assert_raise ActionController::RoutingError do
       get :index, "api_version" => "1"
     end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'bundler'
 Bundler.require
 
@@ -5,13 +8,14 @@ require 'versioncake'
 
 ENV["RAILS_ENV"] = 'test'
 
-require 'rails/all'
 require 'rails/test_help'
 require 'test/unit'
 
+require "mocha"
+
 require File.expand_path('../config/application', __FILE__)
 
 FIXTURE_LOAD_PATH = File.join(File.dirname(__FILE__), 'fixtures')
 FIXTURES = Pathname.new(FIXTURE_LOAD_PATH)
 
-RendersTest::Application.initialize!
+RendersTest::Application.initialize!

data/test/unit/configuration_test.rb

@@ -0,0 +1,49 @@
+require './test/test_helper'
+
+class ConfigurationTest < ActiveSupport::TestCase
+  setup do
+    @previous_versions = VersionCake::Configuration.supported_version_numbers
+  end
+
+  teardown do
+    VersionCake::Configuration.supported_version_numbers = @previous_versions
+  end
+
+  test "supported_version_numbers can be set with range" do
+    VersionCake::Configuration.supported_version_numbers = (1..7)
+    assert_equal [7,6,5,4,3,2,1], VersionCake::Configuration.supported_version_numbers
+  end
+
+  test "supported_version_numbers can be set with an unordered array" do
+    VersionCake::Configuration.supported_version_numbers = [2,4,1,5,3,6,7]
+    assert_equal [7,6,5,4,3,2,1], VersionCake::Configuration.supported_version_numbers
+  end
+
+  test "supported_version_numbers can be set with a single value" do
+    VersionCake::Configuration.supported_version_numbers = 19
+    assert_equal [19], VersionCake::Configuration.supported_version_numbers
+  end
+
+  test "supports_version? is only true for given supported versions" do
+    VersionCake::Configuration.supported_version_numbers = (1..7)
+    VersionCake::Configuration.supported_version_numbers.each do |supported_version|
+      assert_true VersionCake::Configuration.supports_version? supported_version
+    end
+  end
+
+  test "supports_version? is not true for other versions" do
+    VersionCake::Configuration.supported_version_numbers = (1..7)
+    [-2,-1,0,8,9,10].each do |unsupported_version|
+      assert_false VersionCake::Configuration.supports_version? unsupported_version
+    end
+  end
+
+  test "latest_version retrieves the highest supported version" do
+    VersionCake::Configuration.supported_version_numbers = [4,1,3,9,2,54]
+    assert_equal 54, VersionCake::Configuration.latest_version
+  end
+
+  test "default supported_version_numbers should be a logic set of version numbers" do
+    assert_equal VersionCake::Configuration::SUPPORTED_VERSIONS_DEFAULT, (1..10)
+  end
+end

data/test/unit/strategies/extraction_strategy_test.rb

@@ -0,0 +1,38 @@
+require './test/test_helper'
+
+class ExtractionStrategyTest < ActiveSupport::TestCase
+  test "execute is required for a strategy" do
+    assert_raise(Exception) do
+      VersionCake::ExtractionStrategy.new.execute("request")
+    end
+  end
+
+  test "extract will convert the the result to integer" do
+    class TestStrategy < VersionCake::ExtractionStrategy
+      def execute(request); "123"; end
+    end
+    assert_equal TestStrategy.new.extract("request"), 123
+  end
+
+  test "it can lookup a strategy" do
+    strategy = VersionCake::ExtractionStrategy.lookup(:query_parameter)
+    assert_equal VersionCake::QueryParameterStrategy, strategy.class
+  end
+
+  test "it creates a custom strategy for a proc" do
+    strategy = VersionCake::ExtractionStrategy.lookup(lambda{|req|})
+    assert_equal VersionCake::CustomStrategy, strategy.class
+  end
+
+  test "it fails to create a custom strategy for a proc with no parameters" do
+    assert_raise(Exception) do
+      VersionCake::ExtractionStrategy.lookup(lambda{})
+    end
+  end
+
+  test "it raises error when no strategy is found" do
+    assert_raise(Exception) do
+      VersionCake::ExtractionStrategy.lookup(:fake_extraction)
+    end
+  end
+end

data/test/unit/strategies/http_accept_parameter_strategy_test.rb

@@ -0,0 +1,17 @@
+require './test/test_helper'
+
+class HttpAcceptParameterStrategyTest < ActiveSupport::TestCase
+  setup do
+    @strategy = VersionCake::HttpAcceptParameterStrategy.new
+  end
+
+  test "a request with an HTTP_ACCEPT version retrieves the version" do
+    request = stub(:headers => {'HTTP_ACCEPT' => 'application/xml; api_version=11'})
+    assert_equal 11, @strategy.extract(request)
+  end
+
+  test "a request without an HTTP_ACCEPT version returns nil" do
+    request = stub(:headers => {'HTTP_ACCEPT' => 'text/x-dvi; q=.8; mxb=100000; mxt=5.0, text/x-c'})
+    assert_nil @strategy.extract(request)
+  end
+end

data/test/unit/strategies/http_header_strategy_test.rb

@@ -0,0 +1,17 @@
+require './test/test_helper'
+
+class HttpHeaderStrategyTest < ActiveSupport::TestCase
+  setup do
+    @strategy = VersionCake::HttpHeaderStrategy.new
+  end
+
+  test "a request with an HTTP_X_API_VERSION retrieves the version" do
+    request = stub(:headers => {'HTTP_X_API_VERSION' => '11'})
+    assert_equal 11, @strategy.extract(request)
+  end
+
+  test "a request without an HTTP_X_API_VERSION returns nil" do
+    request = stub(:headers => {'HTTP_ACCEPT' => 'text/x-dvi; q=.8; mxb=100000; mxt=5.0, text/x-c'})
+    assert_nil @strategy.extract(request)
+  end
+end

data/test/unit/strategies/query_parameter_strategy_test.rb

@@ -0,0 +1,17 @@
+require './test/test_helper'
+
+class QueryParameterStrategyTest < ActiveSupport::TestCase
+  setup do
+    @strategy = VersionCake::QueryParameterStrategy.new
+  end
+
+  test "a request with an api_version parameter retrieves the version" do
+    request = stub(:query_parameters => {:api_version => '11', :other => 'parameter'})
+    assert_equal 11, @strategy.extract(request)
+  end
+
+  test "a request without an api_version parameter returns nil" do
+    request = stub(:query_parameters => {:other => 'parameter', :another => 'parameter'})
+    assert_nil @strategy.extract(request)
+  end
+end

data/test/unit/strategies/request_parameter_strategy_test.rb

@@ -0,0 +1,17 @@
+require './test/test_helper'
+
+class RequestParameterStrategyTest < ActiveSupport::TestCase
+  setup do
+    @strategy = VersionCake::RequestParameterStrategy.new
+  end
+
+  test "a request with an api_version request parameter retrieves the version" do
+    request = stub(:request_parameters => {:api_version => '11', :other => 'parameter'})
+    assert_equal 11, @strategy.extract(request)
+  end
+
+  test "a request without an api_version request parameter returns nil" do
+    request = stub(:request_parameters => {:other => 'parameter', :another => 'parameter'})
+    assert_nil @strategy.extract(request)
+  end
+end

data/test/unit/versioned_request_test.rb

@@ -0,0 +1,48 @@
+require './test/test_helper'
+
+class VersionedRequestTest < ActiveSupport::TestCase
+  test "a request with a supported version returns the version" do
+    VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => 2)
+    versioned_request = VersionCake::VersionedRequest.new(stub())
+    assert_equal 2, versioned_request.version
+  end
+
+  test "a request without a version returns the latest version" do
+    VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => nil)
+    versioned_request = VersionCake::VersionedRequest.new(stub())
+    assert_equal 3, versioned_request.version
+  end
+
+  test "a request for a version that is higher than the latest version raises an error" do
+    VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => 99)
+    assert_raise ActionController::RoutingError do
+      VersionCake::VersionedRequest.new(stub())
+    end
+  end
+
+  test "a request for a deprecated version raises an exception" do
+    VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => 2)
+    VersionCake::Configuration.stubs(:supports_version? => false)
+    assert_raise ActionController::RoutingError do
+      VersionCake::VersionedRequest.new(stub())
+    end
+  end
+
+  test "has a method to determine if requesting the latest version" do
+    VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => nil)
+    versioned_request = VersionCake::VersionedRequest.new(stub())
+    assert_true versioned_request.is_latest_version
+  end
+
+  test "has a method to retrieve the extracted version" do
+    VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => nil)
+    versioned_request = VersionCake::VersionedRequest.new(stub())
+    assert_nil versioned_request.extracted_version
+    assert_equal 3, versioned_request.version
+  end
+
+  test "the version can be overriden by a parameter" do
+    versioned_request = VersionCake::VersionedRequest.new(stub(), 8)
+    assert_equal 8, versioned_request.version
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versioncake
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Jim Jones
@@ -10,86 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Render versioned views automagically based on the clients requested version.
@@ -102,28 +91,32 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - images/versioncake-logo450x100.png
 - lib/versioncake.rb
-- lib/versioncake/action_controller/versioning.rb
-- lib/versioncake/action_view/lookup_context.rb
-- lib/versioncake/action_view/railtie.rb
-- lib/versioncake/action_view/resolver.rb
-- lib/versioncake/action_view/template.rb
-- lib/versioncake/action_view/versions.rb
+- lib/versioncake/configuration.rb
+- lib/versioncake/controller_additions.rb
+- lib/versioncake/railtie.rb
+- lib/versioncake/strategies/custom_strategy.rb
+- lib/versioncake/strategies/extraction_strategy.rb
+- lib/versioncake/strategies/http_accept_parameter_strategy.rb
+- lib/versioncake/strategies/http_header_strategy.rb
+- lib/versioncake/strategies/query_parameter_strategy.rb
+- lib/versioncake/strategies/request_parameter_strategy.rb
 - lib/versioncake/version.rb
+- lib/versioncake/versioned_request.rb
+- lib/versioncake/view_additions.rb
 - test/app/controllers/renders_controller.rb
 - test/app/views/renders/index.html.erb
 - test/app/views/renders/index.v1.html.erb
 - test/app/views/renders/index.v2.html.erb
 - test/config.ru
 - test/config/application.rb
-- test/config/database.yml
 - test/config/routes.rb
-- test/db/test.sqlite3
 - test/fixtures/partials/_versioned.erb
 - test/fixtures/partials/_versioned.v1.erb
 - test/fixtures/partials/_versioned.v2.erb
@@ -139,29 +132,35 @@ files:
 - test/script/rails
 - test/template/render_test.rb
 - test/test_helper.rb
+- test/unit/configuration_test.rb
+- test/unit/strategies/extraction_strategy_test.rb
+- test/unit/strategies/http_accept_parameter_strategy_test.rb
+- test/unit/strategies/http_header_strategy_test.rb
+- test/unit/strategies/query_parameter_strategy_test.rb
+- test/unit/strategies/request_parameter_strategy_test.rb
+- test/unit/versioned_request_test.rb
 - versioncake.gemspec
 homepage: https://github.com/bwillis/versioncake
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Easily render versions of your rails views.
 test_files: []

data/lib/versioncake/action_controller/versioning.rb

@@ -1,31 +0,0 @@
-require 'action_controller'
-
-module ActionController #:nodoc:
-  module Versioning
-    extend ActiveSupport::Concern
-
-    attr_accessor :requested_version, :is_latest_version, :derived_version
-
-    included do
-      prepend_before_filter :set_version
-    end
-
-    protected
-      def set_version
-        @requested_version = ActionView::Template::Versions.extract_version request
-
-        if @requested_version.nil?
-          @derived_version = ActionView::Template::Versions.latest_version
-        elsif ActionView::Template::Versions.supports_version? @requested_version
-          @derived_version = @requested_version
-        elsif @requested_version > ActionView::Template::Versions.latest_version
-          raise ActionController::RoutingError.new("No route match for version")
-        else
-          raise ActionController::RoutingError.new("Version is deprecated")
-        end
-        @_lookup_context.versions = ActionView::Template::Versions.supported_versions(@derived_version)
-        @is_latest_version = @derived_version == ActionView::Template::Versions.latest_version
-      end
-  end
-end
-ActionController::Base.send(:include, ActionController::Versioning)

data/lib/versioncake/action_view/lookup_context.rb

@@ -1,10 +0,0 @@
-require 'action_view'
-
-ActionView::LookupContext.class_eval do
-
-  # register an addition detail for the lookup context to understand,
-  # this will allow us to have the versions available upon lookup in
-  # the resolver.
-  register_detail(:versions){ ActionView::Template::Versions.supported_versions }
-
-end

data/lib/versioncake/action_view/railtie.rb

@@ -1,19 +0,0 @@
-require 'rails'
-
-class ActionViewVersions < Rails::Railtie
-  initializer "view_versions" do |app|
-    ActiveSupport.on_load(:action_view) do
-      if app.config.respond_to?(:view_versions)
-        ActionView::Template::Versions.supported_version_numbers = app.config.view_versions
-      end
-
-      if app.config.respond_to?(:view_version_extraction_strategy)
-        ActionView::Template::Versions.extraction_strategy = app.config.view_version_extraction_strategy
-      end
-
-      if app.config.respond_to?(:view_version_string)
-        ActionView::Template::Versions.version_string = app.config.view_version_string
-      end
-    end
-  end
-end

data/lib/versioncake/action_view/template.rb

@@ -1,11 +0,0 @@
-require 'action_view'
-
-ActionView::Template.class_eval do
-
-  # the identifier method name filters out numbers,
-  # but we want to preserve them for v1 etc.
-  def identifier_method_name #:nodoc:
-    inspect.gsub(/[^a-z0-9_]/, '_')
-  end
-
-end

data/lib/versioncake/action_view/versions.rb

@@ -1,90 +0,0 @@
-require 'active_support/core_ext/module/attribute_accessors.rb'
-
-module ActionView
-  class Template
-    module Versions
-
-      mattr_accessor :version_string
-      self.version_string = "api_version"
-
-      mattr_accessor :supported_version_numbers
-      self.supported_version_numbers = []
-
-      mattr_accessor :extraction_strategy
-      self.extraction_strategy = [:query_parameter]
-
-      def self.extract_version(request)
-        version = nil
-        extraction_strategy.each do |strategy|
-          version = apply_strategy(request, strategy)
-          break unless version.nil?
-        end
-        version
-      end
-
-      def self.apply_strategy(request, strategy)
-        case strategy
-          when Proc
-            strategy.call(request)
-          when :http_accept_parameter
-            if request.headers.has_key?("HTTP_ACCEPT") &&
-                match = request.headers["HTTP_ACCEPT"].match(%{#{@@version_string}=([0-9])})
-              match[1].to_i
-            end
-          when :http_header
-            if request.headers.has_key? "HTTP_X_#{@@version_string.upcase}"
-              request.headers["HTTP_X_#{@@version_string.upcase}"].to_i
-            end
-          when :query_parameter
-            if request.query_parameters.has_key? @@version_string.to_sym
-              request.query_parameters[@@version_string.to_sym].to_i
-            end
-          when :request_parameter
-            if request.request_parameters.has_key? @@version_string.to_sym
-              request.request_parameters[@@version_string.to_sym].to_i
-            end
-          else
-            raise "Unknown extraction strategy #{strategy}"
-        end
-      end
-
-      def self.extraction_strategy=(val)
-        case val
-          when Array
-            @@extraction_strategy = val
-          else
-            @@extraction_strategy = Array.wrap(val)
-        end
-      end
-
-      def self.supported_version_numbers=(val)
-        case val
-          when Range
-            @@supported_version_numbers = val.to_a
-          when Array
-            @@supported_version_numbers = val
-          else
-            @@supported_version_numbers = Array.wrap(val)
-        end
-        @@supported_version_numbers.sort!.reverse!
-      end
-
-      def self.supported_versions(requested_version_number=nil)
-        supported_version_numbers.collect do |supported_version_number|
-          if requested_version_number.nil? || supported_version_number <= requested_version_number
-            :"v#{supported_version_number}"
-          end
-        end
-      end
-
-      def self.supports_version?(version)
-        supported_version_numbers.include? version
-      end
-
-      def self.latest_version
-        supported_version_numbers.first
-      end
-
-    end
-  end
-end

data/test/config/database.yml

@@ -1,4 +0,0 @@
-test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  timeout: 5000