versioncake 2.2.0 → 2.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTZjMGMyZDYzMThlZTljNzJlYjliY2FkMmYwZGRhOWYyMTc5YjZjNw==
+    YTY4ZDYxNWY2ZDdjMjEwMjQyZDYwZDQ1ZTM2MmYyMzZkZTQzYjE1NA==
   data.tar.gz: !binary |-
-    MWVhM2IzMGVlODFhYWFhOTkyNTc2MTYzMzMzMTlmNTExODM4YjAxMQ==
+    MjcxYTE4N2NjMmQxMjU3NTIwNDA2ZDQzNTcyMWQ2YzU0ZTA5ODBhZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YTg2MjZkMWI1ODkxMzM1MjJlZWExMDNjZGQyZjYwZjc3N2MwODkzNjM4OGZj
-    NGQxMDY2ZWZiZGZiOWI3MTBiOGE1YzdhZTExOGJmMTIzYjczYjk4ZTNjMTU2
-    NDM2MDMwOTVjMmIzMDBhNmM0YzQxN2JlOTJiZWYyYjQzOGM5NzA=
+    YjA2ZDU2MDEzMjk3NzBhODNmZDhlNTY1ZDI1Y2I5OWQ2OWE4OTM1ODBhNjg0
+    ZDUzYTI5MmNhYTNiODg1M2IxNTY3MzFmNDNjNjFhZWQyZTM1MjI5NzUyZGUx
+    NGNmZWExN2QzOTgzMGM2MzZkMzA5NDBiN2M0ZTI2MjUzOTkyYTU=
   data.tar.gz: !binary |-
-    OTJhNDY0ZDM1MGFlNDI5NDZjN2MyNGNmMGI1NDcwYTc3MzVmNjgwNjJmMGQy
-    NjFmOTg5NzI5ODkwYjY1ODczYzkwODI2NjBhODQyZDY3NTNjNDRjMTZhZjky
-    MjQ2MjEyNjkwODMzZGQ1OGZkZTVlMmYzNWFjZTMxNmI4ZGU5MmI=
+    NDljNjI2NDk3ZjY2YTI3NGZlMTFiY2IxNmYxNTU0YjdkMTVlOTFhZjY5ZmM1
+    N2M5ODM4MmM3YjAzMDM3OGY0YWNmMDk4YzdiNTk2MDExZmEwMDk1MDgxMjgy
+    NzI2OTFiYzA3YTc0NTZmZjVhNTExN2NmN2U4YmYwZWJjYzA4ZDM=

data/CHANGELOG.md

@@ -1,13 +1,39 @@
 ## Unreleased Changes
 
-[Full Changelog](https://github.com/bwillis/versioncake/compare/v2.1...master)
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v2.3...master)
 
 Bug Fixes:
 
+* None
+
+Enhancements:
+
+* None
+
+Deprecations:
+
+* None
+
+## 2.3.0 (Mar 6, 2014)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v2.2...v2.3)
+
 Enhancements:
 
