versioncake 0.3.2 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    versioncake (0.3.1)
+    versioncake (0.4.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)

data/README.md

@@ -19,6 +19,8 @@ app/views/posts/
 - Clients can request API versions through different strategies
 - Dry your controller logic with exposed helpers
 
+Check out https://github.com/bwillis/350-rest-api-versioning for a comparison of traditional versioning approaches and a versioncake implementation.
+
 ## Install
 
 ```
@@ -168,9 +170,14 @@ config.view_version_extraction_strategy = :query_parameter # [:http_header, :htt
 ```
 These are the available strategies:
  - **query_parameter**: version in the url query parameter, for testing or to override for special case i.e. ```http://localhost:3000/posts.json?api_version=1```  (This is the default.)
- - **http_header**: Api version HTTP header ie. ```API-Version: 1```
+ - **http_header**: Api version HTTP header ie. ```X-API-Version: 1```
  - **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_API_VERSION"].to_i }` takes the request object and must return an integer
+ - **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:
+```ruby
+config.view_version_string = "special_version_parameter_name"
+```
 
 ### Version your views
 

data/lib/versioncake/action_view/railtie.rb

@@ -10,6 +10,10 @@ class ActionViewVersions < Rails::Railtie
       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/versions.rb

@@ -4,7 +4,8 @@ module ActionView
   class Template
     module Versions
 
-      VERSION_STRING = "api_version"
+      mattr_accessor :version_string
+      self.version_string = "api_version"
 
       mattr_accessor :supported_version_numbers
       self.supported_version_numbers = []
@@ -14,18 +15,18 @@ module ActionView
 
       EXTRACTION_STRATEGIES = {
         :query_parameter => lambda { |request|
-          if request.query_parameters.has_key? VERSION_STRING.to_sym
-            request.query_parameters[VERSION_STRING.to_sym].to_i
+          if request.query_parameters.has_key? @@version_string.to_sym
+            request.query_parameters[@@version_string.to_sym].to_i
           end
         },
         :http_header => lambda { |request|
-          if request.headers.has_key? "HTTP_#{VERSION_STRING.upcase}"
-            request.headers["HTTP_#{VERSION_STRING.upcase}"].to_i
+          if request.headers.has_key? "HTTP_X_#{@@version_string.upcase}"
+            request.headers["HTTP_X_#{@@version_string.upcase}"].to_i
           end
         },
         :http_accept_parameter => lambda { |request|
           if request.headers.has_key?("HTTP_ACCEPT") &&
-              match = request.headers["HTTP_ACCEPT"].match(%{#{VERSION_STRING}=([0-9])})
+              match = request.headers["HTTP_ACCEPT"].match(%{#{@@version_string}=([0-9])})
             match[1].to_i
           end
         }

data/lib/versioncake/version.rb

@@ -1,3 +1,3 @@
 module VersionCake
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/test/functional/renders_controller_test.rb

@@ -4,23 +4,33 @@ require "action_controller"
 require "action_controller/test_case"
 
 class RendersControllerTest < ActionController::TestCase
+
+  setup do
+    # change the version string for configuration testing
+    ActionView::Template::Versions.version_string = "version"
+  end
+
+  teardown do
+    ActionView::Template::Versions.version_string = "api_version"
+  end
+
   test "render latest version of partial" do
     get :index
     assert_equal @response.body, "index.v2.html.erb"
   end
 
   test "exposes the requested version" do
-    get :index, "api_version" => "1"
+    get :index, "version" => "1"
     assert_equal @controller.requested_version, 1
   end
 
   test "exposes latest version when requesting the latest" do
-    get :index, "api_version" => "3"
+    get :index, "version" => "3"
     assert @controller.is_latest_version
   end
 
   test "reports not the latest version" do
-    get :index, "api_version" => "1"
+    get :index, "version" => "1"
     assert !@controller.is_latest_version
   end
 
@@ -66,19 +76,19 @@ tests RendersController
   end
 
   test "renders version 1 of the partial based on the header API-Version" do
-    @controller.request.stubs(:headers).returns({"HTTP_API_VERSION" => "1"})
+    @controller.request.stubs(:headers).returns({"HTTP_X_API_VERSION" => "1"})
     get :index
     assert_equal @response.body, "index.v1.html.erb"
   end
 
   test "renders version 2 of the partial based on the header API-Version" do
-    @controller.request.stubs(:headers).returns({"HTTP_API_VERSION" => "2"})
+    @controller.request.stubs(:headers).returns({"HTTP_X_API_VERSION" => "2"})
     get :index
     assert_equal @response.body, "index.v2.html.erb"
   end
 
   test "renders the latest available version (v2) of the partial based on the header API-Version" do
-    @controller.request.stubs(:headers).returns({"HTTP_API_VERSION" => "3"})
+    @controller.request.stubs(:headers).returns({"HTTP_X_API_VERSION" => "3"})
     get :index
     assert_equal @response.body, "index.v2.html.erb"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versioncake
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-14 00:00:00.000000000 Z
+date: 2012-10-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Easily render versions of your rails views.