api-versions 0.0.1 → 0.0.3

data/README.md

@@ -1,9 +1,13 @@
 API-Versions
 ================
-If you have multiple versions of an API, it is not very DRY to include the same resources over and over again.  Instead, in your routes.rb file:
+If you have multiple versions of an API, it is not very DRY to include the same resources over and over again.
+In your Gemfile:
+
+	gem "api-versions", "~> 0.0.2"
+	
+In your routes.rb file:
 
 	include ApiVersions
-	has_common_resources
 
 Further down...
 
@@ -26,8 +30,44 @@ Further down...
 	  end 
 	end
 
-In your Gemfile
-	gem 'api-versions'
+A more complicated example
+--------------------------
+	namespace :api do
+	  self.api_version = 1
+	  self.vendor = "bulletin"
+  
+	  constraints ApiVersionCheck.new(:version => 1) do
+	     scope :module => :v1 do 
+	       cache_resources :as => :v1 do
+	        resources :authorizations, :only => [ :create ]
+	        resources :foo
+	        resources :bar
+	      end
+	     end
+	  end
+  
+	# 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
+	     scope :module => :v2 do 
+	       cache_resources :as => :v2 do 
+	         resources :my_new_resource
+	         inherit_resources :from => :v1
+	      end
+	     end
+	  end
+  
+	# Version 3 of the API has everything in API Version 2, and by
+	# virtue of API Version 2 having everything in Version 1, Version 3
+	# also has everything in Version 1.
+	
+	  constraints ApiVersionCheck.new(:version => 3) do
+	     scope :module => :v3 do 
+	        inherit_resources :from => :v2
+	     end
+	  end
+
+	end
 
 License
 =======

data/lib/api-versions.rb

@@ -1,8 +1,17 @@
 require "api-versions/version"
 
 module ApiVersions
-  def has_common_resources
-    include InstanceMethods
+
+  def inherit_resources(args)
+    [*args[:from]].each do |block|
+      @resource_cache[block].call
+    end
+  end
+    
+  def cache_resources(args, &block)
+    @resource_cache ||= {}
+    @resource_cache.merge!(args[:as] => block)
+    block.call
   end
   
   def api_version=(version)
@@ -13,22 +22,10 @@ module ApiVersions
     @@vendor = vendor
   end
   
-  module InstanceMethods
-    def inherit_resources(args)
-      @resource_cache[args[:from]].call
-    end
-    
-    def cache_resources(args, &block)
-      @resource_cache ||= {}
-      @resource_cache.merge!(args[:as] => block)
-      block.call
-    end
-  end
-  
   class ApiVersionCheck
 
     def initialize(args = {})
-      @version = args[:version]
+      @process_version = args[:version]
     end
 
     def matches?(request)
@@ -42,11 +39,11 @@ module ApiVersions
     end
 
     def matches_version?(request)
-      !!(request.headers['Accept'] =~ /version\s*?=\s*?#{@version}\b/)
+      !!(request.headers['Accept'] =~ /version\s*?=\s*?#{@process_version}\b/)
     end
 
     def unversioned?(request)
-        @version == @@version && !(request.headers['Accept'] =~ /version\s*?=\s*?\d*\b/i)
+        @process_version == @@version && !(request.headers['Accept'] =~ /version\s*?=\s*?\d*\b/i)
     end
     
   end

data/lib/api-versions/version.rb

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

metadata

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