versioncake 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 8fbcc57e744a93f5f6de3774d76ac1243a7fa412
-  data.tar.gz: a928bce4aaf76fa1bfd130773b1e7f8bd4b85727
-SHA512:
-  metadata.gz: 9e1bd9d2d1206d7ac5f036ff4b58ac6ef5bc218eb86a11319efa7a93dcb341a8ce1760740be620fbef9ca0b205dd067e414ae0f06c22c28b38851a746ad8b661
-  data.tar.gz: 77692e1b0088daa052cbca53d4da0f35acbac818d7e7e0277df12111eeafb6f0592f05e10faccb8ba6dcd78ecd261a7e45dea494c101eb7d53abe3edb999fbb7
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjUzNjczOGFiZjY3NDliNmRmYzJhZTI5NDIzNDhhYWM4YTgxMGE2YQ==
+  data.tar.gz: !binary |-
+    YzM4MzAwZjk2MDNlYThjZjRkMWE5NTk1MTM3Mzg3NzlmYmY2NzdlYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MWU4NTRjNzNkMzA4MmRkZTcxYWI2M2MxMmY2NmQwZDM4NTMyYzM0MTEyZDE1
+    N2I2NTY3MzQyMzUxYjgyNjUwYTE1ZGI3NGVlZjU0YjI1MDQ2MzAwMDhmNmQx
+    NGQ5NmU3YjI3MWU5ZWNiMWI4MGVkMzUxNjE1MmU0MzU3OGIzNzU=
+  data.tar.gz: !binary |-
+    MDJkNTJlM2QxMmE0ZmU2Y2JiNmMyZDk3Y2Q1ZWE5NjU3ZjI4YmU3NzBkZDZj
+    MmJiMDAxMTAyMzYxMTZlMmNiNjVlNjNjMWI5MWM2M2VmM2IzZjkwYzViYmVh
+    MDNiMzY1NjJiN2RjM2I1ODk2Y2IxNzFiZmMyNzM4ODkxOTM4Njg=

data/Appraisals

@@ -11,7 +11,7 @@ appraise "rails4.0" do
 end
 
 appraise "rails4.1" do
-  gem('actionpack',     '~> 4.1.0.beta1')
-  gem('activesupport',  '~> 4.1.0.beta1')
-  gem('railties',       '~> 4.1.0.beta1')
+  gem('actionpack',     '~> 4.1.0.rc1')
+  gem('activesupport',  '~> 4.1.0.rc1')
+  gem('railties',       '~> 4.1.0.rc1')
 end

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 ## Unreleased Changes
 
