api-versions 0.0.3 → 0.0.4

data/README.md

@@ -1,21 +1,17 @@
 API-Versions
 ================
-If you have multiple versions of an API, it is not very DRY to include the same resources over and over again.
+If you have multiple versions of an API in your Rails app, it is not very DRY to include the same resources over and over again.
 In your Gemfile:
 
-	gem "api-versions", "~> 0.0.2"
+	gem "api-versions", "~> 0.0.4"
 	
 In your routes.rb file:
 
-	include ApiVersions
-
-Further down...
-
 	namespace :api do
-	  self.api_version = 1 # If no API version is specified in the Accept header, this is what will be used.
-	  self.vendor = "myvendor" # For HTTP Accept Header application/vnd.myvendor+json;version=1
+	  default_api_version 	1   			 # If no API version is specified in the Accept header, this is what will be used.
+	  api_vendor 			"myvendor"   	 # For HTTP Accept Header application/vnd.myvendor+json;version=1
   
-	  constraints ApiVersionCheck.new(:version => 1) do
+	   constraints api_version_check(:version => 1) do
 	     scope :module => :v1 do 
 	       cache_resources :as => :v1 do
 	         resources :authorizations, :only => [ :create ]
@@ -23,20 +19,39 @@ Further down...
 	     end
 	  end
   
-	  constraints ApiVersionCheck.new(:version => 2) do
+	  constraints api_version_check(:version => 2) do
 	     scope :module => :v2 do 
 	       inherit_resources :from => :v1
 	     end
 	  end 
 	end
 
+rake routes outputs:
+
+	    api_authorizations GET    /api/authorizations(.:format)          api/v1/authorizations#index
+	                       POST   /api/authorizations(.:format)          api/v1/authorizations#create
+	 new_api_authorization GET    /api/authorizations/new(.:format)      api/v1/authorizations#new
+	edit_api_authorization GET    /api/authorizations/:id/edit(.:format) api/v1/authorizations#edit
+	     api_authorization GET    /api/authorizations/:id(.:format)      api/v1/authorizations#show
+	                       PUT    /api/authorizations/:id(.:format)      api/v1/authorizations#update
+	                       DELETE /api/authorizations/:id(.:format)      api/v1/authorizations#destroy
+	                       GET    /api/authorizations(.:format)          api/v2/authorizations#index
+	                       POST   /api/authorizations(.:format)          api/v2/authorizations#create
+	                       GET    /api/authorizations/new(.:format)      api/v2/authorizations#new
+	                       GET    /api/authorizations/:id/edit(.:format) api/v2/authorizations#edit
+	                       GET    /api/authorizations/:id(.:format)      api/v2/authorizations#show
+	                       PUT    /api/authorizations/:id(.:format)      api/v2/authorizations#update
+	                       DELETE /api/authorizations/:id(.:format)      api/v2/authorizations#destroy
+
+Then the client simply sets the Accept header "application/vnd.myvendor+json;version=1". If no version is specified, the default version you set will be assumed.  You'll of course still need to copy all of your controllers over, even if they haven't changed from version to version.  At least you'll remove a bit of the mess in your routes file.
+
 A more complicated example
 --------------------------
 	namespace :api do
-	  self.api_version = 1
-	  self.vendor = "bulletin"
+	  default_api_version 	1
+	  api_vendor 		 	"myvendor"
   
-	  constraints ApiVersionCheck.new(:version => 1) do
+	  constraints api_version_check(:version => 1) do
 	     scope :module => :v1 do 
 	       cache_resources :as => :v1 do
 	        resources :authorizations, :only => [ :create ]
@@ -48,7 +63,7 @@ A more complicated example
   
 	# Version 2 of the API has everything in Version 1, plus my_new_resource
 	# Version 2 will cache this entire package of resources
-	  constraints ApiVersionCheck.new(:version => 2) do
+	  constraints api_version_check(:version => 2) do
 	     scope :module => :v2 do 
 	       cache_resources :as => :v2 do 
 	         resources :my_new_resource
@@ -61,7 +76,7 @@ A more complicated example
 	# virtue of API Version 2 having everything in Version 1, Version 3
 	# also has everything in Version 1.
 	
-	  constraints ApiVersionCheck.new(:version => 3) do
+	  constraints api_version_check(:version => 3) do
 	     scope :module => :v3 do 
 	        inherit_resources :from => :v2
 	     end

data/lib/api-versions/version.rb

@@ -1,5 +1,5 @@
 module Api
   module Versions
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/api-versions.rb

@@ -1,5 +1,11 @@
 require "api-versions/version"
 
+class Engine < Rails::Engine
+  initializer "api_versions" do
+    config.to_prepare { ActionDispatch::Routing::Mapper.send :include, ApiVersions }
+  end
+end
+
 module ApiVersions
 
   def inherit_resources(args)
@@ -15,14 +21,23 @@ module ApiVersions
   end
   
   def api_version=(version)
-    @@version = version
+    ApiVersions::ApiVersionCheck.api_version = version
   end
+  alias_method :default_api_version, :api_version=
+  
   
   def vendor=(vendor)
-    @@vendor = vendor
+    ApiVersions::ApiVersionCheck.api_vendor = vendor
+  end
+  alias_method :api_vendor, :vendor=
+  
+  def api_version_check(*args)
+    ApiVersions::ApiVersionCheck.new(*args)
   end
   
   class ApiVersionCheck
+    
+    cattr_accessor :api_version, :api_vendor
 
     def initialize(args = {})
       @process_version = args[:version]
@@ -35,7 +50,7 @@ module ApiVersions
     private
 
     def accepts_proper_format?(request)
-      !!(request.headers['Accept'] =~ /^application\/vnd\.#{@@vendor}\+json/)
+      !!(request.headers['Accept'] =~ /^application\/vnd\.#{self.class.api_vendor}\+json/)
     end
 
     def matches_version?(request)
@@ -43,7 +58,7 @@ module ApiVersions
     end
 
     def unversioned?(request)
-        @process_version == @@version && !(request.headers['Accept'] =~ /version\s*?=\s*?\d*\b/i)
+        @process_version == self.class.api_version && !(request.headers['Accept'] =~ /version\s*?=\s*?\d*\b/i)
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-versions
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies: []
 description: Useful for API versioning.
 email: