api-versions 0.0.4 → 0.0.5

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/dummy/log/*

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+
+branches:
+  only:
+    - master
+    - develop
+
+notifications:
+  email:
+    recipients:
+      - api-versions@erichmenge.com

data/Gemfile

@@ -2,3 +2,4 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in api-versions.gemspec
 gemspec
+gem 'rails'

data/README.md

@@ -1,29 +1,30 @@
-API-Versions
-================
+API-Versions [![Build Status](https://secure.travis-ci.org/erichmenge/api-versions.png)](http://travis-ci.org/erichmenge/api-versions)
+======================================================================================================================================
+
 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.4"
-	
+
 In your routes.rb file:
 
 	namespace :api do
 	  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 api_version_check(:version => 1) do
-	     scope :module => :v1 do 
+	     scope :module => :v1 do
 	       cache_resources :as => :v1 do
-	         resources :authorizations, :only => [ :create ]
+	         resources :authorizations
 	       end
 	     end
 	  end
-  
+
 	  constraints api_version_check(:version => 2) do
-	     scope :module => :v2 do 
+	     scope :module => :v2 do
 	       inherit_resources :from => :v1
 	     end
-	  end 
+	  end
 	end
 
 rake routes outputs:
@@ -50,9 +51,9 @@ A more complicated example
 	namespace :api do
 	  default_api_version 	1
 	  api_vendor 		 	"myvendor"
-  
+
 	  constraints api_version_check(:version => 1) do
-	     scope :module => :v1 do 
+	     scope :module => :v1 do
 	       cache_resources :as => :v1 do
 	        resources :authorizations, :only => [ :create ]
 	        resources :foo
@@ -60,24 +61,24 @@ A more complicated example
 	      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 api_version_check(:version => 2) do
-	     scope :module => :v2 do 
-	       cache_resources :as => :v2 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 api_version_check(:version => 3) do
-	     scope :module => :v3 do 
+	     scope :module => :v3 do
 	        inherit_resources :from => :v2
 	     end
 	  end

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+task :default => :spec

data/api-versions.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "rspec-rails"
 end

data/lib/api-versions.rb

@@ -1,42 +1,35 @@
 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)
     [*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)
     ApiVersions::ApiVersionCheck.api_version = version
   end
   alias_method :default_api_version, :api_version=
-  
-  
+
+
   def 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 = {})
@@ -46,11 +39,11 @@ module ApiVersions
     def matches?(request)
       accepts_proper_format?(request) && (matches_version?(request) || unversioned?(request))
     end
-    
+
     private
 
     def accepts_proper_format?(request)
-      !!(request.headers['Accept'] =~ /^application\/vnd\.#{self.class.api_vendor}\+json/)
+      !!(request.headers['Accept'] =~ /^application\/vnd\.#{self.class.api_vendor}\+.+/)
     end
 
     def matches_version?(request)
@@ -60,6 +53,7 @@ module ApiVersions
     def unversioned?(request)
         @process_version == self.class.api_version && !(request.headers['Accept'] =~ /version\s*?=\s*?\d*\b/i)
     end
-    
   end
 end
+
+ActionDispatch::Routing::Mapper.send :include, ApiVersions

data/lib/api-versions/version.rb

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

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy/app/controllers/api/v1/bar_controller.rb

@@ -0,0 +1,2 @@
+class Api::V1::BarController < ApplicationController
+end

data/spec/dummy/app/controllers/api/v2/bar_controller.rb

@@ -0,0 +1,5 @@
+class Api::V2::BarController < ApplicationController
+  def new
+
+  end
+end

data/spec/dummy/app/controllers/api/v2/foo_controller.rb

@@ -0,0 +1,2 @@
+class Api::V2::FooController < ApplicationController
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,54 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "action_controller/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require
+require "api-versions"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/routes.rb

@@ -0,0 +1,25 @@
+Dummy::Application.routes.draw do
+  namespace :api do
+    default_api_version   1
+    api_vendor            "myvendor"
+
+    constraints api_version_check(:version => 1) do
+       scope :module => :v1 do
+         cache_resources :as => :v1 do
+          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 api_version_check(:version => 2) do
+       scope :module => :v2 do
+         cache_resources :as => :v2 do
+           resources :foo
+           inherit_resources :from => :v1
+        end
+       end
+    end
+  end
+end

data/spec/routing/routing_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe 'API Routing' do
+  def merge_and_stub(path, method, hash)
+    env_hash = Rack::MockRequest.env_for(path, method: method).merge(hash)
+    Rack::MockRequest.stub(:env_for).and_return env_hash
+  end
+
+  describe "V1" do
+    context "when no header is set" do
+      it "doesn't route" do
+        expect(get: new_api_bar_path).to_not be_routable
+      end
+    end
+
+    context "when the header is set incorrectly" do
+      it "doesn't route" do
+        merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.mybadvendor+json;version=1'
+        expect(get: '/api/bar/new').to_not be_routable
+      end
+    end
+
+    context "when it is set correctly" do
+      it "should not route something from V2" do
+        merge_and_stub new_api_foo_path, 'get', 'Accept' => 'application/vnd.myvendor+json;version=1'
+        expect(get: new_api_foo_path).to_not be_routable
+      end
+
+      it "should route" do
+        merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+json;version=1'
+        expect(get: new_api_bar_path).to route_to(controller: 'api/v1/bar', action: 'new')
+      end
+
+      it "should default" do
+        merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+json'
+        expect(get: new_api_bar_path).to route_to(controller: 'api/v1/bar', action: 'new')
+      end
+
+      it "should default with nothing after the semi-colon" do
+        merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+json; '
+        expect(get: new_api_bar_path).to route_to(controller: 'api/v1/bar', action: 'new')
+      end
+    end
+  end
+
+  describe "V2" do
+    it "should copy bar" do
+      merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+json;version=2'
+      expect(get: new_api_bar_path).to route_to(controller: 'api/v2/bar', action: 'new')
+    end
+
+    it "should add foo" do
+      merge_and_stub new_api_foo_path, 'get', 'Accept' => 'application/vnd.myvendor+json;version=2'
+      expect(get: new_api_foo_path).to route_to(controller: 'api/v2/foo', action: 'new')
+    end
+
+    it "should not default" do
+      merge_and_stub new_api_foo_path, 'get', 'Accept' => 'application/vnd.myvendor+json'
+      expect(get: new_api_foo_path).to_not be_routable
+    end
+
+    it "should default" do
+      original_version = ApiVersions::ApiVersionCheck.api_version
+      ApiVersions::ApiVersionCheck.api_version = 2
+      merge_and_stub new_api_foo_path, 'get', 'Accept' => 'application/vnd.myvendor+json'
+      expect(get: new_api_foo_path).to route_to(controller: 'api/v2/foo', action: 'new')
+      ApiVersions::ApiVersionCheck.api_version = original_version
+    end
+  end
+
+  describe "Header syntax" do
+    after(:each) do
+      expect(get: new_api_bar_path).to route_to(controller: 'api/v1/bar', action: 'new')
+    end
+
+    it "should allow spaces after the semi-colon" do
+      merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+json;   version=1'
+    end
+
+    it "should allow other formats besides json" do
+      merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+xml; version=1'
+    end
+
+    it "should allow spacing around the equal sign" do
+      merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+json; version = 1'
+    end
+
+    it "should allow spacing around the plus" do
+      merge_and_stub new_api_bar_path, 'get', 'Accept' => 'application/vnd.myvendor+xml; version=1'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-versions
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000 Z
-dependencies: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Useful for API versioning.
 email:
 - erich.menge@me.com
@@ -19,12 +35,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
 - api-versions.gemspec
 - lib/api-versions.rb
 - lib/api-versions/version.rb
+- spec/dummy/.rspec
+- spec/dummy/app/controllers/api/v1/bar_controller.rb
+- spec/dummy/app/controllers/api/v2/bar_controller.rb
+- spec/dummy/app/controllers/api/v2/foo_controller.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/log/.gitkeep
+- spec/routing/routing_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/erichmenge/api-versions
 licenses: []
 post_install_message: 
@@ -45,8 +76,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: api-versions
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Allows you to cache routing and then inherit it in other modules.
-test_files: []
+test_files:
+- spec/dummy/.rspec
+- spec/dummy/app/controllers/api/v1/bar_controller.rb
+- spec/dummy/app/controllers/api/v2/bar_controller.rb
+- spec/dummy/app/controllers/api/v2/foo_controller.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/log/.gitkeep
+- spec/routing/routing_spec.rb
+- spec/spec_helper.rb