如何使用 rspec 测试路由约束

我正在开发一个主要用作 API 的应用程序（除了一些次要视图，例如会话/注册，这将是“标准”）。我喜欢最终确定的方法Railscast #350：API 版本控制 http://railscasts.com/episodes/350-rest-api-versioning，于是也跟着做了。我的路线如下：

namespace :api, :defaults => {:format => 'json'} do
  scope :module => :v1, :constraints => ApiConstraints.new(:version => 1, :default => false) do
    resources :posts, :only => [:create, :show, :destroy, :index]
  end

  scope :module => :v2, :constraints => ApiConstraints.new(:version => 2, :default => true) do
    resources :posts, :only => [:create, :show, :destroy, :index]
  end
end

在每个路由中，我的 Constraint 是一个新的 ApiConstraints 对象，它位于我的./lib文件夹。该类看起来像这样：

class ApiConstraints
  def initialize(options)
    @version = options[:version]
    @default = options[:default]
  end

  def matches?(req)
    @default || req.headers['Accept'].include?("application/vnd.MYAPP.v#{@version}")
  end
end

现在，当手动测试时，一切都按预期进行。在我的 API 中，每个版本可能有 5 到 10 个控制器，并且不想测试 API 约束是否适用于每个单独的控制器，因为这没有意义。我正在寻找一个测试我的 API 约束的规范文件，但我不确定将该规范放在哪里。

我试过添加一个spec/routing/api_spec.rb文件来测试事物，但它无法正常工作，因为它抱怨未提供某些内容，如下所示：

it "should route an unversioned request to the latest version" do
  expect(:get => "/api/posts", :format => "json").to route_to(:controller => "api/v1/posts")
end

即使控制器正确匹配，上面的代码也会抛出错误。它失败并出现以下错误：

The recognized options <{"format"=>"json", "action"=>"index", "controller"=>"api/v1/posts"}>
did not match <{"controller"=>"api/v1/posts"}>,
difference: <{"format"=>"json", "action"=>"index"}>.

请注意，控制器已正确确定，但由于我不想在此测试中测试格式和操作，因此会出错。我希望有 3 个“API 规范”：

• 它应该将未版本控制的请求路由到最新版本
• 如果未指定，则默认为 JSON 格式
• 它应该在请求时返回指定的 API 版本

有人有为此类路线编写规范的经验吗？我不想为 API 内的每个控制器添加规范，因为它们不负责此功能。

Rspec's route_to匹配器代表ActionDispatch::Assertions::RoutingAssertions#assert_recognizes http://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes

论点为route_to被传递为expected_options哈希（经过一些预处理后，它还可以理解速记样式的参数，例如items#index).

您期望匹配的哈希值route_to匹配器（即{:get => "/api/posts", :format => "json"}）实际上并不是一个格式良好的论证expect。如果你看来源 https://github.com/rspec/rspec-rails/blob/master/lib/rspec/rails/matchers/routing_matchers.rb，你可以看到我们得到了匹配的路径 via

path, query = *verb_to_path_map.values.first.split('?')

The #first这是一个明确的信号，表明我们期望得到一个只有一个键值对的哈希值。所以:format => "json"组件实际上只是被丢弃，并且没有做任何事情。

The ActionDispatch断言期望您将完整的路径+动词与一组完整的控制器、操作和路径参数相匹配。所以 rspec 匹配器只是传递它委托的方法的限制。

听起来像是 rspec 内置的route_tomatcher 不会做你想做的事。所以下一个建议是假设ActionDispatch会做它应该做的事情，而只是为你的产品编写规范ApiConstraints class.

为此，我首先建议not使用默认值spec_helper。科里·海恩斯（Corey Haines）有一个很好的要点如何制作一个更快的规范助手，并且不会启动整个 Rails 应用程序 https://gist.github.com/coreyhaines/2068977。它可能并不适合您的情况，但我只是想指出这一点，因为您只是在这里实例化基本的 ruby​​ 对象，并且实际上并不需要任何 Rails 魔法。您也可以尝试要求ActionDispatch::Request& 依赖项，如果您不想像我在这里那样删除请求对象。

那看起来像

spec/lib/api_constraint.rb

require 'active_record_spec_helper'
require_relative '../../lib/api_constraint'

describe ApiConstraint do

  describe "#matches?" do

    let(:req) { Object.new }

     context "default version" do

       before :each do
         req.stub(:headers).and_return {}
         @opts = { :version => nil, :default => true }
       end

       it "returns true regardless of version number" do
         ApiConstraint.new(@opts).should match req
       end

     end

  end

end

...aa并且我会让您准确地弄清楚如何设置上下文/编写其他测试的期望。