-[Full Changelog](https://github.com/bwillis/versioncake/compare/v1.3...master)
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v2.1...master)
+
+Bug Fixes:
+
+Enhancements:
+
+## 2.1.0 (Mar 3, 2014)
+
+Enhancements:
+
+* Allow simpler handling of an unsupported versioned request by raising a custom error (issues #24 and #25) thanks [Richard Nuno](https://github.com/richardnuno) and [Andres Camacho](https://github.com/andresfcamacho)
+
+## 2.0.0 (Feb 6, 2014)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v1.3...v2.0)
 
 Bug Fixes:
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    versioncake (2.0.0)
+    versioncake (2.1.0)
       actionpack (>= 3.2)
       activesupport (>= 3.2)
       railties (>= 3.2)

data/README.md

@@ -6,7 +6,7 @@
 [![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)).
+Co-authored by Ben Willis ([bwillis](https://github.com/bwillis/)) and Jim Jones ([aantix](https://github.com/aantix)).
 
 Version Cake is an unobtrusive way to version APIs in your Rails app. 
 
@@ -35,13 +35,13 @@ gem install versioncake
 
 | Version | Rails 3.2 Support? | Rails 4 Support? | Rails 4.1 Support? |
 | ------- |:---------:| -------:| -------:|
-| 1.0     | Yes       | No      | No      |
-| 1.1     | Yes       | No      | No      |
-| 1.2     | Yes       | Yes     | No      |
-| 1.3     | Yes       | Yes     | No      |
-| 2.0     | Yes       | Yes     | Yes     |
+| [1.0](CHANGELOG.md#100-march-14-2013) | Yes       | No      | No      |
+| [1.1](CHANGELOG.md#110-may-18-2013)   | Yes       | No      | No      |
+| [1.2](CHANGELOG.md#120-may-26-2013)   | Yes       | Yes     | No      |
+| [1.3](CHANGELOG.md#130-sept-26-2013)  | Yes       | Yes     | No      |
+| [2.0](CHANGELOG.md#200-feb-6-2014)    | Yes       | Yes     | Yes     |
 
-## Upgrade v1.0 -> v2.0
+## Upgrade v1.* -> v2.0
 
 ### Filename changes
 The major breaking change to require a bump to v2.0 was the order of the extensions. To avoid priority issues with the format (#14), the version number and the format have been swapped.
@@ -220,6 +220,16 @@ request_parameter | version that is sent in the body of the request | Good for t
 :http_accept_parameter | HTTP Accept header | `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 | takes the request object and must return an integer | lambda {|request| request.headers["HTTP_X_MY_VERSION"].to_i }
 
+If you use the path_parameter strategy with resources routes, you will want to setup your routes.rb config file to capture the api version.  You can do that in a few ways.  If you have just a few api routes you might specify the path directly like this:
+```
+resources :cakes, path: '/api/v:api_version/cakes'
+```
+If you are using a lot of routes it might be better to keep them all inside a scope like this:
+```
+scope '/api/v:api_version' do
+  resources :cakes
+end
+```
 
 #### Default Version
 
@@ -271,6 +281,32 @@ 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``.
 
+### Unsupported Version Requests
+
+If a client requests a version that is no longer supported (is not included in the `config.versioncake.supported_version_numbers`), a `VersionCake::UnsupportedVersionError` will be raised. This can be handled using Rails `rescue_from` to return app specific messages to the client.
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  ...
+
+  rescue_from VersionCake::UnsupportedVersionError, :with => :render_unsupported_version
+
+  private
+
+  def render_unsupported_version
+    headers['X-API-Version-Supported'] = 'false'
+    respond_to do |format|
+      format.json { render json: {message: "You requested an unsupported version (#{requested_version})"}, status: :unprocessable_entity }
+    end
+  end
+
+  ...
+
+end
+
+```
+
 ## How to test
 
 Testing can be painful but here are some easy ways to test different versions of your api using version cake.
@@ -325,12 +361,15 @@ 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
+* [Sevag](https://github.com/sevagf)
 * [Billy](https://github.com/bcatherall)
 * [Jérémie Meyer de Ville](https://github.com/jeremiemv)
 * [Michael Elfassy](https://github.com/elfassy)
 * [Kelley Reynolds](https://github.com/kreynolds)
 * [Washington L Braga Jr](https://github.com/huoxito)
+* [mbradshawabs](https://github.com/mbradshawabs)
+* [Richard Nuno](https://github.com/richardnuno)
+* [Andres Camacho](https://github.com/andresfcamacho)
 
 # Related Material
 

data/gemfiles/rails3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    versioncake (2.0.0)
+    versioncake (2.1.0)
       actionpack (>= 3.2)
       activesupport (>= 3.2)
       railties (>= 3.2)

data/gemfiles/rails4.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    versioncake (2.0.0)
+    versioncake (2.1.0)
       actionpack (>= 3.2)
       activesupport (>= 3.2)
       railties (>= 3.2)

data/gemfiles/rails4.1.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "actionpack", "~> 4.1.0.beta1"
-gem "activesupport", "~> 4.1.0.beta1"
-gem "railties", "~> 4.1.0.beta1"
+gem "actionpack", "~> 4.1.0.rc1"
+gem "activesupport", "~> 4.1.0.rc1"
+gem "railties", "~> 4.1.0.rc1"
 
 gemspec :path=>"../"

data/gemfiles/rails4.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    versioncake (2.0.0)
+    versioncake (2.1.0)
       actionpack (>= 3.2)
       activesupport (>= 3.2)
       railties (>= 3.2)
@@ -10,16 +10,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.1.0.beta1)
-      actionview (= 4.1.0.beta1)
-      activesupport (= 4.1.0.beta1)
+    actionpack (4.1.0.rc1)
+      actionview (= 4.1.0.rc1)
+      activesupport (= 4.1.0.rc1)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.0.beta1)
-      activesupport (= 4.1.0.beta1)
+    actionview (4.1.0.rc1)
+      activesupport (= 4.1.0.rc1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activesupport (4.1.0.beta1)
+    activesupport (4.1.0.rc1)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -36,22 +36,22 @@ GEM
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    docile (1.1.2)
+    docile (1.1.3)
     erubis (2.7.0)
     i18n (0.6.9)
     json (1.8.1)
-    metaclass (0.0.2)
-    mime-types (2.0)
-    minitest (5.2.1)
+    metaclass (0.0.4)
+    mime-types (2.1)
+    minitest (5.2.3)
     mocha (1.0.0)
       metaclass (~> 0.0.1)
     multi_json (1.8.4)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    railties (4.1.0.beta1)
-      actionpack (= 4.1.0.beta1)
-      activesupport (= 4.1.0.beta1)
+    railties (4.1.0.rc1)
+      actionpack (= 4.1.0.rc1)
+      activesupport (= 4.1.0.rc1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.1.1)
@@ -62,13 +62,13 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
     test-unit (2.5.5)
     thor (0.18.1)
     thread_safe (0.1.3)
       atomic
-    tins (0.13.1)
+    tins (1.0.0)
     tzinfo (1.1.0)
       thread_safe (~> 0.1)
 
@@ -76,12 +76,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 4.1.0.beta1)
-  activesupport (~> 4.1.0.beta1)
+  actionpack (~> 4.1.0.rc1)
+  activesupport (~> 4.1.0.rc1)
   appraisal
   coveralls
   mocha
-  railties (~> 4.1.0.beta1)
+  railties (~> 4.1.0.rc1)
   rake
   test-unit
   versioncake!

data/lib/versioncake.rb

@@ -6,6 +6,7 @@ require 'versioncake/strategies/path_parameter_strategy'
 require 'versioncake/strategies/request_parameter_strategy'
 require 'versioncake/strategies/custom_strategy'
 
+require 'versioncake/exceptions'
 require 'versioncake/configuration'
 require 'versioncake/controller_additions'
 require 'versioncake/view_additions'

data/lib/versioncake/controller_additions.rb

@@ -33,8 +33,11 @@ module VersionCake
       versioned_request         = VersionCake::VersionedRequest.new(request, override_version)
       @requested_version        = versioned_request.extracted_version
       @derived_version          = versioned_request.version
+      @is_latest_version        = versioned_request.is_latest_version?
+      if !versioned_request.is_version_supported?
+        raise UnsupportedVersionError.new('Unsupported version error')
+      end
       @_lookup_context.versions = versioned_request.supported_versions
-      @is_latest_version        = versioned_request.is_latest_version
     end
   end
 end

data/lib/versioncake/exceptions.rb

@@ -0,0 +1,6 @@
+require 'action_controller/metal/exceptions'
+
+module VersionCake
+  class UnsupportedVersionError < ::ActionController::RoutingError
+  end
+end

data/lib/versioncake/version.rb

@@ -1,3 +1,3 @@
 module VersionCake
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/versioncake/versioned_request.rb

@@ -1,16 +1,23 @@
 module VersionCake
   class VersionedRequest
-    attr_reader :version, :extracted_version, :is_latest_version
+    attr_reader :version, :extracted_version
 
     def initialize(request, version_override=nil)
-      @version = version_override || extract_version(request)
-      @is_latest_version = @version == config.latest_version
+      derive_version(request, version_override)
     end
 
     def supported_versions
       config.supported_versions(@version)
     end
 
+    def is_latest_version?
+      @version == config.latest_version
+    end
+
+    def is_version_supported?
+      config.supports_version? @version
+    end
+
     private
 
     def config
@@ -26,16 +33,12 @@ module VersionCake
       version
     end
 
-    def extract_version(request)
-      @extracted_version = apply_strategies(request)
-      if @extracted_version.nil?
-        @version = config.default_version || config.latest_version
-      elsif config.supports_version? @extracted_version
-        @version = @extracted_version
-      elsif @extracted_version > config.latest_version
-        raise ActionController::RoutingError.new("No route match for version")
+    def derive_version(request, version_override)
+      if version_override
+        @version = version_override
       else
-        raise ActionController::RoutingError.new("Version is deprecated")
+        @extracted_version = apply_strategies(request)
+        @version = @extracted_version || config.default_version || config.latest_version
       end
     end
   end

data/test/functional/renders_controller_test.rb

@@ -46,13 +46,13 @@ class RendersControllerTest < ActionController::TestCase
   end
 
   test "responds with 404 when the version is larger than the supported version" do
-    assert_raise ActionController::RoutingError do
+    assert_raise VersionCake::UnsupportedVersionError do
       get :index, "api_version" => "4"
     end
   end
 
   test "responds with 404 when the version is lower than the latest version, but not an available version" do
-    assert_raise ActionController::RoutingError do
+    assert_raise VersionCake::UnsupportedVersionError do
       get :index, "api_version" => "0"
     end
   end

data/test/unit/versioned_request_test.rb

@@ -15,23 +15,19 @@ class VersionedRequestTest < ActiveSupport::TestCase
 
   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
+    assert !VersionCake::VersionedRequest.new(stub()).is_version_supported?
   end
 
   test "a request for a deprecated version raises an exception" do
     VersionCake::VersionedRequest.any_instance.stubs(:apply_strategies => 2)
     VersionCake::Configuration.any_instance.stubs(:supports_version? => false)
-    assert_raise ActionController::RoutingError do
-      VersionCake::VersionedRequest.new(stub())
-    end
+    assert !VersionCake::VersionedRequest.new(stub()).is_version_supported?
   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 versioned_request.is_latest_version
+    assert versioned_request.is_latest_version?
   end
 
   test "has a method to retrieve the extracted version" do

data/versioncake.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.authors     = ["Jim Jones", "Ben Willis"]
   s.email       = ["jim.jones1@gmail.com", "benjamin.willis@gmail.com"]
-  s.homepage    = "https://github.com/bwillis/versioncake"
+  s.homepage    = "http://bwillis.github.io/versioncake"
   s.summary     = %q{Easily render versions of your rails views.}
   s.description = %q{Render versioned views automagically based on the clients requested version.}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versioncake
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jim Jones
@@ -9,132 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Render versioned views automagically based on the clients requested version.
@@ -168,6 +168,7 @@ files:
 - lib/versioncake/cli.rb
 - lib/versioncake/configuration.rb
 - lib/versioncake/controller_additions.rb
+- lib/versioncake/exceptions.rb
 - lib/versioncake/railtie.rb
 - lib/versioncake/strategies/custom_strategy.rb
 - lib/versioncake/strategies/extraction_strategy.rb
@@ -218,7 +219,7 @@ files:
 - test/unit/versioned_request_test.rb
 - test/unit/view_additions_test.rb
 - versioncake.gemspec
-homepage: https://github.com/bwillis/versioncake
+homepage: http://bwillis.github.io/versioncake
 licenses:
 - MIT
 metadata: {}
@@ -228,17 +229,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Easily render versions of your rails views.