+* Allow an object instance to be used as a custom strategy
+
+## 2.2.0 (Mar 5, 2014)
+
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v2.1...v2.2)
+
+Bug Fixes:
+
+* Be defensive with the return value of a custom strategy (#27)
+
 ## 2.1.0 (Mar 3, 2014)
 
+[Full Changelog](https://github.com/bwillis/versioncake/compare/v2.0...v2.1)
+
 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)
@@ -40,20 +66,12 @@ Bug Fixes:
 
 [Full Changelog](https://github.com/bwillis/versioncake/compare/v1.1...v1.2)
 
-Bug Fixes:
-
-* None
-
 Enhancements:
 
 * Support Rails 4
 * Adding Rails version testing with [Appraisals](https://github.com/thoughtbot/appraisal)
 * Added contribution guide
 
-Deprecations:
-
-* None
-
 ## 1.1.0 (May 18, 2013)
 
 [Full Changelog](https://github.com/bwillis/versioncake/compare/v1.0...v1.1)
@@ -69,10 +87,6 @@ Enhancements:
 * 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)

data/Gemfile.lock

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

data/README.md

@@ -8,7 +8,7 @@
 
 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. 
+Version Cake is an unobtrusive way to version APIs in your Rails app.
 
 - Easily version any view with their API version:
 
@@ -39,7 +39,7 @@ gem install versioncake
 | [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     |
+| [>2.0](CHANGELOG.md#200-feb-6-2014)     | Yes       | Yes     | Yes     |
 
 ## Upgrade v1.* -> v2.0
 
@@ -74,7 +74,7 @@ config.versioncake.extraction_strategy       = :query_parameter # for simplicity
 ```
 
 Often times with APIs, depending upon the version, different logic needs to be applied. With the following controller code, the initial value of @posts includes all Post entries.
-But if the requested API version is three or greater, we're going to eagerly load the associated comments as well.  
+But if the requested API version is three or greater, we're going to eagerly load the associated comments as well.
 
 Being able to control the logic based on the api version allow you to ensure forwards and backwards compatibility for future changes.
 
@@ -119,7 +119,7 @@ end
 
 When a version is specified for which a view doesn't exist, the request degrades and renders the next lowest version number to ensure the API's backwards compatibility.  In the following case, since views/posts/index.json.v3.jbuilder doesn't exist, views/posts/index.json.v1.jbuilder is rendered instead.
 
-#### http://localhost:3000/posts.json?api_version=3 
+#### http://localhost:3000/posts.json?api_version=3
 ```javascript
 [
   {
@@ -140,7 +140,7 @@ When a version is specified for which a view doesn't exist, the request degrades
 
 For a given request, if we specify the version number, and that version of the view exists, that version specific view version will be rendered.  In the below case, views/posts/index.json.v1.jbuilder is rendered.
 
-#### http://localhost:3000/posts.json?api_version=2 or http://localhost:3000/posts.json?api_version=1 
+#### http://localhost:3000/posts.json?api_version=2 or http://localhost:3000/posts.json?api_version=1
 ```javascript
 [
   {
@@ -214,11 +214,11 @@ These are the available strategies:
 Strategy | Description | Example
 --- | --- | ---
 :query_parameter | version in the url query parameter, for testing or to override for special case | `http://localhost:3000/posts.json?api_version=1`  (This is the default.)
-:path_parameter | version in the url path parameter | `api/v:api_version/` 
+:path_parameter | version in the url path parameter | `api/v:api_version/`
 request_parameter | version that is sent in the body of the request | Good for testing.
 :http_header | Api version HTTP header | `X-API-Version: 1`
 :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 }
+custom | takes the request object and must return an integer | lambda {|request| request.headers["HTTP_X_MY_VERSION"].to_i } or class ExtractorStrategy; def execute(request);end;end
 
 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:
 ```
@@ -346,7 +346,7 @@ AppName::Application.config.versioncake.supported_version_numbers.each do |suppo
   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.html.v1.erb"

data/gemfiles/rails3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    versioncake (2.2.0)
+    versioncake (2.3.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.2.0)
+    versioncake (2.3.0)
       actionpack (>= 3.2)
       activesupport (>= 3.2)
       railties (>= 3.2)

data/gemfiles/rails4.1.gemfile.lock

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

data/lib/versioncake/strategies/extraction_strategy.rb

@@ -23,22 +23,31 @@ module VersionCake
     end
 
     def self.lookup(strategy)
-      if strategy.class == Proc
-        if strategy.arity == 1
-          VersionCake::CustomStrategy.new(strategy)
+      case strategy
+        when String, Symbol
+          strategy_name = "#{strategy}_strategy".camelize
+          begin
+            VersionCake.const_get(strategy_name).new
+          rescue
+            raise Exception, "Unknown VersionCake extraction strategy #{strategy_name}"
+          end
+        when Proc
+          if strategy.arity == 1
+            VersionCake::CustomStrategy.new(strategy)
+          else
+            raise Exception, "Custom proc extraction strategy requires a single parameter"
+          end
+        when Object
+          if !strategy.methods.include?(:execute)
+            raise Exception, "Custom extraction strategy requires an execute method"
+          elsif strategy.method(:execute).arity != 1
+            raise Exception, "Custom extraction strategy requires an execute method with a single parameter"
+          else
+            strategy
+          end
         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
+          raise Exception, "Invalid extration strategy"
       end
-
     end
-
   end
-end
+end

data/lib/versioncake/version.rb

@@ -1,3 +1,3 @@
 module VersionCake
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/test/unit/strategies/extraction_strategy_test.rb

@@ -38,6 +38,15 @@ class ExtractionStrategyTest < ActiveSupport::TestCase
     assert_equal VersionCake::CustomStrategy, strategy.class
   end
 
+  test "it allows a custom class" do
+    class FakeStrategy
+      def execute(request); end
+    end
+    instance = FakeStrategy.new
+    strategy = VersionCake::ExtractionStrategy.lookup(instance)
+    assert_equal instance, strategy
+  end
+
   test "it fails to create a custom strategy for a proc with no parameters" do
     assert_raise(Exception) do
       VersionCake::ExtractionStrategy.lookup(lambda{})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versioncake
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Jim Jones
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack