api-versions 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daa8e2061260c0cf2b7f4d58d95d9f321ba5796b
-  data.tar.gz: 1de22bfc799fb807ee1e8af14d47ef8707c59a4a
+  metadata.gz: 76c06f9b24fbbbce7345e61b4cce9a66f955f32a
+  data.tar.gz: d596f61158abb67ba28f5b7200a8f774416bb33d
 SHA512:
-  metadata.gz: 3e5a9e281b081b71b0caad6c1b71acac5a00ca01040337182e00a3ee68eedf39de6ccb1caecc3b69632772e69f916116c53894995270769de2471f1c5aacf817
-  data.tar.gz: 562696e06899eadf515615ae257357cd3610125559236f9876c1de48824bb85ce026560f5565b4b5492e67c2d1e7ff0f54596197b7ffaa3daf1cd25e957194f5
+  metadata.gz: 9243f84c3b74cae3311a3cfd01a6cd63f8d28cf5f2df870aa6c9afd915858cef2bc91d26f1fe79ef1d914cee6a2ddbdfa464a36d4e095f60faa83aecc65e0eac
+  data.tar.gz: 293cb32aaaa8b3b2953c38235778307a88e452ff512fe845ecc05a9270db3e18a9deabd794520bb2bff48f6c47229347ee788f759058a306d4167032a664d3ad

data/Changes.md

@@ -1,3 +1,8 @@
-## 1.1
+## 1.2.0
+
+* Pass `#api` options to Rails namespace          [#1, David Celis]
+* Fix issue with middleware and nil accept header [#2, rposborne]
+
+## 1.1.0
 
 * Use middleware to simplify the MIME type instead of doing it at the controller.

data/README.md

@@ -1,4 +1,7 @@
-# api-versions [![Build Status](https://travis-ci.org/erichmenge/api-versions.png?branch=master)](https://travis-ci.org/erichmenge/api-versions) #
+# api-versions
+
+[![Build Status](https://travis-ci.org/erichmenge/api-versions.png?branch=master)](https://travis-ci.org/erichmenge/api-versions)
+[![Gem Version](https://badge.fury.io/rb/api-versions.png)](http://badge.fury.io/rb/api-versions)
 
 
 ### Requirements
@@ -178,3 +181,28 @@ end
 
 So instead of copying your prior version controllers over to the new ones and duplicating all the code in them, you can redefine specific methods,
 or start from scratch by removing the inheritance.
+
+## Passing Rails Routing options
+The api-versions routing DSL will pass any options that are regularly accepted by Rails' own routing DSL. For example, if you are using an api subdomain and don't need your paths prefixed with `/api`, you can override it as you normally would:
+
+```ruby
+api vendor_string: 'myvendor', default_version: 1, path: '' do
+  version 1 do
+    cache as: 'v1' do
+      resources :foo
+    end
+  end
+end
+```
+
+Then a `rake routes` would show your desires fulfilled:
+
+```
+                              GET    /foo(.:format)                      api/v1/foo#index
+                              POST   /foo(.:format)                      api/v1/foo#create
+                              GET    /foo/new(.:format)                  api/v1/foo#new
+                              GET    /foo/:id/edit(.:format)             api/v1/foo#edit
+                              GET    /foo/:id(.:format)                  api/v1/foo#show
+                              PUT    /foo/:id(.:format)                  api/v2/foo#update
+                              DELETE /foo/:id(.:format)                  api/v2/foo#destroy
+```

data/lib/api-versions.rb

@@ -11,7 +11,7 @@ module ApiVersions
     VersionCheck.default_version = options[:default_version]
     VersionCheck.vendor_string   = options[:vendor_string]
 
-    namespace(:api) { DSL.new(self, &block) }
+    namespace(:api, options) { DSL.new(self, &block) }
   end
 end
 

data/lib/api-versions/middleware.rb

@@ -5,6 +5,8 @@ module ApiVersions
     end
 
     def call(env)
+      return @app.call(env) unless env['HTTP_ACCEPT']
+
       accepts = env['HTTP_ACCEPT'].split(',')
       offset = 0
       accepts.dup.each_with_index do |accept, i|

data/lib/api-versions/version.rb

@@ -1,3 +1,8 @@
 module ApiVersions
-  VERSION = "1.1.0"
+  MAJOR = 1
+  MINOR = 2
+  PATCH = 0
+  PRE   = nil
+
+  VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join '.'
 end

data/spec/dummy/config/routes.rb

@@ -18,7 +18,13 @@ Dummy::Application.routes.draw do
     end
   end
 
-  get '*a' => 'errors#not_found'
+  api vendor_string: 'myvendor', path: '' do
+    version 1 do
+      cache as: 'v1' do
+        resources :baz
+      end
+    end
+  end
 
-  get 'index' => 'simplified_format#index'
+  get '*a' => 'errors#not_found'
 end

data/spec/middleware_spec.rb

@@ -2,23 +2,38 @@ require 'spec_helper'
 require 'rack/test'
 
 describe ApiVersions::Middleware do
-  let(:app) { ->(env) { [200, { "Content-Type" => "text/plain"}, [env["HTTP_ACCEPT"]]] } }
+  let(:app) { ->(env) { [200, { "Content-Type" => "text/plain" }, [env["HTTP_ACCEPT"]]] } }
 
-  before do
+  around do |example|
+    original = ApiVersions::VersionCheck.vendor_string
     ApiVersions::VersionCheck.vendor_string = "myvendor"
+    example.run
+    ApiVersions::VersionCheck.vendor_string = original
   end
 
   describe "the accept header" do
     it "should not adjust the header" do
       request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "application/vnd.foobar+json;version=1", lint: true, fatal: true)
-      _, _, response = described_class.new(app).call(request)
+      response = described_class.new(app).call(request).last
       response.first.should == "application/vnd.foobar+json;version=1"
     end
 
     it "should adjust the header" do
       request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "text/plain,application/vnd.myvendor+json;version=1,text/html,application/vnd.myvendor+xml", lint: true, fatal: true)
-      _, _, response = described_class.new(app).call(request)
+      response = described_class.new(app).call(request).last
       response.last.should == "text/plain,application/json,application/vnd.myvendor+json;version=1,text/html,application/xml,application/vnd.myvendor+xml"
     end
+
+    it "should tolerate a nil Accept header" do
+      request = Rack::MockRequest.env_for("/", lint: true, fatal: true)
+      response = described_class.new(app).call(request).last
+      response.last.should_not be
+    end
+
+    it "should tolerate an empty Accept header" do
+      request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => '', lint: true, fatal: true)
+      response = described_class.new(app).call(request).last
+      response.last.should == ""
+    end
   end
 end

data/spec/routing_spec.rb

@@ -119,4 +119,10 @@ describe 'API Routing' do
       response.status.should == 404
     end
   end
+
+  describe 'paths' do
+    it "should pass options, such as :path, to the regular routing DSL" do
+      new_api_baz_path.should == '/baz/new'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-versions
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Erich Menge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: api-versions
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: api-versions helps manage your Rails app API endpoints.
@@ -154,4 +154,3 @@ test_files:
 - spec/middleware_spec.rb
 - spec/routing_spec.rb
 - spec/spec_helper.rb
-has_rdoc: