api-versions 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76c06f9b24fbbbce7345e61b4cce9a66f955f32a
-  data.tar.gz: d596f61158abb67ba28f5b7200a8f774416bb33d
+  metadata.gz: 8edd7dd575a06946e485d061aa3453b0d122e25a
+  data.tar.gz: cedef947d6ff68d8cbf2f8a33a0b3422a3ca3c1b
 SHA512:
-  metadata.gz: 9243f84c3b74cae3311a3cfd01a6cd63f8d28cf5f2df870aa6c9afd915858cef2bc91d26f1fe79ef1d914cee6a2ddbdfa464a36d4e095f60faa83aecc65e0eac
-  data.tar.gz: 293cb32aaaa8b3b2953c38235778307a88e452ff512fe845ecc05a9270db3e18a9deabd794520bb2bff48f6c47229347ee788f759058a306d4167032a664d3ad
+  metadata.gz: ad2e9a388fe6741320e6b626a1078a6eccdb28dcb97f249ae2ed5e734b843c9cbf3752300bc37e0275364fc4c6e42bb2bc4c314e24c3cd8bb7cbced4631284e8
+  data.tar.gz: f62e2d9c1d466d8207e0d1b5229e6c24e41b648df498f9bd560de84a8d9c57b199a8d31ea0a3ec3fb5ff9c807b979aa08e1a3999e68c233ccf1ff7d5ce93c5d1

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 spec/dummy/log/*
 log/*
 tmp/*
+coverage/*

data/.travis.yml

@@ -8,11 +8,13 @@ notifications:
   email:
     recipients:
       - api-versions@erich.erichmenge.com
+      - me@davidcel.is
 env:
   - RAILS_VERSION=3-0-stable
   - RAILS_VERSION=3-1-stable
   - RAILS_VERSION=3-2-stable
   - RAILS_VERSION=4-0-stable
+  - RAILS_VERSION=4.0.0
   - RAILS_VERSION=master
 
 matrix:

data/README.md

@@ -1,8 +1,9 @@
 # api-versions
 
-[![Build Status](https://travis-ci.org/erichmenge/api-versions.png?branch=master)](https://travis-ci.org/erichmenge/api-versions)
+[![Build Status](https://travis-ci.org/EDMC/api-versions.png?branch=master)](https://travis-ci.org/EDMC/api-versions)
 [![Gem Version](https://badge.fury.io/rb/api-versions.png)](http://badge.fury.io/rb/api-versions)
-
+[![Coverage Status](https://coveralls.io/repos/erichmenge/api-versions/badge.png)](https://coveralls.io/r/erichmenge/api-versions)
+[![Code Climate](https://codeclimate.com/github/erichmenge/api-versions.png)](https://codeclimate.com/github/erichmenge/api-versions)
 
 ### Requirements
 * Rails 4 or Rails 3
@@ -206,3 +207,39 @@ Then a `rake routes` would show your desires fulfilled:
                               PUT    /foo/:id(.:format)                  api/v2/foo#update
                               DELETE /foo/:id(.:format)                  api/v2/foo#destroy
 ```
+
+## Testing
+Because controller tests will not go through the routing constraints, you will get routing errors when testing API
+controllers.
+
+To avoid this problem you can use request/integration tests which will hit the routing constraints.
+
+To do this in RSpec, you should only need to move your spec files from `spec/controllers.` to `spec/requests/`:
+
+```ruby
+# spec/requests/api/v1/widgets_controller_spec.rb
+require 'spec_helper'
+
+describe Api::V1::WidgetsController do
+  describe "GET 'index'" do
+    it "should be successful" do
+      get '/api/widgets', {}, 'HTTP_ACCEPT' => 'application/vnd.myvendor+json; version=1'
+      response.should be_success
+    end
+  end
+end
+```
+
+For Test::Unit, inherit from ActionDispatch::IntegrationTest:
+
+```ruby
+# test/integration/api/v1/widgets_controller_test.rb
+require 'test_helper'
+
+class Api::V1::WidgetsControllerTest < ActionDispatch::IntegrationTest
+  test "GET 'index'" do
+    get '/api/widgets', {}, 'HTTP_ACCEPT' => 'application/vnd.myvendor+json; version=1'
+    assert_response 200
+  end
+end
+```

data/api-versions.gemspec

@@ -5,14 +5,12 @@ require "api-versions/version"
 Gem::Specification.new do |s|
   s.name        = "api-versions"
   s.version     = ApiVersions::VERSION
-  s.authors     = ["Erich Menge"]
-  s.email       = ["erich.menge@me.com"]
-  s.homepage    = "https://github.com/erichmenge/api-versions"
+  s.authors     = ["Erich Menge", "David Celis"]
+  s.email       = ["erich.menge@me.com", "me@davidcel.is"]
+  s.homepage    = "https://github.com/EDMC/api-versions"
   s.summary     = "api-versions helps manage your Rails app API endpoints."
   s.description = "api-versions helps manage your Rails app API endpoints."
 
-  s.rubyforge_project = "api-versions"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -25,4 +23,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec-rails", "~> 2.0"
   s.add_development_dependency 'ammeter',  '0.2.5'
+  s.add_development_dependency "coveralls"
 end

data/lib/api-versions/middleware.rb

@@ -5,9 +5,9 @@ module ApiVersions
     end
 
     def call(env)
-      return @app.call(env) unless env['HTTP_ACCEPT']
-
-      accepts = env['HTTP_ACCEPT'].split(',')
+      accept_string = env['HTTP_ACCEPT'] || ""
+      accepts = accept_string.split(',')
+      accepts.push("application/vnd.#{ApiVersions::VersionCheck.vendor_string}+json") unless accept_string.include?('application/vnd.')
       offset = 0
       accepts.dup.each_with_index do |accept, i|
         accept.strip!

data/lib/api-versions/version.rb

@@ -1,8 +1,13 @@
 module ApiVersions
-  MAJOR = 1
-  MINOR = 2
-  PATCH = 0
-  PRE   = nil
+  class Version
+    MAJOR = 1
+    MINOR = 2
+    PATCH = 1
 
-  VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join '.'
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+
+  VERSION = Version.to_s
 end

data/spec/dummy/app/controllers/api/v3/nests/nested_controller.rb

@@ -1,2 +1,5 @@
-class Api::V3::Nests::NestedController
+class Api::V3::Nests::NestedController < ActionController::Base
+  def new
+    render nothing: true
+  end
 end

data/spec/dummy/config/routes.rb

@@ -15,6 +15,10 @@ Dummy::Application.routes.draw do
 
     version 3 do
       inherit from: 'v2'
+
+      namespace :nests do
+        resources :nested
+      end
     end
   end
 

data/spec/middleware_spec.rb

@@ -24,16 +24,16 @@ describe ApiVersions::Middleware do
       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
+    it "should add a default vendor accept to 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
+      response.last.should == "application/json,application/vnd.#{ApiVersions::VersionCheck.vendor_string}+json"
     end
 
-    it "should tolerate an empty Accept header" do
+    it "should add a default vendor accept to 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 == ""
+      response.last.should == "application/json,application/vnd.#{ApiVersions::VersionCheck.vendor_string}+json"
     end
   end
 end

data/spec/routing_spec.rb

@@ -55,13 +55,18 @@ describe 'API Routing' do
       get new_api_foo_path, nil, 'HTTP_ACCEPT' => 'application/vnd.myvendor+json;version=3'
       @controller.class.should == Api::V3::FooController
     end
+
+    it "should route to nested controllers" do
+      get new_api_nests_nested_path, nil, 'HTTP_ACCEPT' => 'application/vnd.myvendor+json;version=3'
+      @controller.class.should == Api::V3::Nests::NestedController
+    end
   end
 
   describe "Header syntax" do
     context "when valid" do
       after(:each) do
         get new_api_bar_path, nil, 'HTTP_ACCEPT' => @accept_string
-        desired_format = /application\/.*\+\W*(?<format>\w+)\W*/.match(@accept_string)[:format]
+        desired_format = /application\/.*\+\s*(?<format>\w+)\s*/.match(@accept_string)[:format]
         response.content_type.should == "application/#{desired_format}"
         response.should be_success
       end
