versioncake 0.5.0 → 1.0.0

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,7 @@
 ![Version Cake](https://raw.github.com/alicial/versioncake/master/images/versioncake-logo450x100.png)
 
 [![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)
 
 Co-authored by Ben Willis ([@bwillis](https://github.com/bwillis/)) and Jim Jones ([@aantix](https://github.com/aantix)).
 
@@ -170,6 +171,7 @@ 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.)
+ - **request_parameter**: version that is sent in the body of the request. Good for testing.
  - **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_MY_VERSION"].to_i }` takes the request object and must return an integer
@@ -215,6 +217,53 @@ end
 
 When a client makes a request it will automatically receive the latest supported version of the view. The client can also request for a specific version by one of the strategies configured by ``view_version_extraction_strategy``.
 
+## How to test
+
+Testing can be painful but here are some easy ways to test different versions of your api using version cake.
+
+### Test configuration
+
+Allowing more extraction strategies during testing can be helpful when needing to override the version.
+```ruby
+# config/environments/test.rb
+config.view_version_extraction_strategy = [:query_parameter, :request_parameter, :http_header, :http_accept_parameter]
+```
+
+### Testing a specific version
+
+One way to test a specific version for would be to stub the requested version in the before block:
+```ruby
+before do
+  @controller.stubs(:requested_version).returns(3)
+end
+```
+
+You can also test a specific version through a specific strategy such query_parameter or request_parameter strategies (configured in test environment) like so:
+```ruby
+# test/functional/renders_controller_test.rb#L47
+test "render version 1 of the partial based on the parameter _api_version" do
+  get :index, "api_version" => "1"
+  assert_equal @response.body, "index.v1.html.erb"
+end
+```
+
+### Testing all supported versions
+
+You can iterate over all of the supported version numbers by accessing the ```AppName::Application.config.view_versions```.
+
+```ruby
+AppName::Application.config.view_versions.each do |supported_version|
+  before do
+    @controller.stubs(:requested_version).returns(supported_version)
+  end
+  
+  test "all versions render the correct template" do
+    get :index
+    assert_equal @response.body, "index.v1.html.erb"
+  end
+end
+```
+
 # Related Material
 
 ## Usages
@@ -231,7 +280,7 @@ When a client makes a request it will automatically receive the latest supported
 ## Discussions
 
 - [Steve Klabnik on how to version in a resful way](http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http#i_want_my_api_to_be_versioned)
-- [Rails API project disucssion on versioning](https://github.com/spastorino/rails-api/issues/8)
+- [Rails API project disucssion on versioning](https://github.com/rails-api/rails-api/issues/8)
 - [Railscast on versioning](http://railscasts.com/episodes/350-rest-api-versioning)
 - [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)

data/lib/versioncake/action_view/versions.rb

@@ -13,38 +13,39 @@ module ActionView
       mattr_accessor :extraction_strategy
       self.extraction_strategy = [:query_parameter]
 
-      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
-          end
-        },
-        :http_header => lambda { |request|
-          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[1].to_i
-          end
-        }
-      }
-
       def self.extract_version(request)
         version = nil
         extraction_strategy.each do |strategy|
-          version = if strategy.is_a? Proc
+          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)
-          elsif EXTRACTION_STRATEGIES.include? strategy
-            EXTRACTION_STRATEGIES[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
-          break unless version.nil?
         end
-        version
       end
 
       def self.extraction_strategy=(val)
@@ -59,11 +60,11 @@ module ActionView
       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)
+            @@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

data/lib/versioncake/version.rb

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

data/test/functional/renders_controller_test.rb

@@ -1,7 +1,6 @@
-require 'test_helper'
-
-require "action_controller"
-require "action_controller/test_case"
+require './test/test_helper'
+require 'action_controller'
+require 'action_controller/test_case'
 
 class RendersControllerTest < ActionController::TestCase
 
@@ -94,6 +93,19 @@ tests RendersController
   end
 end
 
+class RequestBodyStrategyTest < ActionController::TestCase
+ tests RendersController
+
+  setup do
+    ActionView::Template::Versions.extraction_strategy = :request_parameter
+  end
+
+  test "requested version is in the body" do
+    post :index, "api_version" => "2"
+    assert_equal 2, @controller.requested_version
+  end
+end
+
 class AcceptHeaderStrategyTest < ActionController::TestCase
   tests RendersController
 
@@ -183,4 +195,4 @@ class UnsupportedVersionTest < ActionController::TestCase
       get :index, "api_version" => "1"
     end
   end
-end
+end

data/test/template/render_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require "./test/test_helper"
 
 class VersionRenderTest < ActiveSupport::TestCase
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versioncake
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2013-03-14 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.