@@ -72,11 +77,11 @@ describe 'API Routing' do
         end
 
         it "should allow spaces before" do
-          @accept_string = 'application/vnd.myvendor + xml ;version=1'
+          @accept_string = 'application/vnd.myvendor+xml ;version=1'
         end
 
         it "should allow spaces around" do
-          @accept_string = 'application/vnd.myvendor + xml ; version=1'
+          @accept_string = 'application/vnd.myvendor+xml ; version=1'
         end
       end
 
@@ -104,7 +109,7 @@ describe 'API Routing' do
         end
 
         it "should allow spacing around" do
-          @accept_string = 'application/vnd.myvendor +xml; version=1'
+          @accept_string = 'application/vnd.myvendor + xml; version=1'
         end
       end
     end
@@ -113,11 +118,6 @@ describe 'API Routing' do
       get new_api_bar_path, nil, 'HTTP_ACCEPT' => 'application/vnd.garbage+xml;version=1'
       response.status.should == 404
     end
-
-    it "should not route when no header is specified" do
-      get new_api_bar_path, nil
-      response.status.should == 404
-    end
   end
 
   describe 'paths' do

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+require 'coveralls'
+
+Coveralls.wear! do
+  add_filter "/spec/"
+end
+
 ENV["RAILS_ENV"] ||= 'test'
 require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'

metadata

@@ -1,55 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: api-versions
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Erich Menge
+- David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -66,16 +67,31 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: api-versions helps manage your Rails app API endpoints.
 email:
 - erich.menge@me.com
+- me@davidcel.is
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Changes.md
 - Gemfile
 - License.txt
@@ -110,7 +126,7 @@ files:
 - spec/middleware_spec.rb
 - spec/routing_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/erichmenge/api-versions
+homepage: https://github.com/EDMC/api-versions
 licenses: []
 metadata: {}
 post_install_message: 
@@ -119,17 +135,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: api-versions
-rubygems_version: 2.0.2
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: api-versions helps manage your Rails app API endpoints.
@@ -154,3 +170,4 @@ test_files:
 - spec/middleware_spec.rb
 - spec/routing_spec.rb
 - spec/spec_helper.rb
+has_rdoc: